Skip to content

Search API documentation

Metrics, companies & guides

Start here

Quickstart Authentication API plans & access Bitcoin prices & OHLCV data
Try

Bitcoin Realized Profit API

Total profit (in USD) from coins that were moved when their price was lower at their last movement compared to their current movement

Request

GET
curl -H "Authorization: Bearer YOUR_TOKEN" "https://newhedge.io/api/v2/metrics/realized-profit/METRIC_NAME"
Parameters & responses
Query params

Authorization: Bearer YOUR_TOKEN (required) — your 24 character API key (also accepted: the X-API-Key header or the api_token query parameter).

resolution (optional) — 1d (default), 12h, 4h, 1h, 30m, 10m, coarsest to finest. Finer buckets are served to Advanced and Enterprise accounts, and only for the metrics that ingest them (listed per metric below); see Resolutions.

before (optional) — exclusive cursor, returns observations older than this timestamp_ms. Works on every resolution.

limit (optional) — the most recent N observations, maximum 5000. Finer resolutions page by default (2500); a 1d request returns the whole series unless you send limit or before.

before and limit narrow a time series. On a metric keyed by exchange or tenor they apply to each series, and the keys stay where they are. A response with no time axis, such as a labelled snapshot table, has nothing to cut on. It is returned whole, and both parameters are ignored rather than rejected.

A before that is not a positive epoch-millisecond timestamp is a 400. It is the one paging value we reject rather than ignore, because a page size has a sensible default and a cursor does not.

include (optional) — definition wraps the response as {"definition": …, "data": …} and returns the record shown under each metric; see Definitions. Any other value is a 400.

Path params

:metric_name — one of the metric names listed below.

Responses

200 with JSON payload, 400 for an unknown include value, 401 for missing/invalid token, 404 for missing resources, 429 when the monthly limit is reached. A 404 for a metric withdrawn on purpose adds withdrawn, withdrawn_on and reason, for example {"error":"Metric not found","withdrawn":true,"withdrawn_on":"2026-09-07","reason":"The venue's public feed reports insurance-fund settlements, not liquidation orders."}; a removed chart can add successor.

Plan and quota refusals keep their error texts and add code, required_plan, current_plan, feature, upgrade_url, limit and resets_at where they apply. The 429 for a used-up monthly allowance carries Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. A Pro token whose history window removed points also gets the X-Newhedge-History-Truncated headers, and for a Pro token X-Newhedge-Available-From is the start of the window. See Errors and plan limits.

Every 404 and 400 also carries a machine code and, where a list of valid names exists, up to 3 did_you_mean spellings, catalog_url and docs_url. Two different keys in one request are a 400 with code: conflicting_credentials. Only a successful response spends one call from the monthly allowance. A refused or failed call (any 4xx or 5xx, a conflict between credentials, an unknown path) spends nothing, and the request-rate limits are unchanged. The full list of codes is under Errors on the introduction page.

Metrics

One request per metric.

1 metric
Metric

Realized Profitrealized_profit

Resolutions: 1d, 12h, 4h, 1h, 30m, 10m.

Endpoint
curl -H "Authorization: Bearer YOUR_TOKEN" "https://newhedge.io/api/v2/metrics/realized-profit/realized_profit"

Replace `YOUR_TOKEN` with your API token.

Example response
200 Historical · 2025-01-01
[
  [1735516800000,3090072019.48],
  [1735603200000,2309596287.64],
  [1735689600000,1279419061.66]
]
Definition & units Definition

Value: Realized profit in US dollars: the trailing 24-hour sum of profit locked in by outputs spent above their cost basis, taken at the day's final block. A suffix of _lth or _sth selects the holder cohort and no suffix is all holders. Long-term holders (LTH) hold outputs at least 150 days old and short-term holders (STH) hold outputs younger than 150 days. UTXO-based, not entity-adjusted.

Units: usd

Timestamp (1d): Labelled 00:00 UTC of the day it describes.

Timestamp (finer resolutions): A finer resolution is labelled in UTC at the end of the interval it covers, not at its start. Request include=definition for the selected bucket.

Calendar: calendar_daily

Revision policy: append_only. A stored day is not rewritten by the regular daily update. From 2026-10-09 the short-term series comes from the same data source as the long-term and total series, so they are additive: short-term plus long-term equals the total, and short-term profit minus short-term loss equals short-term net. Earlier short-term values can differ.

Universe: Bitcoin on-chain, UTXO-based.

Methodology version: 2026-10-09