API 2.0 - Gate.io | Bitcoin Exchange | Bitcoin Price | Crypto Exchange

API Document

API (4.0) provides spot, margin and futures trading operations

REST API (Spot, Margin and Futures)

REST API Reference

Demos: PYTHON, JAVA, PHP, JAVASCRIPT, GO, NODEJS, CSHARP

Futures WebSocket API

Spot WebSocket API

API Keys

API V4 Keys are independent from API 2.0 Keys. Generate them in APIv4 Keys.

API (2.0) only provides spot

REST API

Demos: PHP, JAVA, NODEJS, PYTHON, GO, CSHARP, PERL

Spot WebSocket API

WS API Reference

Demos: NODEJS, PHP, PYTHON

Trading Pairs API

Return all the trading pairs supported by gate.io

URL: https://data.gateapi.io/api2/1/pairs

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/pairs
    # Response
        [
                "eth_btc","etc_btc","etc_eth","zec_btc","dash_btc","ltc_btc","bcc_btc","qtum_btc",
                "qtum_eth","xrp_btc","zrx_btc","zrx_eth","dnt_eth","dpy_eth","oax_eth","lrc_eth",
                "lrc_btc","pst_eth","tnt_eth","snt_eth","snt_btc","omg_eth","omg_btc","pay_eth",
                "pay_btc","bat_eth","cvc_eth","storj_eth","storj_btc","eos_eth","eos_btc"
        ]

Market Info API

Returns all markets fee, minimum order total amount, price decimal places.

URL: https://data.gateapi.io/api2/1/marketinfo

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/marketinfo
    # Response
   {
        "result": "true",
        "pairs": [
                      {
                            "eth_btc": {
                                "decimal_places": 6,
                                "amount_decimal_places": 4,
                                "min_amount": 0.001,
                                "min_amount_a": 0.001,
                                "min_amount_b": 0.0001,
                                "fee": 0.2,
                                "trade_disabled ": 0,
                                "buy_disabled" : 0,
                                "sell_disabled" : 0,
                            }
                      },
                      {
                            "zec_btc": {
                                "decimal_places": 4,
                                "amount_decimal_places": 5,
                                "min_amount": 0.0001,
                                "min_amount_a": 0.0001,
                                "min_amount_b": 0.0001,
                                "fee": 0.2,
                                "trade_disabled ": 0,
                                "buy_disabled" : 0,
                                "sell_disabled" : 0,
                            }
                      }
            ]
    }

CoinInfo

Return coin info include deposit, withdraw, trade status

URL: https://data.gateapi.io/api2/1/coininfo

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/coininfo
    # Response
   {
        "result": "true",
        "pairs": [
                      {
                            "USDT": {
                                "delisted": 0,
                                "withdraw_disabled": 0,
								"withdraw_delayed ": 0,
                                "deposit_disabled": 0,
                                "trade_disabled": 0,
                            }
                      }
            ]
    }

Market Details API

Returns market details including pair, coin name, coin symbol, last price, trading volume, coin supply, coin market cap, price trend, etc.

URL: https://data.gateapi.io/api2/1/marketlist

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/marketlist
    # Response
       {
        "result": "true",
        "data": [
                {
                    "no": 1,
                    "symbol": "LTC",
                    "name": "Litecoin",
                    "name_en": "Litecoin",
                    "name_cn": "莱特币",
                    "pair": "ltc_btc",
                    "rate": "418.00",
                    "vol_a": 168120.2,
                    "vol_b": "65,616,561",
                    "curr_a": "LTC",
                    "curr_b": "BTC",
                    "curr_suffix": " BTC",
                    "rate_percent": "19.73",
                    "trend": "up",
                    "supply": 25760300,
                    "marketcap": "10,767,805,404",
                    "plot": null
                },
                {
                    "no": 2,
                    "symbol": "ETH",
                    "name": "ETH",
                    "name_en": "ETH",
                    "name_cn": "以太币",
                    "pair": "etc_eth",
                    "rate": "0.7450",
                    "vol_a": 65227328.3,
                    "vol_b": "51,041,999",
                    "curr_a": "etc",
                    "curr_b": "eth",
                    "curr_suffix": " eth",
                    "rate_percent": "-1.84",
                    "trend": "up",
                    "supply": 1050000000,
                    "marketcap": "782,250,000",
                    "plot": null
                }
            ]
    }

