ADS-B Exchange · Example Payload

Postapiaircraftv2Registration

This endpoint will return aircraft data for the provided registration number(s). Because GET request has a limit on the number of characters in the URL, it is recommended to use POST request when querying multiple aircraft (more than 10).

AviationFlight TrackingADS-BAircraftReal-TimeMilitaryMLAT

Postapiaircraftv2Registration is an example object payload from ADS-B Exchange, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdsummarydescriptionmethodpathparametersresponsesrequestBody

Example Payload

{
  "operationId": "PostApiAircraftV2Registration",
  "summary": "Get aircraft by registrations",
  "description": "This endpoint will return aircraft data for the provided registration number(s).\n\nBecause GET request has a limit on the number of characters in the URL,\nit is recommended to use POST request when querying multiple aircraft (more than 10).",
  "method": "POST",
  "path": "/registration",
  "parameters": [
    {
      "type": "string",
      "name": "Accept-Encoding",
      "in": "header",
      "required": true,
      "description": "The encoding type the client will accept in the response. API call must use compression.",
      "default": "gzip",
      "example": "gzip"
    }
  ],
  "responses": {
    "200": {
      "description": "Response containing a collection of aircraft models.",
      "content_type": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AircraftCollectionResponse"
      },
      "example": {}
    },
    "402": {
      "description": "Payment Required",
      "content_type": "application/json",
      "schema": {
        "$ref": "#/components/schemas/ApiUnauthorizedResponse"
      },
      "example": {}
    },
    "403": {
      "description": "Forbidden",
      "content_type": "application/json",
      "schema": {
        "$ref": "#/components/schemas/ApiForbiddenResponse"
      },
      "example": {}
    },
    "429": {
      "description": "Rate Limit Exceeded",
      "content_type": "application/json",
      "schema": {
        "$ref": "#/components/schemas/ApiTooManyRequestsResponse"
      },
      "example": {}
    },
    "500": {
      "description": "Server Error",
      "content_type": "application/json",
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      },
      "example": {}
    }
  },
  "requestBody": {
    "x-name": "request",
    "description": "JSON request model containing a list of registration numbers to retrieve aircraft data for.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/RegistrationRequest"
        }
      }
    },
    "required": true,
    "x-position": 1
  }
}