EarnApi.md

gate_api.EarnApi

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

Method	HTTP request	Description
list_dual_investment_plans	GET /earn/dual/investment_plan	Dual Investment product list
list_dual_orders	GET /earn/dual/orders	Dual Investment order list
place_dual_order	POST /earn/dual/orders	Place Dual Investment order
list_dual_balance	GET /earn/dual/balance	Dual-Currency Earning Assets
get_dual_order_refund_preview	GET /earn/dual/order-refund-preview	Dual-currency early redemption preview
place_dual_order_refund	POST /earn/dual/order-refund	Dual-currency order early redemption
modify_dual_order_reinvest	POST /earn/dual/modify-order-reinvest	Modify dual-currency order reinvest
get_dual_project_recommend	GET /earn/dual/project-recommend	Dual-currency recommended projects
find_coin	GET /earn/staking/coins	Staking coins
swap_staking_coin	POST /earn/staking/swap	On-chain token swap for earned coins
order_list	GET /earn/staking/order_list	List of on-chain coin-earning orders
award_list	GET /earn/staking/award_list	On-chain coin-earning dividend records
asset_list	GET /earn/staking/assets	On-chain coin-earning assets
create_auto_invest_plan	POST /earn/autoinvest/plans/create	Create auto invest plan
update_auto_invest_plan	POST /earn/autoinvest/plans/update	UpdateAuto invest plan
stop_auto_invest_plan	POST /earn/autoinvest/plans/stop	StopAuto invest plan
add_position_auto_invest_plan	POST /earn/autoinvest/plans/add_position	Add position immediately
list_auto_invest_coins	GET /earn/autoinvest/coins	QueryCurrencies supporting auto invest
get_auto_invest_min_amount	POST /earn/autoinvest/min_invest_amount	Get minimum investment amount
list_auto_invest_plan_records	GET /earn/autoinvest/plans/records	List plan execution records
list_auto_invest_orders	GET /earn/autoinvest/orders	List plan execution recordsDetails（OrderDetails）
list_auto_invest_config	GET /earn/autoinvest/config	List investment currency configuration
get_auto_invest_plan_detail	GET /earn/autoinvest/plans/detail	QueryAuto invest planDetails
list_auto_invest_plans	GET /earn/autoinvest/plans/list_info	QueryAuto invest planList
list_earn_fixed_term_products	GET /earn/fixed-term/product	Get product list
list_earn_fixed_term_products_by_asset	GET /earn/fixed-term/product/{asset}/list	Get product list by single currency
list_earn_fixed_term_lends	GET /earn/fixed-term/user/lend	Subscription list
create_earn_fixed_term_lend	POST /earn/fixed-term/user/lend	Subscription
create_earn_fixed_term_pre_redeem	POST /earn/fixed-term/user/pre-redeem	Redeem
list_earn_fixed_term_history	GET /earn/fixed-term/user/history	Subscription history

list_dual_investment_plans

list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id, coin=coin, type=type, quote_currency=quote_currency, sort=sort, page=page, page_size=page_size)

Dual Investment product list

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
plan_id=1# int | Financial project ID (optional)coin='BTC'# str | Investment Token (optional)type='call'# str | Type enum: `put` — buy low; `call` — sell high (optional)quote_currency='quote_currency_example'# str | Settlement currency enum: defaults to USDT; GUSD optional (optional)sort='sort_example'# str | Sort field enum: `apy` — highest APY first `short-period` — shortest tenor first `multiple` — highest premium first (optional)page=1# int | page number (optional)page_size=3# int | Items per page (optional)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=plan_id, coin=coin, type=type, quote_currency=quote_currency, sort=sort, page=page, page_size=page_size)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_dual_investment_plans: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_id	int	Financial project ID	[optional]
coin	str	Investment Token	[optional]
type	str	Type enum: `put` — buy low; `call` — sell high	[optional]
quote_currency	str	Settlement currency enum: defaults to USDT; GUSD optional	[optional]
sort	str	Sort field enum: `apy` — highest APY first `short-period` — shortest tenor first `multiple` — highest premium first	[optional]
page	int	page number	[optional]
page_size	int	Items per page	[optional]

Return type

list[DualGetPlans]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_dual_orders

list[DualGetOrders] list_dual_orders(_from=_from, to=to, type=type, status=status, coin=coin, page=page, limit=limit)