Tickers API

returns the tickers for all the supported trading pairs at once, cached in 20 seconds:

URL: https://data.gateapi.io/api2/1/tickers

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/tickers
    # Response
      {
          "eth_btc": {
                "result": "true",
                "last": 0.1,
                "lowestAsk": 0.1,
                "highestBid": "0.00000000",
                "percentChange": 0,
                "baseVolume": 0.001,
                "quoteVolume": 0.01,
                "high24hr": 0.1,
                "low24hr": 0.1
            },
        "xrp_btc": {
                "result": "true",
                "last": "0.00004720",
                "lowestAsk": "0.00005620",
                "highestBid": "0.00004550",
                "percentChange": -7.4510907045863,
                "baseVolume": 0.5324,
                "quoteVolume": 11417.333,
                "high24hr": "0.00005580",
                "low24hr": "0.00004560"
            }
        }

Ticker API

returns the tickers for all the supported trading pairs at once, cached in 20 seconds:

URL: https://data.gateapi.io/api2/1/ticker/[CURR_A]_[CURR_B]

Replace [CURR_A] and [CURR_B] with the selected currencies.

Links:

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/ticker/eth_btc
    # Response
        {
            "result": "true",
            "last": 0.1,
            "lowestAsk": 0.1,
            "highestBid": "0.00000000",
            "percentChange": 0,
            "baseVolume": 0.001,
            "quoteVolume": 0.01,
            "high24hr": 0.1,
            "low24hr": 0.1
        }

Depth API

Return the market depth including ask and bid orders.

URL: https://data.gateapi.io/api2/1/orderBooks

Current market depth API

Return the market depth including ask and bid orders.

URL: https://data.gateapi.io/api2/1/orderBook/[CURR_A]_[CURR_B]

Replace [CURR_A] and [CURR_B] with the selected currencies.

Links:

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/orderBook/eth_btc
    # Response
      {
        "result": "true",
        "asks": [
                [29500,    4.07172355],
                [29499,    0.00203397],
                [29495,    1],
                [29488,    0.0672],
                [29475,    0.001]
            ],
        "bids": [
                [28001, 0.0477],
                [28000, 0.35714018],
                [28000, 2.56222976],
                [27800, 0.0015],
                [27777, 0.1]
            ]
        }

History API

Return the most recent 80 trade history records:

URL: https://data.gateapi.io/api2/1/tradeHistory/[CURR_A]_[CURR_B]

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/tradeHistory/eth_btc
    # Response
    {
        "result": "true",
        "data": [
            {
                "tradeID": "27734287",
                "date": "2017-09-29 11:52:05",
                "timestamp": "1506657125",
                "type": "buy",
                "rate": 0.1,
                "amount": 0.01,
                "total": 0.001,
                "fee": "0.002",
                "fee_coin": "eth"
                "gt_fee":"0",
                "point_fee":"0.1213",
            }
        ],
        "elapsed": "6.901ms"
    }

Return at most 1,000 trade history records after [TID]:

URL: https://data.gateapi.io/api2/1/tradeHistory/[CURR_A]_[CURR_B]/[TID]

Replace [CURR_A] and [CURR_B] with the selected currencies.

Links:

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/tradeHistory/eth_btc/3275876
    # Response
    {
        "result": "true",
        "data": [
                {
                "tradeID": 3175762,
                "date": "2017-08-25 07:24:28",
                "type": "sell",
                "rate": 29011,
                "amount": 0.0019,
                "total": 55.1209,
                "fee": "0",
                "fee_coin": "btc",
                "gt_fee":"0",
                "point_fee":"0.1213",
                },
                {
                "tradeID": 3175771,
                "date": "2017-08-25 07:24:41",
                "type": "sell",
                "rate": 29011,
                "amount": 0.0032,
                "total": 92.8352,
                "fee": "0.0002",
                "fee_coin": "btc",
                "gt_fee":"0",
                "point_fee":"0",
                }
            ],
        "elapsed": "31.518ms"
    }

K-line data in trading market

Return K line data in the most recent time period of the market

URL: https://data.gateapi.io/api2/1/candlestick2/[CURR_A]_[CURR_B]?group_sec=[GROUP_SEC]&range_hour=[RANGE_HOUR]

