Status Codes
We follow the HTTP status code conventions. See the HTTP Status Code Summary for more details.2xx Range (Success): Codes in this range indicate a successful API request. This means the requested operation was completed as expected.
4xx Range (Client Errors): Codes in this range indicate an error related to the client’s request. These errors may occur due to missing required parameters, payment failures, or other client-specific issues.
5xx Range (Server Errors): These codes indicate an issue with Ivy’s servers. When you encounter a code in this range, it signifies an error on Ivy’s side rather than an issue with the client’s request.
Understanding these response codes helps developers work with Ivy’s API effectively and handle different scenarios appropriately, ensuring smooth and reliable integration.
Error Structure
All errors return a consistent JSON structure in the response body:A human-readable message explaining what went wrong. This message is suitable for displaying to end customers or for debugging purposes.
A broad category classifying the type of error. Possible values:
api_error- Server-side errors or unexpected issuesinvalid_request_error- Client-side errors such as invalid parameters, authentication failures, or authorization issuesrate_limiting- Request was rejected due to rate limitingidempotency_error- Request conflicts with a previous request using the same idempotency key
A short string indicating the specific error code. You can use this to handle errors programmatically.
When the error is parameter-specific, this field indicates which parameter caused the error. Useful for displaying validation errors near the appropriate form field.
A URL linking to relevant documentation that provides more context about the error.
DEPRECATED: A human-readable message providing additional details about the error, primarily intended for developers.
DEPRECATED: The HTTP status code that corresponds to the error.
DEPRECATED: Additional error context.