Skip to main content
GET
/
metrics
/
data
Get Dataset
curl --request GET \
  --url https://api.amberdata.com/amberlens/metrics/data \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "data": [
      {
        "bucket": "1000-10000 BTC",
        "bucketSize": "1919",
        "supplyHeld": 4686221.887717294,
        "timestamp": "2024-01-01 00:00:00 000"
      },
      {
        "bucket": "0.001-0.01 BTC",
        "bucketSize": "12319890",
        "supplyHeld": 44928.49075751555,
        "timestamp": "2024-01-01 00:00:00 000"
      },
      {
        "bucket": "0.00001-0.0001 BTC",
        "bucketSize": "9923858",
        "supplyHeld": 424.2221137385358,
        "timestamp": "2024-01-01 00:00:00 000"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string
required

The id value from the Datasets Information for a specific dataset.

​
startDate
string<date>

[Optional] Payload only includes data after this date (inclusive).
[Formats] seconds | milliseconds | iso8601
[Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
endDate
string<date>

[Optional] Payload only includes data before this date (exclusive).
[Formats] seconds | milliseconds | iso8601
[Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
timeFormat
enum<string>
default:hr

[Optional] Time format of the timestamps in the return payload.

Available options:
milliseconds,
ms,
iso,
iso8601,
hr,
human_readable

Response

200 - application/json

200

The response is of type any.