Return data example:

    # Request
    https://data.gateapi.io/api2/1/candlestick2/btc_usdt?group_sec=60&range_hour=1
    # Response
    {
		"result": "true",
		"data": [
			[1524556800000, 12.8756391686, 9266.02, 9266.21, 9231.01, 9233.99],
			[1524558600000, 18.3153691562, 9255.79, 9284, 9251.01, 9252],
			[1524560400000, 17.5693326481, 9255, 9290.37, 9238.89, 9255.79],
			[1524562200000, 13.0314933662, 9281.92, 9295, 9239, 9255.4],
			[1524564000000, 26.0352948098, 9290.92, 9327.46, 9282, 9282],
			[1524565800000, 24.5813921079, 9300, 9340, 9290, 9297.5],
			[1524567600000, 27.8742949471, 9345, 9348.99, 9291.91, 9300],
			[1524569400000, 29.3344591996, 9299.99, 9349.99, 9290, 9343.93],
			[1524571200000, 28.4720072519, 9305, 9327.99, 9286.32, 9290.02],
			...
		]
	}

Return to K line data in [range_hour] range:

URL: https://data.gateapi.io/api2/1/candlestick2/[CURR_A]_[CURR_B]?group_sec=[GROUP_SEC]&range_hour=[RANGE_HOUR]

Replace [CURR_A] and [CURR_B] for the currencies you need to view, GROUP_SEC and RANGE_HOUR for the time zone you need to obtain.

Links:

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/candlestick2/btc_usdt?group_sec=60&range_hour=1
    # Response
    {
		"result": "true",
		"data": [
			[1524556800000, 12.8756391686, 9266.02, 9266.21, 9231.01, 9233.99],
			[1524558600000, 18.3153691562, 9255.79, 9284, 9251.01, 9252],
			[1524560400000, 17.5693326481, 9255, 9290.37, 9238.89, 9255.79],
			[1524562200000, 13.0314933662, 9281.92, 9295, 9239, 9255.4],
			[1524564000000, 26.0352948098, 9290.92, 9327.46, 9282, 9282],
			[1524565800000, 24.5813921079, 9300, 9340, 9290, 9297.5],
			[1524567600000, 27.8742949471, 9345, 9348.99, 9291.91, 9300],
			[1524569400000, 29.3344591996, 9299.99, 9349.99, 9290, 9343.93],
			[1524571200000, 28.4720072519, 9305, 9327.99, 9286.32, 9290.02],
			...
		]
	}

Response description

   time
   trading volume
   close price
   highest price
   lowest price
   open price

C2C Depth API

Return the C2C market depth including ask and bid orders.

URL: https://data.gateapi.io/api2/1/orderBooks_c2c

Current market depth API

Return the C2C market depth including ask and bid orders.

URL: https://data.gateapi.io/api2/1/orderBook_c2c/[CURR_A]_[CURR_B]

Replace [CURR_A] and [CURR_B] with the selected currencies.

Links:

Return data example:

    # Request
    GET: https://data.gateapi.io/api2/1/orderBook_c2c/usdt_cny
    # Response
	{
		"result": "true",
		"asks": [
			["6.86", "306.1114", "100.0000", "30000.0000"],
			["6.86", "808.0467", "100.0000", "4220.0000"],
			["6.86", "12922.3622", "200.0000", "24131.4000"],
			["6.86", "4412.0000", "300.0000", "4412.0000"]
		],
		"bids": [
			["6.84", "3654.9707", "3654.0000", "3654.9700"],
			["6.84", "17487.1700", "1500.0000", "30000.0000"],
			["6.84", "21.1317", "20.0000", "1461.9883"],
			["6.83", "27846.0000", "800.0000", "30000.0000"]
		]
	},

Trade API

Error codes details from system

The user has to go through firstthis linkGet Key and Secret for API interface authentication. Secret is used as the password in the program. Sign is obtained by signing the data that POST needs to send to the server through SHA512 encryption. Key and ign are returned in the Header part of HTTPS request. Please refer to the following interface instructions and example programs to set up

Get account balance API

API URL: https://api.gateio.la/api2/1/private/balances

Parameter data submission: POST

Parameters: no

