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>'
import requests

url = "http://localhost:5001/balances/indicator/{indicator}/currency/{currency}"

headers = {"X-blnk-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/balances/indicator/{indicator}/currency/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5001",
  CURLOPT_URL => "http://localhost:5001/balances/indicator/{indicator}/currency/{currency}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-blnk-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5001/balances/indicator/{indicator}/currency/{currency}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-blnk-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:5001/balances/indicator/{indicator}/currency/{currency}")
  .header("X-blnk-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/balances/indicator/{indicator}/currency/{currency}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.ledger_balances.get_by_indicator to look up an internal balance by indicator and currency.
1

Call the method

blnk.ledger_balances.get_by_indicator
response = blnk.ledger_balances.get_by_indicator("@World", "USD")
FieldTypeDescription
indicatorstrBalance indicator (for example @World). The SDK URL-encodes this in the request path.
currencystrCurrency code (for example USD).
2

Save the balance ID

Use response.data["balance_id"] when you need the canonical ID for transactions or API calls that do not accept indicators.
3

Response

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
}
FieldTypeDescription
balance_idstrUnique ID for the balance.
indicatorstrIndicator you passed in the request.
currencystrCurrency you passed in the request.
balancenumberCurrent 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.