Data lake
Get lake schema
List column names and types for each lake table on an instance.
GET
/
data
/
lake
/
schema
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"
}
}
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.
Authorization
Blnk Cloud APIs support any one of the following authentication methods. All of them work with yourCLOUD_API_KEY or OAUTH_ACCESS_TOKEN.
Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.
Query parameters
curl -X GET 'https://api.cloud.blnkfinance.com/data/lake/schema?instance_id=YOUR_INSTANCE_ID' \
-H 'X-blnk-key: CLOUD_API_KEY'
string
required
Unique id of the instance (
instance_...). Get it from get instance details. Do not pass deployment_id.Response
{
"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"
}
}
array
One entry per lake table Cloud can query on this instance. Empty when the lake has not published a schema for the instance yet.
Show Resource properties
Show Resource properties
string
Lake table name to use in
FROM or as resource. One of transactions, balances, ledgers, identity, or anomalies.integer
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.array
Public columns you can use in
SELECT, WHERE, or filters. Internal columns are omitted.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.Was this page helpful?
⌘I
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"
}
}