Ledger balances

Get balance by indicator

Retrieve a balance by its indicator.

GET/balances/indicator/{indicator}/currency/{currency}

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.

Path

indicatorstringrequiredpath

Specifies the indicator of the balance being retrieved.

currencystringrequiredpath

Specifies the currency of the balance being retrieved.

curl -X GET "http://localhost:5001/balances/indicator/{indicator}/currency/{currency}" \
  -H "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
}

{
  "error": "balance with indicator '@MissingIndicator' not found",
  "error_detail": {
    "code": "BAL_NOT_FOUND",
    "message": "balance with indicator '@MissingIndicator' not found"
  }
}