Return data format: JSON

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/balances
    # Response
    {
        "result": "true",
        "available": {
            "BTC": "1000",
            "ETH": "968.8",
            "ETC": "0",
            },
        "locked": {
            "ETH": "1"
            }
    }

Get leverage account balance API

API URL: https://api.gateio.la/api2/1/private/marginbalances

Parameter data submission: POST

Parameters: no

Return data format: JSON

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/marginbalances
    # Response
    {
        "result": "true",
        "datas": [
            {
                "market": "BTC_USDT",
                "curr_a": "BTC",
                "curr_b": "USDT",
                "available_a": "99.993214",
                "available_b": "9994.000035",
                "frozen_a": "0.000000",
                "frozen_b": "0.000000",
                "borrowed_a": "0.000000",
                "borrowed_b": "0.000000"
            }
        ]
    }

Get the financial account balance API

API URL: https://api.gateio.la/api2/1/private/fundingbalances

Parameter data submission: POST

Parameters: no

Return data format: JSON

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/fundingbalances
    # Response
    {
        "result": "true",
        "datas": [
            {
                "asset": "BTC",
                "available": "0.000000",
                "freeze": "10.000000",
                "lent": "0.000000",
                "total_lend": "10.000000"
            },
            {
                "asset": "USDT",
                "available": "0.000000",
                "freeze": "0.000000",
                "lent": "0.000000",
                "total_lend": "0.000000"
            },
            {
                "asset": "ETH",
                "available": "99987.911780",
                "freeze": "0.000000",
                "lent": "0.000000",
                "total_lend": "0.000000"
            }
        ]
    }

Get the recharge address API

API URL: https://api.gateio.la/api2/1/private/depositAddress

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
currency	String	yes	Currencies such as (BTC, LTC)

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/depositAddress
    # Response
    {
        "result": "true",
        "addr": "LPXtk1kWHioP62SzfqwKbYE3Z7Wt2ujYEc",
        "message": "Sucess",
        "code": 0
    }

Get repaid history API

API URL: https://api.gateio.la/api2/1/private/depositsWithdrawals

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
start	String	no	Start UNIX time (e.g. 1469092370)
end	String	no	Termination of UNIX time (e.g. 1469713981)
sortType	String	no	Sort order ("ASC": ascending, "DESC": descending)
page	String	no	Page number, starting from 1

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/depositsWithdrawals
    # Response
    {
        "result": "true",
        "deposits": [
                {
                "id": "c204730",
                "currency": "ETH",
                "address": "1111 1111 1111 1111 1111 1",
                "amount": "222.61",
                "txid": "210496",
                "timestamp": "1474962729",
                "status": "DONE"
                }

            ],
        "withdraws": [
                {
                "currency": "ETC",
                "address": "addr2",
                "amount": "600000000",
                "txid": "2104963",
                "timestamp": "1469092378",
                "status": "DONE"
                }
            ],
        "message": "Success"
    }

Order and buy API

API URL: https://api.gateio.la/api2/1/private/buy

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description	Return data example:
currencyPair	String	yes	Trade currency pairs (such as btc_usdt,ltc_btc)	ltc_btc
rate	String	yes	Price	1000
amount	String	yes	Volume	800
orderType	String	no	Order type ("gtc": Ordinary order (default); "ioc": Immediate-Or-Cancel (IOC));"poc":Passive order(maker only) (Pending-Or-Cancelled，POC)	ioc
text	String	no	user defined information; requires: prefixed with "t-", no longer than 16 bytes("t-" not counted) and use characters in [0-9a-zA-Z-_.]	t-1128392

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/buy
    # Response
    {
		"result":"true",
		"orderNumber":5825355678,
		"rate":"1000",
		"leftAmount":"0",
		"filledAmount":"0.1",
		"filledRate":"800.00",
                "text":"t-1128392", //user defined information. returned if provided, otherwise left empty
		"message":"Success"
    }

Place an order and trade to sell API

