Get custody balance

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

POST /0/private/GetCustodyBalance

Get custody balance

cURL

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"
}
'

import requests

url = "https://api.kraken.com/0/private/GetCustodyBalance"

payload = {
    "nonce": 123,
    "vault_id": "VN2F7NJJWKJHI2"
}
headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({nonce: 123, vault_id: 'VN2F7NJJWKJHI2'})
};

fetch('https://api.kraken.com/0/private/GetCustodyBalance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kraken.com/0/private/GetCustodyBalance"

	payload := strings.NewReader("{\n  \"nonce\": 123,\n  \"vault_id\": \"VN2F7NJJWKJHI2\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

default

{
  "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

Show child attributes

result · object | null

Balance breakdown by asset.

Show child attributes