Coming soon. These API docs are published for reference, but public API
access isn’t open yet — it will be available in the near future.
Live heatmap
Current per-strike heatmap for one or more symbols, including live
velocityPct.Historical replay
The snapshot nearest any past instant — up to 365 days back.
Live stream (SSE)
A Server-Sent Events feed of live heatmap updates, one symbol per connection.
Authentication
Bearer API keys, credit metering, and rate limits.
Base URL
Quickstart
Get an API key
Generate a key from your account console. New accounts are
seeded with 5,000 credits.
How responses look
Every success returns adata / meta envelope; errors return an error object. Fields are camelCase.
Each strike carries Skylit’s node classification — the same vocabulary used throughout
Patternpedia.
Present on
/v1/heatmap; omitted on /v1/historical (velocity is a live metric)./v1/heatmap costs 1, /v1/historical costs 5, /v1/stream 1 per minute open.
Every response carries X-Credits-Remaining. See Authentication.