API URL: https://api.gateio.la/api2/1/private/sell

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description	Return data example:
currencyPair	String	yes	Trade currency pairs (such as btc_usdt,ltc_btc)	ltc_btc
rate	String	yes	Price	1000
amount	String	yes	Volume	800
orderType	String	no	Order type ("gtc": Ordinary order (default); "ioc": Immediate-Or-Cancel (IOC));"poc":Passive order(maker only) (Pending-Or-Cancelled，POC)	ioc
text	String	no	user defined information; requires: prefixed with "t-", no longer than 16 bytes("t-" not counted) and use characters in [0-9a-zA-Z-_.]	t-1128392

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/sell
    # Response
    {
		"result":"true",
		"orderNumber":5825355678,
		"rate":"1000",
		"leftAmount":"0",
		"filledAmount":"0.1",
		"filledRate":"800.00",
                "text":"t-1128392", //user defined information. returned if provided, otherwise left empty
		"message":"Success"
    }

Batch Orders

API URL: https://api.gateio.la/api2/1/private/batch_orders

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description	Return data example:
batch_orders_json	Json	yes	text:user defined information; requires: prefixed with "t-", no longer than 16 bytes("t-" not counted) and use characters in [0-9a-zA-Z-_.] currencyPair:Trade currency pairs (such as btc_usdt,ltc_btc) side: buy or sell rate:Price amount:Volume orderType:Order type ("gtc": Ordinary order (default); "ioc": Immediate-Or-Cancel (IOC));"poc":Passive order(maker only) (Pending-Or-Cancelled，POC)	[{ "text": "t-1001", "currencyPair": "GT_USDT", "rate": 0.01, "amount": 1000, "side": "buy", "orderType": "gtc" }, { "text": "t-1002", "currencyPair": "BTC_USDT", "rate": 8000, "amount": 0.1, "side": "sell", "orderType": "ioc" } ]

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/batch_orders
    # Response
   {"result":"true","orders":"[[
        {
            "result": "true",
            "message": "Success",
            "code": 0,
            "ctime": 1574846296.986704,
            "side": 2,
            "orderNumber": 28237020,
            "rate": "0.01",
            "leftAmount": "1000.00000000",
            "filledAmount": "0",
            "market": "GT_USDT",
            "iceberg": "0",
            "text": "t-1001",
            "filledRate": "0.010000000",
            "feePercentage": 0.002,
            "feeValue": "0",
            "feeCurrency": "GT",
            "fee": "0 GT"
        },
        {
            "result": "true",
            "message": "Success",
            "code": 0,
            "ctime": 1574846296.995313,
            "side": 1,
            "orderNumber": 28237021,
            "rate": "8000",
            "leftAmount": "0.10000000",
            "filledAmount": "0",
            "market": "BTC_USDT",
            "iceberg": "0",
            "text": "t-1002",
            "filledRate": "8000.000000000",
            "feePercentage": 0.002,
            "feeValue": "0",
            "feeCurrency": "USDT",
            "fee": "0 USDT"}
         ]"
    }

Note: at most 4 trading pairs can be placed at a time and only 5 orders can be placed in batches for each trading pair

Cancel the order API

API URL: https://api.gateio.la/api2/1/private/cancelOrder

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
orderNumber	String	yes	The serial number of the order
currencyPair	String	yes	Trading currency pairs (such as ltc_btc)

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/cancelOrder
    # Response
   {"result":"true","message":"Success"}

Cancel multiple order apis

API URL: https://api.gateio.la/api2/1/private/cancelOrders

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
orders_json	String	yes	[ { "orderNumber":"7942422" "currencyPair":"ltc_btc" }, { "orderNumber":"7942423" "currencyPair":"ltc_btc" } ]

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/cancelOrders
    # Response
   {"result":"true","message":"Success"}

Note:The number of cancellation in batch is limited to 20

Cancel all ordering apis

API URL: https://api.gateio.la/api2/1/private/cancelAllOrders

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
type	int	yes	Order type (0: sell,1: buy,-1: unlimited)
currencyPair	String	yes	Trade currency pairs (example: LTC BTC)

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/cancelAllOrders
    # Response
   {"result":"true","message":"Success"}

Get the order status API

API URL: https://api.gateio.la/api2/1/private/getOrder

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
orderNumber	String	yes	The serial number of the order
currencyPair	String	yes	Exchange currency pair (e.g. Eth BTC)

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/getOrder
    # Response
    {
        "result":"true",
        "order":{
            "id":"15088",
            "status":"cancelled",
            "currencyPair":"eth_btc",
            "type":"sell",
            "rate":811,
            "amount":"0.39901357",
            "initialRate":811,
            "initialAmount":"1"
            },
        "message":"Success"
    }

