GET/api/v1/onchain/status

Discover available on-chain metrics for a specific blockchain.

Returns a list of all available on-chain metrics for a given blockchain, including each metric's ID, available data fields, and source file name. Use this endpoint to discover what data you can query before fetching it.

#Authentication

Requires an API key with an active Pro subscription and onchain permission.

x-api-key: YOUR_API_KEY

#Query Parameters

Parameter	Type	Default	Description
`chain`	`string`	`bitcoin`	Blockchain to list metrics for. Options: `bitcoin`, `cardano`, `dogecoin`, `litecoin`

#Request

bash

Try in Playground

curl -H "x-api-key: YOUR_API_KEY" \
  "https://chartinspect.com/api/v1/onchain/status?chain=bitcoin"

#Response

json

{
  "success": true,
  "chain": "bitcoin",
  "metricsCount": 115,
  "metrics": [
    {
      "metric": "mvrv",
      "fields": ["timestamp", "close", "mvrv"],
      "fileName": "mvrv.json"
    },
    {
      "metric": "nupl",
      "fields": ["timestamp", "close", "nupl"],
      "fileName": "nupl.json"
    },
    {
      "metric": "sopr",
      "fields": ["timestamp", "close", "sopr", "sopr_sma7"],
      "fileName": "sopr.json"
    },
    {
      "metric": "sell-side-risk",
      "fields": ["timestamp", "close", "sellSideRisk", "sellSideRisk_sma30"],
      "fileName": "sell-side-risk.json"
    },
    {
      "metric": "realized-price-streak",
      "fields": ["timestamp", "close", "realizedPrice", "streak", "streakDays"],
      "fileName": "realized-price-streak.json"
    }
  ]
}

The full response contains all available metrics. The example above shows a representative sample.

#Response Fields

Field	Type	Description
`metric`	`string`	Metric identifier used in the data endpoint URL path
`fields`	`string[]`	Array of field names available in the metric's data. Use these with the `fields` query parameter when fetching data
`fileName`	`string`	Source file name (informational)

#Metric Aliases

Some metrics have aliases for convenience. Both the alias and the canonical name resolve to the same data:

Alias	Resolves To
`detailed-mvrv`	`mvrv`
`asopr`	`sopr`
`adjusted-sopr`	`sopr`
`rhodl-ratio`	`rhodl`

If you request a metric by alias, the API automatically resolves it to the canonical metric and returns the correct data.

#Example: Listing Cardano Metrics

bash

Try in Playground

curl -H "x-api-key: YOUR_API_KEY" \
  "https://chartinspect.com/api/v1/onchain/status?chain=cardano"

json

{
  "success": true,
  "chain": "cardano",
  "metricsCount": 28,
  "metrics": [
    {
      "metric": "mvrv",
      "fields": ["timestamp", "close", "mvrv"],
      "fileName": "mvrv.json"
    },
    {
      "metric": "nupl",
      "fields": ["timestamp", "close", "nupl"],
      "fileName": "nupl.json"
    }
  ]
}

#Error Responses

Status	Description
`403`	Invalid or missing API key, or subscription does not include onchain access
`400`	Unsupported chain value

Was this page helpful?

PreviousGET /api/v1/chains

NextGET /api/v1/onchain/{metric}