Gate API v4

https://www.gate.com/docs/developers/apiv4/en/
Admin
Gate API v4 is a comprehensive REST API providing operations for spot, margin, and futures trading,...
Tokens:1,016,413
Snippets:5,190
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example 200 Response for GET /earn/dual/project-recommend

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Example 200 response for GET /earn/dual/project-recommend, showing a single recommended dual-currency project with fields such as id, type, invest_currency, exercise_price, and apy_display.

```json
[
  {
    "id": 110669,
    "category": 1,
    "type": "call",
    "invest_currency": "BTC",
    "exercise_currency": "USDT",
    "apy_display": "2.60",
    "exercise_price": "71303.44279",
    "delivery_timest": 1775289600,
    "min_amount": "1",
    "max_amount": "100000",
    "min_copies": 1,
    "max_copies": 100000,
    "invest_days": 2,
    "invest_hours": "70.43458031"
  }
]

```

--------------------------------

### Example 200 response for GET /loan/multi_collateral/ltv

Source: https://www.gate.com/docs/developers/apiv4/en/multi-collateral-loan

Example 200 response for the GET /loan/multi_collateral/ltv endpoint. Shows the initial, warning, and liquidation collateralization rates as strings.

```json
{
  "init_ltv": "0.7",
  "alert_ltv": "0.8",
  "liquidate_ltv": "0.9"
}

```

--------------------------------

### Example 200 Response for GET /wallet/small_balance

Source: https://www.gate.com/docs/developers/apiv4/en/wallet

Example 200 response for GET /wallet/small_balance, showing an array of small balance conversion objects with currency, available_balance, estimated_as_btc, and convertible_to_gt fields.

```json
[
  [
    {
      "currency": "FLOKI",
      "available_balance": "182.29400000",
      "estimated_as_btc": "0.00000012",
      "convertible_to_gt": "0.001080"
    },
    {
      "currency": "MBLK",
      "available_balance": "0.91723337",
      "estimated_as_btc": "0.00000102",
      "convertible_to_gt": "0.009188"
    }
  ]
]
```

--------------------------------

### GET /futures/{settle}/insurance - Python and curl examples

Source: https://www.gate.com/docs/developers/apiv4/en/futures

Example requests for the GET /futures/{settle}/insurance endpoint. The Python example uses the requests library and prints the JSON response. The shell example uses curl with the Accept header.

```python
# coding: utf-8
import requests

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/futures/usdt/insurance'
query_param = ''
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

```shell
curl -X GET https://api.gateio.ws/api/v4/futures/usdt/insurance \
  -H 'Accept: application/json'

```

--------------------------------

### Example response for GET /options/expirations

Source: https://www.gate.com/docs/developers/apiv4/en/options

Example 200 response for the GET /options/expirations endpoint. Shows an array of Unix timestamps representing expiration dates.

```json
[
  1637913600
]

```

--------------------------------

### Create Spot POV Order with Python

Source: https://www.gate.com/docs/developers/apiv4/en/spot

Python example for creating a Spot POV order. Requires the `gen_sign` function from the Authentication section and a valid API key/secret.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/spot/pov_orders'
query_param = ''
body='{"currency_pair":"BTC_USDT","side":"buy","amount":"1","participation_rate":5,"ttl":"1h","limit_price":"63000","trigger_price":"63000"}'
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('POST', prefix + url, query_param, body)
headers.update(sign_headers)
r = requests.request('POST', host + prefix + url, headers=headers, data=body)
print(r.json())
```

--------------------------------

### Example response for GET /options/underlyings

Source: https://www.gate.com/docs/developers/apiv4/en/options

Example 200 response for the GET /options/underlyings endpoint. Shows an array of underlying objects with name and index_price fields.

```json
[
  {
    "name": "BTC_USDT",
    "index_price": "70000"
  }
]

```

--------------------------------

### List options orders with Python

Source: https://www.gate.com/docs/developers/apiv4/en/options

Python example for listing options orders with status=open. Requires the gen_sign function from the Authentication section.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/options/orders'
query_param = 'status=open'
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 Response for GET /rebate/agency/transaction_history

Source: https://www.gate.com/docs/developers/apiv4/en/rebate

Example 200 response for the GET /rebate/agency/transaction_history endpoint, showing the structure of the returned transaction history list.