Gets my current list API

API URL: https://api.gateio.la/api2/1/private/openOrders

Parameter data submission: POST

Request parameters

Parameter	Parameter type	Required	Description
currencyPair	String	no	Exchange currency pair (e.g. Eth BTC)

Returns all trading market pending when the currencyPair parameter is empty

Return data format: JSON

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/openOrders
    # Response
    {
        "result": "true", "message": "Success", "code": 0,"elapsed": "6.262ms",
        "orders": [
                {
                "orderNumber": "30032151",
                "type": "buy",
                "rate": 21367.521367521,
                "amount": "0.0936",
                "total": "2000",
                "initialRate": 21367.521367521,
                "initialAmount": "0.0936",
                "filledRate": 0,
                "filledAmount": 0,
                "currencyPair": "eth_btc",
                "timestamp": "1407828913",
                "status": "open"
                }
            ]
        }

Get my last 100 transaction record API

API URL: https://api.gateio.la/api2/1/private/tradeHistory

Parameter data submission: POST

Return data format: JSON

Parameters:

Parameter	Parameter type	Required	Description
currencyPair	String	yes	Currency pair
orderNumber	String	no	Order number

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/tradeHistory
    # Response
    {
        "result": "true",
        "message": "Success",
        "trades": [
                {
                "id": "7942422",
                "orderid": "38100491",
                "pair": "ltc_btc",
                "type": "buy",
                "rate": "0.01719",
                "amount": "0.0588",
                "time": "06-12 02:49:11",
                "time_unix": "1402512551"
                }
            ]
    }

Withdrawal API

API URL: https://api.gateio.la/api2/1/private/withdraw

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
currency	String	yes	Currency (e.g. : BTC)
amount	String	yes	Withdraw amount
address	String	yes	Address(Transaction MEMO can be entered after the address separated by a space, format: Address MEMO)

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/withdraw
    # Response
    { "result": "true",  "message": "Success"}

Sub Account API

Query single sub account available

API URL: https://api.gateio.la/api2/1/private/get_sub_account_available

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
sub_uid	Int	yes	sub account ID

Return data example:

        # Request
        POST: https://api.gateio.la/api2/1/private/get_sub_account_available
        # Response
        {
            "result": true,
            "available": {
                "uid": "XXX",
                "BTC": "0.1",
                "USDT": "0",
                "GT": "0"
            }
        }

Query all sub account available

API URL: https://api.gateio.la/api2/1/private/get_sub_account_available

Return data format: JSON

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/get_sub_account_available
    # Response
        {
            "result": true,
            "available": [{
                "uid": "XXX",
                "BTC": "0.1",
                "USDT": "0",
                "GT": "0"
                }, {
                    "uid": "XXX",
                    "USDT": "94.70916"
                }]
        }

Sub account funds transfer

API URL: https://api.gateio.la/api2/1/private/sub_account_transfer

Parameter data submission: POST

Return data format: JSON

Request parameters

Parameter	Parameter type	Required	Description
sub_uid	Int	yes	sub account ID
transfer_type	String	yes	Trander type 'in':from main account to sub account, 'out':from sub account to main account
coin	String	yes	Coin
amount	String	yes	Amount

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/sub_account_transfer
    # Response
    {
	"result": "true",
	"message": "Success"
    }

Fees

Return coin fees info include deposit, withdraw, trade status

URL: https://api.gateio.la/api2/1/private/feelist

Return data example:

    # Request
    POST: https://api.gateio.la/api2/1/private/feelist
    # Response
   {
        "GT":{
                "no":149,
                "symbol":"GT",
                "name":"GatechainToken",
                "name_cn":"GateChain",
                "fee_usdt":"0.2%",
                "fee_btc":"0.2%",
                "fee_eth":"-",
                "deposit":"0",
                "withdraw_percent":"0%",
                "withdraw_fix":"0.1",
                "withdraw_day_limit":"500000",
                "withdraw_amount_mini": 0.2,
                "withdraw_day_limit_remain": 500000,
                "withdraw_eachtime_limit": 500000
             },
        "USDT":{
                "no":3,
                "symbol":"USDT",
                "name":"Tether",
                "name_cn":"Tether",
                "fee_usdt":"-",
                "fee_btc":"0.2%",
                "fee_eth":"0.2%",
                "deposit":"0",
                "withdraw_percent":"0%",
                "withdraw_fix":"3",
                "withdraw_day_limit":"300000",
                "withdraw_amount_mini": 53,
                "withdraw_day_limit_remain": 300000,
                "withdraw_eachtime_limit": 1000000,
                "usdt_erc20_withdraw_txfee": 10.0,
                "usdt_trc20_withdraw_txfee": 0.1
             },...
   }

