API Reference

Version: v18 | Updated: February 2026

This document provides a comprehensive reference for PERTI's RESTful API endpoints. These APIs enable integration with external systems and support the web interface.

Overview

Base URL

Production: https://perti.vatcscc.org/api

Authentication

Most endpoints require an active session (VATSIM OAuth). Public endpoints are noted below.

Response Format

All APIs return JSON. Standard response structure:

{
  "success": true,
  "data": { ... },
  "message": "Optional status message"
}

Error responses:

{
  "success": false,
  "error": "Error description",
  "code": 400
}

ADL Flight Data APIs

These endpoints provide access to real-time and historical flight data from the Aggregate Demand List (ADL) system.

GET /api/adl/current.php

Returns current flight snapshot with filtering options.

Access: Authenticated

Parameter	Type	Description
`dest`	string	Filter by destination airport (ICAO)
`orig`	string	Filter by origin airport (ICAO)
`artcc`	string	Filter by ARTCC code
`airline`	string	Filter by airline ICAO code
`limit`	int	Maximum results (default: 1000)

Example:

GET /api/adl/current.php?dest=KJFK&artcc=ZNY

Response:

{
  "success": true,
  "timestamp": "2026-01-10T14:30:00Z",
  "count": 47,
  "flights": [
    {
      "callsign": "DAL123",
      "departure": "KATL",
      "arrival": "KJFK",
      "aircraft": "B739",
      "altitude": 35000,
      "groundspeed": 480,
      "latitude": 39.5234,
      "longitude": -74.1234,
      "phase": "cruise",
      "eta": "2026-01-10T15:45:00Z"
    }
  ]
}

GET /api/adl/flight.php

Returns detailed information for a single flight.

Access: Authenticated

Parameter	Type	Description
`id`	string	Flight ID or callsign (required)

GET /api/adl/stats.php

Returns aggregate flight statistics.

Access: Authenticated

Response includes:

Active flight count by phase
Flights by ARTCC
Airport arrival/departure counts
System health metrics

GET /api/adl/snapshot_history.php

Returns historical flight snapshots.

Access: Authenticated

Parameter	Type	Description
`from`	datetime	Start time (ISO 8601)
`to`	datetime	End time (ISO 8601)
`airport`	string	Filter by airport

Traffic Management Initiative (TMI) APIs

APIs for managing Ground Stops, Ground Delay Programs, and other traffic initiatives.

Ground Stop Operations

POST /api/tmi/gs/create.php

Creates a new Ground Stop in proposed status.

Access: Authenticated (DCC role)

Request Body:

{
  "airport": "KJFK",
  "reason": "Weather",
  "scope": "tier1",
  "end_time": "2026-01-10T18:00:00Z",
  "notes": "Thunderstorms in terminal area"
}

POST /api/tmi/gs/model.php

Models the scope of a Ground Stop to identify affected flights.

Access: Authenticated (DCC role)

Parameter	Type	Description
`gs_id`	int	Ground Stop ID

POST /api/tmi/gs/activate.php

Activates a proposed Ground Stop, issuing EDCTs to affected flights.

Access: Authenticated (DCC role)

Parameter	Type	Description
`gs_id`	int	Ground Stop ID

POST /api/tmi/gs/extend.php

Extends an active Ground Stop end time.

Access: Authenticated (DCC role)

Parameter	Type	Description
`gs_id`	int	Ground Stop ID
`new_end`	datetime	New end time

POST /api/tmi/gs/purge.php

Cancels a Ground Stop, releasing affected flights.

Access: Authenticated (DCC role)

Parameter	Type	Description
`gs_id`	int	Ground Stop ID

GET /api/tmi/gs/flights.php

Returns flights affected by a Ground Stop.

Access: Authenticated

Parameter	Type	Description
`gs_id`	int	Ground Stop ID

GET /api/tmi/gs/list.php

Returns all Ground Stop programs.

Access: Authenticated

Parameter	Type	Description
`status`	string	Filter: proposed, active, expired
`airport`	string	Filter by airport

GDT APIs (Unified TMI)

Ground Delay Tool unified API for managing GS, GDP, and AFP programs. Uses VATSIM_TMI database.

Base Path: /api/gdt/

Program Operations

Endpoint	Method	Description
`/api/gdt/programs/create.php`	POST	Create new GS/GDP/AFP program
`/api/gdt/programs/list.php`	GET	List programs with filtering
`/api/gdt/programs/get.php`	GET	Get single program with slots
`/api/gdt/programs/simulate.php`	POST	Generate slots and run RBS
`/api/gdt/programs/activate.php`	POST	Activate proposed program
`/api/gdt/programs/extend.php`	POST	Extend program end time
`/api/gdt/programs/purge.php`	POST	Cancel/purge program
`/api/gdt/programs/transition.php`	POST	Transition GS to GDP

Flight and Slot Operations

Endpoint	Method	Description
`/api/gdt/flights/list.php`	GET	List flights for a program
`/api/gdt/slots/list.php`	GET	List slots for a program
`/api/gdt/demand/hourly.php`	GET	Get hourly demand/capacity

GS/GDP Compliance Analysis (v18)

GET /api/gdt/programs/flight_list.php

Returns the dynamic flight list for a GS/GDP program with compliance status tracking and summary statistics. Supports filtering by compliance status and pagination.

Access: Authenticated

Parameter	Type	Description
`program_id`	int	Program ID (required)
`status`	string	Filter by compliance status: `PENDING`, `COMPLIANT`, `NON_COMPLIANT`, `EXEMPT`, `CANCELLED`
`include_stats`	bool	Include summary statistics (default: true)
`limit`	int	Max flights to return (default: 500)
`offset`	int	Pagination offset (default: 0)

Response:

