Data lake

Get lake schema

List column names and types for each lake table on an instance.

GET/data/lake/schema

Return the latest lake schema for each ledger resource on an instance. Use this before you write SQL or filters so you know which table names and columns Cloud will accept.

The response lists only public columns. Internal columns (names that start with _blnk_) are omitted. For table relationships and when to use each column, see Schema.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Query parameters

instance_idstringrequiredquery

Unique id of the instance (instance_...). Get it from get instance details. Do not pass deployment_id.

Response

resourcesarray

One entry per lake table Cloud can query on this instance. Empty when the lake has not published a schema for the instance yet.

Resource properties

namestring

Lake table name to use in FROM or as resource. One of transactions, balances, ledgers, identity, or anomalies.

schema_versioninteger

Version of the column set Cloud last observed for this table. Increments when the lake adds or changes columns. 0 when Cloud is still describing a mirrored table and has not stored a versioned schema yet.

columnsarray

Public columns you can use in SELECT, WHERE, or filters. Internal columns are omitted.

Column properties

namestring

Column name to use in SQL or in a filter field. For example currency, status, or meta_data.

typestring

Physical type Cloud stores for the column, such as VARCHAR, DOUBLE, TIMESTAMP, or JSON. meta_data is always JSON.

curl -X GET 'https://api.cloud.blnkfinance.com/data/lake/schema?instance_id=YOUR_INSTANCE_ID' \
  -H 'X-blnk-key: CLOUD_API_KEY'

{
  "data": {
    "resources": [
      {
        "name": "balances",
        "schema_version": 3,
        "columns": [
          {
            "name": "balance_id",
            "type": "VARCHAR"
          },
          {
            "name": "currency",
            "type": "VARCHAR"
          },
          {
            "name": "meta_data",
            "type": "JSON"
          }
        ]
      },
      {
        "name": "transactions",
        "schema_version": 3,
        "columns": [
          {
            "name": "transaction_id",
            "type": "VARCHAR"
          },
          {
            "name": "currency",
            "type": "VARCHAR"
          },
          {
            "name": "status",
            "type": "VARCHAR"
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "instance_id is required"
  }
}