Response description

    no:No.
    symbol:Coin
    name:Coin
    name_cn:Coin
    fee_usdt:USDT Trading
    fee_btc:BTC Trading
    fee_eth:ETH Trading
    deposit:Deposit
    withdraw_percent:Withdraw
    withdraw_fix:Withdraw
    withdraw_day_limit:Withdraw Daily Limit
    withdraw_amount_mini:Minimum
    withdraw_day_limit_remain:Remaining
    withdraw_eachtime_limit:Maximum

Announcements

URL: https://api.gateio.la/api2/1/annlist?page=1&lang=en

Request parameters

Parameter	Parameter type	Required	Description
page	Int	no	Page number, starting from 1(1-1000)
lang	string	no	Language: cn (简体中文), kr (한국어), en (English), vn (Tiếng Việt), tw (繁体中文), es (Español), ru (Русский язык), fr (Français), th (ภาษาไทย)

Return data example:

    # Request
    GET: https://api.gateio.la/api2/1/annlist?page=1
    # Response
        {
            "result": true,
            "message":"Success",
            "page":3,
            "data":[
                {
                    "id":"1",
                    "title":"test title 1",
                    "brief":"test brief 1",
                    "updated_t":"2020-06-02 11:59:04"
                },
                {
                    "id":"2",
                    "title":"test title 2",
                    "brief":"test brief 2",
                    "updated_t":"2020-06-02 11:59:04"
                }
            ]
        }

Response description

    id:No.
    title:Title
    brief:Details
    updated_t:Updated

Error code

Error codes details from system

Error codes	Details
1	Invalid request
2	Invalid version
3	Invalid request
4	Forbidden access
5,6	Invalid sign
7	Currency is not supported
8,9	Currency is not supported
10	Verified failed
11	Obtaining address failed
12	Empty params
13	Internal error, please report to administrator
14	Invalid user
15	Cancel order too fast, please wait 1 min and try again
16	Invalid order id or order is already closed
17	Invalid orderid
18	Invalid amount
19	Not permitted or trade is disabled
20	Your order size is too small
21	You don't have enough fund
24	Invalid asset
40	Too many attempts
102	Withdraw suspended
1401	Invaild sub account ID Or sub account not found
1402	Sub account can not use transfer
1403	Invalid parameters
1404	Sub account transfer fail
1405	Sub account frozen

Demos