```json
{
  "total": 100,
  "list": [
    {
      "transaction_time": 1539852480,
      "user_id": 10000,
      "group_name": "gateio",
      "fee": "1",
      "fee_asset": "GT",
      "currency_pair": "GT_USDT",
      "amount": "1000",
      "source": "SPOT",
      "amount_asset": "GT"
    }
  ]
}
```

--------------------------------

### Python: GET /earn/dual/project-recommend

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Python example for the authenticated GET /earn/dual/project-recommend endpoint. Requires API key and secret; uses the gen_sign helper from the Authentication section.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/earn/dual/project-recommend'
query_param = ''
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 Response for GET /rebate/agency/commission_history

Source: https://www.gate.com/docs/developers/apiv4/en/rebate

Example 200 response for the GET /rebate/agency/commission_history endpoint, showing the structure with total and list of commission history objects.

```json
{
  "total": 100,
  "list": [
    {
      "commission_time": 1539852480,
      "user_id": 10000,
      "group_name": "gateio",
      "commission_amount": "1000",
      "source": "SPOT",
      "commission_asset": "GT"
    }
  ]
}
```

--------------------------------

### Example 200 Response for GET /account/main_keys

Source: https://www.gate.com/docs/developers/apiv4/en/account

Example JSON response for a successful request. Shows an array of AccountKeyInfo objects with fields such as state, mode, name, perms, ip_whitelist, currency_pairs, key, created_at, update_at, and last_access.

```JSON
[
  {
    "state": 1,
    "mode": 1,
    "name": "test1",
    "user_id": 1,
    "perms": [
      {
        "name": "account",
        "read_only": false
      },
      {
        "name": "spot",
        "read_only": false
      }
    ],
    "ip_whitelist": [],
    "currency_pairs": [
      "BTC_USD",
      "ETH_USD"
    ],
    "key": "c5dcfbf1f3a7*****",
    "created_at": 1753030929,
    "update_at": 1756300567,
    "last_access": 1753030929
  },
  {
    "state": 1,
    "mode": 1,
    "name": "test2",
    "user_id": 1,
    "perms": [
      {
        "name": "spot",
        "read_only": false
      },
      {
        "name": "account",
        "read_only": false
      }
    ],
    "ip_whitelist": [],
    "currency_pairs": [
      "BTC_USD",
      "ETH_USD"
    ],
    "key": "52fd0035f665*****",
    "created_at": 1753897991,
    "update_at": 1756300567,
    "last_access": 1753897991
  }
]

```

--------------------------------

### Example 200 Response for GET /margin/uni/borrowable

Source: https://www.gate.com/docs/developers/apiv4/en/isolated-margin

Example 200 response for the GET /margin/uni/borrowable endpoint, showing the MaxUniBorrowable schema with currency, borrowable, and currency_pair fields.

```json
{
  "currency": "AE",
  "borrowable": "1123.344",
  "currency_pair": "AE_USDT"
}
```

--------------------------------

### Example response: Query user's lending order list

Source: https://www.gate.com/docs/developers/apiv4/en/earnuni

Example 200 response for the GET /earn/uni/lends endpoint. Shows an array of UniLend objects with fields like currency, current_amount, amount, lent_amount, frozen_amount, min_rate, interest_status, reinvest_left_amount, create_time, and update_time.

```JSON
[
  {
    "currency": "BTC",
    "current_amount": "20.999992",
    "amount": "20.999992",
    "lent_amount": "0",
    "frozen_amount": "0",
    "min_rate": "0.1",
    "interest_status": "interest_dividend",
    "reinvest_left_amount": 0,
    "create_time": 1673247054000,
    "update_time": 1673247054000
  }
]

```

--------------------------------

### Example 200 response for /spot/fee

Source: https://www.gate.com/docs/developers/apiv4/en/spot

Example 200 response for the `/spot/fee` endpoint, showing fee rates, GT discount settings, loan fee, point type, currency pair, and debit fee.

```json
{
  "user_id": 10001,
  "taker_fee": "0.002",
  "maker_fee": "0.002",
  "gt_discount": false,
  "gt_taker_fee": "0",
  "gt_maker_fee": "0",
  "loan_fee": "0.18",
  "point_type": "1",
  "currency_pair": "BTC_USDT",
  "debit_fee": 3
}
```

--------------------------------

