Skip to main content
POST
GetAircraftDetailsBatch

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Headers

Idempotency-Key
string

Optional client-generated idempotency key. Retrying a POST with the same key and an identical request body replays the original response (only the status, body, and Content-Type are reproduced) instead of re-executing; reusing the key with a different body is rejected with 422. For mutations this avoids duplicating the side effect, while for batch-read POSTs it replays a cached snapshot that can be up to 24 hours stale. Keys are scoped per authenticated caller (falling back to the source IP for unauthenticated endpoints) and retained for 24 hours.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

GetAircraftDetailsBatchRequest looks up multiple aircraft by ICAO 24-bit hex.

icao24s
string[]
Required array length: 1 - 20 elements

ICAO 24-bit hex addresses (lowercase). Up to 20 are accepted by validation, but the handler de-duplicates, sorts, and processes at most the first 10 addresses.

Response

Successful response

GetAircraftDetailsBatchResponse contains the batch lookup results.

results
object

Map of icao24 -> aircraft details for found aircraft.

fetched
integer<int32>

Number of aircraft successfully fetched from upstream.

requested
integer<int32>

Number of aircraft requested.

configured
boolean

Whether the Wingbits API is configured.