Our API is REST-based. This means:
- It makes use of standard HTTP verbs like GET, POST, DELETE.
- The API uses standard HTTP error responses to describe errors.
- Authentication is specified with HTTP Basic Authentication.
All requests use standard query encoding.
POST data should be encoded as standard application/x-www-form-urlencoded.
Data types
| Data type | Description |
|---|---|
| string | A stream of ASCII characters enclosed in double quotation marks |
| number | Integers and floating-point numbers |
| hash or object | A collection of key-value pairs enclosed in curly braces. All keys are strings and values can be strings, numbers, other hashes, lists, or null values |
| array or list | A collection of objects enclosed in square brackets. All objects can be strings, numbers, other hashes, or lists |
| null | A placeholder value indicating the non-existence of a value |
Rules
| Rule | Descriotion |
|---|---|
| required | Required fields are mandatory for a request to be successful. Omitting it can result in a 4xx status response. Sometimes, they are also generated by our systems and don't need you to include them in the payload. Such as unique ids. |
| optional | Optional fields are not needed for a request to be successful and are often saved as null values or empty lists and objects in the database. |
Rate Limits
At the moment, you are limited to 3,600 requests per hour. You can check your rate limit by looking at the X-RateLimit-Limit header in every response.
We will return the following headers to help you manage this:
X-RateLimit-Limit: 3600
X-RateLimit-Remaining: 3599
If you are consistently hitting our rate limits, please contact us with as much detail as possible regarding your use case and we will look into increasing this for you.