ADS-B Exchange · Example Payload

Getapiaircraftv2Airport

This endpoint will return aircraft data within 5 nautical miles of the provided airport ICAO code. Get aircraft within 5 nautical miles of San Francisco airport: ``` GET /api/aircraft/v2/airport/KSFO ``` Use https://www.world-airport-codes.com/ to find ICAO codes for airports.

AviationFlight TrackingADS-BAircraftReal-TimeMilitaryMLAT

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

Top-level fields

operationIdsummarydescriptionmethodpathparametersresponses

Example Payload

{
  "operationId": "GetApiAircraftV2Airport",
  "summary": "Get aircraft near the airport",
  "description": "This endpoint will return aircraft data within 5 nautical miles of the provided airport ICAO code.\n\nGet aircraft within 5 nautical miles of San Francisco airport:\n```\nGET /api/aircraft/v2/airport/KSFO\n```\nUse https://www.world-airport-codes.com/ to find ICAO codes for airports.",
  "method": "GET",
  "path": "/airport/{airport}",
  "parameters": [
    {
      "name": "airport",
      "in": "path",
      "required": true,
      "description": "ICAO code of the airport.",
      "schema": {
        "type": "string"
      },
      "x-position": 1
    },
    {
      "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 within the given radius.",
      "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": {}
    }
  }
}