Dual Investment order list

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
_from=1740727000# int | Start settlement time (optional)to=1740729000# int | End settlement time (optional)type='put'# str | Type enum: `put` — buy low; `call` — sell high (optional)status='HOLD'# str | Order status enum: `HOLD` — open position `REPAY` — historical position `PROCESSING` — position active `SETTLEMENT_PROCESSING` — settlement in progress `ALL` — all (optional)coin='BTC'# str | Investment Token (optional)page=1# int | Page number (optional) (default to 1)limit=100# int | Maximum number of records returned in a single list (optional) (default to 100)try:
# Dual Investment order listapi_response=api_instance.list_dual_orders(_from=_from, to=to, type=type, status=status, coin=coin, page=page, limit=limit)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_dual_orders: %s\n"%e)

Parameters

Name	Type	Description	Notes
_from	int	Start settlement time	[optional]
to	int	End settlement time	[optional]
type	str	Type enum: `put` — buy low; `call` — sell high	[optional]
status	str	Order status enum: `HOLD` — open position `REPAY` — historical position `PROCESSING` — position active `SETTLEMENT_PROCESSING` — settlement in progress `ALL` — all	[optional]
coin	str	Investment Token	[optional]
page	int	Page number	[optional] [default to 1]
limit	int	Maximum number of records returned in a single list	[optional] [default to 100]

Return type

list[DualGetOrders]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

place_dual_order

PlaceDualInvestmentOrder place_dual_order(place_dual_investment_order_params)

Place Dual Investment order

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
place_dual_investment_order_params=gate_api.PlaceDualInvestmentOrderParams() # PlaceDualInvestmentOrderParams | try:
# Place Dual Investment orderapi_response=api_instance.place_dual_order(place_dual_investment_order_params)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_dual_order: %s\n"%e)

Parameters

Name	Type	Description	Notes
place_dual_investment_order_params	PlaceDualInvestmentOrderParams

Return type

PlaceDualInvestmentOrder

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Order placed successfully	-

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

list_dual_balance

DualGetBalance list_dual_balance()

Dual-Currency Earning Assets

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
try:
# Dual-Currency Earning Assetsapi_response=api_instance.list_dual_balance()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_dual_balance: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

DualGetBalance

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

get_dual_order_refund_preview

DualOrderRefundPreview get_dual_order_refund_preview(order_id)

Dual-currency early redemption preview

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
order_id='9497'# str | Order IDtry:
# Dual-currency early redemption previewapi_response=api_instance.get_dual_order_refund_preview(order_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->get_dual_order_refund_preview: %s\n"%e)

Parameters

Name	Type	Description	Notes
order_id	str	Order ID

Return type

DualOrderRefundPreview

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

place_dual_order_refund

place_dual_order_refund(dual_order_refund_params)

Dual-currency order early redemption

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
dual_order_refund_params=gate_api.DualOrderRefundParams() # DualOrderRefundParams | try:
# Dual-currency order early redemptionapi_instance.place_dual_order_refund(dual_order_refund_params)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_dual_order_refund: %s\n"%e)

Parameters

Name	Type	Description	Notes
dual_order_refund_params	DualOrderRefundParams

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Redemption successful	-

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

modify_dual_order_reinvest

modify_dual_order_reinvest(dual_modify_order_reinvest_params)

Modify dual-currency order reinvest

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
dual_modify_order_reinvest_params=gate_api.DualModifyOrderReinvestParams() # DualModifyOrderReinvestParams | try:
# Modify dual-currency order reinvestapi_instance.modify_dual_order_reinvest(dual_modify_order_reinvest_params)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->modify_dual_order_reinvest: %s\n"%e)

Parameters

Name	Type	Description	Notes
dual_modify_order_reinvest_params	DualModifyOrderReinvestParams

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated successfully	-

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

get_dual_project_recommend

list[DualProjectRecommend] get_dual_project_recommend(mode=mode, coin=coin, type=type, history_pids=history_pids)

