GET
/
balances
/
indicator
/
{indicator}
/
currency
/
{currency}
curl --request GET \
    --url http://localhost:5001/balances/indicator/{indicator}/currency/{currency} \
  --header 'X-blnk-key: <api-key>'

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

​
Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Secure your Blnk server

​
Path

Available in version 0.10.3 and later.
​
indicator
string

Specifies the indicator of the balance being retrieved.

​
currency
string

Specifies the currency of the balance being retrieved.

curl --request GET \
    --url http://localhost:5001/balances/indicator/{indicator}/currency/{currency} \
  --header 'X-blnk-key: <api-key>'

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

​
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.