Quickstart

Create a workspace

Choose a plan

Pick Starter, Growth, or Scale at checkout, or talk to sales about Enterprise. You can create test keys before subscribing and build against sample data. See Plans and limits.

Create an API key

Open API keys and select Create API key. Copy the secret right away: it is shown only once.

Make your first request

Request one day of hourly BTC candles:

curl "https://data.hyperdash.com/v1/markets/BTC/candles?interval=1h&start_time=1792454400000&end_time=1792540800000" \
  -H "Authorization: Bearer $HYPERDASH_API_KEY"

The response

List endpoints return data, has_more, next_cursor, and meta. Prices and sizes are decimal strings, so no precision is lost.

{
  "data": [
    { "t": 1792454400000, "o": "108412.0", "h": "108950.0", "l": "108201.0", "c": "108733.0", "v": "1532.48211", "q": "166329104.2", "n": 48213 }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": { "coin": "BTC", "interval": "1h", "start_time": 1792454400000, "end_time": 1792540800000, "sample": false, "forming": false }
}

Every response also states what it cost:

X-Request-Id: 019a3c4e-7b2d-7f10-9c4a-2e6d1b8f0a53
X-Credits-Charged: 36
X-Credit-Price-Version: 1
ratelimit-policy: 50;w=2

This request returned 24 bars over a 24-hour range, so it cost 10 base credits, plus 24 for the bars, plus 2 for one node read: 36 credits. See Credits for the formula.

Next steps

Check your balance with GET /v1/me (free, needs the usage:read scope).
Price a request before running it with GET /v1/quote (free).
Browse the API reference for every endpoint, its parameters, and its limits.

Get started

Using the API

API reference

Operations

Data & Infrastructure

The response

Next steps

​The response

​Next steps

The response

Next steps