Skip to main content
GET
cURL

What it measures

Net Realized Profit and Loss — the net profit or loss, in USD, realized by all holders who spent coins in the window, measured against the price when each coin last moved.

Assets and windows

The default window is day.

Response fields

The time key depends on the window: datetime for day and hour and blockheight plus datetime for block.

Authorizations

Authorization
string
header
required

For each API request, include the Authorization HTTP header with Bearer {access_token}.

Query Parameters

asset
string
required

Asset to query, by its CryptoQuant alias (no chain suffix — usdt, not usdt_eth). 1 asset is available on this endpoint, across the asset class btc. Enumerate them with /v2/discovery/endpoints.

chain
enum<string>

Chain the asset lives on. Optional for an asset that exists on exactly one chain, required when the same alias exists on several.

Available options:
bitcoin
window
enum<string>
default:day

Aggregation window. Which windows are valid depends on the asset — see the endpoint page. Defaults to day.

Available options:
block,
hour,
day
from
string

Inclusive start time, YYYYMMDDTHHMMSS (UTC). If window=day, YYYYMMDD is also accepted.

to
string

Inclusive end time, YYYYMMDDTHHMMSS (UTC). If window=day, YYYYMMDD is also accepted.

limit
integer
default:100

Maximum rows returned (default 100, max 10000).

Required range: x <= 10000
format
enum<string>
default:json

Response format: json (default) or csv.

Available options:
json,
csv

Response

200 - application/json

NRPL time-series.

status
object
required

Returned with every response; indicates whether the request was successful.

result
object
required