{
  "status": "ok",
  "data": {
    "program_id": 123,
    "flights": [
      {
        "callsign": "DAL456",
        "flight_uid": 98765,
        "dep_airport": "KATL",
        "arr_airport": "KJFK",
        "compliance_status": "COMPLIANT",
        "edct_utc": "2026-01-10T15:30:00Z",
        "actual_dep_utc": "2026-01-10T15:28:00Z",
        "delay_minutes": 47
      }
    ],
    "stats": {
      "total": 145,
      "controlled": 120,
      "exempt": 25,
      "pending": 90,
      "compliant": 25,
      "non_compliant": 5,
      "cancelled": 0,
      "avg_delay_min": 47,
      "max_delay_min": 123
    },
    "generated_at": "2026-01-10T15:00:00Z"
  }
}

Compliance Status Values: PENDING (not yet departed), COMPLIANT (departed within EDCT window), NON_COMPLIANT (departed outside EDCT window), EXEMPT (exempt from program), CANCELLED (flight cancelled)

See TMI API for full request/response documentation.

GIS Boundaries API

PostGIS-powered spatial queries for route analysis and boundary detection.

Base Path: /api/gis/

Route Expansion

Endpoint	Method	Description
`boundaries.php?action=expand_route`	GET	Expand route string to waypoints + ARTCCs
`boundaries.php?action=expand_routes`	GET/POST	Batch expand multiple routes
`boundaries.php?action=expand_playbook`	GET	Expand playbook code (PB.PLAY.ORIG.DEST)
`boundaries.php?action=analyze_route`	GET/POST	Full route analysis with sectors
`boundaries.php?action=resolve_waypoint`	GET	Resolve fix/airport to coordinates
`boundaries.php?action=routes_geojson`	GET/POST	Convert routes to GeoJSON FeatureCollection

Boundary Queries (from waypoints)

Endpoint	Method	Description
`boundaries.php?action=at_point`	GET	Point-in-polygon boundary lookup
`boundaries.php?action=route_artccs`	GET	Get ARTCCs traversed by waypoints
`boundaries.php?action=route_tracons`	GET	Get TRACONs traversed by waypoints
`boundaries.php?action=route_full`	GET	Full boundary analysis from waypoints
`boundaries.php?action=analyze_tmi_route`	POST	TMI route analysis for coordination

Airport Queries

Endpoint	Method	Description
`boundaries.php?action=airport_artcc`	GET	Get ARTCC containing an airport
`boundaries.php?action=artcc_airports`	GET	Get airports within an ARTCC

Trajectory Crossings

Endpoint	Method	Description
`boundaries.php?action=trajectory_crossings`	GET	ARTCC boundary crossings along trajectory
`boundaries.php?action=sector_crossings`	GET	Sector boundary crossings along trajectory
`boundaries.php?action=all_crossings`	GET	All boundary crossings (ARTCC + sectors)
`boundaries.php?action=artccs_traversed`	GET	Simple list of ARTCCs crossed
`boundaries.php?action=crossing_etas`	GET	ETAs for upcoming boundary crossings

Boundary Adjacency Network

Endpoint	Method	Description
`boundaries.php?action=compute_adjacencies`	GET	Compute all boundary adjacencies
`boundaries.php?action=boundary_neighbors`	GET	Get neighbors of a boundary
`boundaries.php?action=adjacency_stats`	GET	Adjacency network statistics
`boundaries.php?action=adjacency_edges`	GET	Export adjacency as edge list
`boundaries.php?action=boundary_path`	GET	Find path between boundaries
`boundaries.php?action=artcc_adjacency_map`	GET	ARTCC-to-ARTCC adjacency map
`boundaries.php?action=sector_adjacency`	GET	Sector adjacency within ARTCC

Proximity Tiers

Endpoint	Method	Description
`boundaries.php?action=proximity_tiers`	GET	Boundaries within N tiers
`boundaries.php?action=proximity_distance`	GET	Tier distance between boundaries
`boundaries.php?action=boundaries_at_tier`	GET	Boundaries at specific tier
`boundaries.php?action=proximity_summary`	GET	Count summary per tier
`boundaries.php?action=validate_tiers`	GET	Validate GIS vs ADL tier mappings

Service/Diagnostics

Endpoint	Method	Description
`boundaries.php?action=health`	GET	Service health check
`boundaries.php?action=diag`	GET	Connection diagnostics for debugging

Example: Expand Route

Request:

GET /api/gis/boundaries.php?action=expand_route&route=KDFW BNA KMCO

Response:

{
  "success": true,
  "route": "KDFW BNA KMCO",
  "artccs": ["ZFW", "ZME", "ZJX"],
  "artccs_display": "ZFW -> ZME -> ZJX",
  "waypoints": [
    {"seq": 1, "id": "KDFW", "lat": 32.897, "lon": -97.038},
    {"seq": 2, "id": "BNA", "lat": 36.124, "lon": -86.678},
    {"seq": 3, "id": "KMCO", "lat": 28.429, "lon": -81.309}
  ],
  "distance_nm": 812.5,
  "geojson": {"type": "LineString", "coordinates": [...]}
}

See GIS API for full request/response documentation.

JATOC APIs

Joint Air Traffic Operations Command incident tracking.

GET /api/jatoc/incidents.php

Returns list of incidents.

Access: Public (read), Authenticated (write)

Parameter	Type	Description
`status`	string	active, resolved, all
`type`	string	atc_zero, atc_alert, atc_limited
`facility`	string	Filter by facility
`from`	datetime	Start date
`to`	datetime	End date

GET /api/jatoc/incident.php

Returns single incident details.

Access: Public

Parameter	Type	Description
`id`	int	Incident ID (required)

POST /api/jatoc/incident.php

Creates a new incident.

Access: Authenticated (DCC role)

Request Body:

{
  "facility": "ZNY",
  "type": "atc_limited",
  "ops_level": 2,
  "description": "Reduced staffing - expect delays",
  "expected_duration": 120
}

PUT /api/jatoc/incident.php

Updates an existing incident.

Access: Authenticated (DCC role)

NOD Dashboard APIs

NAS Operations Dashboard data endpoints.

GET /api/nod/tmi_active.php

Returns all active Traffic Management Initiatives.

Access: Public

Response includes:

Active Ground Stops
Active GDPs
Active reroutes
Affected airports summary

GET /api/nod/advisories.php

Returns DCC advisories.

Access: Public

Parameter	Type	Description
`active`	bool	Only active advisories
`category`	string	Filter by category

GET /api/nod/tracks.php

Returns historical flight track data.

Access: Authenticated

Parameter	Type	Description
`callsign`	string	Flight callsign
`from`	datetime	Start time
`to`	datetime	End time

GET/POST /api/nod/discord.php

Discord TMI integration for NOD.

Access: Authenticated (some actions public)

Action	Method	Description
`status`	GET	Check Discord integration status
`list`	GET	List Discord TMI entries
`active`	GET	List currently active TMIs
`refresh`	GET	Trigger manual Discord refresh
`parse`	POST	Parse TMI message
`end`	POST	Mark Discord TMI as ended
`send`	POST	Send TMI to Discord

See NOD Discord API for full documentation.

NOD Flow Configuration APIs (v18)

Facility-specific flow element configuration for the NOD map display. Manages flow configs, elements (fixes, procedures, routes, gates), and gate groupings. All data is stored in VATSIM_ADL via Azure SQL (sqlsrv).

Base Path: /api/nod/flows/

Flow Config CRUD

Endpoint	Method	Description
`configs.php?facility_code=ZNY`	GET	List all configs for a facility
`configs.php?config_id=1`	GET	Get single config with nested elements and gates
`configs.php`	POST	Create new flow config
`configs.php`	PUT	Update flow config
`configs.php?config_id=1`	DELETE	Delete config (cascades to elements/gates)

POST/PUT Request Body (configs):

{
  "facility_code": "ZNY",
  "facility_type": "ARTCC",
  "config_name": "Default ZNY Flows",
  "is_shared": 1,
  "is_default": 1,
  "map_center_lat": 40.63,
  "map_center_lon": -73.77,
  "map_zoom": 7,
  "boundary_layers": ["artcc", "tracon"]
}

Flow Element CRUD

Endpoint	Method	Description
`elements.php?config_id=1`	GET	List elements for a config (with fix lat/lon for FIX types)
`elements.php?element_id=5`	GET	Get single element
`elements.php`	POST	Create new element
`elements.php`	PUT	Update element
`elements.php?element_id=5`	DELETE	Delete element

Element Types: FIX, PROCEDURE, ROUTE, GATE

POST/PUT Request Body (elements):

{
  "config_id": 1,
  "element_type": "FIX",
  "element_name": "MERIT Arrivals",
  "fix_name": "MERIT",
  "direction": "arrival",
  "color": "#FF6600",
  "line_weight": 2,
  "line_style": "solid",
  "sort_order": 1,
  "is_visible": 1,
  "auto_fea": "via_fix"
}

FIX-type elements automatically resolve fix_lat/fix_lon from nav_fixes via LEFT JOIN.

Flow Gate CRUD

Endpoint	Method	Description
`gates.php?config_id=1`	GET	List gates for a config (with member element count)
`gates.php?gate_id=3`	GET	Get single gate with member elements
`gates.php`	POST	Create new gate
`gates.php`	PUT	Update gate
`gates.php?gate_id=3`	DELETE	Delete gate (detaches member elements first)

POST/PUT Request Body (gates):

{
  "config_id": 1,
  "gate_name": "West Gate",
  "direction": "arrival",
  "color": "#3388FF",
  "label_format": "{name}: {count}",
  "sort_order": 1,
  "auto_fea": "via_fix"
}

Element Autocomplete Suggestions

GET /api/nod/flows/suggestions.php

Returns autocomplete suggestions from nav_fixes or nav_procedures for the flow element editor.

Access: Authenticated

Parameter	Type	Description
`type`	string	`fix` or `procedure` (required)
`q`	string	Search prefix/substring (required)
`airport`	string	Airport ICAO code (required for `procedure` type)

Examples:

GET /api/nod/flows/suggestions.php?type=fix&q=MER
GET /api/nod/flows/suggestions.php?type=procedure&airport=KATL&q=RPTOR

Response (fix):

{
  "suggestions": [
    {"fix_name": "MERIT", "fix_type": "FIX", "lat": 40.818, "lon": -73.467},
    {"fix_name": "MERCE", "fix_type": "FIX", "lat": 37.456, "lon": -122.012}
  ]
}

Response (procedure):

{
  "suggestions": [
    {"procedure_id": 1234, "procedure_type": "STAR", "procedure_name": "RPTOR2", "airport_icao": "KATL"}
  ]
}

FEA Bridge API (v18)

POST /api/nod/fea.php

Creates or removes demand monitors linked to NOD flow elements or TMI entries. Bridges the flow configuration layer with the demand analysis system.

Access: Authenticated

Source Types:

`source_type`	Required Field	Description
`flow_element`	`element_id`	Create demand monitor from a flow element (FIX, ROUTE, or PROCEDURE type)
`tmi_entry`	`entry_id`	Create demand monitor from a TMI NTML entry (MIT fix)
`bulk`	`config_id`	Bulk-create monitors for all visible FIX/ROUTE elements in a config

POST Request Body (flow_element):

{
  "source_type": "flow_element",
  "element_id": 5
}

POST Response:

{
  "monitor_id": 42,
  "monitor_key": "via_fix_MERIT",
  "monitor_type": "via_fix",
  "definition": {
    "via": "MERIT",
    "filter": {"type": "airport", "code": "ZNY", "direction": "arrival"}
  }
}

POST Request Body (bulk):

{
  "source_type": "bulk",
  "config_id": 1
}

Bulk Response:

{
  "created": 5,
  "monitors": [
    {"element_id": 5, "monitor_id": 42, "monitor_key": "via_fix_MERIT", "monitor_type": "via_fix", "definition": {...}},
    {"element_id": 6, "monitor_id": 43, "monitor_key": "route_elem_6", "monitor_type": "segment", "definition": {...}}
  ]
}

DELETE /api/nod/fea.php

Removes demand monitors linked to flow elements.

Parameter	Type	Description
`source_type`	string	`flow_element` or `config` (required)
`element_id`	int	Element ID (required when `source_type=flow_element`)
`config_id`	int	Config ID (required when `source_type=config`)

Examples:

DELETE /api/nod/fea.php?source_type=flow_element&element_id=5
DELETE /api/nod/fea.php?source_type=config&config_id=1

Demand Analysis APIs

Airport demand and capacity analysis.

GET /api/demand/airports.php

Returns list of airports with demand data.

Access: Authenticated

GET /api/demand/summary.php

Returns demand summary for specified airports.

Access: Authenticated

Parameter	Type	Description
`airports`	string	Comma-separated ICAO codes
`hours`	int	Hours to forecast (default: 6)

Response:

{
  "success": true,
  "airports": {
    "KJFK": {
      "current_aar": 44,
      "current_adr": 40,
      "demand": [
        {"hour": "14:00", "arrivals": 38, "departures": 35},
        {"hour": "15:00", "arrivals": 52, "departures": 42}
      ],
      "weather_category": "VFR",
      "suggested_rate": 44,
      "confidence": "high"
    }
  }
}

GET /api/demand/rates.php

Returns rate data for an airport.

Access: Authenticated

Parameter	Type	Description
`airport`	string	ICAO code (required)

POST /api/demand/override.php

Applies manual rate override.

Access: Authenticated (DCC role)

Request Body:

{
  "airport": "KJFK",
  "aar": 32,
  "adr": 30,
  "reason": "Runway closure",
  "valid_from": "2026-01-10T16:00:00Z",
  "valid_until": "2026-01-10T20:00:00Z"
}

Airspace Element Demand APIs (v17)

Query traffic demand at navigation fixes, airway segments, and route segments. These endpoints call table-valued functions in Azure SQL for efficient demand analysis.

GET /api/adl/demand/fix.php

Returns flights passing through a specific navigation fix within a time window.

Access: Authenticated

Parameter	Type	Description
`fix`	string	Navigation fix identifier (required)
`minutes`	int	Time window in minutes (default: 60, max: 720)
`dep_tracon`	string	Filter by departure TRACON (e.g., N90)
`arr_tracon`	string	Filter by arrival TRACON
`format`	string	'list' (default) or 'count'

Example:

GET /api/adl/demand/fix?fix=MERIT&minutes=45&dep_tracon=N90

GET /api/adl/demand/airway.php

Returns flights on an airway segment between two fixes. Requires the flight to have filed via the specified airway.

Access: Authenticated

Parameter	Type	Description
`airway`	string	Airway identifier (required, e.g., J48, V1, Q100)
`from_fix`	string	Segment start fix (required)
`to_fix`	string	Segment end fix (required)
`minutes`	int	Time window in minutes (default: 60, max: 720)
`format`	string	'list' (default) or 'count'

Example:

GET /api/adl/demand/airway?airway=J48&from_fix=LANNA&to_fix=MOL&minutes=180

GET /api/adl/demand/segment.php

Returns flights passing through two fixes in sequence, regardless of whether they filed via an airway or direct (DCT). More flexible than the airway endpoint for VATSIM where pilots often file direct routes.

Access: Authenticated

Parameter	Type	Description
`from_fix`	string	First fix (required)
`to_fix`	string	Second fix (required)
`minutes`	int	Time window in minutes (default: 60, max: 720)
`format`	string	'list' (default) or 'count'

Example:

GET /api/adl/demand/segment?from_fix=CAM&to_fix=GONZZ&minutes=180

Response fields:

Field	Description
`entry_eta`	ETA at the first fix
`exit_eta`	ETA at the second fix
`segment_minutes`	Time to traverse the segment
`direction`	'forward' or 'reverse' based on sequence order
`on_airway`	Airway identifier if filed via an airway

GET /api/adl/demand/batch.php

Returns time-bucketed demand counts for multiple monitors in a single call. Efficiently queries traffic at multiple fixes/segments with results grouped into time buckets.

Access: Authenticated

Parameter	Type	Description
`monitors`	JSON	Array of monitor definitions (required)
`bucket_minutes`	int	Time bucket size (default: 15, min: 5, max: 60)
`horizon_hours`	int	Projection horizon (default: 4, max: 12)

Monitor types: fix, segment, airway, airway_segment, via_fix

Example:

GET /api/adl/demand/batch?monitors=[{"type":"fix","fix":"MERIT"}]&bucket_minutes=15

/api/adl/demand/monitors.php

CRUD operations for shared demand monitors that persist across sessions.

Access: Authenticated

Method	Description
GET	List all active monitors
POST	Create a new monitor
DELETE	Remove a monitor (by `id` or `monitor_key`)

GET /api/adl/demand/details.php

Returns individual flights captured by a demand monitor.

Access: Authenticated

Parameter	Type	Description
`type`	string	Monitor type (required)
`fix/from/to/airway`	string	Type-specific identifiers
`minutes_ahead`	int	Time window (default: 60, max: 720)
`airline`	string	Filter by airline prefix
`aircraft_category`	string	HEAVY, LARGE, or SMALL

