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/v2/notams?locations=EPWA" \
  --header "Bearer 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:

  • 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 and duration_hrs to indicate recuring times

    • affected_elements: More in https://notamify.com/atomic-elements

    • Full description and short interpretation (excerpt)

Last updated