Dual-currency recommended projects

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
mode='normal'# str | Sort mode; default `normal`: `senior` — curated picks (APR/tenor) `apy_up` — APY ascending `ep_down` — target price descending `ep_up` — target price ascending `dt_down` — maturity time descending `dt_up` — maturity time ascending (optional)coin='ETH'# str | Investment Token (optional)type='call'# str | `call`: sell high; `put`: buy low (optional)history_pids='110656,110652'# str | Comma-separated project IDs to exclude already recommended items (optional)try:
# Dual-currency recommended projectsapi_response=api_instance.get_dual_project_recommend(mode=mode, coin=coin, type=type, history_pids=history_pids)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->get_dual_project_recommend: %s\n"%e)

Parameters

Name	Type	Description	Notes
mode	str	Sort mode; default `normal`: `senior` — curated picks (APR/tenor) `apy_up` — APY ascending `ep_down` — target price descending `ep_up` — target price ascending `dt_down` — maturity time descending `dt_up` — maturity time ascending	[optional]
coin	str	Investment Token	[optional]
type	str	`call`: sell high; `put`: buy low	[optional]
history_pids	str	Comma-separated project IDs to exclude already recommended items	[optional]

Return type

list[DualProjectRecommend]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

find_coin

list[object] find_coin(cointype=cointype)

Staking coins

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
cointype='cointype_example'# str | Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. (optional)try:
# Staking coinsapi_response=api_instance.find_coin(cointype=cointype)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->find_coin: %s\n"%e)

Parameters

Name	Type	Description	Notes
cointype	str	Currency type: swap - voucher; lock - locked position; debt - US Treasury bond.	[optional]

Return type

list[object]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

swap_staking_coin

SwapCoinStruct swap_staking_coin(swap_coin)

On-chain token swap for earned coins

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
swap_coin=gate_api.SwapCoin() # SwapCoin | try:
# On-chain token swap for earned coinsapi_response=api_instance.swap_staking_coin(swap_coin)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_staking_coin: %s\n"%e)

Parameters

Name	Type	Description	Notes
swap_coin	SwapCoin

Return type

SwapCoinStruct

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Swap successful	-

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

order_list

OrderListStruct order_list(pid=pid, coin=coin, type=type, page=page)

List of on-chain coin-earning orders

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
pid=7# int | Product ID (optional)coin='ETH'# str | Currency name (optional)type=0# int | Type 0-staking 1-redemption (optional)page=1# int | Page number (optional) (default to 1)try:
# List of on-chain coin-earning ordersapi_response=api_instance.order_list(pid=pid, coin=coin, type=type, page=page)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->order_list: %s\n"%e)

Parameters

Name	Type	Description	Notes
pid	int	Product ID	[optional]
coin	str	Currency name	[optional]
type	int	Type 0-staking 1-redemption	[optional]
page	int	Page number	[optional] [default to 1]

Return type

OrderListStruct

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

award_list

AwardListStruct award_list(pid=pid, coin=coin, page=page)

On-chain coin-earning dividend records

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
pid=7# int | Product ID (optional)coin='ETH'# str | Currency name (optional)page=1# int | Page number (optional) (default to 1)try:
# On-chain coin-earning dividend recordsapi_response=api_instance.award_list(pid=pid, coin=coin, page=page)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->award_list: %s\n"%e)

Parameters

Name	Type	Description	Notes
pid	int	Product ID	[optional]
coin	str	Currency name	[optional]
page	int	Page number	[optional] [default to 1]

Return type

AwardListStruct

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

asset_list

list[object] asset_list(coin=coin)

On-chain coin-earning assets

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
coin='ETH'# str | Currency name (optional)try:
# On-chain coin-earning assetsapi_response=api_instance.asset_list(coin=coin)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->asset_list: %s\n"%e)

Parameters

Name	Type	Description	Notes
coin	str	Currency name	[optional]

Return type

list[object]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

create_auto_invest_plan

AutoInvestPlanCreateResp create_auto_invest_plan(auto_invest_plan_create)

Create auto invest plan

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
auto_invest_plan_create=gate_api.AutoInvestPlanCreate() # AutoInvestPlanCreate | try:
# Create auto invest planapi_response=api_instance.create_auto_invest_plan(auto_invest_plan_create)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->create_auto_invest_plan: %s\n"%e)

Parameters

Name	Type	Description	Notes
auto_invest_plan_create	AutoInvestPlanCreate

Return type

AutoInvestPlanCreateResp

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Created successfully	-

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

update_auto_invest_plan

update_auto_invest_plan(auto_invest_plan_update)