TMR (Traffic Management Review) APIs (v18)

Post-event Traffic Management Review report management. TMR reports are linked to PERTI plans and follow the NTMO Guide template format.

Base Path: /api/data/review/

GET /api/data/review/tmr_report.php

Loads a saved TMR report for a plan, or returns empty defaults populated from plan metadata if no report exists yet.

Access: Authenticated

Parameter	Type	Description
`p_id`	int	PERTI plan ID (required)

Response:

{
  "success": true,
  "report": {
    "p_id": 42,
    "host_artcc": "ZNY",
    "tmr_triggers": ["holding_15", "ground_stop"],
    "overview": "Significant weather impact...",
    "airport_conditions": "KJFK | ILS 22L/22R | DEP 31L | 44/40",
    "airport_config_correct": true,
    "weather_category": "IMC",
    "weather_summary": "Embedded thunderstorms...",
    "special_events": null,
    "tmi_list": [
      {"type": "GS", "element": "KJFK", "start_utc": "2026-01-10 14:00", "end_utc": "2026-01-10 16:30"}
    ],
    "tmi_source": "historical",
    "tmi_complied": true,
    "tmi_effective": true,
    "tmi_timely": false,
    "tmi_timely_details": "GDP issued 15 minutes late",
    "equipment": "All equipment operational",
    "personnel_adequate": true,
    "operational_plan_link": "https://perti.vatcscc.org/plan?42",
    "findings": "TMIs were effective but delayed...",
    "recommendations": "Establish earlier coordination...",
    "status": "draft"
  },
  "is_new": false
}

POST /api/data/review/tmr_report.php

Saves or updates a TMR report using upsert (INSERT ON DUPLICATE KEY UPDATE) keyed on p_id. Supports both application/json and form-encoded POST bodies. Auto-save friendly.

Access: Authenticated

Request Body:

{
  "p_id": 42,
  "host_artcc": "ZNY",
  "tmr_triggers": ["holding_15", "ground_stop"],
  "overview": "Significant weather impact...",
  "airport_conditions": "KJFK | ILS 22L/22R | DEP 31L | 44/40",
  "airport_config_correct": true,
  "weather_category": "IMC",
  "weather_summary": "Embedded thunderstorms...",
  "tmi_list": [...],
  "tmi_source": "historical",
  "tmi_complied": true,
  "tmi_effective": true,
  "tmi_timely": false,
  "tmi_timely_details": "GDP issued 15 minutes late",
  "findings": "...",
  "recommendations": "...",
  "status": "draft"
}

TMR Trigger Values: holding_15, delays_30, no_notice_holding, reroutes, ground_stop, gdp, equipment

Status Values: draft, final

GET /api/data/review/tmr_tmis.php

Queries historical TMIs from the VATSIM_TMI database for the plan's event time window (+/- 1 hour padding). Returns a combined, time-sorted list of NTML entries, programs (GDP/GS), advisories, and reroutes that overlapped with the event.

Access: Authenticated

Parameter	Type	Description
`p_id`	int	PERTI plan ID (required)

Response:

{
  "success": true,
  "tmis": [
    {
      "id": 156,
      "category": "program",
      "type": "GS",
      "element": "KJFK",
      "facility": "KJFK",
      "detail": "Weather - thunderstorms",
      "start_utc": "2026-01-10 14:00",
      "end_utc": "2026-01-10 16:30",
      "status": "expired",
      "created_by": "1234567"
    },
    {
      "id": 89,
      "category": "ntml",
      "type": "MIT",
      "element": "MERIT",
      "facility": "ZNY",
      "detail": "15 MIT | Reason: WEATHER",
      "start_utc": "2026-01-10 13:30",
      "end_utc": "2026-01-10 17:00",
      "status": "active"
    }
  ],
  "event_window": {
    "start": "2026-01-10 14:00",
    "end": "2026-01-10 22:00"
  },
  "count": 7
}

TMI Categories: ntml (NTML log entries), program (GDP/GS), advisory, reroute

GET /api/data/review/tmr_export.php

Generates a Discord-formatted TMR message following the NTMO Guide template. Returns the complete formatted text ready for copy/paste or Discord posting.

Access: Authenticated

Parameter	Type	Description
`p_id`	int	PERTI plan ID (required)

Response:

{
  "success": true,
  "message": "**BEGIN SATURDAY KJFK EVENT TMR**\nZNY | 01/10 2026 | 1400-2200z\n\n**TMR Triggers:** Ground stop, Holding in excess of 15 minutes\n...\n**END SATURDAY KJFK EVENT TMR**",
  "char_count": 1847,
  "plan_name": "Saturday KJFK Event"
}

CDR APIs

Coded Departure Route reference data. CDRs are pre-coordinated reroutes between airport pairs used for traffic management.

Internal Base Path: None (CDRs are read-only reference data accessed via SWIM API) SWIM API: GET /api/swim/v1/routes/cdrs (public, no auth required) -- see SWIM Routes API

Data Source: FAA NASR cdrs.csv (~41,000 routes), stored in VATSIM_REF.coded_departure_routes and mirrored to SWIM_API.swim_coded_departure_routes daily at 06:00Z.

Internal GIS Endpoints:

Endpoint	Method	Description
`/api/adl/boundaries.php?action=expand_route`	GET	Expand a route string to waypoints + geometry via PostGIS
`/api/data/playbook/analysis.php`	GET	Route analysis with facility traversal and time segments

Playbook APIs (v18)

Pre-coordinated route play catalog management. Playbook plays define route sets for common traffic management scenarios (weather reroutes, volume management, etc.).

