Skip to content

RebateApi.md

Latest commit

 

History

History
951 lines (747 loc) · 37.5 KB

RebateApi.md

File metadata and controls

951 lines (747 loc) · 37.5 KB

Io.Gate.GateApi.Api.RebateApi

All URIs are relative to https://api.gateio.ws/api/v4

Method HTTP request Description
AgencyTransactionHistory GET /rebate/agency/transaction_history Broker obtains transaction history of recommended users
AgencyCommissionsHistory GET /rebate/agency/commission_history Broker obtains rebate history of recommended users
PartnerTransactionHistory GET /rebate/partner/transaction_history Partner obtains transaction history of recommended users
PartnerCommissionsHistory GET /rebate/partner/commission_history Partner obtains rebate records of recommended users
PartnerSubList GET /rebate/partner/sub_list Partner subordinate list
RebateBrokerCommissionHistory GET /rebate/broker/commission_history Broker obtains user's rebate records
RebateBrokerTransactionHistory GET /rebate/broker/transaction_history Broker obtains user's trading history
RebateUserInfo GET /rebate/user/info User obtains rebate information
UserSubRelation GET /rebate/user/sub_relation User subordinate relationship
GetPartnerApplicationRecent GET /rebate/partner/applications/recent Get recent partner application records
GetPartnerEligibility GET /rebate/partner/eligibility Check partner application eligibility
GetPartnerAgentDataAggregated GET /rebate/partner/data/aggregated Aggregated partner agent statistics

AgencyTransactionHistory

List<AgencyTransactionHistory> AgencyTransactionHistory (string currencyPair = null, long? userId = null, long? from = null, long? to = null, int? limit = null, int? offset = null)

Broker obtains transaction history of recommended users

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class AgencyTransactionHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var currencyPair = "BTC_USDT";  // string | Specify the trading pair. If not specified, returns all trading pairs (optional) 
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1602120000;  // long? | Start time for querying records. If not specified, defaults to 7 days before current time (optional) 
            var to = 1602123600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)

            try
            {
                // Broker obtains transaction history of recommended users
                List<AgencyTransactionHistory> result = apiInstance.AgencyTransactionHistory(currencyPair, userId, from, to, limit, offset);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.AgencyTransactionHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
currencyPair string Specify the trading pair. If not specified, returns all trading pairs [optional]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time for querying records. If not specified, defaults to 7 days before current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]

Return type

List<AgencyTransactionHistory>

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AgencyCommissionsHistory

List<AgencyCommissionHistory> AgencyCommissionsHistory (string currency = null, int? commissionType = null, long? userId = null, long? from = null, long? to = null, int? limit = null, int? offset = null)

Broker obtains rebate history of recommended users

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class AgencyCommissionsHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var currency = "BTC";  // string | Specify the currency. If not specified, returns all currencies (optional) 
            var commissionType = 1;  // int? | Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate (optional) 
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1602120000;  // long? | Start time for querying records. If not specified, defaults to 7 days before current time (optional) 
            var to = 1602123600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)

            try
            {
                // Broker obtains rebate history of recommended users
                List<AgencyCommissionHistory> result = apiInstance.AgencyCommissionsHistory(currency, commissionType, userId, from, to, limit, offset);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.AgencyCommissionsHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
currency string Specify the currency. If not specified, returns all currencies [optional]
commissionType int? Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate [optional]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time for querying records. If not specified, defaults to 7 days before current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]

Return type

List<AgencyCommissionHistory>

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PartnerTransactionHistory

PartnerTransactionHistory PartnerTransactionHistory (string currencyPair = null, long? userId = null, long? from = null, long? to = null, int? limit = null, int? offset = null)

Partner obtains transaction history of recommended users

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class PartnerTransactionHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var currencyPair = "BTC_USDT";  // string | Specify the trading pair. If not specified, returns all trading pairs (optional) 
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1602120000;  // long? | Start time for querying records. If not specified, defaults to 7 days before current time (optional) 
            var to = 1602123600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)

            try
            {
                // Partner obtains transaction history of recommended users
                PartnerTransactionHistory result = apiInstance.PartnerTransactionHistory(currencyPair, userId, from, to, limit, offset);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.PartnerTransactionHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
currencyPair string Specify the trading pair. If not specified, returns all trading pairs [optional]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time for querying records. If not specified, defaults to 7 days before current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]

