NOTAM and Briefing endpoints

The following document is endpoint details guide about real-time get-notam and get-briefing endpoints.

Note: The following endpoints allow to retrive data only for real-time NOTAMs.

Limits:

The endpoints ratelimit is 20 calls / minute.

Fetch NOTAMs with AI interpretation

get

Fetches NOTAMs for the given locations and date or datetime range. Works for the current and future (already issued) NOTAMs.

Query parameters

locationsstring[]Required

Comma-separated list of ICAO codes. Up to 5 ICAO codes. Example: EPWA,EDDM,EPPO

start_datestring · dateOptional

Start date (YYYY-MM-DD) [UTC] or Start datetime (YYYY-MM-DDTHH:MM:SS) [UTC]

end_datestring · dateOptional

End date (YYYY-MM-DD) [UTC] or End datetime (YYYY-MM-DDTHH:MM:SS) [UTC]

dry_runbooleanOptional

Flag to perform a dry run without fetching NOTAMs

Default: false

always_include_estbooleanOptional

Flag to always include estimated NOTAMs into the briefing

Default: true

Header parameters

X-API-KeystringRequired

Signed API key for authentication

Responses

200

Successful response

application/json

400

Invalid request parameters

401

Unauthorized - Missing or invalid API key. Check if the key is signed.

404

NOTAMs not found

429

Too many requests

get

Python

import requests

url = 'https://api.notamify.com/api/get-notams'
headers = {
    'X-API-Key': 'YOUR_API_KEY'
}
params = {
    'locations': 'ICAO1,ICAO2',
    'start_date': '2023-01-01',
    'end_date': '2023-01-02',
    'dry_run': 'false'
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    notams = response.json()
    print(notams)
else:
    print(f'Error: {response.status_code} - {response.text}')

[
  {
    "EST": false,
    "PERM": false,
    "ai_ac_type": "",
    "ai_category": "Airport maintenance",
    "ai_interpretation": "Taxiway N6 is closed daily from 2030 to 0500.",
    "ai_interpretation_role": "Pilot",
    "ai_main_category": "AERODROME",
    "ai_short_interpretation": "Taxiway N6 closed.",
    "ai_timing": "Daily from 2030 to 0500.",
    "all": "A5496/24 NOTAMN\nQ) EDGG/QMXLC/IV/BO /A /000/999/5002N00834E005\nA) EDDF B) 2410212030 C) 2410260500\nD) DAILY 2030-0500\nE) TWY N6 CLSD.",
    "enddate": "2024-10-26T05:00:00",
    "has_active_range": true,
    "icao": "EDDF",
    "key": "EDDF_A5496/24",
    "location": "EDDF",
    "message": "TWY N6 CLSD.",
    "notam_id": "7OA91QL5FIbRACJ61QxPhl",
    "processed_at": "2024-10-23T17:46:46.219691",
    "raw_id": "A5496/24",
    "startdate": "2024-10-21T20:30:00",
    "timing_info": "DAILY 2030-0500"
  }
]

Generate a briefing

get

Generates a briefing for the given locations, date range, and role. Works for the current and future (already issued) NOTAMs.

Query parameters

locationsstring[]Required

Comma-separated list of ICAO codes. Up to 5 ICAO codes. Example: EPWA,EDDM,EPPO

start_datestring · dateOptional

Start date (YYYY-MM-DD) [UTC] or Start datetime (YYYY-MM-DDTHH:MM:SS) [UTC]

end_datestring · dateOptional

End date (YYYY-MM-DD) [UTC] or End datetime (YYYY-MM-DDTHH:MM:SS) [UTC]

rolestring · enumOptional

Role for which the briefing is generated.

Default: flight dispatcherPossible values:

dry_runbooleanOptional

Flag to perform a dry run without generating the briefing

Default: false

always_include_estbooleanOptional

Flag to always include estimated NOTAMs into the briefing

Default: true

detailed_briefingbooleanOptional

Flag to generated detailed briefing. The flag set to 'false' generate shorter briefings

Default: true

streambooleanOptional

Flag to return streaming response.

Default: false

markdownbooleanOptional

Flag to return briefing in markdown. If false, then returns plain text.

Default: true

Header parameters

X-API-KeystringRequired

Signed API key for authentication

Responses

200

Successful response

application/json

400

Invalid request parameters

401

Unauthorized - Missing or invalid API key. Check if the key is signed.

404

NOTAMs not found

429

Too many requests

get

Python

import requests

url = 'https://api.notamify.com/api/get-briefing'
headers = {
    'X-API-Key': 'YOUR_API_KEY'
}
params = {
    'locations': 'ICAO1,ICAO2',
    'start_date': '2023-01-01',
    'end_date': '2023-01-02',
    'role': 'flight dispatcher',
    'dry_run': 'false',
    'always_include_est': 'true',
    'detailed_briefing': 'true'
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    briefing = response.json()
    print(briefing)
else:
    print(f'Error: {response.status_code} - {response.text}')

{
  "notam_ids": {
    "EDDF": [
      "U0038/11",
      "A3170/22"
    ],
    "EPWA": [
      "A3059/24",
      "A3189/24"
    ]
  },
  "summary": "Briefing summary for the given locations and date range."
}