Get balance

POST 
/0/private/BalanceEx

Retrieve the balance for each asset held in the specified vault.

Request

Header Parameters

x-vault-id stringrequired
Possible values: >= 12 characters and <= 19 characters, Value must match regular expression (^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$|AA[A-Z0-9]{2} ?[A-Z0-9]{4} ?[A-Z0-9]{4} ?[A-Z0-9]{4})
Vault ID or Vault IIBAN
Example: VOBJAQBMOKYR3K or AA73 N84G ZI3B MCFQ

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

Responses

default

Response

application/json

Schema

Schema

error object[]required
Array [
severity stringrequired
Possible values: [E, W]
API error severity.
errorClass stringrequired
type stringrequired
errorMessage stringnullable
]
result objectnullable

Balance breakdown by asset.

asset object

balance stringrequired

Total balance amount for an asset.

hold_trade stringrequired

Total held amount for an asset.

Example (from schema)

{
  "error": [
    {
      "severity": "E",
      "errorClass": "string",
      "type": "string",
      "errorMessage": "string"
    }
  ],
  "result": {
    "asset": {
      "balance": "string",
      "hold_trade": "string"
    }
  }
}

Loading...