# Quick start #### 1. Prerequisites * **Notamify Pro Subscription**: API access is included in the Notamify Pro plan. Click [here](https://notamify.com/activate-pro) to start your 7 days free, and 50 API credits. * **API Credits**: Ensure you have a sufficient API credit package (e.g., Intro, Growth, Scale, or Enterprise). * **Tools**: Any HTTP client or integration library (e.g., `curl`, Postman, or the [Notamify Python SDK](https://github.com/skymerse/notamify-sdk-python)). #### 2. Getting Your API Key 1. **Sign up or Log in** to your Notamify account. 2. Navigate to [**API Manager**](https://notamify.com/api-manager). 3. **Generate** a new API key or **retrieve** your existing key. > **Pro Tip:** Store your API key securely and never expose it in public repositories or client-side code. #### 3. Making Your First Request Below is a minimal `curl` example to fetch NOTAM data from one or more airports using the `/api/v2/notams` endpoint. ```bash curl --request GET \ --url "https://api.notamify.com/api/v2/notams?locations=EPWA" \ --header "Bearer YOUR_API_KEY" ``` #### Using the Python SDK Install the SDK: ```bash pip install notamify-sdk ``` Then fetch active NOTAMs in a few lines: ```python from notamify_sdk import NotamifyClient, ActiveNotamsQuery client = NotamifyClient(token="YOUR_API_KEY") result = client.get_active_notams(ActiveNotamsQuery(location=["EPWA"])) for notam in result.notams: print(f"{notam.notam_number}: {notam.interpretation.excerpt}") ``` For auto-pagination across multiple pages, use the pager: ```python pager = client.notams.active(ActiveNotamsQuery(location=["EPWA"])) for notam in pager: print(f"{notam.notam_number}: {notam.interpretation.excerpt}") ``` > **Tip:** The SDK supports config files and environment variables. Set `NOTAMIFY_TOKEN` to avoid passing the token directly. See the [Authentication guide](https://skymerse.gitbook.io/notamify-api/basics/authentication-guide) for details. **Parameters** * **location**: Pass one or more ICAO codes (up to five). Example: `?location=KJFK` * **date\_range** (optional): Filter NOTAMs by start and end date. Example: `?starts_at=2025-01-15T00:00:00&ends_at=2025-01-20T23:59:00` #### 4. Understanding the Response A successful response returns a JSON object with key elements: {% code expandable="true" %} ```json { "notams": [ { "ends_at": "2025-03-21T15:30:00Z", "icao_code": "LIMA", "icao_message": "C0184/25 NOTAMN\nQ) LIMM/QFAXX/IV/NBO/A /000/999/4505N00736E005\nA) LIMA B) 2503181200 C) 2503211530\nD) 18 1200-1530, 19-21 0800-1100 1200-1530\nE) TESTO ITALIANO:\nTUTTO IL TRAFFICO E' SOGGETTO A RITARDI A CAUSAALL' ATTIVITA' DI\nLANCI PARACADUTISTICI MILITARI ANNUNCIATA DAL NOTAM W0738/25.\nTRAFFICO SERVIZIO MEDICO DI EMERGENZA CON ELICOTTERI (HEMS)\nNON INTERESSATO.\nRMK: TRAFFICO CONSENTITO PREVIO COORDINAMENTO CON LOCALE SERVIZIO\nAERONAUTICAL FLIGHT INFO UNIT (AFIU) LOCALE.\nENGLISH TEXT:\nALL TRAFFIC SUBJ DLA DUE TO MIL PJE ANNOUNCED BY NOTAM W0738/25.\nHELICOPTER EMERG MEDICAL SER (HEMS) NOT AFFECTED.\nRMK: TRAFFIC ALLOWED PRIOR COOR WITH LOCAL AERONAUTICAL FLIGHT INFO\nUNIT (AFIU).\nREF AIP AD 2 LIMA 1-1", "id": "263dbe90-b168-412f-aa9a-0555fa9cd736", "interpretation": { "affected_elements": [ { "details": "Announced parachuting operations are causing delays to traffic.", "effect": "RESTRICTED", "identifier": "Notam W0738/25 parachuting area", "type": "AIRSPACE", }, { "details": "All traffic subject to service delays due to parachuting military operations.", "effect": "RESTRICTED", "identifier": "AIR TRAFFIC CONTROL", "type": "SERVICE", }, ], "category": "OTHER", "description": "All traffic is subject to delays due to military parachute drop activities announced in NOTAM W0738/25. Emergency medical service traffic is still operational during scheduled times.", "excerpt": "Traffic delays due to military parachute activities.", "map_elements": [ { "area_number": None, "coordinates": [ { "lat": 52.224722, "lon": 20.991111, "radius_nm": 0.11, "raw_radius": "200M", "raw_string": "521329N 0205928E", } ], "description": "Laser and reflector at position with a range of 200 meters.", "element_type": "circle", "geojson": { "geometry": { "coordinates": [ [ [ 20.991111, 52.2265540978663, ], [ 20.991404155310587, 52.22654527581431, ], [ 20.991694487375277, 52.226518894619524, ], [ 20.991979200137575, 52.226475208347274, ], [ 20.992255551657944, 52.22641463772023, ], [ 20.99252088052017, 52.226337766066656, ], [ 20.99277263146227, 52.22624533370259, ], [ 20.993008379985046, 52.226138230802235, ], [ 20.993225855701354, 52.22601748882506, ], [ 20.99342296420116, 52.22588427058231, ], [ 20.99359780722186, 52.2257398590385, ], [ 20.993748700929586, 52.22558564495572, ], [ 20.993874192135447, 52.22542311349991, ], [ 20.99397307229053, 52.22525382993782, ], [ 20.994044389124884, 52.2250794245627, ], [ 20.994087455818416, 52.22490157699366, ], [ 20.994101857615316, 52.224722, ], [ 20.994087455818416, 52.22454242300634, ], [ 20.994044389124884, 52.2243645754373, ], [ 20.99397307229053, 52.22419017006218, ], [ 20.993874192135447, 52.22402088650009, ], [ 20.993748700929586, 52.22385835504428, ], [ 20.99359780722186, 52.2237041409615, ], [ 20.99342296420116, 52.22355972941769, ], [ 20.993225855701354, 52.22342651117494, ], [ 20.993008379985046, 52.223305769197765, ], [ 20.99277263146227, 52.22319866629741, ], [ 20.99252088052017, 52.22310623393334, ], [ 20.992255551657944, 52.22302936227977, ], [ 20.991979200137575, 52.222968791652725, ], [ 20.991694487375277, 52.222925105380476, ], [ 20.991404155310587, 52.22289872418569, ], [ 20.991111, 52.2228899021337, ], [ 20.990817844689413, 52.22289872418569, ], [ 20.990527512624723, 52.222925105380476, ], [ 20.990242799862425, 52.222968791652725, ], [ 20.989966448342056, 52.22302936227977, ], [ 20.98970111947983, 52.22310623393334, ], [ 20.98944936853773, 52.22319866629741, ], [ 20.989213620014954, 52.223305769197765, ], [ 20.988996144298646, 52.22342651117494, ], [ 20.98879903579884, 52.22355972941769, ], [ 20.98862419277814, 52.2237041409615, ], [ 20.988473299070414, 52.22385835504428, ], [ 20.988347807864553, 52.22402088650009, ], [ 20.98824892770947, 52.22419017006218, ], [ 20.988177610875116, 52.2243645754373, ], [ 20.988134544181584, 52.22454242300634, ], [ 20.988120142384684, 52.224722, ], [ 20.988134544181584, 52.22490157699366, ], [ 20.988177610875116, 52.2250794245627, ], [ 20.98824892770947, 52.22525382993782, ], [ 20.988347807864553, 52.22542311349991, ], [ 20.988473299070414, 52.22558564495572, ], [ 20.98862419277814, 52.2257398590385, ], [ 20.98879903579884, 52.22588427058231, ], [ 20.988996144298646, 52.22601748882506, ], [ 20.989213620014954, 52.226138230802235, ], [ 20.98944936853773, 52.22624533370259, ], [ 20.98970111947983, 52.226337766066656, ], [ 20.989966448342056, 52.22641463772023, ], [ 20.990242799862425, 52.226475208347274, ], [ 20.990527512624723, 52.226518894619524, ], [ 20.990817844689413, 52.22654527581431, ], [ 20.991111, 52.2265540978663, ], ] ], "type": "Polygon", }, "properties": { "element_type": "circle", "radius_nm": 0.11, }, "type": "Feature", }, } ], "schedules": [ { "description": "On March 18 from 12:00 to 15:30.", "is_sunrise_sunset": False, "rrule": "DTSTART:20250318T120000Z\nRRULE:FREQ=DAILY;UNTIL=20250318T153000Z;BYHOUR=12;BYMINUTE=0;BYSECOND=0", "source": "18 1200-1530", }, { "description": "On March 19 to 21 from 08:00 to 11:00 and 12:00 to 15:30.", "is_sunrise_sunset": False, "rrule": "DTSTART:20250319T080000Z\nRRULE:FREQ=DAILY;COUNT=3;BYHOUR=8;BYMINUTE=0;BYSECOND=0", "source": "19-21 0800-1100 1200-1530", }, { "description": "On March 19 to 21 from 12:00 to 15:30.", "is_sunrise_sunset": False, "rrule": "DTSTART:20250319T120000Z\nRRULE:FREQ=DAILY;COUNT=3;BYHOUR=12;BYMINUTE=0;BYSECOND=0", "source": "19-21 0800-1100 1200-1530", }, ], "subcategory": "OTHER", }, "is_estimated": False, "is_permanent": False, "issued_at": "2025-03-17T12:06:00Z", "location": "LIMA", "message": "TESTO ITALIANO:\nTUTTO IL TRAFFICO E' SOGGETTO A RITARDI A CAUSAALL' ATTIVITA' DI\nLANCI PARACADUTISTICI MILITARI ANNUNCIATA DAL NOTAM W0738/25.\nTRAFFICO SERVIZIO MEDICO DI EMERGENZA CON ...", "notam_number": "C0184/25", "qcode": "QFAXX", "starts_at": "2025-03-18T12:00:00Z", }, ], "page": 1, "per_page": 30, "total_count": 45, } ``` {% endcode %} * **icao\_message**: The original NOTAM text. * **interpretation**: Intepretation object of given NOTAM containing: * **categories**: One or more standardized categories (among 42 possible). * **schedules:** Intepreted D) section of the NOTAM, highliting when the notam is applicable. Uses [RRULE](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) and duration\_hrs to indicate recuring times * **affected\_elements**: More in [**https://notamify.com/atomic-elements**](https://notamify.com/atomic-elements) * Full `description` and short interpretation (`excerpt`)