AVIATOR DEVELOPERS

API v1 documentation

Read-only access to AVIATOR News, Companies, Press, and Macro intelligence through scoped client credentials.

OpenAPI specification Request API access

Base URL

https://api.aviator.aero

All v1 requests use HTTPS. Credentials are environment-specific and must never be placed in URLs or browser code.

Authentication

Authorization: Bearer av_live_...
Accept: application/json

AVIATOR displays each credential once and stores only its SHA-256 hash. Contact AVIATOR to replace a lost credential.

Endpoints and scopes

Endpoint	Required scope	Purpose
`/v1/news`	`news:read`	Published News transactions and source links.
`/v1/companies`	`companies:read`	Active canonical company records. Supports q search.
`/v1/press`	`press:read`	Published Press Room articles and provenance.
`/v1/macro`	`macro:read`	Current published Macro indicators.

List endpoints accept limit from 1–100 and a zero-based offset. Companies also accepts q. Example: /v1/news?limit=25&offset=0.

Request example

curl -sS \
  -H "Authorization: Bearer $AVIATOR_API_KEY" \
  "https://api.aviator.aero/v1/news?limit=25&offset=0"

Response envelope

{
  "data": [...],
  "meta": {
    "request_id": "uuid",
    "limit": 25,
    "offset": 0,
    "total": 125
  }
}

Preserve the response x-request-id when contacting support.

Errors

Errors use {"error":{"code":"…","message":"…","request_id":"…"}}.

HTTP	Code	Meaning
400	`invalid_request`	The request parameters are invalid.
401	`missing_credentials`	No supported Bearer credential was supplied.
401	`invalid_credentials`	The credential is unknown or malformed.
401	`inactive_credentials`	The key or client is revoked, expired, or inactive.
403	`insufficient_scope`	The credential lacks the endpoint scope.
429	`rate_limit_exceeded`	The client minute limit has been reached.
500	`internal_error`	AVIATOR could not complete the request.

Legacy AAero migration

Legacy credentials are not imported. Each client receives a new scoped AVIATOR credential and should operate both integrations during an agreed migration window before the legacy endpoint is retired.