TidePerp API

Versioned REST under /v1 and a WebSocket stream at /v1/ws. Decimal strings for every financial value, ISO-8601 UTC timestamps, and provenance on every time-sensitive value. The OpenAPI document is served by the API itself.

Full reference

Quick start: BTC market data in four requests

No key needed for public market data (60 requests per minute per address)

1Find the instrument. Search returns markets, protocols and assets; the id is stable across symbol changes.
```
curl "https://api.tideperp.tech/v1/search?q=BTC&limit=3"
```
2Read the market: current metrics, specification, fee schedule and provenance in one document.
```
curl "https://api.tideperp.tech/v1/markets/{id}"
```

3Pull history: candles, funding, open interest, trades, liquidity.

curl "https://api.tideperp.tech/v1/markets/{id}/candles?interval=1h&limit=168"
curl "https://api.tideperp.tech/v1/markets/{id}/funding?limit=168"
curl "https://api.tideperp.tech/v1/markets/{id}/open-interest?bucket=1h&limit=168"

4Stream it. Subscribe per channel and instrument; every event carries a sequence per (channel, instrument), its observation time and quality status.

const ws = new WebSocket("wss://api.tideperp.tech/v1/ws");
ws.onopen = () => ws.send(JSON.stringify({ action: "subscribe", channel: "market.ticker", instrument_ids: ["{id}"] }));
ws.onmessage = (m) => { const e = JSON.parse(m.data); if (e.type === "event") console.log(e.sequence, e.quality_status, e.data.mark_price); };

Every REST response is { data, meta }; meta carries request_id, generated_at, environment, the overall source_status and next_cursor for paginated lists. Errors are { error: { code, message, request_id, details } }.

Authentication

Public market data needs no credentials. Account features (watchlists, alerts, keys) use the browser session cookie with a CSRF token, or an API key:

curl -H "Authorization: Bearer tp_live_xxxxxxxx_…" "https://api.tideperp.tech/v1/watchlists"

Keys are created at API keys, shown once, stored as a peppered hash, and sent only in the Authorization header (never in a query string).
Scopes: read for REST, stream to raise WebSocket subscription limits with an auth message.
Keys can expire; revoking is immediate.

Rate limits

TidePerp policy limits, enforced per key, per session or per address

Principal	REST requests / minute	WebSocket subscriptions
Anonymous (per address)	60	50 per connection
Developer plan	300	200
Professional plan	1,200	800

Defaults of this deployment; the effective limit is returned on every response in x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset. A rejected request answers 429 with RATE_LIMIT_EXCEEDED. These are TidePerp limits, independent of the exchange’s own limits, which the ingester respects separately.

Endpoints · TidePerp API 0.1.0

Generated from the live OpenAPI document; each row links to its reference entry

overview

markets

protocols

compare

intelligence

chain

methodology

get/v1/methodology

auth

watchlists

alerts

api-keys

admin

get/v1/admin/overview
patch/v1/admin/protocols/{slug}
patch/v1/admin/contracts/{id}
patch/v1/admin/detectors/{code}
get/v1/admin/quality-events
post/v1/admin/quality-events/{id}/resolve
post/v1/admin/corrections
get/v1/admin/audit-log
post/v1/admin/users/{id}/role

Endpoints

WebSocket channels

/v1/ws · heartbeat every 20 s · ping/pong · subscribe, unsubscribe and auth actions

Channel	Payload
market.ticker	Mark, mid, oracle, funding, open interest and 24h volume per instrument, on every source update.
market.trades	Observed trades for the subscribed instruments (demand-driven on the source).
market.orderbook	Top-of-book snapshots with up to 20 levels per side.
market.funding	Funding observations as they are recorded.
market.open_interest	Open interest observations.
protocol.metrics	Reserved for venue-level aggregates; no publisher in this version.
intelligence.alerts	Detector signals as they are detected.
chain.blocks	Indexed Elysium blocks.
system.health	Source health transitions.

Event envelope: { type: "event", event_id, channel, sequence, occurred_at, published_at, environment, instrument_id, quality_status, data }. Subscribing without instrument_ids receives every instrument on the channel as one subscription.

Error reference

Code	Meaning
INVALID_PARAMETER	A query, path or body value failed validation; details name the field.
MARKET_NOT_FOUND	No instrument with that id or canonical code.
VENUE_NOT_FOUND	No venue with that id or code.
PROTOCOL_NOT_FOUND	No protocol with that slug.
NOT_FOUND	The resource does not exist or is not yours.
NON_COMPARABLE_MARKETS	The instruments are not in one comparison group; they cannot be ranked together.
INSUFFICIENT_DEPTH	The visible order book cannot fill the requested size; nothing is extrapolated.
STALE_MARKET_DATA	The latest snapshot is older than max_snapshot_age_ms; raise it or wait for a fresh book.
SOURCE_UNAVAILABLE	An upstream source is down or the platform has no observation yet.
RATE_LIMIT_EXCEEDED	Too many requests for this key, session or address; details carry retry_after_ms.
UNAUTHORIZED	Missing, invalid, expired or revoked credentials.
FORBIDDEN	Authenticated but not allowed: wrong scope, missing CSRF token or missing role.
CONFLICT	The request conflicts with existing state (for example a duplicate email).
INTERNAL_ERROR	The platform failed; the request_id lets operators find the trace.

Data methodology

Formulas, detector parameters, quality states and source limits are published at GET /v1/methodology and rendered on the methodology page. Quality status values: LIVE, DELAYED, STALE, ESTIMATED, RECONSTRUCTED, MISSING, UNAVAILABLE, INVALID.

Changelog

0.1.02026-11-07 · Initial public API: markets, protocols, overview aggregates, compare and funding opportunities, intelligence, chain telemetry, accounts, watchlists, alerts, API keys, methodology; WebSocket stream.

Status

Platform and source health: system status, or GET /v1/health (exempt from rate limits). OpenAPI document: GET /v1/openapi.json.