Assets

Get an asset's metric history

GEThttps://api.arzdigital.com/v1/assets/{slug}/metrics

X-API-Key headerHow credits work

Send type, plus either range or all of from, to and interval. With from, to and interval the window can hold at most 1000 points.

Credit use: Each successful call costs 1 credit for every 100 points it returns, rounded up. For example, 250 points cost 3 credits.

An empty result and any error cost nothing.

GET/v1/assets/bitcoin/metrics

curl -sS "https://api.arzdigital.com/v1/assets/bitcoin/metrics?type=market_cap&range=7d" \
  -H "X-API-Key: YOUR_API_KEY"

Example response200

{
  "status": "success",
  "data": [
    {
      "time": 1793982000,
      "value": 1515627046896.06
    },
    {
      "time": 1793982300,
      "value": 1521337024131.88
    },
    {
      "time": 1793982600,
      "value": 1521486005547.19
    },
    {
      "time": 1793982900,
      "value": 1524507955857.99
    }
  ]
}

Run these from your server. The API sends no CORS headers, so a browser will block the call.

Parameters

slugstringPathRequired
Asset slug, such as bitcoin.
Example: bitcoin
typestringQueryRequired
The metric. volume_market_cap_ratio is returned as a percentage.
circulating_supplydominancevolumemarket_capvolume_market_cap_ratio
rangestringQuery
Window ending now. Cannot be combined with from, to or interval.
1d7d1m3m6m1yall
fromintegerQuery
Window start, in Unix seconds. Requires to and interval.
tointegerQuery
Window end, in Unix seconds. Requires from and interval.
intervalstringQuery
Point spacing. Requires from and to.
Allowed values (11)
5m30m2h6h12h1d2d3d7d30d60d

Request headers

X-API-KeystringRequired
Your API key. Send it in this header on every call; it is not accepted in the URL.

Response

Metric points.

Response fields (4)

statusstring
dataarray
data[].timeinteger
Unix seconds.
data[].valuenumber

Response headers

X-Credits-Charged
Credits this call cost. 0 on every non-200 response.
X-Credits-Remaining
Account balance after this call, not counting what calls still in flight have set aside. Negative only for an account in debt after an adjustment.
X-RateLimit-Limit
Requests per minute allowed for this key.
X-RateLimit-Remaining
Requests left in the current window.
X-RateLimit-Reset
Unix seconds at which the window has room again.

Errors

bad_requesterror_code 1001
A parameter is missing

Errors are never charged. Errors