Base Path: /api/data/playbook/ (read) and /api/mgt/playbook/ (write) SWIM API: GET /api/swim/v1/playbook/plays (public), GET /api/swim/v1/playbook/analysis (auth required), GET/POST /api/swim/v1/playbook/throughput (auth required) -- see SWIM Routes API

Read Endpoints

Endpoint	Method	Description
`/api/data/playbook/list.php`	GET	List all plays with optional filtering
`/api/data/playbook/get.php`	GET	Get single play with routes
`/api/data/playbook/categories.php`	GET	List distinct categories
`/api/data/playbook/changelog.php`	GET	Playbook audit trail
`/api/data/playbook/analysis.php`	GET	Route analysis (facility traversal, distance, time segments)

GET /api/data/playbook/list.php

Returns all playbook plays with filtering options.

Access: Authenticated

Parameter	Type	Description
`source`	string	Filter by source: `FAA`, `DCC`, `ECFMP`, `CANOC`
`category`	string	Filter by category
`status`	string	Filter by status: `active`, `draft`, `archived`
`search`	string	Search play name, display name, or description
`artcc`	string	Filter by ARTCC in facilities_involved
`page`	int	Page number (default 1)
`per_page`	int	Results per page (default 200, max 10000)
`include_legacy`	bool	Include archived/legacy plays (default: false)

GET /api/data/playbook/get.php

Returns a single play with all routes.

Access: Authenticated

Parameter	Type	Description
`id`	int	Play ID (required, unless `name` provided)
`name`	string	Play name (alternative to `id`)

Response:

{
  "success": true,
  "play": {
    "play_id": 1,
    "play_name": "ZNY_WEST_SWAP",
    "display_name": "ZNY West Gate SWAP",
    "description": "West gate weather avoidance routing",
    "category": "WEATHER",
    "source": "DCC",
    "scenario_type": "WEATHER",
    "route_format": "standard",
    "status": "active",
    "route_count": 4,
    "routes": [
      {
        "route_id": 1,
        "origin": "KATL",
        "origin_filter": "",
        "dest": "KJFK",
        "dest_filter": "",
        "route_string": "KATL HYDRR Q85 MERIT KJFK",
        "remarks": "Primary west gate route"
      }
    ]
  }
}

GET /api/data/playbook/analysis.php

Computes facility traversal, distances, and time segments for a route using PostGIS.

Access: Public

Parameter	Type	Description
`route_id`	int	Playbook route ID
`route_string`	string	Route string (requires `origin` + `dest`)
`origin`	string	Origin airport ICAO
`dest`	string	Destination airport ICAO
`climb_kts`	int	Climb speed TAS (default 280)
`cruise_kts`	int	Cruise speed TAS (default 460)
`descent_kts`	int	Descent speed TAS (default 250)
`wind_component_kts`	int	Wind component (positive=headwind, default 0)
`facility_types`	string	Facility types to include (default `ARTCC,FIR`)

Write Endpoints

Endpoint	Method	Description
`/api/mgt/playbook/save.php`	POST	Create or update a play with routes
`/api/mgt/playbook/delete.php`	POST	Delete a play (cascades to routes)
`/api/mgt/playbook/route.php`	POST/DELETE	Add or remove individual routes

POST /api/mgt/playbook/save.php

Creates or updates a playbook play with its routes. Uses upsert logic keyed on play_id (update) or auto-increment (create).

Access: Authenticated

Request Body:

{
  "play_id": 0,
  "play_name": "ZNY_WEST_SWAP",
  "display_name": "ZNY West Gate SWAP",
  "description": "West gate weather avoidance routing",
  "category": "WEATHER",
  "source": "DCC",
  "scenario_type": "WEATHER",
  "route_format": "standard",
  "status": "active",
  "routes": [
    {
      "origin": "KATL",
      "origin_filter": "",
      "dest": "KJFK",
      "dest_filter": "",
      "route_string": "KATL HYDRR Q85 MERIT KJFK",
      "remarks": ""
    }
  ]
}

Playbook Data Model

Playbook tables are in perti_site MySQL:

Table	Purpose
`playbook_plays`	Play definitions with category, source, status
`playbook_routes`	Routes per play (origin, dest, route string, remarks)
`playbook_changelog`	Audit trail of play changes

Source values: FAA, DCC, ECFMP, CANOC Route format: standard (single route per O/D) or split (split route with segments) Status: active, draft, archived

Public Routes APIs

Shared route advisories for coordination.

GET /api/routes/public.php

Returns published public routes.

Access: Public

Parameter	Type	Description
`active`	bool	Only active routes
`region`	string	Filter by region

POST /api/routes/public_post.php

Publishes a new public route.

Access: Authenticated

Splits APIs

Sector configuration management for ARTCC/FIR split assignments.

Base Path: /api/splits/

Sector Data

Endpoint	Method	Description
`index.php`	GET	List available sector maps from CRC index
`sectors.php`	GET	Return sector GeoJSON boundaries
`maps.php`	GET	List available sector-related videomaps
`tracons.php`	GET	Return TRACON data for a facility

Configuration Management

Endpoint	Method	Description
`areas.php`	GET/POST/PUT/PATCH/DELETE	CRUD for sector area group definitions
`configs.php`	GET/POST/PUT/DELETE	CRUD for split configurations
`presets.php`	GET/POST/PUT/DELETE	CRUD for reusable configuration presets
`active.php`	GET	Currently active splits for a facility
`scheduled.php`	GET/PUT/DELETE	Scheduled configurations with future activation times
`scheduler.php`	GET/POST	Scheduler state and manual trigger

Key Parameters

sectors.php:

Parameter	Type	Description
`facility`	string	ARTCC/FIR code (required)
`filter`	string	`all`, `high`, `low`, `ultra` (default: `all`)

areas.php:

Parameter	Type	Description
`artcc`	string	Filter by ARTCC code
`id`	int	Area ID (for PUT/PATCH/DELETE)

