ReferenceAPI ReferenceWallet

List wallet balances

GET/wallets/{id}/balances●Retrieve all balances held by a wallet across symbols.

Returns all balances held by this wallet across symbols. A wallet can hold balances in multiple currencies or units of exchange simultaneously. Only symbols that have had balance activity are returned — symbols with no prior transactions will not appear with a zero balance.

Balances are returned as integers in the smallest unit defined by the symbol's factor. Divide the balance by the factor to get the decimal value. For example, a balance of 1550 with a symbol factor of 100 represents 15.50.

GET
/wallets/{id}/balances

Usage Examples

curl -X GET "http://localhost:3000/v2/wallets/string/balances" \  -H "x-ledger: <YOUR LEDGER HANDLE>"
{
  "hash": "1a13f7083eda9f955e47b168f74cd6fec353fa66a1deb03c9c153a33eb7dfb31",
  "data": [
    {
      "luid": "$bal.-01xK0aRsT1bQ2vW1",
      "hash": "435a43b702dd65b745c3ad3d362e1b1aecfc773c925a7aef2d7447363f7caa75",
      "data": {
        "schema": "available",
        "wallet": "tesla-bank-wallet",
        "symbol": "usd",
        "amount": 1500000
      },
      "meta": {
        "moment": "2025-04-05T14:30:00.500Z",
        "proofs": [
          {
            "signer": "system",
            "method": "ed25519-v2",
            "digest": "b504c021a5c87b4a67d79197124b94549bb14ee289fdb855a43c59cfac1b0a72",
            "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
            "result": "LMn3mXU63tU9+YuSVHQM3EhWK+ulw2p2RW/APyxVyNs2jC7VpVOpnbglk3V4Ct/PhQTK8kVvtUoUEIXhyIEhDw==",
            "custom": {
              "luid": "$bal.-01xK0aRsT1bQ2vW1",
              "moment": "2025-04-05T14:30:00.500Z"
            }
          }
        ]
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 20
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "d6e8f6a734b8c55d0043ad0090d75ac7659ce106dcb36322b2220a79d7dd64a4",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "2jHq7QMHJeMyowWxjTVu++94/xZ1FGxhzG6OEgSYDsfJNLU9Cxp2C/cn6RKYnQbNZP3ABwAEHRUOACuJgmPDAg==",
        "custom": {
          "moment": "2025-04-05T14:30:00.100Z"
        }
      }
    ]
  }
}
{
  "hash": "b7eb7ccf5ffc126951e13e29a8dcfdaf95db859715d4edfc2d16f59a79d4cd58",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "3acece870c4118bfe4223118e4d2f3cfd5b8947a7093785b66d49aa57fa2890a",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "gnK63DqqWDY/UXvnZHixDKPKS6tfeGHgdARylnPiJLwQGyYxuD97TYbSg2wrzsf/bDrHwQYZaf8Gu5ryYP0UAA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}
{
  "hash": "9ec02726b50650add8acfd124c6defeb978a9ac252a5de888f9493ddc701e927",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "4f8cbdc38d73348de0c31805c783c84a0fecc6be736d7e187004ba68cd00e675",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "P3hRnveehtuobb4AIO56XBmiduvmYJbpdmOHltG/IifBEH7QSWdv/0pqled4SO9x1Ne3oXuWxJy40DzMvx1MBA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}
{
  "hash": "d6c59a6df7165fa4a75159799ca5f5e26e544cbb8769eced3d35d8021f6f7935",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "78cf86f34aefcf9da6ed4167a38aac0a2739f68f7bafb1d3e033c01ed1b6cdf1",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "9Ledk+/iAAtj+uLjGe2afq4kID7n8UQD6UpRpLBCujxFjxddq0uZ2tnYRTAXmYdHDkbF0uXqtNM9qO3xhEtpAA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

{
  "hash": "1c084e8dcfb9bb84bc8ea96e9e137b149a34b2bbd85f8e60b4263f5aba980476",
  "data": {
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
        }
      ]
    },
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "7a5febb431719b6f43d7e88e79211308e16ac651b71b339276373fdb4e7c3760",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "2/1zYw4AaIzsIHfOIC6V/CHw6owbjYHt48cwmFOig0ibeT0IbojLmj1RCRi8W00ka0udPa9WsacWDd7ObMY8CA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

{
  "hash": "93a5f4d97a42c2df97f827c58ff7768d02568c15aca931e22b81fa3160ba0df3",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "efaf5360143b586917d9636779ad6e08571c5b06909a20dd0f5eba4bf3be7eae",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "hERh6Aecj59iR+Fb25OQsHJScOi4t8EiffKSfjlMQdjHMccTnfDlgZFdaJzXzUtpSwy/NHq0l+7ydh3HSWCoAg==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

Path Parameters

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Query Parameters

page?

Pagination options. Set limit and index to page through results.

filter?

Filter by field values using dot notation (e.g. data.handle=value). Operators like $in and $regex are optional — equality is the default.

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Add wallet proof POST

Appends a signed proof to the record. The proof must be signed against the record's current hash. Use proofs to change status, update labels, or record custom data — see [About Proofs](/ledger/structuring-data/about-proofs) for details. Returns the updated record with the new proof in `meta.proofs`. Broadcasts the `wallet-proofs-added` signal. Use [effects](/ledger/reference/api/effect) to subscribe.

List wallet limits GET

Returns limits applied to the wallet such as `minBalance`, `maxBalance`, `dailyAmount`, and `dailyCount`. Limits are set through intent claims with the `limit` action. Limit amounts follow the same integer format as balances — divide by the symbol's factor to get the decimal value.