SWIM Technical Documentation

Architecture, Standards & Reference Materials

Version 1.0.0

Quick Access

Interactive API Docs OpenAPI Spec Get API Key SWIM Overview Discord Support

API Reference

Primary API documentation and specifications

Interactive API Docs Primary

Swagger UI with "Try It Out" functionality. Test endpoints directly in your browser.

Opens in new tab

OpenAPI 3.0 Specification YAML

Machine-readable API definition. Import into Postman, Insomnia, or code generators.

Quick Reference

Condensed endpoint table, rate limits, and SDK links. Good for quick lookups.

View Documentation

Architecture & Design

System architecture, design decisions, and integration patterns

Design Document v1.3

Complete architecture overview including data flow, infrastructure, and unified flight record design.

View Documentation

Full API Documentation

Comprehensive API guide with examples, WebSocket events, and integration patterns.

View Documentation

Release Documentation

Release notes, deployment guide, and configuration reference.

View Documentation

Schema & Standards Reference

Field mappings, data standards alignment, and schema documentation

FIXM Field Mapping FIXM 4.3

Complete field mapping between VATSWIM, FIXM 4.3, and TFMS standards.

View Documentation

Aviation Standards Cross-Reference

Comparison of aviation data standards (FIXM, AIXM, IWXXM, etc.) and their applicability.

View Documentation

Field Migration Guide

Migration guide for transitioning from legacy field names to FIXM-aligned naming.

View Documentation

ADL Flights Schema

Database schema reference for the adl_flights table structure.

View Documentation

Normalized Schema Reference

Documentation for normalized/lookup tables (airports, aircraft, airlines).

View Documentation

Rate Limits Quick Reference

API access tiers and their limits

Tier	Prefix	Rate Limit	WebSocket	Write Access	Self-Service
Public	`swim_pub_`	100 req/min	5 connections	No	Yes
Developer	`swim_dev_`	300 req/min	50 connections	No	Yes
Partner	`swim_par_`	3,000 req/min	500 connections	Limited	Contact Us
System	`swim_sys_`	30,000 req/min	10,000 connections	Full	Contact Us

Announcements & Guides

Getting started guides and public announcements

Launch Announcement

Official SWIM API launch announcement with feature overview and getting started guide.

View Documentation

Development Notes

Internal development documentation and session transition notes

TODO List Internal

Outstanding work items and planned features.

Phase 2: Real-Time Design Internal

WebSocket and real-time streaming architecture design.

Phase 2/3 Transition Internal

Phase transition planning and implementation notes.

Session transition documents (SWIM_Session_Transition_*.md) are available in the docs/swim/ directory for detailed development history.

Need Help?

Questions about the API or documentation? Reach out to us.