### API Request Examples
Source: https://developer.cirium.com/apis/cirium-sky-api/authentication
Examples of how to perform a GET request to the flight status endpoint using various tools and languages.
```bash
curl -X GET https://api.sky.cirium.com/v1/flights/status/airline/WQ/flight-number/123/departure-date/2026-08-23 \ -H "Accept: application/json" \ -H "Authorization: {{your_api_token}}"
```
```python
import requests headers = { "Authorization": "{{your_api_token}}", "Accept": "application/json" } response = requests.get("https://api.sky.cirium.com/v1/flights/status/airline/WQ/flight-number/123/departure-date/2026-08-23", headers=headers) print(response.json())
```
```javascript
const axios = require('axios'); const apiToken = '{{your_api_token}}'; axios.get('https://api.sky.cirium.com/v1/flights/status/airline/WQ/flight-number/123/departure-date/2026-08-23', { headers: { Authorization: apiToken, Accept: 'application/json' } }).then(response => { console.log(response.data); });
```
--------------------------------
### Requesting JSON Response with Format Parameter
Source: https://developer.cirium.com/apis/laminar-data-hub/get-started
This example demonstrates how to request a JSON response by including the 'format=json' query parameter in the GET request.
```HTTP
curl -X GET https://api.laminardata.aero/v1/aerodromes/EGLL/arrivals?user_key=USER_KEY&format=json
```
--------------------------------
### Constructing a REST API Request
Source: https://developer.cirium.com/apis/laminar-data-hub/get-started
This example shows the structure of a complete REST GET request, including the base URI, version, API path, user key, and optional query parameters.
```HTTP
https://api.laminardata.aero/v1/airlines/AAL/flights?user_key=YOUR_USER_KEY&status=AIRBORNE
```
--------------------------------
### Example Request/Response Structure
Source: https://developer.cirium.com/apis/cirium-sky-api/flight-alerts
An example of the JSON structure for requests and responses, illustrating the data fields.
```APIDOC
## Example Request/Response Structure
### Request Body Example
```json
{
"request": {
"airlineCode": {
"requested": "string",
"interpreted": "string",
"airport": {
"fs": "PDX",
"iata": "PDX",
"icao": "KPDX",
"faa": "PDX",
"name": "Portland International Airport",
"street1": "7000 NE Airport Way",
"street2": "string",
"city": "Portland",
"cityCode": "PDX",
"stateCode": "OR",
"postalCode": "97218",
"countryCode": "US",
"district": "string",
"countryName": "United States",
"regionName": "North America",
"timeZoneRegionName": "America/Los_Angeles",
"weatherZone": "ORZ006",
"localTime": "2020-01-01T00:00:00.000",
"utcOffsetHours": -8,
"latitude": 45.588995,
"longitude": -122.592901,
"elevationFeet": 30,
"classification": 1,
"active": true,
"dateFrom": "string",
"dateTo": "string",
"weatherUrl": "https://api.flightstats.com/flex/weather/rest/v1/json/all/PDX?codeType=fs",
"delayIndexUrl": "https://api.flightstats.com/flex/delayindex/rest/v1/json/airports/PDX?codeType=fs"
},
"airline": {
"fs": "AS",
"iata": "AS",
"icao": "ASA",
"name": "Alaska Airlines",
"phoneNumber": "1-800-433-7300",
"active": true,
"dateFrom": "string",
"dateTo": "string",
"category": "string"
},
"equipment": {
"iata": "72W",
"name": "Boeing 727-200 (winglets) Passenger",
"turboProp": false,
"jet": true,
"widebody": false,
"regional": false
},
"legacyCode": true,
"fsCode": "string",
"requestedCode": "string"
},
"airlineCodes": {
"requested": "string",
"interpreted": [
"string"
],
"airport": {
"fs": "PDX",
"iata": "PDX",
"icao": "KPDX",
"faa": "PDX",
"name": "Portland International Airport",
"street1": "7000 NE Airport Way",
"street2": "string",
"city": "Portland",
"cityCode": "PDX",
"stateCode": "OR",
"postalCode": "97218",
"countryCode": "US",
"district": "string",
"countryName": "United States",
"regionName": "North America",
"timeZoneRegionName": "America/Los_Angeles",
"weatherZone": "ORZ006",
"localTime": "2020-01-01T00:00:00.000",
"utcOffsetHours": -8,
"latitude": 45.588995,
"longitude": -122.592901,
"elevationFeet": 30,
"classification": 1,
"active": true,
"dateFrom": "string",
"dateTo": "string",
"weatherUrl": "https://api.flightstats.com/flex/weather/rest/v1/json/all/PDX?codeType=fs",
"delayIndexUrl": "https://api.flightstats.com/flex/delayindex/rest/v1/json/airports/PDX?codeType=fs"
},
"airline": {
"fs": "AS",
"iata": "AS",
"icao": "ASA",
"name": "Alaska Airlines",
"phoneNumber": "1-800-433-7300",
"active": true,
"dateFrom": "string",
"dateTo": "string",
"category": "string"
},
"equipment": {
"iata": "72W",
"name": "Boeing 727-200 (winglets) Passenger",
"turboProp": false,
"jet": true,
"widebody": false,
"regional": false
},
"legacyCode": true,
"fsCode": "string",
"requestedCode": "string"
},
"flightNumber": {
"requested": "string",
"interpreted": "string",
"airport": {
"fs": "PDX",
"iata": "PDX",
"icao": "KPDX",
"faa": "PDX",
"name": "Portland International Airport",
"street1": "7000 NE Airport Way",
"street2": "string",
"city": "Portland",
"cityCode": "PDX",
"stateCode": "OR",
"postalCode": "97218",
"countryCode": "US",
"district": "string",
"countryName": "United States",
"regionName": "North America",
"timeZoneRegionName": "America/Los_Angeles",
"weatherZone": "ORZ006",
"localTime": "2020-01-01T00:00:00.000",
"utcOffsetHours": -8,
"latitude": 45.588995,
"longitude": -122.592901,
"elevationFeet": 30,
"classification": 1,
"active": true,
"dateFrom": "string",
"dateTo": "string",
"weatherUrl": "https://api.flightstats.com/flex/weather/rest/v1/json/all/PDX?codeType=fs"
}
}
}
}
```
```
--------------------------------
### GET /equipment
Source: https://developer.cirium.com/apis/cirium-sky-api/equipment
Returns a list of all equipment reference data.
```APIDOC
## GET /equipment
### Description
Returns all equipment reference data.
### Method
GET
### Endpoint
https://api.sky.cirium.com/v1/equipment
### Parameters
#### Query Parameters
- **extendedOptions** (Array of strings) - Optional - List of flags used to modify default API behavior, such as languageCode.
#### Header Parameters
- **Accept** (string) - Required - Defines the response format (application/json or application/xml).
### Response
#### Success Response (200)
- A list of all equipment.
#### Error Responses
- **400**: The request is invalid.
- **401**: Authorization header is missing, malformed, or token is deactivated.
- **403**: Request cannot be fulfilled (unauthorized or quota_exceeded).
- **404**: The requested endpoint does not exist.
- **406**: The Accept header is missing or not supported.
- **5XX**: Internal server error.
```
--------------------------------
### API Versioning Path Example
Source: https://developer.cirium.com/apis/laminar-data-hub/get-started
Demonstrates the structure for versioned API endpoints.
```http
https://api.laminardata.aero/v2/icao-prefixes/{icao.prefix}/firs/{fir.icao}/airspaces
```
--------------------------------
### GET /flight/status/{airline}/{flightNumber}/dep/{year}/{month}/{day}
Source: https://developer.cirium.com/apis/flightstats-apis/get-started
Example of a flight status request demonstrating request summarization and extended options.
```APIDOC
## GET /flight/status/{airline}/{flightNumber}/dep/{year}/{month}/{day}
### Description
Retrieves flight status information. Includes a request summary element for debugging and supports inlining references via extended options.
### Method
GET
### Endpoint
https://api.flightstats.com/flex/flightstatus/rest/v2/json/flight/status/{airline}/{flightNumber}/dep/{year}/{month}/{day}
### Parameters
#### Path Parameters
- **airline** (string) - Required - Airline code
- **flightNumber** (string) - Required - Flight number
- **year** (integer) - Required - Departure year
- **month** (integer) - Required - Departure month
- **day** (integer) - Required - Departure day
#### Query Parameters
- **appId** (string) - Required - Application ID
- **appKey** (string) - Required - Application Key
- **extendedOptions** (string) - Optional - Use 'useInlinedReferences' to inline airline and airport objects.
```
--------------------------------
### Request API Data with cURL
Source: https://developer.cirium.com/apis/cirium-sky-api/build-and-connect
Examples of making GET requests to the schedules endpoint using different Accept headers for JSON and XML responses.
```bash
curl -X GET "https://api.cirium.com/v1/schedules/airline/BA/flight-number/1234/departure-date/2027-10-08/" \ -H "Accept: application/json" \ -H "Authorization: {your_api_token}"
```
```bash
curl -X GET "https://api.cirium.com/v1/schedules/airline/BA/flight-number/1234/departure-date/2027-10-08/" \ -H "Accept: application/xml" \ -H "Authorization: {your_api_token}"
```
--------------------------------
### Sample Authenticated Request
Source: https://developer.cirium.com/apis/cirium-sky-api/authentication
A concrete example of a cURL request using a valid token format.
```bash
curl -X GET https://api.sky.cirium.com/v1/flights/status/airline/WQ/flight-number/123/departure-date/2026-08-23 \ -H "Accept: application/json" \ -H "Authorization: xbMa1aws7TjxyBXldMgYrhN8STKMi8Twmu10K1vydplMSccT"
```
--------------------------------
### Filter NOTAMs by Q-Code
Source: https://developer.cirium.com/postman/cirium-sky-api.postman_collection.json
Use this endpoint to retrieve NOTAMs that match a specific Q-Code. The Q-Code must start with 'Q', contain exactly five characters, and is required if 'text_contains' is empty. Example: `QOBCE`.
```json
{
"description": "Filters results by NOTAM Q-Code (selection code). \nUsed to return only NOTAMs with the specified Q-Code, such as `QOBCE` for obstacle-related notices. \nQ-Code rules: \n- Must start with `Q` \n- Must contain exactly five characters \n- Must be provided if `text_contains` is empty \nExample: `QOBCE`"
}
```
--------------------------------
### Create a Rule with Additional Name/Value Pairs
Source: https://developer.cirium.com/showcase/notification-of-equipment-changes
When creating a rule, you can include additional query parameters starting with an underscore. These are treated as name/value pairs and will be included in the alert response. For example, &_foo=bar adds a name/value pair where the name is 'foo' and the value is 'bar'.
```http
POST /rules?_foo=bar HTTP/1.1
Host: api.cirium.com
...
```
--------------------------------
### Configure Extended Options
Source: https://developer.cirium.com/apis/flightstats-apis/get-started
Examples of valid extendedOptions parameter strings for customizing API responses.
```text
extendedOptions=useHTTPErrors
extendedOptions=usehTTpeRRors // (not case sensitive)
extendedOptions=usehttperrors+useInlinedReferences
```
--------------------------------
### Example HTML Error Response
Source: https://developer.cirium.com/apis/laminar-data-hub/get-started
An example of the HTML body returned during an API error.
```html
Authentication FailedError 403 - Authentication Failed
The following APIs are restricted to customers who have passed an approval process: Route Segments, Aerodromes, Airspaces, Designated Points, Navaids & Flight Detail By GUFI. Please check your API request & API Key on our developer portal. To request access, please fill out the form here.
Snowflake Software
```
--------------------------------
### POST /flex/alerts/rest/v1/{format}/create/multiflight/airport/to/{arrivalAirport}
Source: https://developer.cirium.com/apis/flightstats-apis/flight-alerts
Creates a multi-flight rule to monitor flights arriving at a specific airport.
```APIDOC
## POST /flex/alerts/rest/v1/{format}/create/multiflight/airport/to/{arrivalAirport}
### Description
Creates a Multi-flight rule that monitors for flights arriving at an airport and optionally flights that are operated by a set of carriers.
### Method
POST
### Endpoint
/flex/alerts/rest/v1/{format}/create/multiflight/airport/to/{arrivalAirport}
### Parameters
#### Path Parameters
- **format** (string) - Required - The data format returned in the response (json, jsonp, xml)
- **arrivalAirport** (string) - Required - The arrival airport code to monitor for flights
#### Query Parameters
- **carriers** (string) - Optional - Comma separated list of airline codes to constrain monitoring.
- **name** (string) - Optional - The name of the rule to be created (max 64 chars).
- **desc** (string) - Optional - A description of the rule to be created (max 256 chars).
- **type** (string) - Required - The format of the alert data to be posted (JSON or XML).
- **deliverTo** (string) - Required - The URL of an HTTP/HTTPS service that accepts POST data.
- **events** (string) - Required - A comma separated list of events that should be emitted for the flight.
- **codeType** (string) - Optional - Airport code type (IATA, ICAO, FS).
- **includeCodeshares** (boolean) - Optional - Whether the carriers filter should also apply to codeshares.
- **extendedOptions** (Array of strings) - Optional - Extended options for modifying standard API behavior.
### Response
#### Success Response (200)
- **Details** (object) - Details about the newly created rule.
#### Error Responses
- **400** - Client request error.
- **403** - Authorization failure.
- **404** - Requested item could not be found.
- **5XX** - API application error.
```
--------------------------------
### Content Negotiation and Headers
Source: https://developer.cirium.com/apis/laminar-data-hub/get-started
How to specify response formats and compression using HTTP headers.
```APIDOC
## GET /v1/aerodromes/{icao}/arrivals
### Description
Demonstrates how to use the Accept header to request specific response formats like JSON or XML, and how to request compressed data.
### Method
GET
### Endpoint
https://api.laminardata.aero/v1/aerodromes/{icao}/arrivals
### Parameters
#### Path Parameters
- **icao** (string) - Required - The ICAO code of the aerodrome.
#### Query Parameters
- **user_key** (string) - Required - The access key assigned to your account.
### Request Example
curl -X GET --header "Accept: application/json" "https://api.laminardata.aero/v1/aerodromes/EGLL/arrivals?user_key=USER_KEY"
```
--------------------------------
### Delete Alert Response Example
Source: https://developer.cirium.com/apis/flightstats-apis/flight-alerts
Example JSON response returned after successfully deleting a flight rule.
```json
{
* "request": {
* "ruleId": {
* "requested": "125524637",
* "interpreted": "125524637"
},
* "extendedOptions": {
* "requested": ""
},
* "url": "https://api.flightstats.com/flex/alerts/rest/v1/json/delete/125524637"
},
* "rule": {
* "id": "125524637",
* "name": "Example alert name",
* "description": "Example alert description",
* "carrierFsCode": "AA",
* "flightNumber": "100",
* "departureAirportFsCode": "JFK",
* "arrivalAirportFsCode": "LHR",
* "departure": "2013-02-26T18:15:00.000",
* "arrival": "2013-02-27T06:20:00.000",
* "ruleEvents": [
* {
* "type": "ALL_CHANGES"
}
],
* "nameValues": [ ],
* "delivery": {
* "format": "json",
* "destination": "https://example.com/your_post_url"
}
},
* "appendix": {
* "airlines": [
* {
* "fs": "AA",
* "iata": "AA",
* "icao": "AAL",
* "name": "American Airlines",
* "phoneNumber": "1-800-433-7300",
* "active": true
}
],
* "airports": [
* {
* "fs": "JFK",
* "iata": "JFK",
* "icao": "KJFK",
* "faa": "JFK",
* "name": "John F. Kennedy International Airport",
* "street1": "JFK Airport",
* "city": "New York",
* "cityCode": "NYC",
* "stateCode": "NY",
* "postalCode": "11430",
* "countryCode": "US",
* "countryName": "United States",
* "regionName": "North America",
* "timeZoneRegionName": "America/New_York",
* "weatherZone": "NYZ178",
* "localTime": "2013-02-26T19:42:52.570",
* "utcOffsetHours": -5,
* "latitude": 40.642335,
* "longitude": -73.78817,
* "elevationFeet": 13,
* "classification": 1,
* "active": true
},
* {
* "fs": "LHR",
* "iata": "LHR",
* "icao": "EGLL",
* "name": "London Heathrow Airport",
* "city": "London",
* "cityCode": "LON",
* "stateCode": "EN",
* "countryCode": "GB",
* "countryName": "United Kingdom",
* "regionName": "Europe",
* "timeZoneRegionName": "Europe/London",
* "localTime": "2013-02-27T00:42:52.570",
* "utcOffsetHours": 0,
* "latitude": 51.469603,
* "longitude": -0.453566,
* "elevationFeet": 80,
* "classification": 1,
* "active": true
}
]
}
}
```
--------------------------------
### GET /connections/departure-airport/{departureAirport}/arrival-airport/{arrivalAirport}/arriving-before/{arrivingBeforeTime}
Source: https://developer.cirium.com/apis/cirium-sky-api/connections
Finds connections arriving as late as possible before the given time.
```APIDOC
## GET /connections/departure-airport/{departureAirport}/arrival-airport/{arrivalAirport}/arriving-before/{arrivingBeforeTime}
### Description
Finds connections arriving as late as possible before the given time.
### Method
GET
### Endpoint
/connections/departure-airport/{departureAirport}/arrival-airport/{arrivalAirport}/arriving-before/{arrivingBeforeTime}
### Parameters
#### Path Parameters
- **departureAirport** (string) - Required - Code of the departure airport (IATA, ICAO, or FS).
- **arrivalAirport** (string) - Required - Code of the arrival airport (IATA, ICAO, or FS).
- **arrivingBeforeTime** (string) - Required - Timestamp (YYYY-MM-DDTHH:mm:ss) used to find connections arriving before the specified time.
```
--------------------------------
### GET /flex/equipment/rest/v1/{format}/iata/{code}
Source: https://developer.cirium.com/apis/flightstats-apis/equipment
Retrieves equipment details for a specific IATA code. This endpoint is useful for getting information about a particular aircraft type.
```APIDOC
## GET /flex/equipment/rest/v1/{format}/iata/{code}
### Description
Returns the equipment for the given IATA code. This endpoint is useful for getting information about a particular aircraft type.
### Method
GET
### Endpoint
https://api.flightstats.com/flex/equipment/rest/v1/{format}/iata/{code}
### Parameters
#### Path Parameters
- **format** (string) - Required - The data format returned in the response. Enum: "json", "jsonp", "xml". Example: json
- **code** (string) - Required - Equipment IATA code. Example: CRV
#### Query Parameters
- **extendedOptions** (Array of strings) - Optional - Extended options for modifying standard API behavior. Items Enum: "useHttpErrors", "languageCode:en", "languageCode:ar", "languageCode:de", "languageCode:es", "languageCode:fr", "languageCode:ja", "languageCode:ko", "languageCode:pt", "languageCode:zh".
### Responses
#### Success Response (200)
A single equipment item by IATA code.
#### Error Response (400)
Client request error. Consult error response for specifics.
#### Error Response (403)
Authorization failure. Invalid 'appId', 'appKey', or rate limit violation.
#### Error Response (404)
Requested item could not be found, or the endpoint does not exist.
#### Error Response (5XX)
API application error. If error is consistent, please contact Cirium Support.
### Response Example
(No sample provided in the source text)
```
--------------------------------
### GET /v1/flights/track/departure-airport/:departureAirport/departure-date/:departureDate
Source: https://developer.cirium.com/postman/cirium-sky-api.postman_collection.json
Retrieves flight track data for a specific departure airport and date. This endpoint allows you to get information about flights departing from a particular airport on a given date.
```APIDOC
## GET /v1/flights/track/departure-airport/:departureAirport/departure-date/:departureDate
### Description
Retrieves flight track data for a specific departure airport and date. This endpoint allows you to get information about flights departing from a particular airport on a given date.
### Method
GET
### Endpoint
/v1/flights/track/departure-airport/:departureAirport/departure-date/:departureDate
### Parameters
#### Path Parameters
- **departureAirport** (string) - Required - Code of the departure airport. Accepted formats: IATA (3-letter), ICAO (4-letter), FS (3-4 alphanumeric characters, Cirium unique airport code).
- **departureDate** (string) - Required - The date for which to retrieve flight track data. Format: YYYY-MM-DD.
#### Query Parameters
- **airportCodeType** (string) - Optional - Defines what type of airport code is being used in the request. Options: IATA, ICAO, FS. If not set, the API will try all formats in this order: IATA, ICAO, then FS.
- **maxFlights** (integer) - Optional - Limits the number of unique flights to return track data for. If omitted, tracks for all available flights are returned. Accepted values start from 1.
- **extendedOptions** (string) - Optional - Optional list of flags used to modify default API behavior. Supported values: includeNewFields, useInlinedReferences, languageCode:{code}. You can pass multiple options using commas or plus signs. Example: ?extendedOptions=includeDeltas,languageCode:fr
### Request Example
```json
{
"example": "GET /v1/flights/track/departure-airport/SOU/departure-date/2023-10-26?airportCodeType=IATA&maxFlights=5&extendedOptions=includeNewFields,languageCode:es"
}
```
### Response
#### Success Response (200)
- **data** (array) - Contains flight track data.
- **links** (object) - Contains links for pagination and related resources.
#### Response Example
```json
{
"example": "{\"data\": [...], \"links\": {...}}"
}
```
```
--------------------------------
### GET /flex/equipment/rest/v1/{format}/all
Source: https://developer.cirium.com/apis/flightstats-apis/equipment
Retrieves all equipment reference data. This endpoint provides a comprehensive list of all known equipment types.
```APIDOC
## GET /flex/equipment/rest/v1/{format}/all
### Description
Returns all equipment reference data. This endpoint provides a comprehensive list of all known equipment types.
### Method
GET
### Endpoint
https://api.flightstats.com/flex/equipment/rest/v1/{format}/all
### Parameters
#### Path Parameters
- **format** (string) - Required - The data format returned in the response. Enum: "json", "jsonp", "xml". Example: json
#### Query Parameters
- **extendedOptions** (Array of strings) - Optional - Extended options for modifying standard API behavior. Items Enum: "useHttpErrors", "languageCode:en", "languageCode:ar", "languageCode:de", "languageCode:es", "languageCode:fr", "languageCode:ja", "languageCode:ko", "languageCode:pt", "languageCode:zh".
### Responses
#### Success Response (200)
A list of all equipment.
#### Error Response (400)
Client request error. Consult error response for specifics.
#### Error Response (403)
Authorization failure. Invalid 'appId', 'appKey', or rate limit violation.
#### Error Response (404)
Requested item could not be found, or the endpoint does not exist.
#### Error Response (5XX)
API application error. If error is consistent, please contact Cirium Support.
### Response Example
(No sample provided in the source text)
```
--------------------------------
### Example cURL Request - Invalid Token (401)
Source: https://developer.cirium.com/apis/cirium-sky-api/error-handling
Demonstrates how to simulate an invalid token error using cURL. This requires omitting or providing an incorrect Authorization header.
```bash
# 401 - Invalid token curl -H "Authorization: invalid_token" https://api.sky.cirium.com/v1/flights/status/airline/WQ/flight-number/123/departure-date/2026-08-23
```
--------------------------------
### GET /v1/equipment
Source: https://developer.cirium.com/postman/cirium-sky-api.postman_collection.json
Retrieves a list of all aircraft equipment.
```APIDOC
## GET /v1/equipment
### Description
Retrieves a list of all aircraft equipment.
### Method
GET
### Endpoint
https://api.sky.cirium.com/v1/equipment
### Parameters
#### Query Parameters
- **extendedOptions** (string) - Optional - List of flags used to modify default API behavior, such as languageCode:{code} for localization.
### Request Example
GET https://api.sky.cirium.com/v1/equipment
```
--------------------------------
### GET /v1/airlines/
Source: https://developer.cirium.com/postman/cirium-sky-api.postman_collection.json
Retrieves a list of active airlines.
```APIDOC
## GET /v1/airlines/
### Description
Retrieves a list of airlines, filtered by active status.
### Method
GET
### Endpoint
https://api.sky.cirium.com/v1/airlines/
### Parameters
#### Query Parameters
- **onlyActive** (boolean) - Optional - Filter to return only active airlines.
```
--------------------------------
### Retrieve NOTAMs with Filters using cURL
Source: https://developer.cirium.com/showcase/displaying-NOTAMs-and-restrictions
This example shows how to apply filters like 'qcode' or 'text_contains' when requesting NOTAM data. Replace {value} with your user key.
```bash
curl "https://api.laminardata.aero/v2/icao-prefixes/K/firs/KZDC/notams?user_key={value}&qcode=A0000/23&text_contains=closed"
```
--------------------------------
### GET /v1/alerts/
Source: https://developer.cirium.com/postman/cirium-sky-api.postman_collection.json
Retrieves a list of alert rule IDs.
```APIDOC
## GET /v1/alerts/
### Description
Retrieves a list of alert rule IDs associated with the account.
### Method
GET
### Endpoint
https://api.sky.cirium.com/v1/alerts/
### Parameters
#### Headers
- **Authorization** (string) - Required - 48-character API access token.
- **Accept** (string) - Required - Response format (application/json or application/xml).
```
--------------------------------
### Arrival Delay Monitoring Window
Source: https://developer.cirium.com/apis/cirium-sky-api/flight-alerts
Configure the time window for monitoring arrival delays.
```APIDOC
## POST /api/alerts/flights
### Description
Configures an alert for arrival delays within a specified monitoring window.
### Method
POST
### Endpoint
/api/alerts/flights
### Parameters
#### Query Parameters
- **arrDelayWindow#** (integer) - Required - The number of minutes in advance of the scheduled arrival time during which arrival delays should be monitored. If omitted, then delays are monitored for the entire period while the flight is active. Allowable value range: 0 to 1440.
- **arrDelayAllowRunway** (boolean) - Optional - Allow delay computations to take into consideration runway arrival times.
- **arrDelayRunwayOnly** (boolean) - Optional - Generates delay alerts using only runway arrival times.
- **depGate[#]** (integer) - Optional - Alert on changes to the departure gate that occur within the specified number of minutes of departure. If the optional number of minutes is omitted, then changes to the departure gate are monitored at all times while the flight is active. Allowable value range: 0 to 1440.
- **arrGate[#]** (integer) - Optional - Alert on changes to the arrival gate that occur within the specified number of minutes of arrival. If the optional number of minutes is omitted, then changes to the arrival gate are monitored at all times while the flight is active. Allowable value range: 0 to 1440.
- **bag[#]** (integer) - Optional - Alert on changes to the baggage pickup location that occur within the specified number of minutes of arrival. If the optional number of minutes is omitted, then changes to the baggage pickup location are monitored at all times while the flight is active. Allowable value range: 0 to 1440.
- **tailNumber** (string) - Optional - Alert on changes to the tail number.
- **&_foo** (string) - Optional - Custom name/value pair for alert details. The name should start with an underscore.
### Request Example
```json
{
"example": "POST /api/alerts/flights?arrDelayWindow=120&_myCustomField=someValue"
}
```
### Response
#### Success Response (200)
- **alertId** (string) - The unique identifier for the created alert.
#### Response Example
```json
{
"example": "{\"alertId\": \"alert_12345\"}"
}
```
```