Skip to main content
GET
/
data
/
{resource}
curl -X GET 'https://api.cloud.blnkfinance.com/data/transactions?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "data": [
    {
      "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
      "amount": 100.50,
      "currency": "USD",
      "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
      "destination": "bln_ANOTHER_BALANCE_ID",
      "status": "APPLIED",
      "created_at": "2024-11-26T08:40:00.000000000Z"
    }
  ],
  "total": 42
}
The Data API lets you read data stored in a Blnk Core instance through Blnk Cloud. Requests query the instance database directly and are commonly used for dashboards, analytics, reporting, and back-office operations.
The Data API is read-only and queries the instance DB directly via our query agent. It does not forward requests to Core over HTTP.For write operations, use the Proxy API. For JSON body filters, use the Filters API.
For a step-by-step walkthrough, see Retrieving data.

​
Request structure

curl -X GET 'https://api.cloud.blnkfinance.com/data/transactions?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
​
Authorization
string
required
Bearer token for an API key or OAuth access token. Requires the data:read scope. Create credentials with the data:read scope in API keys or OAuth clients.
​
instance_id
string
required
Unique identifier of the Blnk Core instance to query. Required on every Data API request.
​
page
integer
default:"1"
Page number for paginated list requests.
​
pageSize
integer
Number of records per page. Defaults vary by resource: 30 for ledgers, 20 for balances, transactions, and identities.

​
List resources

All list paths are relative to https://api.cloud.blnkfinance.com/data.
ResourcePath
Ledgers/ledgers
Balances/balances
Transactions/transactions
Identities/identities
Reconciliations/reconciliations
Matching rules/matching-rules
External transactions/external-transactions
{
  "data": [
    {
      "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
      "amount": 100.50,
      "currency": "USD",
      "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
      "destination": "bln_ANOTHER_BALANCE_ID",
      "status": "APPLIED",
      "created_at": "2024-11-26T08:40:00.000000000Z"
    }
  ],
  "total": 42
}
​
data
array
required
Array of records for the requested resource.
​
total
integer
required
Total number of matching records.
For request examples, detail routes, and query-parameter filters, see Retrieving data. To filter with a JSON body, use the Filters API.

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