Metadata

Metrics

GET https://api.glassnode.com/v1/metadata/metrics

Lists all available metric paths. This should be used as the base list which can then be used to retrieve metadata from the detail view Metric Metadata

Note: the paths only include the metric portion of the path, and not the full path containing /v1/metrics.

200 OK

[
    "/addresses/accumulation_balance",
    "/addresses/accumulation_balance_pit",
    "/addresses/accumulation_count",
    "/addresses/accumulation_count_pit",
    "/addresses/active_count",
    "/addresses/count",
    ...
]

Metric

GET https://api.glassnode.com/v1/metadata/metric

Retrieves metadata describing the available parameters and potential drill-down options for a metric.

The base request, where only path is queried, returns the union of all possible parameters and their values.

If the response contains next_parameter, this indicates that query parameters are distinct across next_parameter values. If not present in the base response, all request parameters have the same supported set of values.

Once next_parameter is no longer present, no further narrowing of values is possible and the response represents the set of valid parameters and values for the query.

See Usage for a complete example.

Schema

Name	Type	Description	Presence
path	string	metric path	always
parameters	Dict[string, List[string]	list of all allowed parameters and their values	always
next_parameter	string	should the metric possess a hierarchy by which the valid parameters change, this key-value pair denotes the next available parameter which can be queried	only present in the response when a drill-down is available
queried	Dict[string, string]	the query which was processed by the server; extraneous values will not be queried	always
modified	int	the last unix timestamp that the metadata was updated in UTC

Query Parameters

Name	Type	Description
path*	string	metric path: /addresses/count
a	string	asset symbol: BTC

200 OK

{
  "path": "/distribution/balance_exchanges",
  "tier": 2,
  "parameters": {
    "a": [
      "1INCH",
      "AAVE",
      "ABT",
      ...
    ],
    "e": [
      "aggregated",
      "bibox",
      "bigone",
      "binance",
      ...
    ],
    "f": [
      "csv",
      "json"
    ],
    "i": [
      "10m",
      "1h",
      "24h"
    ]
  },
  "queried": {
    "path": "/distribution/balance_exchanges"
  },
  "next_parameter": "a",
  "modified": 1730993909
}

400 Bad Request - Required Parameter Not Set

required parameter not set: path

400 Bad Request - Invalid Query

invalid query parameter: invalid value a=invalid_asset value must be one of [BTC ETH]

404 Not Found

metadata not found: path=/distribution/does_not_exist

Usage

Request metadata for metric:

GET https://api.glassnode.com/v1/metadata/metric?path=/distribution/balance_exchanges

{
  "path": "/distribution/balance_exchanges",
  "tier": 2,
  "parameters": {
    "a": [
      "1INCH",
      "AAVE",
      "ABT",
      ...
    ],
    "e": [
      "aggregated",
      "bibox",
      "bigone",
      "binance",
      ...
    ],
    "f": [
      "csv",
      "json"
    ],
    "i": [
      "10m",
      "1h",
      "24h"
    ]
  },
  "queried": {
    "path": "/distribution/balance_exchanges"
  },
  "next_parameter": "a",
  "modified": 1730993909
}

Add the value of next_parameter to the query with a value from the response to refine the query further. Continue this process until next_parameter is no longer present in the response.

GET https://api.glassnode.com/v1/metadata/metric?path=/distribution/balance_exchanges&a=BTC

{
  "path": "/distribution/balance_exchanges",
  "tier": 2,
  "parameters": {
    "c": [
      "native",
      "usd"
    ],
    "e": [
      "aggregated",
      "binance",
      "bitfinex",
      "bitget",
      "bithumb",
      "bitmex",
      "bitstamp",
      "bittrex",
      "bybit",
      "coinbase",
      "coincheck",
      "coinex",
      "crypto.com",
      "deribit",
      "ftx",
      "gate.io",
      "gemini",
      "hitbtc",
      "huobi",
      "korbit",
      "kraken",
      "kucoin",
      "luno",
      "okex",
      "poloniex",
      "swissborg"
    ],
    "f": [
      "csv",
      "json"
    ],
    "i": [
      "10m",
      "1h",
      "24h"
    ]
  },
  "queried": {
    "a": "BTC",
    "path": "/distribution/balance_exchanges"
  },
  "modified": 1733829848
}

The result displays the set of valid parameters and their values given the query:

{
  "a": "BTC",
  "path": "/distribution/balance_exchanges"
}