Authentication

The Skylit Public API uses bearer authentication. Send your API key in the Authorization header on every request:

Authorization: Bearer <your-api-key>

Getting a key

Generate and manage keys on the Developer page (API keys tab). New accounts are seeded with 5,000 credits.

curl "https://api.skylit.ai/v1/heatmap?symbols=SPY" \
  -H "Authorization: Bearer $SKYLIT_API_KEY"

import os, requests

session = requests.Session()
session.headers["Authorization"] = f"Bearer {os.environ['SKYLIT_API_KEY']}"
print(session.get("https://api.skylit.ai/v1/heatmap", params={"symbols": "SPY"}).json())

const skylit = (path) =>
  fetch(`https://api.skylit.ai${path}`, {
    headers: { Authorization: `Bearer ${process.env.SKYLIT_API_KEY}` },
  }).then((r) => r.json());

console.log(await skylit("/v1/heatmap?symbols=SPY"));

Credits

Every chargeable request debits a fixed cost from your credit balance.

Every chargeable response carries X-Credits-Remaining: <balance>. Failed calls are free: a request answered with any 4xx or 5xx is refunded, and its X-Credits-Remaining already reflects the refund.

Rate limits

A safety ceiling of 600 requests / minute per key is enforced by the Skylit gateway. This is runaway protection, not your quota — credit metering does the per-customer accounting. The X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers describe the key's quota, which is unlimited (-1, 0, 0). They don't count toward the per-minute ceiling, so don't throttle on them.