Skip to main content
POST
/
0
/
private
/
GetCustodyBalance
Get custody balance
curl --request POST \
  --url https://api.kraken.com/0/private/GetCustodyBalance \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "vault_id": "VN2F7NJJWKJHI2"
}
'
{
  "error": [
    {
      "errorClass": "<string>",
      "type": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "result": {
    "asset": {
      "balance": "<string>",
      "hold_trade": "<string>"
    }
  }
}

Authorizations

​
API-Key
string
header
required

The "API-Key" header should contain your API key.

​
API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
​
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

​
vault_id
string
required

The vault ID to retrieve balances for.

Required string length: 14
Pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Example:

"VN2F7NJJWKJHI2"

Response

default - application/json

Response

​
error
object[]
required
​
result
object

Balance breakdown by asset.