configs.php:

Parameter	Type	Description
`artcc`	string	Filter by ARTCC code
`id`	int	Config ID (for GET single, PUT, DELETE)
`status`	string	Filter: `draft`, `active`, `scheduled`

See Splits for feature documentation.

Reference Data APIs

GET /api/data/weather.php

Returns current weather data.

Access: Public

Parameter	Type	Description
`airport`	string	ICAO code
`type`	string	metar, taf, sigmet

GET /api/data/sua.php

Returns Special Use Airspace data.

Access: Public

Parameter	Type	Description
`active`	bool	Only active SUAs
`bounds`	string	Geographic bounds (lat1,lon1,lat2,lon2)

GET /api/data/tfr.php

Returns Temporary Flight Restrictions.

Access: Public

ATFM Training Simulator APIs

Training simulator for TMU personnel practice.

GET /api/simulator/navdata.php

Returns navigation data for flight routing.

Access: Authenticated

Parameter	Type	Description
`bounds`	string	Geographic bounds (lat1,lon1,lat2,lon2)
`type`	string	Filter: waypoint, navaid, airport

GET /api/simulator/routes.php

Returns route pattern reference data.

Access: Authenticated

Parameter	Type	Description
`origin`	string	Origin airport (ICAO)
`destination`	string	Destination airport (ICAO)
`carrier`	string	Filter by carrier ICAO

Response:

{
  "success": true,
  "routes": [
    {
      "route_id": 1234,
      "origin": "KATL",
      "destination": "KJFK",
      "avg_daily_flights": 12.5,
      "primary_carrier_icao": "DAL",
      "flight_time_min": 135,
      "distance_nm": 762
    }
  ]
}

GET/POST /api/simulator/engine.php

Controls the flight simulation engine. Proxies to Node.js flight engine.

Access: Authenticated

Action	Method	Description
`health`	GET	Check engine status
`create`	POST	Create new simulation
`list`	GET	List all simulations
`status`	GET	Get simulation status
`spawn`	POST	Spawn aircraft
`aircraft`	GET	Get aircraft (single/all)
`tick`	POST	Advance simulation time
`run`	POST	Run for duration
`command`	POST	Issue ATC command
`commands`	POST	Batch ATC commands
`pause`	POST	Pause simulation
`resume`	POST	Resume simulation
`delete`	POST	Delete simulation
`remove_aircraft`	POST	Remove aircraft

See Simulator API for full documentation.

GET/POST /api/simulator/traffic.php

Generates and manages simulated traffic.

Access: Authenticated

Parameter	Type	Description
`session_id`	string	Simulation session ID
`airport`	string	Target airport for traffic
`hours`	int	Hours of traffic to generate

Rate Limiting

API requests are subject to rate limiting:

Tier	Requests/Minute	Notes
Public	60	Unauthenticated endpoints
Authenticated	300	Standard users
DCC Role	600	Traffic management personnel

Exceeded limits return HTTP 429 with retry information.

Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Resource does not exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

SWIM v1 APIs

System Wide Information Management - external flight data integration.

Authentication

POST /api/swim/v1/auth.php

Validates API key and returns session token.

Access: API Key

Request Body:

{
  "api_key": "swim_xxxxxxxxxxxx"
}

Response:

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expires_at": "2026-01-10T16:00:00Z"
}

Flight Data

GET /api/swim/v1/flights.php

Returns current flights with optional filters.

Access: API Key

Parameter	Type	Description
`dest`	string	Destination airport (ICAO)
`orig`	string	Origin airport (ICAO)
`artcc`	string	Current ARTCC
`phase`	string	Flight phase (prefile, departed, enroute, arrived)
`limit`	int	Maximum results (default: 500)

GET /api/swim/v1/flight.php

Returns single flight details.

Access: API Key

Parameter	Type	Description
`callsign`	string	Flight callsign (required)
`flight_uid`	int	Flight UID (alternative to callsign)

GET /api/swim/v1/positions.php

Returns position data for active flights.

Access: API Key

Parameter	Type	Description
`bounds`	string	Geographic bounds (lat1,lon1,lat2,lon2)
`artcc`	string	Filter by ARTCC
`since`	datetime	Positions updated since (ISO 8601)

API Key Management

POST /api/swim/v1/keys/provision.php

Provisions a new SWIM API key.

Access: Authenticated (Admin role)

Request Body:

{
  "name": "My Integration",
  "organization": "vZNY",
  "contact_email": "admin@example.com",
  "rate_limit": 300
}

POST /api/swim/v1/keys/revoke.php

Revokes an existing API key.

Access: Authenticated (Admin role)

Parameter	Type	Description
`key_id`	int	Key ID to revoke

TMI via SWIM

GET /api/swim/v1/tmi/programs.php

Returns active TMI programs (GS, GDP, AFP).

Access: API Key

GET /api/swim/v1/tmi/advisories.php

Returns active advisories.

Access: API Key

GET /api/swim/v1/tmi/controlled.php

Returns flights under TMI control (with EDCTs).

Access: API Key

Parameter	Type	Description
`program_id`	int	Filter by specific program
`airport`	string	Filter by control element

Reference Data (v18)

GET /api/swim/v1/reference/taxi-times.php

Returns unimpeded taxi-out reference times per airport, computed using FAA ASPM methodology (p5-p15 average over a 90-day rolling window). Refreshed daily at 02:00Z.

Access: API Key (read-only)

Endpoints:

Path	Description
`/reference/taxi-times`	All airports with taxi reference data
`/reference/taxi-times/{airport}`	Single airport with dimensional breakdown (weight class, carrier, engine config, destination region)

