Contents

The calling key: plan, limits, usage

The caller: the key (masked, never the secret: name, scopes, expiry, IP allowlist, browser origins), the plan and its limits, the account’s usage of the current minute and UTC day, overage, the history window and the venues the licence gate withholds.

GET/api/v1/meEvery key

Description

Not counted against the limits and never 429: ask it when a client is limited. Keyless public access (X-Blockmetric-Access: public) gets the public tier and key null.

Who can call it

Available with every key and keyless (X-Blockmetric-Access: public). Keys of Free accounts get free-tier data (real-time feeds, 30 days of history, heatmap over time for every coin over the last 24 hours, liquidation levels now for every coin, the same as the free web plan); Pro and Desk keys the data of their plan; API Dev / API Pro raise the limits.

No key: 24 h
Free: 30 days
Pro: 365 days
Desk: 1095 days
API Dev: 365 days
API Pro: 1095 days

History window per plan. Limits: Authentication & limits.

Parameters

No parameters.

Response fields

Every success is { data, meta }; these are the fields of data. meta is the same on every endpoint.

Response fields of /me
Field	Description
`keyless`boolean	true = keyless public access (X-Blockmetric-Access: public).
`key`object · nullable	The calling key; null with keyless access.
`key.masked`string	Prefix and last 4 characters (bm_live_…ABCD), never the key.
`key.name`string · nullable	Your label of the key.
`key.createdAt`string (ISO 8601)	Created.
`key.expiresAt`string (ISO 8601) · nullable	Expiry; null = none.
`key.lastUsedAt`string (ISO 8601) · nullable	Last request with the key (updated at most once a minute).
`key.scopes[]`array of "api" \| "node"	api = this data API, node = the node gateway.
`key.ipAllowlist[]`array of string	CIDR ranges the key is limited to; empty = any address.
`key.allowedOrigins[]`array of string	Browser origins that may use the key; empty = server use only.
`plan`"free" \| "pro" \| "desk" \| "api_dev" \| "api_pro"	The caller's plan.
`limits`object	Limits of the plan.
`limits.perMinute`integer	Requests per minute (account, all keys).
`limits.perDay`integer	Requests per UTC day.
`limits.webhookEndpoints`integer	Webhook endpoints the plan includes.
`limits.streams`integer	Concurrent live streams the plan includes.
`usage`object	Requests of the account in the current minute and UTC day (this request is not counted).
`usage.minute`object · nullable	The current one-minute window; null when unknown.
`usage.minute.limit`integer	Requests allowed in the window.
`usage.minute.used`integer	Requests used.
`usage.minute.remaining`integer	Requests left.
`usage.minute.resetsAt`string (ISO 8601)	When the window resets.
`usage.day`object · nullable	The current UTC day; null when unknown.
`usage.day.limit`integer	Requests allowed in the window.
`usage.day.used`integer	Requests used.
`usage.day.remaining`integer	Requests left.
`usage.day.resetsAt`string (ISO 8601)	When the window resets.
`overage`object	Requests beyond the daily limit (billed per 1,000 calls up to the monthly cap).
`overage.available`boolean	The plan can bill requests beyond the daily limit (API Dev, API Pro).
`overage.enabled`boolean	Overage is switched on for the account.
`overage.capUsd`number · nullable	Monthly cap of the overage cost in USD.
`overage.pricePer1kUsd`number · nullable	Price per 1,000 calls beyond the daily limit in USD.
`overage.monthCalls`integer	Calls billed as overage this UTC month.
`overage.monthCostUsd`number	Overage cost this UTC month (USD).
`access`object	Data scope of the plan.
`access.historyDays`integer	Days of history the plan reads.
`access.delayMinutes`integer	Feed delay in minutes (0 = real time).
`access.heatmapTimeframes[]`array of string (enum)	Heatmap intervals of the plan.
`access.liqMapCoins`integer · nullable	Coins with liquidation levels now (top by open interest); null = every coin.
`access.commercial`boolean	Whether the licence allows commercial use (see meta.license).
`restrictedVenues[]`array of "binance" \| "bybit" \| "okx"	Exchanges whose raw rows the API withholds during the licence review.

Errors

400invalid_param Invalid parameter
401unauthorized Missing or invalid API key
403plan_required Plan does not include this
403scope_required Key not scoped for this API
403ip_not_allowed Address not on the IP allowlist of the key
403origin_not_allowed Key used from a browser origin it does not allow
403source_restricted Exchange data not redistributed
403https_required https required
500internal_error Internal errorretry

Request

curl -s -H "X-Blockmetric-Access: public" \
  "https://api.blockmetric.io/v1/me"

Example response

HTTP 200Real data from 2026-10-27 13:13 UTC

{
  "data": {
    "keyless": true,
    "key": null,
    "plan": "free",
    "limits": {
      "perMinute": 10,
      "perDay": 300,
      "webhookEndpoints": 0,
      "streams": 0
    },
    "usage": {
      "minute": {
        "limit": 10,
        "used": 0,
        "remaining": 10,
        "resetsAt": "2026-10-27T13:14:53.000Z"
      },
      "day": {
        "limit": 300,
        "used": 0,
        "remaining": 300,
        "resetsAt": "2026-10-28T00:00:00.000Z"
      }
    },
    "overage": {
      "available": false,
      "enabled": false,
      "capUsd": null,
      "pricePer1kUsd": null,
      "monthCalls": 0,
      "monthCostUsd": 0
    },
    "access": {
      "historyDays": 1,
      "delayMinutes": 0,
      "heatmapTimeframes": [
        "15m",
        "1h"
      ],
      "liqMapCoins": null,
      "commercial": false
    },
    "restrictedVenues": [
      "binance",
      "bybit"
    ]
  },
  "meta": {
    "updatedAt": "2026-10-27T13:13:53.378Z",
    "source": "blockmetric",
    "sources": [],
    "plan": "free",
    "delayMinutes": 0,
    "commercial": false,
    "license": {
      "id": "public",
      "display": true,
      "attributionRequired": true,
      "attribution": "Data by Blockmetric",
      "redistribution": false,
      "mauCap": null,
      "terms": "https://blockmetric.io/terms#api-license"
    },
    "attribution": {
      "text": "Data by Blockmetric",
      "url": "https://blockmetric.io/"
    },
    "access": {
      "historyDays": 1,
      "historyFrom": "2026-10-26T13:14:00.000Z"
    }
  }
}

More options: open in the explorer · SDK method me() / me()

Code snippets in these docs are licensed under MIT-0: copy them into your own code without attribution. The SDKs, CLI and MCP server will be, once published, Apache-2.0; the name Blockmetric is not licensed (forks must be renamed). Data from the API is governed by the API terms; third-party exchange data by the exchange’s terms.