Ivy's API also utilizes standard HTTP response codes to provide information about the success or failure of API requests.

2xx Range (Success): Codes in this range indicate a successful API request. It means that the requested operation was completed as expected.

4xx Range (Client Errors): Codes in this range indicate an error related to the client's request. For instance, it could be due to a missing required parameter, a payment failure, or other client-specific issues.

5xx Range (Server Errors): These indicate an issue with Ivy's servers. When you encounter a code in this range, it signifies an error on Ivy's side, and you should not be concerned about the client's request.

Understanding these response codes helps developers work with Ivy's API effectively and handle different scenarios, ensuring a smooth and reliable integration.

HTTP Status Code Summary

Status CodeDescription
200 - OKThe request was successful, and everything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthenticatedThe request was not authorized due to an invalid or missing API key.
403 - AuthorizationThe used API key doesn't have the necessary permissions to perform the request.
404 - Not FoundThe requested resource does not exist.
409 - ConflictThe request conflicts with another request, often due to the use of the same idempotent key.
423 - LockedThe requested resource is temporarily locked due to an ongoing operation. Please wait for it to become available again before retrying the request.
429 - Too Many RequestsToo many requests were made to the API in a short period. We recommend using an exponential backoff for your requests.
500 - Internal Server ErrorThese codes indicate a rare issue on Ivy's end: something went wrong with Ivy's servers.

Error Attributes

code string
This field provides a short string indicating the reported error code.

devMessage string | undefined
A human-readable message that provides additional details about the error.