This endpoint returns information about subaccounts, including balances and UIDs.
Authentication is required.
|
Endpoint |
Request Type |
Permissible API Keys |
|
/api/v3/subaccounts |
GET |
Read-only, Read-write, Master
|
|
Arguments |
|
None |
|
Sample Call |
|
https://cryptofacilities.com/derivatives/api/v3/subaccounts |
|
Sample Return if Successful |
|
{ "result": "success", "serverTime": "2022-03-31T20:38:53.677Z", "masterAccountUid": "ba598ca1-65c1-4f48-927d-0e2b647d627a", "subaccounts": [ { "holdingAccounts": [ { "currency": "bch", "amount": 0.00004 }, { "currency": "xrp", "amount": 13662.85078 }, { "currency": "eth", "amount": 3.0000485057 }, { "currency": "ltc", "amount": 0.00002 }, { "currency": "xbt", "amount": 3.46e-9 } ], "futuresAccounts": [ { "name": "f-xrp:usd", "availableMargin": 16187.33210488726 }, { "name": "f-eth:usd", "availableMargin": 67.59768318324302 }, { "name": "f-xbt:usd", "availableMargin": 0.0009056832839642471 }, { "name": "f-ltc:usd", "availableMargin": 67.51126059691163 }, { "name": "f-xrp:xbt", "availableMargin": 2.34e-9 }, { "name": "f-bch:usd", "availableMargin": 47.151615710695495 } ], "fullName": "fullname redacted", "email": "email redacted", "accountUid": "7f5c528e-2285-45f0-95f5-83d53d4bfcd2" } ] } |
|
|
|
Field |
Type |
Description |
|
result |
string |
Always success |
|
serverTime |
string |
The server date and time |
|
masterAccountUid (optional) |
string |
Master account UID |
|
subaccounts (optional) |
array of Subaccount |
The sub-account |
|
holdingAccounts |
structure of structures |
Structure containing structures with holding accounts information for a specific holding account asset |
|
currency |
string |
The currency of the account. All figures shown in this currency. |
|
amount |
string |
The amount of currency in the holding account |
|
futuresAccounts |
structure of structures |
Structure containing structures with single-collateral accounts information for a specific futures account asset |
|
name |
string |
The name of the futures account as the account pair |
|
availableMargin |
string |
The amount of currency in the holding account in the quote currency of the name pair |
|
fullname |
string |
The name of the account |
|
|
string |
The email associated with the account |
|
accountUid |
string |
The account UID |