ADS-B Exchange · Example Payload

Getapiaircraftv2Minimallatlondist

This endpoint will return aircraft data within the given radius (NM) of the provided coordinates. The data will be returned in a minimal representation.

AviationFlight TrackingADS-BAircraftReal-TimeMilitaryMLAT

Getapiaircraftv2Minimallatlondist 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

Raw ↑ 
{
  "operationId": "GetApiAircraftV2MinimalLatLonDist",
  "summary": "Get aircraft in radius (minimal)",
  "description": "This endpoint will return aircraft data within the given radius (NM) of the provided coordinates. The data will be returned in a minimal representation.",
  "method": "GET",
  "path": "/minimal/lat/{lat}/lon/{lon}/dist/{dist}",
  "parameters": [
    {
      "name": "lat",
      "in": "path",
      "required": true,
      "description": "Latitude of the center point.",
      "schema": {
        "type": "number",
        "format": "double"
      },
      "x-position": 1
    },
    {
      "name": "lon",
      "in": "path",
      "required": true,
      "description": "Longitude of the center point.",
      "schema": {
        "type": "number",
        "format": "double"
      },
      "x-position": 2
    },
    {
      "name": "dist",
      "in": "path",
      "required": true,
      "description": "Radius in nautical miles.",
      "schema": {
        "type": "number",
        "format": "double"
      },
      "x-position": 3
    },
    {
      "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/AircraftCollectionMinimalResponse"
      },
      "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": {}
    }
  }
}