Authentication
Send your API key in the x-api-key header.
Every request needs the header:
x-api-key: <your API key>Requests pass through a gateway before they reach the API. If the header is missing or the gateway does not recognize the key, it returns 403 with this body:
{
"message": "Forbidden"
}Once a request passes the gateway, the API can still refuse it with 403. In that case it says why in data.message:
| Situation | Status | data.message |
|---|---|---|
| Key accepted by the gateway but not recognized by the API | 403 | You must provide a valid API key |
| Key disabled | 403 | You must provide an active API key |
| Key valid, data family not enabled for your organization | 403 | You don't have access to any of the frameworks requested. |
| Too many instruments in one request | 403 | You can only request data for a maximum of 10000 instruments at a time. |
Keys belong to your organization. Portfolios you create with a key are stored for your organization and are shared by every key in it.
To get, rotate or revoke a key, contact customers@connect.earth.