API reference
The base address is this site's own address. Send your key in the X-API-Key header on every call. Times are Unix seconds in UTC.
Candles
GET /v1/candles
| Parameter | Meaning |
|---|---|
mint | The coin's address. Required. |
interval | 1s, 5s, 15s, 30s, 1m, 5m, 15m, 1h, 4h or 1d. Default 1s. |
from | Start time. With it, candles run forward from here and next_from gives the next page. |
to | End time, inclusive. Without from, you get the newest candles up to this time. |
limit | Width of the window in candles, 1 to 2000. Default 500. |
Seconds with no trades have no candle. Candles always run oldest first.
| Response field | Meaning |
|---|---|
candles[].t | Candle start time. |
candles[].o h l c | Open, high, low and close, in SOL per token. |
candles[].volume_sol | SOL traded in the candle. |
candles[].volume_token | Tokens traded in the candle. |
candles[].buys, sells | Trade counts by side. |
candles[].closed | False while the candle's time window is still open. |
first_trade_at | Time of the first trade on record. |
complete_from_first_trade | True when the coin's creation was seen, the recorder has been connected since, and no history has aged out. |
gaps | Periods overlapping this window when the recorder was disconnected, as from and to. |
history_from | Oldest time kept for this candle size. Sizes under 1m are kept 7 days and larger sizes 90 days. |
next_from | Pass as from for the next page, or null when there is no more. |
Coins
GET /v1/coins/new
Newest coins first. limit is 1 to 200, default 50. Pass the last created_at as before to page back.
GET /v1/coins/{mint}
One coin.
| Field | Meaning |
|---|---|
mint, creator | Addresses. |
name, symbol, uri | Whatever the creator typed. Treat as untrusted text, and null if creation was not seen. |
source | The launchpad. Currently pump. |
created_at | When creation was seen. |
first_trade_at, last_trade_at | Bounds of recorded trading. |
trades | Trades recorded. |
complete_from_first_trade | As in candles. |
Stream
WS /v1/stream/new
Send the key as a header. Browsers can't set websocket headers, so they can pass ?key= instead; keep that key out of public pages. Each message is one JSON object with a type. The stream carries events from the moment you connect, so use /v1/coins/new to catch up after a reconnect.
| Type | Fields |
|---|---|
hello | ingest: state of the recorder when you connected. |
coin | mint name symbol uri creator created_at slot signature |
first_trade | mint t price_sol amount_sol side slot signature |
Usage and limits
GET /v1/usage
Your plan, calls this month and open streams. This call is free. Metered responses also carry X-RateLimit-Limit and X-RateLimit-Remaining for the month. Calls reset on the first of each month, UTC.
Errors
Errors return {"error": {"code", "message"}}.
| Status | Code | Meaning |
|---|---|---|
| 400 | bad_mint bad_interval bad_range | Check the parameter named in the message. |
| 401 | missing_key invalid_key | No key, or not an active one. |
| 404 | unknown_mint | No trades recorded for this coin. |
| 426 | upgrade_required | The stream needs a websocket client. |
| 429 | rate_limited monthly_limit stream_limit | Over a plan limit. rate_limited includes Retry-After. |