UpdateAuto invest plan

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
auto_invest_plan_update=gate_api.AutoInvestPlanUpdate() # AutoInvestPlanUpdate | try:
# UpdateAuto invest planapi_instance.update_auto_invest_plan(auto_invest_plan_update)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->update_auto_invest_plan: %s\n"%e)

Parameters

Name	Type	Description	Notes
auto_invest_plan_update	AutoInvestPlanUpdate

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated successfully	-

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

stop_auto_invest_plan

stop_auto_invest_plan(auto_invest_plan_stop)

StopAuto invest plan

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
auto_invest_plan_stop=gate_api.AutoInvestPlanStop() # AutoInvestPlanStop | try:
# StopAuto invest planapi_instance.stop_auto_invest_plan(auto_invest_plan_stop)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->stop_auto_invest_plan: %s\n"%e)

Parameters

Name	Type	Description	Notes
auto_invest_plan_stop	AutoInvestPlanStop

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Stopped successfully	-

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

add_position_auto_invest_plan

add_position_auto_invest_plan(auto_invest_plan_add_position)

Add position immediately

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
auto_invest_plan_add_position=gate_api.AutoInvestPlanAddPosition() # AutoInvestPlanAddPosition | try:
# Add position immediatelyapi_instance.add_position_auto_invest_plan(auto_invest_plan_add_position)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->add_position_auto_invest_plan: %s\n"%e)

Parameters

Name	Type	Description	Notes
auto_invest_plan_add_position	AutoInvestPlanAddPosition

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Add PositionSuccess	-

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

list_auto_invest_coins

list[AutoInvestCoinsItem] list_auto_invest_coins(plan_money=plan_money)

QueryCurrencies supporting auto invest

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
plan_money='USDT'# str | Pricing currency，Optional: USDT or BTC，Default: USDT (optional)try:
# QueryCurrencies supporting auto investapi_response=api_instance.list_auto_invest_coins(plan_money=plan_money)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_auto_invest_coins: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_money	str	Pricing currency，Optional: USDT or BTC，Default: USDT	[optional]

Return type

list[AutoInvestCoinsItem]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

get_auto_invest_min_amount

AutoInvestMinInvestAmountResp get_auto_invest_min_amount(auto_invest_min_invest_amount)

Get minimum investment amount

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
auto_invest_min_invest_amount=gate_api.AutoInvestMinInvestAmount() # AutoInvestMinInvestAmount | try:
# Get minimum investment amountapi_response=api_instance.get_auto_invest_min_amount(auto_invest_min_invest_amount)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->get_auto_invest_min_amount: %s\n"%e)

Parameters

Name	Type	Description	Notes
auto_invest_min_invest_amount	AutoInvestMinInvestAmount

Return type

AutoInvestMinInvestAmountResp

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_auto_invest_plan_records

AutoInvestPlanRecordsResp list_auto_invest_plan_records(plan_id, page=page, page_size=page_size)

List plan execution records

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
plan_id=141378# int | Plan IDpage=1# int | page number (optional)page_size=10# int | Items per page，Maximum 100 (optional)try:
# List plan execution recordsapi_response=api_instance.list_auto_invest_plan_records(plan_id, page=page, page_size=page_size)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_auto_invest_plan_records: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_id	int	Plan ID
page	int	page number	[optional]
page_size	int	Items per page，Maximum 100	[optional]

Return type

AutoInvestPlanRecordsResp

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_auto_invest_orders

list[AutoInvestOrderItem] list_auto_invest_orders(plan_id, record_id)

List plan execution recordsDetails（OrderDetails）

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
plan_id=142583# int | Plan IDrecord_id=1770805384904919# int | Record IDtry:
# List plan execution recordsDetails（OrderDetails）api_response=api_instance.list_auto_invest_orders(plan_id, record_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_auto_invest_orders: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_id	int	Plan ID
record_id	int	Record ID

Return type

list[AutoInvestOrderItem]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_auto_invest_config

list[AutoInvestConfigItem] list_auto_invest_config()

List investment currency configuration

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
try:
# List investment currency configurationapi_response=api_instance.list_auto_invest_config()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_auto_invest_config: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

list[AutoInvestConfigItem]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

get_auto_invest_plan_detail

AutoInvestPlanDetail get_auto_invest_plan_detail(plan_id)

