ADS-B Exchange · Example Payload

Postapiaircraftv2Proximityradius

This endpoint will return aircraft data within the given radius (NM) of the provided points. Get aircraft within 50 nautical miles of San Francisco, and within 20 nautical miles from New York (KJFK) at altitudes between 5000 and 30000 feet: ``` POST /api/aircraft/v2/proximity/radius { "filters": [ { "latitude": 37.7749, "longitude": -122.4194, "radius": 50 }, { "latitude": 40.641, "longitude": -73.775, "radius": 20, "altitude_min": 5000, "altitude_max": 30000 }, ... ] } ```

AviationFlight TrackingADS-BAircraftReal-TimeMilitaryMLAT

Postapiaircraftv2Proximityradius 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": "PostApiAircraftV2ProximityRadius",
  "summary": "Get aircraft in radius",
  "description": "This endpoint will return aircraft data within the given radius (NM) of the provided points.\n\nGet aircraft within 50 nautical miles of San Francisco, and within 20 nautical miles from New York (KJFK) at altitudes between 5000 and 30000 feet:\n```\nPOST /api/aircraft/v2/proximity/radius\n{\n    \"filters\": [\n        {\n            \"latitude\": 37.7749,\n            \"longitude\": -122.4194,\n            \"radius\": 50\n        },\n        {\n            \"latitude\": 40.641,\n            \"longitude\": -73.775,\n            \"radius\": 20,\n            \"altitude_min\": 5000,\n            \"altitude_max\": 30000\n        },\n        ...\n    ]\n}\n```",
  "method": "POST",
  "path": "/proximity/radius",
  "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 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": {}
    }
  },
  "requestBody": {
    "x-name": "request",
    "description": "JSON request model containing a list of distance filters (points).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ProximityRequest"
        }
      }
    },
    "required": true,
    "x-position": 1
  }
}