Endpoint

List balances

GET/v1/balances

One item per asset held, across all wallets. value uses the rate at as_of. Not paginated.

Scope a restricted key needs: wallets:read
Publishable key: Not allowed: secret or restricted key only
Idempotency-Key: Not used. A GET is already safe to repeat.

Parameters

Parameters of List balances
Parameter	Type and place	Meaning
`wallet`	stringquery	One wallet.
`network`	stringquery	Only balances on this network.
`asset`	stringquery	Only balances of this asset id.
`include_zero`	booleanquery	Also list supported assets with a zero balance. Default `false`.
`currency`	stringquery	Fiat currency for `value`. Default `USD`.
`Orrerie-Version`	stringheader	API version date. Default: the version the key was created with. Example `2026-10-11`.

Example request

curl

curl https://api.orrerie.com/v1/balances \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/balances", {
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
  },
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);

Python

import os
import requests

response = requests.get(
    "https://api.orrerie.com/v1/balances",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)

PHP

<?php
$request = curl_init('https://api.orrerie.com/v1/balances');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
    ],
]);
$body = curl_exec($request);
if ($body === false) {
    throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
    throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);

Responses

`200` OK

A list whose data holds balance objects. Headers: Orrerie-Request-Id.

Example response, 200

{
  "object": "list",
  "url": "/v1/balances",
  "has_more": false,
  "data": [
    {
      "object": "balance",
      "wallet": "wal_bsfw07hymawmda7gg8jsyy3g",
      "network": "base",
      "asset": "base:usdc",
      "amount": "1284.500000",
      "incoming_unconfirmed": "0.000000",
      "reserved": "250.000000",
      "available": "1034.500000",
      "value": {
        "amount": "1284.37",
        "currency": "USD"
      },
      "as_of": "2026-10-12T09:29:58.000Z"
    },
    {
      "object": "balance",
      "wallet": "wal_zjdztygt4g73zm0cdcjjf43k",
      "network": "bitcoin",
      "asset": "bitcoin:btc",
      "amount": "0.01500000",
      "incoming_unconfirmed": "0.00000000",
      "reserved": "0.01000000",
      "available": "0.00500000",
      "value": {
        "amount": "1755.65",
        "currency": "USD"
      },
      "as_of": "2026-10-12T09:29:58.000Z"
    }
  ]
}

Any other status: an error

A status of 400 or above answers with the error object. Branch on its code, never on its message.

Errors

This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.