Example codes in PHP (More:JAVA, NODEJS, PYTHON, GO, PHP, CSHARP, PERL )

					

	<?php

		function gateio_query($path, array $req = array()) {
			// API settings, add your Key and Secret at here
			$key = '';
			$secret = '';

			// generate a nonce to avoid problems with 32bits systems
			$mt = explode(' ', microtime());
			$req['nonce'] = $mt[1].substr($mt[0], 2, 6);

			// generate the POST data string
			$post_data = http_build_query($req, '', '&');
			$sign = hash_hmac('sha512', urldecode($post_data), $secret);

			// generate the extra headers
			$headers = array(
				'KEY: '.$key,
				'SIGN: '.$sign
			);

			//!!! please set Content-Type to application/x-www-form-urlencoded if it's not the default value

			// curl handle (initialize if required)
			static $ch = null;
			if (is_null($ch)) {
				$ch = curl_init();
				curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
				curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; gateio PHP bot; '.php_uname('a').'; PHP/'.phpversion().')');
			}

			curl_setopt($ch, CURLOPT_URL, 'https://api.gateio.la/api2/'.$path);
			curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
			curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
			curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);


			// run the query
			$res = curl_exec($ch);

			if ($res === false) throw new Exception('Could not get reply: '.curl_error($ch));
			//var_dump($res);
			//print_r($res);
			$dec = json_decode($res, true);
			if (!$dec) throw new Exception('Invalid data received, please make sure connection is working and requested API exists: '.$res);

			return $dec;
		}


		function curl_file_get_contents($url) {

			// our curl handle (initialize if required)
			static $ch = null;
			if (is_null($ch)) {
				$ch = curl_init();
				curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
				curl_setopt($ch, CURLOPT_USERAGENT,
					'Mozilla/4.0 (compatible; gateio PHP bot; '.php_uname('a').'; PHP/'.phpversion().')'
					);
			}
			curl_setopt($ch, CURLOPT_URL, 'https://data.gateapi.io/api2/'.$url);
			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);

			// run the query
			$res = curl_exec($ch);
			if ($res === false) throw new Exception('Could not get reply: '.curl_error($ch));
			//echo $res;
			$dec = json_decode($res, true);
			if (!$dec) throw new Exception('Invalid data: '.$res);

			return $dec;
		}

		function get_top_rate($currency_pair, $type='BUY') {

			$url = '1/orderBook/'.strtoupper($currency_pair);
			$json = curl_file_get_contents($url);

			$rate = 0;

			if (strtoupper($type) == 'BUY') {
				$r =  $json['bids'][0];
				$rate = $r[0];
			} else  {
				$r = end($json['asks']);
				$rate = $r[0];
			}

			return $rate;
		}

		function get_pairs() {

			$url = '1/pairs';
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_marketinfo(){

			$url = '1/marketinfo';
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_tickers(){

			$url = '1/tickers';
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_ticker($current_pairs){

			$url = '1/ticker/'.strtoupper($current_pairs);
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_orderbooks(){

			$url = '1/orderBooks';
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_orderbook($current_pairs){

			$url = '1/orderBook/'.strtoupper($current_pairs);
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_trade_history($current_pairs, $tid){

			$url = '1/tradeHistory/'.strtoupper($current_pairs).'/'.$tid;
			$json = curl_file_get_contents($url);

			return $json;
		}

		function get_balances() {

			return gateio_query('1/private/balances');
		}

		function withdraw($currency, $amount, $address) {

			return gateio_query('1/private/withdraw',
				array(
					'currency' => strtoupper($currency),
					'amount' => $amount,
					'address' => $address
				)
			);
		}

		function get_order($order_number, $currency_pair) {

			return gateio_query('1/private/getOrder',
				array(
					'currencyPair' => strtoupper($currency_pair),
					'orderNumber' => $order_number
				)
			);
		}

		function cancel_order($order_number, $currency_pair) {

			return gateio_query('1/private/cancelOrder',
				array(
					'currencyPair' => strtoupper($currency_pair),
					'orderNumber' => $order_number
				)
			);
		}

		function cancel_all_orders($type, $currency_pair) {

			return gateio_query('1/private/cancelAllOrders',
				array(
					'type' => $type,
					'currencyPair' => strtoupper($currency_pair)
				)
			);
		}

		function sell($currency_pair, $rate, $amount) {

			return gateio_query('1/private/sell',
				array(
					'currencyPair' => strtoupper($currency_pair),
					'rate' => $rate,
					'amount' => $amount,
				)
			);
		}

		function buy($currency_pair, $rate, $amount) {

			return gateio_query('1/private/buy',
				array(
					'currencyPair' => strtoupper($currency_pair),
					'rate' => $rate,
					'amount' => $amount,
				)
			);
		}

		function get_my_trade_history($currency_pair, $order_number) {

			return gateio_query('1/private/tradeHistory',
				array(
					'currencyPair' => strtoupper($currency_pair),
					'orderNumber' => $order_number
				)
			);
		}

		function open_orders() {

			return gateio_query('1/private/openOrders');
		}

		function deposit_address($currency) {

			return gateio_query('1/private/depositAddress',
				array(
					'currency' => strtoupper($currency)
				)
			);
		}


		try {
			// example 1: get balances
			var_dump(get_balances());

			// example 2: place a buy order
			$pair = 'ltc_btc';
			$rate = get_top_rate($pair, $type) * 1.01;
			var_dump(buy($pair, $rate, '0.01'));

			// example 3: cancel an order
			var_dump(cancel_order(125811, $pair));

			// example 4: get order status
			var_dump(get_order(15088, $pair));

			// example 5: list all open orders
			var_dump(open_orders());

		} catch (Exception $e) {
			echo "Error:".$e->getMessage();

		}
	?>