Kingfisher API
Use an API key to check subscription access and request Kingfisher market data.
Use the REST API to request Kingfisher market data from your own tools. Open Account menu → Manage API Keys in the app to create or review a key and see the endpoints available to your plan.
Connect
Send your key in the X-API-Key header to https://app.thekingfisher.io. Keep it in an environment variable or secret manager; do not put it in a URL or a public repository.
Start with a subscription check:
curl https://app.thekingfisher.io/api/api-subscription/status \
-H "X-API-Key: $KF_API_KEY"Use GET /api/api-subscription/instruments to see allowed instruments and GET /api/api-subscription/usage to check credit usage. These three subscription requests do not consume data credits.
The status route checks the API subscription; it does not log in or exchange credentials. Successful responses use top-level fields such as status, active, tier_id, expiry, and credits_remaining. An error may return an error object. Check each endpoint’s response shape; market-data routes do not share one universal envelope.
Request market data
For example, request a GEX snapshot for BTC:
curl https://app.thekingfisher.io/api/map/gevex \
-H "X-API-Key: $KF_API_KEY" \
-H "Content-Type: application/json" \
-d '{"instrument":"BTC"}'Check Manage API Keys for routes enabled on your plan, request fields, allowed instruments and history, current credit costs, and subscription limits before automating. Example requests and capacity summaries are not a complete route list. Market-data responses are endpoint-specific; do not assume they share one response envelope. Data requests may consume credits; costs depend on the endpoint and your plan.
If a request fails, check that the key is active, the instrument is allowed, and your plan includes the endpoint. Rotate an exposed key in Manage API Keys and update any integrations that use it.
To connect an AI client through OAuth instead of an API key, see Kingfisher MCP.
Last updated