Skip to main content
GET
/
balances
/
indicator
/
{indicator}
/
currency
/
{currency}
Get balance by indicator
curl --request GET \
  --url http://localhost:5001/balances/indicator/{indicator}/currency/{currency} \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.getByIndicator to look up an internal balance by indicator and currency.
blnk.LedgerBalances.getByIndicator
const response = await blnk.LedgerBalances.getByIndicator('@World', 'USD');
FieldDescription
indicatorBalance indicator (for example @World). The SDK URL-encodes this in the request path.
currencyCurrency code (for example USD).

​
Response shape

200 OK
{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_debit_balance": 0,
  "queued_credit_balance": 0,
  "queued_debit_balance": 0,
  "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
  "indicator": "@World",
  "identity_id": "",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}
FieldDescription
balance_idUnique ID for the balance.
indicatorIndicator you passed in the request.
currencyCurrency you passed in the request.
balanceCurrent net amount.

Internal balances

How @ indicators work.

Get balance by indicator

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.