Data lake API

POST

data

lake

query

curl -X POST 'https://api.cloud.blnkfinance.com/data/lake/query' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "instance_id": "YOUR_INSTANCE_ID",
    "start_date": "2026-08-01",
    "end_date": "2026-08-31",
    "sql": "SELECT currency, COUNT(*) AS txn_count FROM transactions GROUP BY currency LIMIT 1000"
  }'

{
  "data": {
    "run_id": "lqr_...",
    "rows": [
      { "currency": "USD", "txn_count": 1280 }
    ],
    "total": 1
  }
}

Query ledger history (Parquet in the instance data lake) through Cloud. This is not the hot Data API, which reads the live instance database. Use this for reporting and audits over a date range. For live lists, filters, and current wallet holdings, use the Data API.

Requires the data:read scope. Production managed instances include a built-in data lake. See Managed instances.

For SQL tables, casts, and templates, see Insights.

Request structure

curl -X POST 'https://api.cloud.blnkfinance.com/data/lake/query' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "instance_id": "YOUR_INSTANCE_ID",
    "start_date": "2026-08-01",
    "end_date": "2026-08-31",
    "sql": "SELECT currency, COUNT(*) AS txn_count FROM transactions GROUP BY currency LIMIT 1000"
  }'

string

required

Bearer token for an API key or OAuth access token with data:read.

string

required

Core instance whose lake you want to query.

string

Archive range start. Required if end_date is empty. ISO date or datetime.

string

Archive range end. Required if start_date is empty.

string

One read-only DuckDB SELECT or WITH statement. Tables are inferred from the SQL. Do not send resource, resources, or org_id.

string

Run a query saved in Insights instead of sending sql.

SQL response

{
  "data": {
    "run_id": "lqr_...",
    "rows": [
      { "currency": "USD", "txn_count": 1280 }
    ],
    "total": 1
  }
}

array

Result rows. Column names match the SQL aliases.

integer

Number of rows returned in this run.

List without SQL

If you omit sql and saved_query_id, send a resource list instead. resource must be one of transactions, balances, ledgers, identity. Include start_date or end_date.

Body field	Use
`resource`	Lake table to list
`filters`	`{ "field", "op", "value" }` with `op` one of `eq`, `gt`, `gte`, `lt`, `lte`, `like`, `ilike`
`sort_field` / `sort_dir`	`asc` or `desc`
`limit` / `offset`	Pagination. Must not be negative

Saved queries

Saved lake queries live under /data/lake/queries.

Method	Path	Purpose
GET	`/data/lake/queries?instance_id=`	List saved queries
POST	`/data/lake/queries`	Create a saved query
PATCH	`/data/lake/queries/{id}`	Update a saved query
DELETE	`/data/lake/queries/{id}`	Delete a saved query
GET	`/data/lake/schema?instance_id=`	Column schema per resource
GET	`/data/lake/query-runs?instance_id=`	Recent runs

Create body includes instance_id, name, description, sql, range_mode (fixed or rolling), plus either start_date / end_date or rolling_days.

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.

curl -X POST 'https://api.cloud.blnkfinance.com/data/lake/query' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "instance_id": "YOUR_INSTANCE_ID",
    "start_date": "2026-08-01",
    "end_date": "2026-08-31",
    "sql": "SELECT currency, COUNT(*) AS txn_count FROM transactions GROUP BY currency LIMIT 1000"
  }'

{
  "data": {
    "run_id": "lqr_...",
    "rows": [
      { "currency": "USD", "txn_count": 1280 }
    ],
    "total": 1
  }
}

Start Here

Instances

Ledgers

Balances

Transactions

Identities

Reconciliation

Filters & Views

Alerts

Monitoring

Insights

Apps

Settings

Integrations

Request structure

SQL response

List without SQL

Saved queries

Need help?

​Request structure

​SQL response

​List without SQL

​Saved queries

​Need help?

Request structure

SQL response

List without SQL

Saved queries

Need help?