This repository was archived by the owner on Jul 16, 2026. It is now read-only.

683 lines (511 loc) · 23.5 KB

gate_api.EarnApi

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

Method	HTTP request	Description
swap_eth2	POST /earn/staking/eth2/swap	ETH2 swap
rate_list_eth2	GET /earn/staking/eth2/rate_records	ETH2 historical return rate query
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_structured_products	GET /earn/structured/products	Structured Product List
list_structured_orders	GET /earn/structured/orders	Structured Product Order List
place_structured_order	POST /earn/structured/orders	Place Structured Product Order
find_coin	GET /earn/staking/coins	Staking coins
swap_staking_coin	POST /earn/staking/swap	On-chain token swap for earned coins

swap_eth2

swap_eth2(eth2_swap)

ETH2 swap

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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)

Parameters

Name	Type	Description	Notes
eth2_swap	Eth2Swap

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	Swap successful	-

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

rate_list_eth2

list[Eth2RateList] rate_list_eth2()

ETH2 historical return rate query

Query ETH earnings rate records for the last 31 days

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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

list[Eth2RateList]

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_dual_investment_plans

list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)

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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)

Parameters

Name	Type	Description	Notes
plan_id	int	Financial project ID	[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, 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)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, 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]
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

place_dual_order(place_dual_investment_order)

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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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	PlaceDualInvestmentOrder

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	Order placed successfully	-

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

list_structured_products

list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)

Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)

Parameters

Name	Type	Description	Notes
status	str	Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed
type	str	Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball	[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[StructuredGetProjectList]

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_structured_orders

list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)

Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)

Parameters

Name	Type	Description	Notes
_from	int	Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)	[optional]
to	int	Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp	[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[StructuredOrderList]

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_structured_order

place_structured_order(structured_buy)

Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)

Parameters

Name	Type	Description	Notes
structured_buy	StructuredBuy

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	Order placed successfully	-

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

find_coin

object find_coin(find_coin)

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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin	FindCoin

Return type

object

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]

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]

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all

 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

This repository was archived by the owner on Jul 16, 2026. It is now read-only.

gateio
/gateapi-pythonPublic archive
Notifications
You must be signed in to change notification settings
Fork
128

Star
344
Code
Issues43
Pull requests2
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
683 lines (511 loc) · 23.5 KB
Breadcrumbs
gateapi-python
/docs
/EarnApi.md
Copy path
File metadata and controls
683 lines (511 loc) · 23.5 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.EarnApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
swap_eth2 POST /earn/staking/eth2/swap ETH2 swap
rate_list_eth2 GET /earn/staking/eth2/rate_records ETH2 historical return rate query
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_structured_products GET /earn/structured/products Structured Product List
list_structured_orders GET /earn/structured/orders Structured Product Order List
place_structured_order POST /earn/structured/orders Place Structured Product Order
find_coin GET /earn/staking/coins Staking coins
swap_staking_coin POST /earn/staking/swap On-chain token swap for earned coinsswap_eth2
swap_eth2(eth2_swap)
ETH2 swap
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)
eth2_swap=gate_api.Eth2Swap() # Eth2Swap | try:
# ETH2 swapapi_instance.swap_eth2(eth2_swap)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->swap_eth2: %s\n"%e)
Parameters
Name Type Description Notes
eth2_swap Eth2Swap 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 Swap successful -[Back to top][Back to API list][Back to Model list][Back to README]
rate_list_eth2
list[Eth2RateList] rate_list_eth2()
ETH2 historical return rate query
Query ETH earnings rate records for the last 31 days
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:
# ETH2 historical return rate queryapi_response=api_instance.rate_list_eth2()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->rate_list_eth2: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[Eth2RateList]
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_dual_investment_plans
list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
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)try:
# Dual Investment product listapi_response=api_instance.list_dual_investment_plans(plan_id=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->list_dual_investment_plans: %s\n"%e)
Parameters
Name Type Description Notes
plan_id int Financial project ID [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, 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)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, 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]
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
place_dual_order(place_dual_investment_order)
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=gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try:
# Place Dual Investment orderapi_instance.place_dual_order(place_dual_investment_order)
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 PlaceDualInvestmentOrder 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
list_structured_products
list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit)
Structured 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)
status='in_process'# str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed type='BullishSharkFin'# str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (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:
# Structured Product Listapi_response=api_instance.list_structured_products(status, type=type, 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_structured_products: %s\n"%e)
Parameters
Name Type Description Notes
status str Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed 
type str Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball [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[StructuredGetProjectList]
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_structured_orders
list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit)
Structured Product 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=1547706332# int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)to=1547706332# int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (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:
# Structured Product Order Listapi_response=api_instance.list_structured_orders(_from=_from, to=to, 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_structured_orders: %s\n"%e)
Parameters
Name Type Description Notes
_from int Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) [optional]
to int Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp [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[StructuredOrderList]
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_structured_order
place_structured_order(structured_buy)
Place Structured Product 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)
structured_buy=gate_api.StructuredBuy() # StructuredBuy | try:
# Place Structured Product Orderapi_instance.place_structured_order(structured_buy)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling EarnApi->place_structured_order: %s\n"%e)
Parameters
Name Type Description Notes
structured_buy StructuredBuy 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 Order placed successfully -[Back to top][Back to API list][Back to Model list][Back to README]
find_coin
object find_coin(find_coin)
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)
find_coin=gate_api.FindCoin() # FindCoin | try:
# Staking coinsapi_response=api_instance.find_coin(find_coin)
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
find_coin FindCoin Return type
object
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]
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]
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

FilesExpand file tree

EarnApi.md

Latest commit

History

EarnApi.md

File metadata and controls

gate_api.EarnApi

swap_eth2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

rate_list_eth2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_dual_investment_plans

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_dual_orders

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

place_dual_order

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_structured_products

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_structured_orders

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

place_structured_order

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_coin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

swap_staking_coin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

EarnApi.md

Latest commit