### Python GET /earn/dual/investment_plan

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Python example using the requests library to call the GET /earn/dual/investment_plan endpoint. It sets the API host and prefix, sends a GET request with the required headers, and prints the JSON response.

```python
# coding: utf-8
import requests

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/earn/dual/investment_plan'
query_param = ''
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 response for GET /earn/uni/chart

Source: https://www.gate.com/docs/developers/apiv4/en/earnuni

Example 200 response for the GET /earn/uni/chart endpoint. Shows an array of UniChartPoint objects with time and value fields.

```json
[
  {
    "time": 1719705600,
    "value": "0.01"
  }
]
```

--------------------------------

### Python: Query Auto Invest plan details

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Python example for the authenticated GET /earn/autoinvest/plans/detail endpoint. Requires the gen_sign helper from the Authentication section and a valid plan_id.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/earn/autoinvest/plans/detail'
query_param = 'plan_id=142609'
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
print(r.json())
```

--------------------------------

### List lending markets - Python and curl requests

Source: https://www.gate.com/docs/developers/apiv4/en/isolated-margin

Example requests for the GET /margin/uni/currency_pairs endpoint. The Python example uses the requests library and prints the JSON response. The curl example sends a GET request with an Accept header.

```python
# coding: utf-8
import requests

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/margin/uni/currency_pairs'
query_param = ''
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

```shell
curl -X GET https://api.gateio.ws/api/v4/margin/uni/currency_pairs \
  -H 'Accept: application/json'

```

--------------------------------

### Example 200 response for GET /crossex/interest_rate

Source: https://www.gate.com/docs/developers/apiv4/en/crossex

Example 200 response for the GET /crossex/interest_rate endpoint. Returns an array of objects with coin, exchange_type, hour_interest_rate, and time fields.

```json
[
  {
    "coin": "BCH",
    "exchange_type": "GATE",
    "hour_interest_rate": "0.00000485",
    "time": "1763971200000"
  },
  {
    "coin": "ADA",
    "exchange_type": "BINANCE",
    "hour_interest_rate": "0.0000036558334",
    "time": "1763971200000"
  },
  {
    "coin": "BCH",
    "exchange_type": "OKX",
    "hour_interest_rate": "0.00000115",
    "time": "1763971200000"
  }
]
```

--------------------------------

### List spot accounts with Python

Source: https://www.gate.com/docs/developers/apiv4/en/spot

Python example for listing spot trading accounts. Requires API key and secret for authentication; uses the `gen_sign` helper from the Authentication section.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/spot/accounts'
query_param = ''
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 Response for GET /earn/staking/award_list

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Example 200 response for the GET /earn/staking/award_list endpoint, showing the AwardListStruct schema with pagination fields and a list of dividend records.

```json
{
  "page": 1,
  "pageSize": 20,
  "pageCount": 2,
  "totalCount": 33,
  "list": [
    {
      "pid": 64,
      "mortgage_coin": "USDT",
      "amount": "0.0000019100",
      "reward_coin": "COMP",
      "interest": "0.0000019100",
      "fee": "0.0000000700",
      "status": 4,
      "bonus_date": "2025-08-08 00:00:00",
      "should_bonus_stamp": 1755907200
    },
    {
      "pid": 27,
      "mortgage_coin": "DOT",
      "amount": "0.0023424700",
      "reward_coin": "DOT",
      "interest": "0.0023424700",
      "fee": "0.0001232800",
      "status": 4,
      "bonus_date": "2025-08-11 00:00:00",
      "should_bonus_stamp": 1755043200
    }
  ]
}
```

--------------------------------

### JSON: Example 200 response for GET /spot/batch_fee

Source: https://www.gate.com/docs/developers/apiv4/en/spot

Example 200 response for the GET /spot/batch_fee endpoint. Shows the fee rates for BTC_USDT, GT_USDT, and ETH_USDT, including taker/maker fees, GT discount flags, loan fee, point type, debit fee, and RPI MM level.

```JSON
{
  "BTC_USDT": {
    "user_id": 10001,
    "taker_fee": "0.002",
    "maker_fee": "0.002",
    "rpi_maker_fee": "-0.00175",
    "gt_discount": false,
    "gt_taker_fee": "0",
    "gt_maker_fee": "0",
    "loan_fee": "0.18",
    "point_type": "1",
    "currency_pair": "BTC_USDT",
    "debit_fee": 3,
    "rpi_mm": 2
  },
  "GT_USDT": {
    "user_id": 10001,
    "taker_fee": "0.002",
    "maker_fee": "0.002",
    "rpi_maker_fee": "-0.00175",
    "gt_discount": false,
    "gt_taker_fee": "0",
    "gt_maker_fee": "0",
    "loan_fee": "0.18",
    "point_type": "1",
    "currency_pair": "GT_USDT",
    "debit_fee": 3,
    "rpi_mm": 2
  },
  "ETH_USDT": {
    "user_id": 10001,
    "taker_fee": "0.002",
    "maker_fee": "0.002",
    "rpi_maker_fee": "-0.00175",
    "gt_discount": false,
    "gt_taker_fee": "0",
    "gt_maker_fee": "0",
    "loan_fee": "0.18",
    "point_type": "1",
    "currency_pair": "ETH_USDT",
    "debit_fee": 3,
    "rpi_mm": 2
  }
}
```

--------------------------------

### Python: GET /rebate/agency/commission_history

Source: https://www.gate.com/docs/developers/apiv4/en/rebate

Python example using the requests library to call the GET /rebate/agency/commission_history endpoint. Requires a gen_sign function for authentication; the query_param is empty in this example.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/rebate/agency/commission_history'
query_param = ''
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 response for user currency leverage

Source: https://www.gate.com/docs/developers/apiv4/en/unified

Example 200 response for the GET /unified/leverage/user_currency_setting endpoint. Shows an array of UnifiedLeverageSetting objects with currency and leverage fields.

```json
[
  {
    "currency": "BTC",
    "leverage": "3"
  }
]
```

--------------------------------

### 200 Response example for GET /options/trades

Source: https://www.gate.com/docs/developers/apiv4/en/options

Example 200 response for the GET /options/trades endpoint. Shows an array of OptionsTrade objects with fields id, create_time, contract, size, and price.

```json
[
  {
    "id": 121234231,
    "create_time": 1514764800,
    "contract": "BTC_USDT-20211130-65000-C",
    "size": 100,
    "price": "1.032"
  }
]

