Authentication
Proxy API
Data API
Data API
List balances
List all balances from your Blnk Core instance with pagination support.
GET
/
data
/
balances
curl -X GET "https://api.cloud.blnkfinance.com/data/balances?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20" \
-H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
{
"data": [
{
"balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"currency": "USD",
"balance": 100.50,
"created_at": "2024-11-26T08:36:36.238244338Z"
}
],
"total": 42
}
Retrieve a paginated list of balances from your Blnk Core instance.Documentation Index
Fetch the complete documentation index at: https://guide.cloud.blnkfinance.com/llms.txt
Use this file to discover all available pages before exploring further.
For in-depth information about Blnk’s ledger, balance, transaction, and identity APIs, see the Blnk Core docs.
Request structure
curl -X GET "https://api.cloud.blnkfinance.com/data/balances?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20" \
-H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
Bearer token for authentication. Format:
Bearer <access_token>. Your OAuth key must include data:read scope (or *).Query parameters
The Blnk Core instance ID to read from. Find this in Blnk Cloud under Instances.
Page number to retrieve. Defaults to
1.Number of results per page. Defaults to
20 for balances.Response structure
{
"data": [
{
"balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"currency": "USD",
"balance": 100.50,
"created_at": "2024-11-26T08:36:36.238244338Z"
}
],
"total": 42
}
Array of balance objects.
Total number of balances available.
Balances may also include a
"stats" field in the response for aggregate views.Show Balance object properties
Show Balance object properties
Unique identifier for the balance.
ID of the ledger this balance belongs to.
Currency code for the balance.
Current balance amount.
ISO 8601 formatted timestamp of when the balance was created.
For filters and supported fields, see the Data API docs.
Need help?
If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.⌘I
curl -X GET "https://api.cloud.blnkfinance.com/data/balances?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20" \
-H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
{
"data": [
{
"balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"currency": "USD",
"balance": 100.50,
"created_at": "2024-11-26T08:36:36.238244338Z"
}
],
"total": 42
}