Getting started
How do I get an API key?
How do I get an API key?
Create an account in the console, open API Keys and click Create API Key. No approval step. Step by step in Generate API key, first request in the Quickstart.
How do I send my key?
How do I send my key?
Three ways, all equivalent: the
X-API-Key header, Authorization: Bearer <key>, or the api_key query parameter. The same key works for REST, WebSocket and the MCP server. Details in Authentication.Is there a free tier?
Is there a free tier?
Yes, 5,000 credits a month, renewed every 30 days, no card required. See Rate Limits & Pricing.
Which base URL should I use for Europe or Japan?
Which base URL should I use for Europe or Japan?
One URL,
https://api.hypedexer.com. A global load balancer routes you to the nearest region. Quotas and prices are identical on both.Billing
What does one request cost?
What does one request cost?
At least 1 credit, and 1 credit per 25 rows returned on paginated endpoints. Batch endpoints cost 3 credits per wallet. Failed requests (status 400 and above) are free.
How do I know what a call cost me?
How do I know what a call cost me?
Every response carries
X-Credit-Cost (credits charged) and X-Credit-Balance (what is left). No need to poll a usage endpoint.How are WebSocket events billed?
How are WebSocket events billed?
Ten delivered events count as one credit, pooled with your REST credits.
Data coverage
How far back does the data go?
How far back does the data go?
Fills of every user run continuously from 18 November 2024. Candles start on 22 March 2025 for the main perp markets, and at each dex’s launch for HIP-3. Per-dataset detail, including which fields are populated in which period, is in the Historical Trade Archive.
Why are fee, oid or dir empty on old fills?
Why are fee, oid or dir empty on old fills?
Older fills carry fewer fields.
dir, oid, hash and startPosition are populated from 22 March 2025, fee and tid from 25 May 2025. The table in the Historical Trade Archive gives the exact periods. If you compute fees or match both sides of a trade by tid, start on 25 May 2025.Do you cover spot, HIP-3 and HIP-4?
Do you cover spot, HIP-3 and HIP-4?
Can I get the order book?
Can I get the order book?
Yes, both levels: L2 (aggregated by price) and L4 (every resting order with its owner), over REST and over WebSocket. See Live data.
Using the API
A fills query is slow. What should I do?
A fills query is slow. What should I do?
Always bound it with
start_time and end_time. On an active address a five-minute window answers in well under a second, while an unbounded request has to count the whole history first. Then follow next_cursor until has_more is false.Cursor or offset?
Cursor or offset?
It depends on the endpoint: fills and liquidations use
cursor, most other lists use offset. Each endpoint’s parameters are listed on its reference page. See Pagination.My WebSocket connection drops after about three minutes.
My WebSocket connection drops after about three minutes.
The server sends
{"type":"ping","ts":<ms>} every 60 seconds and expects {"method":"pong"} back. Without an answer it closes the socket with code 4000. See the WebSocket overview.Is there replay on the WebSocket?
Is there replay on the WebSocket?
No. A stream resumes at the present moment. Backfill any gap over REST, using the timestamp of the last frame you processed.
Why does my spot query return perp rows?
Why does my spot query return perp rows?
/fills/ and /fills/user/{address} return both. Filter on typeTrade (perp or spot), or use the spot-only endpoints.AI agents
Can I plug this into Claude or Cursor?
Can I plug this into Claude or Cursor?
Yes, through our hosted MCP server at
mcp.hypedexer.com/mcp, 78 read-only tools, authenticated with the same API key. See AI Agents (MCP).Does MCP usage cost extra?
Does MCP usage cost extra?
No, it draws on the same credit balance as REST. One tool call can trigger several API requests.