Exchange Account Objects

ExchangeAccount

ParameterTypeDescription
idstringThe ID of the exchange account to return
typeExchangeType
namestringDisplay name of the exchange account
statusConfigChangeRequestStatusStatus of the exchange account connection
assetsArray of ExchangeAssetAssets in the account
isSubaccountbooleanTrue if the account is a subaccount in an exchange
mainAccountIdstringThe of the exchange main account
tradingAccountsArray of TradingAccountTrading accounts under this exchange account
fundableAccountTypeTradingAccountTypeThe internal account that is used for deposits or withdrawals of this exchange's main or subaccount

ExchangeAsset

ParameterTypeDescription
idstringThe ID of the exchange account to return
totalstringThe total balance of the asset in the exchange account
availablestringThe balance that can be withdrawn from the exchange account or moved to a different account
lockedAmountstringLocked amount in the account
balancestringDeprecated - replaced by "total"

ExchangeType

ParameterTypeDescription
typestring[BINANCE, BINANCEUS, BITFINEX, BITHUMB, BITMEX, BITSO, BITSTAMP, BITTREX, BYBIT, CIRCLE, COINBASEEXCHANGE, COINBASEPRO, COINMETRO, COINSPRO, CRYPTOCOM, DERIBIT, GATE, GEMINI, HITBTC, HUOBI, IR, KORBIT, KRAKEN, KRAKENINTL, LIQUID, POLONIEX, OKCOIN, OKEX, SEEDCX]

📘

Notes

  • The BINANCEUS value should be used only by Binance.us customers.
  • The KRAKENINTL value should be used only by non-US Kraken customers.

TradingAccount

ParameterTypeDescription
typeTradingAccountTypeThe specific trading account under the exchange account
assetsArray of ExchangeAssetAssets in the trading account

TradingAccountType

ParameterTypeDescription
typestring[SPOT, FUTURES, MARGIN, FUNDING, OPTIONS, EXCHANGE, COIN_MARGINED_SWAP, USDT_FUTURES, COIN_FUTURES, USDT_ISOLATED_MARGINED_SWAP, USDT_MARGINED_SWAP_CROSS, FUNDABLE, UNIFIED]