Getting Started
The InsightIQ API is a RESTful API that returns JSON-encoded responses and accepts JSON payloads over HTTPS. For security reasons, API calls must be made from your server and never from your frontend or app.
Modes
The API is available in two modes, each operate using separate API credentials.
Mode | Host | Description |
|---|---|---|
Staging | Used to test your integration with real accounts and data. | |
Production | Used to go live with your integration. Users will use their real credentials and API endpoints will return real data and updates made to the accounts. Note that all operations via APIs in this mode are billable. |
Authentication
We use API credentials with basic authentication scheme to uniquely identify your access. Include your client_ID and Secret in all requests via the Authorization header.
Header | Description |
|---|---|
Authorization |
|
Rate Limit / Throttling
The authenticated API supports a maximum of 20 requests per second across all endpoints, with additional limit on concurrent requests. These limits are calculated using a fixed window approach, meaning the limit resets at the start of each second.
The public API supports a maximum of 3 requests per second across all endpoints, with additional limit on concurrent requests. These limits are calculated using a fixed window approach, meaning the limit resets at the start of each second.
If the rate limit is exceeded, the API will respond with:
A
429orToo Many Requestsstatus code.A
Retry-Afterheader, indicating how many seconds to wait before retrying.
To ensure seamless usage, handle the 429 error and adhere to Retry-After header for guidance in your implementation.
Errors
The API provides clear and descriptive error responses when such a case arises. Each response includes enough information to debug and resolve the issue. For more details, refer Error Handling documentation.
Maintenance Schedule
A weekly maintenance is conducted every Friday from 5:30 AM to 5:45 AM PST (9:30 AM to 9:45 AM UTC, 3:00 PM to 3:15 PM IST). During this time, minor disruptions or downtime may occur. If issues persist beyond this window, please contact us at [email protected].