Return type

PartnerTransactionHistory

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PartnerCommissionsHistory

PartnerCommissionHistory PartnerCommissionsHistory (string currency = null, long? userId = null, long? from = null, long? to = null, int? limit = null, int? offset = null)

Partner obtains rebate records of recommended users

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class PartnerCommissionsHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var currency = "BTC";  // string | Specify the currency. If not specified, returns all currencies (optional) 
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1602120000;  // long? | Start time for querying records. If not specified, defaults to 7 days before current time (optional) 
            var to = 1602123600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)

            try
            {
                // Partner obtains rebate records of recommended users
                PartnerCommissionHistory result = apiInstance.PartnerCommissionsHistory(currency, userId, from, to, limit, offset);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.PartnerCommissionsHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
currency string Specify the currency. If not specified, returns all currencies [optional]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time for querying records. If not specified, defaults to 7 days before current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]

Return type

PartnerCommissionHistory

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PartnerSubList

PartnerSubList PartnerSubList (long? userId = null, int? limit = null, int? offset = null)

Partner subordinate list

Including sub-agents, direct customers, and indirect customers

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class PartnerSubListExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)

            try
            {
                // Partner subordinate list
                PartnerSubList result = apiInstance.PartnerSubList(userId, limit, offset);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.PartnerSubList: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
userId long? User ID. If not specified, all user records will be returned [optional]
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]

Return type

PartnerSubList

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RebateBrokerCommissionHistory

List<BrokerCommission> RebateBrokerCommissionHistory (int? limit = null, int? offset = null, long? userId = null, long? from = null, long? to = null)

Broker obtains user's rebate records

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class RebateBrokerCommissionHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1711929600;  // long? | Start time of the query record. If not specified, defaults to 30 days before the current time (optional) 
            var to = 1714521600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 

            try
            {
                // Broker obtains user's rebate records
                List<BrokerCommission> result = apiInstance.RebateBrokerCommissionHistory(limit, offset, userId, from, to);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.RebateBrokerCommissionHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time of the query record. If not specified, defaults to 30 days before the current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]

Return type

List<BrokerCommission>

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RebateBrokerTransactionHistory

List<BrokerTransactionHistory> RebateBrokerTransactionHistory (int? limit = null, int? offset = null, long? userId = null, long? from = null, long? to = null)

Broker obtains user's trading history

