Get record counts

Return stored records, overage, and create-blocked state for one Core instance.

GET /data/record-counts

cURL

curl -X GET "https://api.cloud.blnkfinance.com/data/record-counts?instance_id=instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" \
  -H "X-blnk-key: CLOUD_API_KEY"

200

{
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "record_counts": {
    "balances": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "identities": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "ledgers": {
      "count": 1,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "reconciliations": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "exact"
    },
    "transactions": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    }
  },
  "total_records": 1,
  "deployment_type": "sandbox",
  "records_included": 100000,
  "overage_records": 0,
  "overage_unit_price": 0.00135,
  "overage_amount": 0,
  "usage_billing_enabled": true,
  "usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
  "record_creates_blocked": false
}

Use this to see how many records one instance stores, how many sit above the included allowance, and whether new record creates are blocked.

A record is a ledger, balance, transaction, identity, or reconciliation external data stored in the instance. See Usage-based billing.

---

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN.

Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.

X-blnk-key · string · required

Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Query

cURL

curl -X GET "https://api.cloud.blnkfinance.com/data/record-counts?instance_id=instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" \
  -H "X-blnk-key: CLOUD_API_KEY"

instance_id · string · required

Cloud instance id (instance_...). Get it from Get instance details. A deploy_... id does not work.

Response

200

{
  "instance_id": "instance_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "record_counts": {
    "balances": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "identities": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "ledgers": {
      "count": 1,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    },
    "reconciliations": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "exact"
    },
    "transactions": {
      "count": 0,
      "total_is_estimate": false,
      "total_source": "lake_catalog"
    }
  },
  "total_records": 1,
  "deployment_type": "sandbox",
  "records_included": 100000,
  "overage_records": 0,
  "overage_unit_price": 0.00135,
  "overage_amount": 0,
  "usage_billing_enabled": true,
  "usage_billing_enabled_at": "2026-09-09T07:20:08.028229Z",
  "record_creates_blocked": false
}

instance_id · string

Instance that was counted (instance_...).

record_counts · object

Counts by resource.

Show child attributes

balances · object

Balance records.

Show child attributes

count · integer

Number of records.

total_is_estimate · boolean

Whether count is an estimate.

total_source · string

Where the count came from, such as lake_catalog or exact.

identities · object

Identity records. Same shape as balances.

ledgers · object

Ledger records. Same shape as balances.

reconciliations · object

Reconciliation records. Same shape as balances.

transactions · object

Transaction records. Same shape as balances.

total_records · integer

Sum of all record counts.

deployment_type · string

sandbox or production.

records_included · integer

Records included in the plan allowance.

overage_records · integer

Records above the included allowance.

overage_unit_price · number

Price per extra record in the billing currency’s major unit (for example USD), not cents. In the sample, 0.00135 is $0.00135 per extra record.

overage_amount · number

Estimated overage charge for the current count, in the billing currency’s major unit (for example USD), not cents.

usage_billing_enabled · boolean

Whether usage-based billing is on for the organization.

usage_billing_enabled_at · timestamp

When usage-based billing was enabled for the organization. ISO 8601.

record_creates_blocked · boolean

true when this instance has used its included records and organization usage-based billing is off, so new records cannot be created. false while the instance is within its allowance or usage-based billing is on.

---

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.