dck8b9de.nx.link

{
  "parameters": [
    {
      "description": "Specifies the FR24 API version. The currently available version is `v1`.",
      "example": "v1",
      "in": "header",
      "name": "Accept-Version",
      "required": true,
      "schema": {
        "default": "v1",
        "type": "string"
      }
    },
    {
      "description": "Coordinates defining an area. Order: north, south, west, east (comma-separated float values). Up to 3 decimal points will be processed.",
      "example": "42.473,37.331,-10.014,-4.115",
      "in": "query",
      "name": "bounds",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flight numbers (comma-separated values, max 15).",
      "example": "CA4515,UA1742",
      "in": "query",
      "name": "flights",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flight callsigns (comma-separated values, max 15).",
      "example": "WJA329,WSW102",
      "in": "query",
      "name": "callsigns",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Aircraft registration numbers (comma-separated values, max 15).",
      "example": "D-AFAM,EC-MQM",
      "in": "query",
      "name": "registrations",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Aircraft painted in an airline\\'s livery, identified by ICAO code, but not necessarily operated by that airline, such as a regional airline operating a flight for a larger airline (comma-separated values, max 15).",
      "example": "SAS,ART",
      "in": "query",
      "name": "painted_as",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Aircraft operating under an airline\\'s call sign, identified by ICAO code, but not necessarily an aircraft belonging to that airline, such as an aircraft on lease from another airline (comma-separated values, max 15).",
      "example": "SAS,ART",
      "in": "query",
      "name": "operating_as",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Airports specified by IATA or ICAO codes or countries specified by ISO 3166-1 alpha-2 codes (comma-separated values)\nTo determine direction use format: &#60;direction&#62;:&#60;code&#62; (colon-separated, max 15)<br><br>\nAvailable directions:\n- both - both directions (default direction when not specified)\n- inbound - flights to airport\n- outbound - flight from airport\n",
      "example": "LHR,SE,inbound:WAW,US,outbound:JFK,both:ESSA",
      "in": "query",
      "name": "airports",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flights between different airports or countries. Airports specified by IATA or ICAO codes or countries specified by ISO 3166-1 alpha-2 codes (comma-separated values, max 15).",
      "example": "SE-US,ESSA-JFK",
      "in": "query",
      "name": "routes",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Aircraft ICAO type codes (comma-separated values, max 15).",
      "example": "B38M,B738",
      "in": "query",
      "name": "aircraft",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flight altitude ranges (comma-separated values) represent the aircraft's barometric pressure altitude above mean sea level (AMSL), measured under standard atmospheric conditions (1013.25 hPa / 29.92 in. Hg.). Altitudes are expressed in feet, starting from 0, where 0 reflects ground level AMSL.",
      "example": "0-3000,5000-7000",
      "in": "query",
      "name": "altitude_ranges",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Squawk codes in hex format (comma-separated values).",
      "example": "6135,7070",
      "in": "query",
      "name": "squawks",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Categories of Flights (comma-separated values).\nAvailable values:\n- <b>P</b> - PASSENGER - Commercial aircraft that carry passengers as their primary purpose\n- <b>C</b> - CARGO - Aircraft that carry only cargo\n- <b>M</b> - MILITARY_AND_GOVERNMENT - Aircraft operated by military or a governmental agency\n- <b>J</b> - BUSINESS_JETS - Larger private aircraft, such as Gulfstream, Bombardier, and Pilatus\n- <b>T</b> - GENERAL_AVIATION - Non-commercial transport flights, including private, ambulance, aerial survey, flight training and instrument calibration aircraft\n- <b>H</b> - HELICOPTERS - Rotary wing aircraft\n- <b>B</b> - LIGHTER_THAN_AIR - Lighter-than-air aircraft include gas-filled airships of all kinds\n- <b>G</b> - GLIDERS - Unpowered aircraft\n- <b>D</b> - DRONES - Uncrewed aircraft, ranging from small consumer drones to larger UAVs\n- <b>V</b> - GROUND_VEHICLES - Transponder equipped vehicles, such as push-back tugs, fire trucks, and operations vehicles\n- <b>O</b> - OTHER - Aircraft appearing on Flightradar24 not classified elsewhere (International Space Station, UFOs, Santa, etc)\n- <b>N</b> - NON_CATEGORIZED - Aircraft not yet placed into a category in the Flightradar24 database\n",
      "example": "P,C",
      "in": "query",
      "name": "categories",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Source of information about flights (comma-separated values).\nAvailable values:\n  - ADSB\n  - MLAT\n  - UAT\n  - ESTIMATED\n  - <i>Empty parameter will include all sources.</i>\n",
      "example": "ADSB,MLAT,ESTIMATED,UAT",
      "in": "query",
      "name": "data_sources",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flight information region in lower or upper airspace.",
      "example": "ESAA,LFFF",
      "in": "query",
      "name": "airspaces",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Flight ground speed (in knots). Accepts single value or range.",
      "examples": {
        "gspeed": {
          "value": "120-140"
        },
        "gspeed2": {
          "value": "80"
        },
        "gspeed3": {
          "value": "0-40"
        }
      },
      "in": "query",
      "name": "gspeed",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Limit of results. Max value 30000.",
      "example": 100,
      "in": "query",
      "name": "limit",
      "schema": {
        "type": "integer"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "examples": {
            "FlightPositionsFullExample": {
              "value": {
                "data": [
                  {
                    "alt": 38000,
                    "callsign": "AFR1463",
                    "dest_iata": "LHR",
                    "dest_icao": "EGLL",
                    "eta": "2023-11-08T16:12:24Z",
                    "flight": "AF1463",
                    "fr24_id": "321a0cc3",
                    "gspeed": 500,
                    "hex": "394C19",
                    "lat": -0.08806,
                    "lon": -168.07118,
                    "operating_as": "THY",
                    "orig_iata": "ARN",
                    "orig_icao": "ESSA",
                    "painted_as": "THY",
                    "reg": "F-GTAZ",
                    "source": "ADSB",
                    "squawk": 6135,
                    "timestamp": "2023-11-08T10:10:00Z",
                    "track": 219,
                    "type": "A321",
                    "vspeed": 340
                  }
                ]
              }
            }
          },
          "schema": {
            "properties": {
              "data": {
                "items": {
                  "properties": {
                    "alt": {
                      "description": "Barometric pressure altitude above mean sea level (AMSL) reported at a standard atmospheric pressure (1013.25 hPa / 29.92 in. Hg.) expressed in feet.",
                      "type": "integer"
                    },
                    "callsign": {
                      "description": "Callsign used by Air Traffic Control to denote a specific flight (as sent by aircraft transponder).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "dest_iata": {
                      "description": "Destination airport IATA code.",
                      "examples": [
                        "ARN"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "dest_icao": {
                      "description": "Destination airport ICAO code.",
                      "examples": [
                        "ESSA"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "eta": {
                      "description": "Estimated time of arrival (ISO 8601 date format).",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "flight": {
                      "description": "Commercial flight number.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "fr24_id": {
                      "description": "Unique identifier assigned by Flightradar24 to each flight leg.",
                      "type": "string"
                    },
                    "gspeed": {
                      "description": "Speed relative to the ground expressed in knots.",
                      "type": "integer"
                    },
                    "hex": {
                      "description": "24 bit Mode-S identifier expressed in hexadecimal format.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "lat": {
                      "description": "Latest latitude expressed in decimal degrees.",
                      "format": "float",
                      "type": "number"
                    },
                    "lon": {
                      "description": "Latest longitude expressed in decimal degrees.",
                      "format": "float",
                      "type": "number"
                    },
                    "operating_as": {
                      "description": "ICAO code of the airline carrier as derived from flight callsign.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "orig_iata": {
                      "description": "Origin airport IATA code.",
                      "examples": [
                        "ARN"
                      ],
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "orig_icao": {
                      "description": "Origin airport ICAO code.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "painted_as": {
                      "description": "ICAO code of the carrier mapped from FR24's internal database.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "reg": {
                      "description": "Aircraft registration as matched from Mode-S identifier.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "source": {
                      "description": "Data source of the provided flight position.",
                      "type": "string"
                    },
                    "squawk": {
                      "description": "4 digit unique identifying code for ATC expressed in octal format.",
                      "type": "string"
                    },
                    "timestamp": {
                      "description": "Timestamp of the flight position expressed in UTC (ISO 8601 date format).",
                      "format": "date-time",
                      "type": "string"
                    },
                    "track": {
                      "description": "True track (over ground) expressed in integer degrees as 0-360. Please note that 0 can in some cases mean unknown.",
                      "type": "integer"
                    },
                    "type": {
                      "description": "Aircraft ICAO type code.",
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "vspeed": {
                      "description": "The rate at which the aircraft is ascending or descending in feet per minute.",
                      "type": "integer"
                    }
                  },
                  "type": "object"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "Success",
      "headers": {}
    },
    "400": {
      "content": {
        "application/json": {
          "examples": {
            "ValidationErrorExample": {
              "value": {
                "details": "The registration is not a valid aircraft registration code.",
                "message": "Validation error"
              }
            }
          },
          "schema": {
            "properties": {
              "details": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "Validation error"
    },
    "401": {
      "content": {
        "application/json": {
          "examples": {
            "UnauthorizedExample": {
              "value": {
                "details": "Invalid API key. Please provide a valid API key from the FR24 API Key Management page at https://fr24api.flightradar24.com/key-management.",
                "message": "Unauthenticated."
              }
            }
          },
          "schema": {
            "properties": {
              "details": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "Unauthorized"
    },
    "402": {
      "content": {
        "application/json": {
          "examples": {
            "PaymentRequiredExample": {
              "value": {
                "details": "Credit limit reached. Please top up your account.",
                "message": "Forbidden"
              }
            }
          },
          "schema": {
            "properties": {
              "details": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "Payment Required"
    }
  }
}