Record query time range cannot exceed 30 days

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class RebateBrokerTransactionHistoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var limit = 100;  // int? | Maximum number of records returned in a single list (optional)  (default to 100)
            var offset = 0;  // int? | List offset, starting from 0 (optional)  (default to 0)
            var userId = 10003;  // long? | User ID. If not specified, all user records will be returned (optional) 
            var from = 1711929600;  // long? | Start time of the query record. If not specified, defaults to 30 days before the current time (optional) 
            var to = 1714521600;  // long? | End timestamp for the query, defaults to current time if not specified (optional) 

            try
            {
                // Broker obtains user's trading history
                List<BrokerTransactionHistory> result = apiInstance.RebateBrokerTransactionHistory(limit, offset, userId, from, to);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.RebateBrokerTransactionHistory: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
limit int? Maximum number of records returned in a single list [optional] [default to 100]
offset int? List offset, starting from 0 [optional] [default to 0]
userId long? User ID. If not specified, all user records will be returned [optional]
from long? Start time of the query record. If not specified, defaults to 30 days before the current time [optional]
to long? End timestamp for the query, defaults to current time if not specified [optional]

Return type

List<BrokerTransactionHistory>

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RebateUserInfo

List<RebateUserInfo> RebateUserInfo ()

User obtains rebate information

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class RebateUserInfoExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);

            try
            {
                // User obtains rebate information
                List<RebateUserInfo> result = apiInstance.RebateUserInfo();
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.RebateUserInfo: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<RebateUserInfo>

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Query successful -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserSubRelation

UserSubRelation UserSubRelation (string userIdList)

User subordinate relationship

Query whether the specified user is within the system

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class UserSubRelationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var userIdList = "1, 2, 3";  // string | Query user ID list, separated by commas. If more than 100, only 100 will be returned

            try
            {
                // User subordinate relationship
                UserSubRelation result = apiInstance.UserSubRelation(userIdList);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.UserSubRelation: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
userIdList string Query user ID list, separated by commas. If more than 100, only 100 will be returned

Return type

UserSubRelation

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List retrieved successfully -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPartnerApplicationRecent

PartnerApplicationResponse GetPartnerApplicationRecent ()

Get recent partner application records

获取当前用户最近的合伙人申请记录。 此接口返回用户最近 30 天内的申请记录，包括申请状态、审核信息、申请材料等详细信息。

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class GetPartnerApplicationRecentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);

            try
            {
                // Get recent partner application records
                PartnerApplicationResponse result = apiInstance.GetPartnerApplicationRecent();
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.GetPartnerApplicationRecent: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PartnerApplicationResponse

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPartnerEligibility

EligibilityResponse GetPartnerEligibility ()

Check partner application eligibility

检查当前用户是否有资格申请成为合伙人。 此接口会检查多个条件： - 账户状态（是否被封禁） - 是否为子账号 - 是否已经是合伙人 - KYC 认证状态 - 是否在其他代理商的邀请链下 - 是否在黑名单中 - 其他业务规则限制

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class GetPartnerEligibilityExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);

            try
            {
                // Check partner application eligibility
                EligibilityResponse result = apiInstance.GetPartnerEligibility();
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.GetPartnerEligibility: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

EligibilityResponse

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPartnerAgentDataAggregated

PartnerDataAggregatedResponse GetPartnerAgentDataAggregated (string startDate = null, string endDate = null, int? businessType = null)

Aggregated partner agent statistics

查询指定时间范围内合伙人代理的数据聚合统计，包括返佣金额、交易量、净手续费、客户数和交易人数。 注意事项： - 交易人数 trading_user_count 仅在 business_type=0（全部）时返回 - 时间参数使用 UTC+8 时区 - 如不传时间参数，默认查询近 7 天数据 - 仅限合伙人代理访问，子账号无权限

Example

using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;

namespace Example
{
    public class GetPartnerAgentDataAggregatedExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.gateio.ws/api/v4";
            config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");

            var apiInstance = new RebateApi(config);
            var startDate = "2024-01-01 00:00:00";  // string | 查询开始时间，格式：yyyy-mm-dd hh:ii:ss（UTC+8）  不传时默认为近 7 日开始时间 (optional) 
            var endDate = "2024-01-07 23:59:59";  // string | 查询结束时间，格式：yyyy-mm-dd hh:ii:ss（UTC+8）  不传时默认为近 7 日结束时间 (optional) 
            var businessType = 0;  // int? | Business type filter: - 0: All (default) - 1: Spot - 2: Futures - 3: Alpha - 4: Web3 - 5: Perps (DEX) - 6: Exchange All - 7: Web3 All - 8: TradFi (optional)  (default to 0)

            try
            {
                // Aggregated partner agent statistics
                PartnerDataAggregatedResponse result = apiInstance.GetPartnerAgentDataAggregated(startDate, endDate, businessType);
                Debug.WriteLine(result);
            }
            catch (GateApiException e)
            {
                Debug.Print("Exception when calling RebateApi.GetPartnerAgentDataAggregated: " + e.Message);
                Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
startDate string 查询开始时间，格式：yyyy-mm-dd hh:ii:ss（UTC+8） 不传时默认为近 7 日开始时间 [optional]
endDate string 查询结束时间，格式：yyyy-mm-dd hh:ii:ss（UTC+8） 不传时默认为近 7 日结束时间 [optional]
businessType int? Business type filter: - 0: All (default) - 1: Spot - 2: Futures - 3: Alpha - 4: Web3 - 5: Perps (DEX) - 6: Exchange All - 7: Web3 All - 8: TradFi [optional] [default to 0]

Return type

PartnerDataAggregatedResponse

Authorization

apiv4

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Query successful -
400 Invalid request parameters -
401 Unauthorized access -
403 Access denied -

[Back to top] [Back to API list] [Back to Model list] [Back to README]