QueryAuto invest planDetails

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
plan_id=142609# int | Plan IDtry:
# QueryAuto invest planDetailsapi_response=api_instance.get_auto_invest_plan_detail(plan_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->get_auto_invest_plan_detail: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_id	int	Plan ID

Return type

AutoInvestPlanDetail

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_auto_invest_plans

AutoInvestPlanListInfoResp list_auto_invest_plans(status, page=page, page_size=page_size)

QueryAuto invest planList

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
status='active'# str | Plan status，History history，Active activepage=56# int | page number (optional)page_size=56# int | Items per page，Maximum 100 (optional)try:
# QueryAuto invest planListapi_response=api_instance.list_auto_invest_plans(status, page=page, page_size=page_size)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_auto_invest_plans: %s\n"%e)

Parameters

Name	Type	Description	Notes
status	str	Plan status，History history，Active active
page	int	page number	[optional]
page_size	int	Items per page，Maximum 100	[optional]

Return type

AutoInvestPlanListInfoResp

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_earn_fixed_term_products

ListEarnFixedTermProductsResponse list_earn_fixed_term_products(page, limit, asset=asset, type=type)

Get product list

Query fixed-term earn product list. Supports filtering by currency, product type, status, etc. Returns product interest rate, lock-up period, quota, and reward campaign information

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
page=1# int | Page numberlimit=100# int | Page sizeasset='USDT'# str | Currency (optional)type=1# int | Product type: 1 for regular, 2 for VIP (optional)try:
# Get product listapi_response=api_instance.list_earn_fixed_term_products(page, limit, asset=asset, type=type)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_earn_fixed_term_products: %s\n"%e)

Parameters

Name	Type	Description	Notes
page	int	Page number
limit	int	Page size
asset	str	Currency	[optional]
type	int	Product type: 1 for regular, 2 for VIP	[optional]

Return type

ListEarnFixedTermProductsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Product list retrieved successfully	-

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

list_earn_fixed_term_products_by_asset

ListEarnFixedTermProductsByAssetResponse list_earn_fixed_term_products_by_asset(asset, type=type)

Get product list by single currency

Sort by product term in ascending order

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
asset='USDT'# str | Currency name, e.g., USDT, BTCtype='1'# str | Product type: \"\" or 1 for regular product list, 2 for VIP product list, 0 for all products (optional)try:
# Get product list by single currencyapi_response=api_instance.list_earn_fixed_term_products_by_asset(asset, type=type)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_earn_fixed_term_products_by_asset: %s\n"%e)

Parameters

Name	Type	Description	Notes
asset	str	Currency name, e.g., USDT, BTC
type	str	Product type: "" or 1 for regular product list, 2 for VIP product list, 0 for all products	[optional]

Return type

ListEarnFixedTermProductsByAssetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Single currency product list retrieved successfully	-

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

list_earn_fixed_term_lends

ListEarnFixedTermLendsResponse list_earn_fixed_term_lends(order_type, page, limit, product_id=product_id, order_id=order_id, asset=asset, sub_business=sub_business, business_filter=business_filter)

Subscription list

Query the user's fixed-term earn subscription order list. Supports filtering by product, currency, order type, etc. Returns order details, earnings, rewards, and interest rate boost coupon information

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
order_type='1'# str | Order type: 1 for current orders, 2 for historical orderspage=1# int | Page numberlimit=10# int | Page sizeproduct_id=56# int | Product ID (optional)order_id=56# int | Order ID (optional)asset='asset_example'# str | Currency (optional)sub_business=56# int | Sub-business (optional)business_filter='[{\"business\":1, \"sub_business\": 0},{\"business\":2, \"sub_business\": 0}]'# str | Business filter conditions, JSON array format, e.g., [{\"business\":1, \"sub_business\": 0}]. business: 1 for regular, 2 for VIP (optional)try:
# Subscription listapi_response=api_instance.list_earn_fixed_term_lends(order_type, page, limit, product_id=product_id, order_id=order_id, asset=asset, sub_business=sub_business, business_filter=business_filter)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_earn_fixed_term_lends: %s\n"%e)

Parameters