```

--------------------------------

### Example 200 response for user currency leverage config

Source: https://www.gate.com/docs/developers/apiv4/en/unified

Example 200 response for the GET /unified/leverage/user_currency_config endpoint, showing the UnifiedLeverageConfig schema fields.

```json
{
  "current_leverage": "2",
  "min_leverage": "0",
  "max_leverage": "0",
  "debit": "0",
  "available_margin": "0",
  "borrowable": "0",
  "except_leverage_borrowable": "0"
}
```

--------------------------------

### Example 200 response for GET /options/underlying/candlesticks

Source: https://www.gate.com/docs/developers/apiv4/en/options

Example 200 response for the GET /options/underlying/candlesticks endpoint, showing a single candlestick data point with timestamp, volume, and OHLC prices.

```json
[
  {
    "t": 1539852480,
    "v": 97151,
    "c": "1.032",
    "h": "1.032",
    "l": "1.032",
    "o": "1.032"
  }
]

```

--------------------------------

### Python: List plan execution records (GET /earn/autoinvest/orders)

Source: https://www.gate.com/docs/developers/apiv4/en/earn

Python example for the authenticated GET /earn/autoinvest/orders endpoint. Requires an API key and secret; the gen_sign function must be implemented as described in the Authentication section.

```python
# coding: utf-8
import requests
import time
import hashlib
import hmac

host = "https://api.gateio.ws"
prefix = "/api/v4"
headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}

url = '/earn/autoinvest/orders'
query_param = 'plan_id=142583&record_id=1770805384904919'
# for `gen_sign` implementation, refer to section `Authentication` above
sign_headers = gen_sign('GET', prefix + url, query_param)
headers.update(sign_headers)
r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
print(r.json())

```

--------------------------------

### Example 200 response for GET /loan/multi_collateral/fixed_rate

Source: https://www.gate.com/docs/developers/apiv4/en/multi-collateral-loan

Example 200 response for the GET /loan/multi_collateral/fixed_rate endpoint. Shows a single CollateralFixRate object with currency, rate_7d, rate_30d, and update_time fields.

```json
[
  {
    "currency": "BTC",
    "rate_7d": "0.000023",
    "rate_30d": "0.1",
    "update_time": 1703820105
  }
]

```
Tokens:
Raw