Documentation / Guides
Authentication
How GreyhoundAPI keys work: the header format, live and sandbox prefixes, rotation with overlap, and what suspension looks like.
Authenticate every request with your key in the X-API-Key header.
Authorization: Bearer <key> is accepted as an alias.
curl "https://api.greyhoundapi.com/v1/status" -H "X-API-Key: $GAPI_KEY"Key types
| Prefix | Tier | Data |
|---|---|---|
gapi_live_ | Live ($99/month) | Everything, including live-day data and the WebSocket stream |
gapi_test_ | Sandbox (free) | A 7-day window ending 24 hours ago |
Handling and rotation
Keys are shown once at creation and stored hashed — treat them like passwords and keep them server-side. Rotating a key issues a replacement immediately and keeps the old key working for 24 hours so deploys can overlap. Revoking is immediate.
Suspension
If a subscription lapses, its keys return 403 with error code
key_suspended and open WebSocket connections are closed. Reactivating the
subscription restores the same keys — nothing needs re-issuing.