Status: Live. Download the validated, versioned AsyncAPI 3 contract for the production WebSocket protocol.

Contract

Download the canonical AsyncAPI YAML for the production wss://api.adsbiq.com/ws/ endpoint. Version 1.0.0 uses AsyncAPI 3.1.0.

curl -fsS https://adsbiq.com/api/other/asyncapi.yaml -o adsbiq-asyncapi.yaml
npx @asyncapi/cli validate adsbiq-asyncapi.yaml

What is described

The contract defines global and 250-nautical-mile zone subscriptions, API-key query authentication, full snapshots, sparse delta patches, removals, monotonic sequence handling, and the set_zone/set_global client commands.

Compatibility and change policy

The document is checked against production message examples and AsyncAPI 3 semantics. Backward-compatible fields may be added under protocol version 1; breaking message or command changes require a new contract version and migration notice.

Security and troubleshooting

Never publish a populated token query parameter in generated examples, logs, or browser source. If a generator rejects AsyncAPI 3, upgrade it or consume the JSON Schemas under components.schemas directly.


All integration technologies · REST docs · Open data