Response Format
All API responses use JSON format for straightforward parsing and integration.Successful Responses
Successful requests return predictable patterns with clear status indicators. When your request succeeds, you receive an HTTP200 status code along with the requested data.
Many successful responses also include a success parameter, though this parameter doesn’t appear across all endpoints.
Error Responses
When requests fail, the API provides clear error messages to help you troubleshoot and resolve issues. When something goes wrong, the API returns a JSON object with anerror field explaining what happened.
For example, a request with these parameters:
GET request to /api/indicator.php with parameters
404 Indicator not found
HTTP Status Codes
The API uses standard HTTP conventions to communicate result outcomes.Success Codes
This code confirms your request completed successfully:200: Request succeeded and data is returned.
Client Error Codes
These codes indicate issues with your request that you can resolve by adjusting parameters or authentication:400: Bad request. Review your parameters or request format.401: Unauthorized. Check your API key or permissions.404: Not found. The requested resource doesn’t exist.429: Rate limit exceeded. Wait before retrying or upgrade your plan for higher limits.
Server Error Codes
These codes indicate temporary issues on our end that resolve automatically:500: Internal server error. We have been automatically notified and are investigating.