Response Format & Error Code
The body of every response will include the following fields. All API response will also be tagged with an appropriate HTTP Response code using which further processing of the API response can be done.
| Field | Description | Type |
|---|---|---|
| payload | The object containing the actual response. | Object |
Error Codes
| Code | Description |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request could not be accepted, usually due to a missing required parameter. |
| 401 - Unauthorized | No valid API key was provided. |
| 404 - Not Found | The request path does not exist. |
| 429 - Too Many Requests | You are being rate-limited. Please see the rate limiting section for more details. |
| 500, 502, 503 - Server Errors | Something went wrong on Propellyr's servers. These are rare. |