Authentication
All API requests require an API key passed in theAuthorization header:
Get an API key
- Sign in at one.finkkle.com
- Click Create API key in the dashboard
- Give your key a name that identifies its scope (e.g.,
prod-search,dev-test) - Copy the key immediately — it is displayed only once
Key scopes
Keys are scoped to the routes they are allowed to call. Use separate keys for different environments and different integrations — a key used in production should not be the same key used in development.Rate limits
When you exceed the rate limit, the API returns a
429 Too Many Requests response. Implement exponential backoff for retries:
Integration pattern
1
Authenticate at your backend
Store your API key in an environment variable. Never send it to the client.
2
Validate and normalize inputs
Validate query inputs before sending them to the API. Ensure
q is non-empty and meets the minimum length requirement.3
Call with an explicit timeout
Set a timeout on every API call — network conditions vary and upstream services can be slow:
4
Log request IDs
Capture request IDs from response headers for debugging and support escalation. Pass them when contacting support.
Webhooks and event handling
For streaming endpoints and event-driven integrations:- Handle events idempotently — store the event ID before applying side effects
- Acknowledge quickly — return a 200 response immediately, process the payload asynchronously
- Retry with backoff — use exponential backoff for transient failures (network errors, 5xx responses)
- Do not retry 4xx errors — these indicate a problem with your request that retrying will not fix
Available endpoints
See individual endpoint pages for full parameter and response documentation.