Authentication and Usage

Authentication

We use a private key in order to authenticate. To create a private key, follow these steps:

1. Login with an administrator account here: https://tools.parrotsoftware.io/app/external-api-private-key/private-key-6639093cedc590737f55d2f8

2. Create Private Key

💡 Make sure to save this key as it will never be displayed again.

3. Autenticate your requests

To authenticate your requests add the private key as a Bearer token

Authorization: Bearer pk_C4nvSTABZr3L6roCsJYq2puqFPB25rdR_744daa39b51e45d79d157f1d3af4c630

Pagination

Pages start at 0 so if you want to query the first results, make sure to set page: 0

Pages can be at most 100 in size

Rate Limiting

Each user has a limit of 15 requests per minute. If you go above the threshold you will recieve a 429 - Too Many Requests response:

{
  "statusCode": "TOO_MANY_REQUESTS",
  "error": "Too many requests: wait at least 21 seconds",
  "code": "request.TooManyRequests",
  "datetime": 1714976844836
}

Every request returns a X-Rate-Limit-Remaining header which lets you know how many tokens you have left.

X-Rate-Limit-Remaining: 13

Date Range Queries

For reliable performance, when querying any endpoints with startTimestamp and endTimestamp, they must be at most 48 hours apart.

Authentication#

Pagination#

Rate Limiting#

Date Range Queries#

Authentication

Pagination

Rate Limiting

Date Range Queries