Parameter	Type	Description
`confidence`	string	Filter by confidence level: `HIGH`, `MEDIUM`, `LOW`, `DEFAULT`
`min_samples`	int	Minimum sample count filter
`format`	string	Response format: `json` (default), `fixm`, `xml`, `csv`, `ndjson`

Example:

GET /api/swim/v1/reference/taxi-times/KJFK?format=json

Response (single airport):

{
  "success": true,
  "airport": {
    "airport_icao": "KJFK",
    "unimpeded_taxi_out_sec": 720,
    "sample_size": 4521,
    "confidence": "HIGH",
    "p05_taxi_sec": 480,
    "p15_taxi_sec": 600,
    "last_refreshed_utc": "2026-02-10T02:00:00+00:00"
  },
  "details": [
    {"dimension": "WEIGHT_CLASS", "dimension_value": "HEAVY", "unimpeded_taxi_out_sec": 780, "sample_size": 1205},
    {"dimension": "CARRIER", "dimension_value": "DAL", "unimpeded_taxi_out_sec": 700, "sample_size": 890}
  ],
  "detail_count": 12,
  "methodology": {
    "description": "FAA ASPM p5-p15 average, 90-day rolling window",
    "min_samples": 50,
    "default_taxi_sec": 600,
    "refresh_schedule": "Daily at 02:00Z",
    "source": "VATSIM OOOI data (out_utc, off_utc)"
  }
}

Response (airport list):

{
  "success": true,
  "airports": [...],
  "count": 3628,
  "summary": {
    "high_confidence": 245,
    "medium_confidence": 412,
    "low_confidence": 891,
    "default": 2080
  },
  "methodology": {...}
}

FIXM Format: When format=fixm, field names use camelCase (e.g., aerodromeIcao, unimpededTaxiOutSeconds, confidenceLevel, sampleCount).

WebSocket

/api/swim/v1/ws/

Real-time position and event streaming via WebSocket.

Connection: wss://perti.vatcscc.org/api/swim/v1/ws/

Subscription Message:

{
  "action": "subscribe",
  "channels": ["positions", "tmi_events"],
  "filters": {
    "artcc": "ZNY",
    "dest": "KJFK"
  }
}

See docs/swim/README.md for full SWIM documentation.

Statistics APIs

Real-time and historical statistics.

GET /api/stats/realtime.php

Returns current system statistics.

Access: Authenticated

Response:

{
  "success": true,
  "timestamp": "2026-01-10T14:30:00Z",
  "flights": {
    "active": 1247,
    "by_phase": {
      "prefile": 89,
      "taxiing": 23,
      "departed": 156,
      "enroute": 834,
      "descending": 112,
      "arrived": 33
    }
  },
  "queue": {
    "pending": 45,
    "processing": 3,
    "avg_parse_ms": 142
  },
  "tmi": {
    "active_gs": 1,
    "active_gdp": 2,
    "controlled_flights": 87
  }
}

GET /api/stats/daily.php

Returns daily aggregated statistics.

Access: Authenticated

Parameter	Type	Description
`date`	date	Date (YYYY-MM-DD), defaults to today
`days`	int	Number of days (for trends)

GET /api/stats/hourly.php

Returns hourly statistics breakdown.

Access: Authenticated

Parameter	Type	Description
`date`	date	Date (YYYY-MM-DD)
`hours`	int	Hours to include (default: 24)

GET /api/stats/airport.php

Returns statistics for a specific airport.

Access: Authenticated

Parameter	Type	Description
`airport`	string	ICAO code (required)
`hours`	int	Lookback hours (default: 6)

Response:

{
  "success": true,
  "airport": "KJFK",
  "arrivals": {
    "last_hour": 38,
    "next_hour": 42,
    "avg_delay_min": 8.5
  },
  "departures": {
    "last_hour": 35,
    "next_hour": 40
  },
  "current_config": "ILS 22L | ILS 22R | DEP 31L",
  "weather_category": "VMC"
}

GET /api/stats/artcc.php

Returns statistics for an ARTCC.

Access: Authenticated

Parameter	Type	Description
`artcc`	string	ARTCC code (required)

GET /api/stats/citypair.php

Returns statistics for city pair routes.

Access: Authenticated

Parameter	Type	Description
`origin`	string	Origin ICAO
`destination`	string	Destination ICAO
`date`	date	Date for statistics

GET /api/stats/tmi.php

Returns TMI program statistics.

Access: Authenticated

Parameter	Type	Description
`from`	datetime	Start date
`to`	datetime	End date
`type`	string	Filter by program type (GS, GDP)

GET /api/stats/flight_phase_history.php

Returns historical flight phase distribution.

Access: Authenticated

Parameter	Type	Description
`hours`	int	Lookback hours (default: 24)

Reroute APIs

Reroute management and compliance tracking.

GET /api/tmi/reroutes.php

Returns reroute definitions.

Access: Authenticated

Parameter	Type	Description
`status`	int	Filter: 0=draft, 1=proposed, 2=active, 3=monitoring, 4=expired, 5=cancelled
`active_only`	bool	Only active reroutes

POST /api/tmi/reroutes.php

Creates a new reroute.

Access: Authenticated (DCC role)

Request Body:

{
  "name": "ZNY WEST GATE",
  "protected_segment": "MERIT..HAAYS..NEION",
  "origin_centers": "ZDC ZOB",
  "dest_airports": "KJFK KEWR KLGA KTEB",
  "start_utc": "2026-01-10T14:00:00Z",
  "end_utc": "2026-01-10T22:00:00Z",
  "time_basis": "ETD",
  "comments": "Weather avoidance routing"
}

GET /api/tmi/reroutes.php?id={reroute_id}

Returns reroute details with assigned flights.

Access: Authenticated

Response includes:

Reroute definition
Assigned flights with compliance status
Compliance statistics (compliant, partial, non-compliant)