Skip to main content

Get Instruments

Get Instruments

Description​

Query tradable CFD instrument information. Authentication is required to access this endpoint.

HTTP Request​

  • GET /api/v3/cfd/account/instruments
  • Rate limit: 10/sec/UID
  • Permission: UTA trade (read-only)
Request
curl "https://api.bitget.com/api/v3/cfd/account/instruments" \
-H "ACCESS-KEY:your apiKey" \
-H "ACCESS-SIGN:*" \
-H "ACCESS-PASSPHRASE:*" \
-H "ACCESS-TIMESTAMP:1659076670000" \
-H "locale:en-US" \
-H "Content-Type: application/json"

Request Parameters​

ParametersTypeRequiredDescription
symbolStringNoTrading pair name
Response
{
"code": "00000",
"msg": "success",
"requestTime": 1740000000000,
"data": [
{
"symbol": "XAUUSD",
"onlineTime": "1740000000000",
"currency": "USD",
"digits": "2",
"spread": "3",
"contractSize": "100",
"marginCurrency": "USD",
"profitCurrency": "USD",
"stopLevel": "0",
"enable": "2",
"marginPercent": "1",
"initialMargin": "200",
"marginMode": "Forex",
"maintMargin": "100",
"maintMarginRateBuy": "0.002",
"maintMarginRateSell": "0.002",
"initialMarginRateBuy": "0.004",
"initialMarginRateSell": "0.004",
"maxVolume": "100",
"minVolume": "0.01",
"stepVolume": "0.01",
"priceCurrency": "USD",
"tickSize": "0.01",
"tickValue": "1",
"leverage": "500",
"tradeTime": "24/5",
"commissionType": "0",
"commissionRate": "0",
"symbolCategory": "XAUUSD",
"exchangeRate": "1",
"marginUsdRate": "1"
}
]
}

Response Parameters​

ParametersTypeDescription
symbolStringTrading symbol
onlineTimeStringTime the instrument was added
currencyStringBase currency
digitsStringNumber of price decimal places
spreadStringSpread
contractSizeStringContract size
marginCurrencyStringMargin currency
profitCurrencyStringProfit currency
stopLevelStringStop level
Same unit as the spread, denominated in the instrument's quote currency
Minimum required distance between the stop-loss/take-profit price and the market price = stopLevel / 10^digits
e.g., for XAUUSD, if stopLevel is 20 and digits is 2, the minimum required distance is 20 / 10^2 = 0.2 USD
enableStringWhether trading is enabled
0: Trading disabled
1: Close-only
2: Trading enabled
marginPercentStringMargin percentage
initialMarginStringInitial margin
marginModeStringMargin model
Forex/CFD
maintMarginStringMaintenance margin
maintMarginRateBuyStringMaintenance margin rate for the buy side
The reciprocal of leverage; e.g., if leverage is 500, this value is 0.002
maintMarginRateSellStringMaintenance margin rate for the sell side
The reciprocal of leverage; e.g., if leverage is 500, this value is 0.002
initialMarginRateBuyStringInitial margin rate for the buy side
initialMarginRateSellStringInitial margin rate for the sell side
maxVolumeStringMaximum tradable volume
minVolumeStringMinimum tradable volume
stepVolumeStringVolume step size
priceCurrencyStringQuote currency
tickSizeStringMinimum price increment
tickValueStringValue of the minimum price increment
leverageStringLeverage
tradeTimeStringTradable hours
commissionTypeStringCommission type
0: Charged per lot, e.g., 6 USD per lot
1: Charged as a percentage of trade value
Only the ECN and Pro trading modes charge commission; the commission is always charged at order opening (not at closing), and is deducted directly from the account balance in USDT
commissionRateStringCommission rate
If charged per lot, this is the commission amount per lot (e.g., XAUUSD charges 6 USD per lot; opening 1 lot of XAUUSD deducts 6 USD from the account balance at opening)
If charged as a percentage of trade value, this is a percentage value; the frontend should append a % sign
Default 0 (zero-commission instruments do not call the commission endpoint and use this default value directly)
symbolCategoryStringInstrument category (the symbol name without its suffix)
e.g., for XAUUSD.s, symbolCategory = "XAUUSD"; for XAUUSD, symbolCategory = "XAUUSD"
exchangeRateStringExchange rate of priceCurrency against USD
marginUsdRateStringExchange rate of marginCurrency against USD

How was your Reading Experience with us?

★
★
★
★
â˜