Get Instruments Info

API Description

Retrieves detailed information about trading instruments including contract specifications, trading rules, and market data. This endpoint provides essential information for trading operations.

HTTP Request

GET /v5/market/instruments-info

Request Parameters

Parameter	Type	Required	Description
symbol	string	No	Symbol name (e.g., BTCUSDT)

Response Parameters

Parameter	Type	Description
instrumentAddress	string	Contract address of the instrument
symbol	string	Trading pair symbol (e.g., BTC-USDM-EMG)
base	object	Base asset information
-> address	string	Asset contract address
-> decimals	number	Asset decimal places
-> name	string	Asset name
-> symbol	string	Asset symbol
quote	object	Quote asset information
-> address	string	Asset contract address
-> decimals	number	Asset decimal places
-> name	string	Asset name
-> symbol	string	Asset symbol
market	object	Market information
-> addrress	string	Market address (note: typo in API)
-> type	string	Market type
initialMarginRatio	number	Initial margin ratio (in basis points)
maintenanceMarginRatio	number	Maintenance margin ratio (in basis points)
minMarginAmount	string	Minimum margin amount
tradingFeeRatio	number	Trading fee ratio (in basis points)
protocolFeeRatio	number	Protocol fee ratio (in basis points)
tip	string	Additional tip information
quoteType	string	Quote type (e.g., STABLE)
minTradeValue	string	Minimum trade value
minOrderValue	string	Minimum order value
minRangeValue	string	Minimum range value
fundingIntervalHour	number	Funding interval in hours
minRangeTickDelta	number	Minimum range tick delta
instrumentCondition	string	Instrument condition (NORMAL, FROZEN, etc.)
instrumentType	string	Instrument type (QUOTE_STABLE, etc.)
placeLimitOrderPaused	boolean	Whether limit orders are paused
disableMakerOrderRebate	boolean	Whether maker order rebates are disabled

Request Example

cURL

curl -X GET \
  'https://api.synfutures.com/v5/market/instruments-info?category=linear' \
  -H 'Content-Type: application/json'

JavaScript (Fetch)

const response = await fetch(
    "https://api.synfutures.com/v5/market/instruments-info?category=linear",
    {
        method: "GET",
        headers: {
            "Content-Type": "application/json",
        },
    }
);

const data = await response.json();
console.log(data);

Python (requests)

import requests

url = "https://api.synfutures.com/v5/market/instruments-info"
params = {
    'category': 'linear'
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers, params=params)
result = response.json()
print(result)

Response Example

Success Response

{
    "code": 0,
    "data": {
        "data": [
            {
                "instrumentAddress": "string",
                "symbol": "BTC-USDM-EMG",
                "base": {
                    "address": "string",
                    "decimals": 0,
                    "name": "string",
                    "symbol": "string"
                },
                "quote": {
                    "symbol": "string",
                    "address": "string",
                    "decimals": 6,
                    "name": "string"
                },
                "market": {
                    "addrress": "string",
                    "type": "string"
                },
                "initialMarginRatio": 1000,
                "maintenanceMarginRatio": 500,
                "minMarginAmount": "string",
                "tradingFeeRatio": 30,
                "protocolFeeRatio": 10,
                "tip": "string",
                "quoteType": "STABLE",
                "minTradeValue": "string",
                "minOrderValue": "string",
                "minRangeValue": "string",
                "fundingIntervalHour": 24,
                "minRangeTickDelta": 1000,
                "instrumentCondition": "NORMAL",
                "instrumentType": "QUOTE_STABLE",
                "placeLimitOrderPaused": false,
                "disableMakerOrderRebate": false
            }
        ],
        "msg": "string",
        "requestId": "string"
    }
}

Error Response

{
    "code": 400,
    "msg": "Request parameter error",
    "data": {},
    "requestId": "string"
}