Quick start

Welcome to the Notamify API Quick Start Guide. In this document, you’ll learn how to make your first API call, understand essential parameters, and interpret the responses. By the end, you should have

1. Prerequisites

• Notamify Pro Subscription: API access is included in the Notamify Pro plan. Click here to start your 7 days free, and 20 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 a programming language with REST support).

2. Getting Your API Key

1. Sign up or Log in to your Notamify account.

2. Navigate to 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/get-notams endpoint.

curl --request GET \
  --url "https://api.notamify.com/api/get-notams?locations=EPWA" \
  --header "X-API-Key: YOUR_API_KEY"

Parameters

• icao: Pass one or more ICAO codes (up to five). Example: ?locations=KJFK

• date_range (optional): Filter NOTAMs by start and end date. Example: ?start_date=2025-01-15&end_date=2025-01-20

4. Understanding the Response

A successful response returns a JSON object with key elements:

[
  {
    "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"
  }

• raw_text: The original NOTAM text.

• interpretation: AI-generated summary of the NOTAM.

• categories: One or more standardized categories (among 42 possible).

Note: Interpretations may be truncated if the original text is extremely long, but essential details are preserved.

5. Next Steps

• Explore the Authentication guide to properly secure your API requests.
• Review the Code samples document to start your API integrations.