Get Instrument Information

API Description

This interface provides detailed information for all spot instrument, including the minimum and maximum order prices, order quantities, and price precision.

Note: Instrument Information is only available via RESTful API.

Precautions

1. This interface returns information for all instruments and does not require parameters to query a specific instrument. To access data for a specific instrument,, please find it int the returned response.

Authentication

This is a public interface and does not require authentication. For details on using the RESTful API, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Public Interface.

Request Method

GET

Endpoint

/api/v1/public?command=returnSymbol

Frequency Limit

The frequency limit for this interface is 80 requests/s per IP. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters

This interface does not require any request parameter.

Response Parameters

Parameter	Type	Description
currencyPair	String	Currency pair, i.e., BTC_USDT.
currencyBase	String	Base currency, i.e., BTC.
currencyQuote	String	Quote currency, i.e., USDT.
maxBuyCount	String	Maximum order quantity, measured in the base currency. For example, if the trading instrument is BTC_USDT, this value represents the maximum quantity of BTC that can be ordered.
minBuyCount	String	Minimum order quantity, measured in the base currency. For example, if the value is 0.0001 and the trading instrument is BTC_USDT, the minimum order is 0.0001 BTC.
pricePrecision	Integer	Price precision
countPrecision	Integer	Quantity precision
minBuyAmount	String	Minimum order amount, measured in the quote currency. For example, for BTC_USDT, a value of 5 means the minimum order amount is 5 USDT.
maxBuyAmount	String	Maximum order amount, measured in the quote currency.
minBuyPrice	String	Minimum allowable order price, measured in the quote currency. For example, for BTC_USDT, a value of 0.001 means the lowest possible price is 0.001 USDT.
maxBuyPrice	String	Maximum allowable order price, measured in the quote currency.
state	Integer	Instrument Status： 1: Normal 2: Disabled

Request Example

The following Python code shows how to get instrument information.

Note: For a complete code example, please refer to Introduction > Authentication & Code Snippet > Spot > Restful Public Interface.

api_url= "/api/v1/public?command=returnSymbol"
params= {}
SpotRestfulPublic(api_url, params)   # function SpotRestfulPublic() is defined in section (Introduction > Authentication & Code Snippet > Spot > RESTful Public Interface)

Note: For a complete Java code example, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Public Interface.

Response Example

The following is an example response returned by the above Python request. For brevity, only the information for BTC and ETH are shown:

{'code': '200',
 'data': [
{'currencyBase': 'BTC',
 'maxBuyCount': '9999999.00000000000000000000',
 'pricePrecision': 2,
 'minBuyPrice': '0.00100000000000000000',
 'currencyPair': 'BTC_USDT',
 'minBuyAmount': '5.00000000000000000000',
 'maxBuyPrice': '99999999.00000000000000000000',
 'currencyQuote': 'USDT',
 'countPrecision': 4,
 'minBuyCount': '0.00010000000000000000',
 'state': 1,
 'maxBuyAmount': '99999999.00000000000000000000'},
{'currencyBase': 'ETH',
 'maxBuyCount': '99999999.00000000000000000000',
 'pricePrecision': 2,
 'minBuyPrice': '0.00100000000000000000',
 'currencyPair': 'ETH_USDT',
 'minBuyAmount': '5.00000000000000000000',
 'maxBuyPrice': '99999999.00000000000000000000',
 'currencyQuote': 'USDT',
 'countPrecision': 4,
 'minBuyCount': '0.00010000000000000000',
 'state': 1,
 'maxBuyAmount': '99999999.00000000000000000000'},......], 
'msg': 'SUCCESS',
 'success': True, 
'failed': False}