Name	Type	Description	Notes
order_type	str	Order type: 1 for current orders, 2 for historical orders
page	int	Page number
limit	int	Page size
product_id	int	Product ID	[optional]
order_id	int	Order ID	[optional]
asset	str	Currency	[optional]
sub_business	int	Sub-business	[optional]
business_filter	str	Business filter conditions, JSON array format, e.g., [{"business":1, "sub_business": 0}]. business: 1 for regular, 2 for VIP	[optional]

Return type

ListEarnFixedTermLendsResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Subscription order list retrieved successfully	-

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

create_earn_fixed_term_lend

CreateEarnFixedTermLendResponse create_earn_fixed_term_lend(fixed_term_lend_request=fixed_term_lend_request)

Subscription

Subscribe to a fixed-term earn product by specifying the product ID and subscription amount. Optionally enable auto-renewal and apply an interest rate boost coupon

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
fixed_term_lend_request=gate_api.FixedTermLendRequest() # FixedTermLendRequest | (optional)try:
# Subscriptionapi_response=api_instance.create_earn_fixed_term_lend(fixed_term_lend_request=fixed_term_lend_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->create_earn_fixed_term_lend: %s\n"%e)

Parameters

Name	Type	Description	Notes
fixed_term_lend_request	FixedTermLendRequest		[optional]

Return type

CreateEarnFixedTermLendResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Subscription successful	-

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

create_earn_fixed_term_pre_redeem

CreateEarnFixedTermPreRedeemResponse create_earn_fixed_term_pre_redeem(earn_fixed_term_pre_redeem_request=earn_fixed_term_pre_redeem_request)

Redeem

Early redemption of a fixed-term earn order, order ID is required

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
earn_fixed_term_pre_redeem_request=gate_api.EarnFixedTermPreRedeemRequest() # EarnFixedTermPreRedeemRequest | (optional)try:
# Redeemapi_response=api_instance.create_earn_fixed_term_pre_redeem(earn_fixed_term_pre_redeem_request=earn_fixed_term_pre_redeem_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->create_earn_fixed_term_pre_redeem: %s\n"%e)

Parameters

Name	Type	Description	Notes
earn_fixed_term_pre_redeem_request	EarnFixedTermPreRedeemRequest		[optional]

Return type

CreateEarnFixedTermPreRedeemResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Redemption successful	-

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

list_earn_fixed_term_history

ListEarnFixedTermHistoryResponse list_earn_fixed_term_history(type, page, limit, product_id=product_id, order_id=order_id, asset=asset, start_at=start_at, end_at=end_at, sub_business=sub_business, business_filter=business_filter)

Subscription history

Query the user's fixed-term earn history records. Supports filtering by type (subscription, redemption, interest, bonus rewards) and time range

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.EarnApi(api_client)
type='1'# str | 1 for subscription, 2 for redemption, 3 for interest, 4 for bonus rewardpage=1# int | Page numberlimit=10# int | Page sizeproduct_id=56# int | Product ID (optional)order_id='order_id_example'# str | Order ID (optional)asset='asset_example'# str | Currency (optional)start_at=56# int | Start timestamp (optional)end_at=56# int | End Timestamp (optional)sub_business=56# int | Sub-business (optional)business_filter='[{\"business\":1, \"sub_business\": 0},{\"business\":2, \"sub_business\": 0}]'# str | Business filter conditions, JSON array format, e.g., [{\"business\":1, \"sub_business\": 0}]. business: 1 for regular, 2 for VIP (optional)try:
# Subscription historyapi_response=api_instance.list_earn_fixed_term_history(type, page, limit, product_id=product_id, order_id=order_id, asset=asset, start_at=start_at, end_at=end_at, sub_business=sub_business, business_filter=business_filter)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->list_earn_fixed_term_history: %s\n"%e)

Parameters

Name	Type	Description	Notes
type	str	1 for subscription, 2 for redemption, 3 for interest, 4 for bonus reward
page	int	Page number
limit	int	Page size
product_id	int	Product ID	[optional]
order_id	str	Order ID	[optional]
asset	str	Currency	[optional]
start_at	int	Start timestamp	[optional]
end_at	int	End Timestamp	[optional]
sub_business	int	Sub-business	[optional]
business_filter	str	Business filter conditions, JSON array format, e.g., [{"business":1, "sub_business": 0}]. business: 1 for regular, 2 for VIP	[optional]

Return type

ListEarnFixedTermHistoryResponse

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	History records retrieved successfully	-

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