What the API is
The Copilot EFB public API gives access to one pilot's own data — aircraft, aerodrome cards with their frequencies, runways and taxiways, weather at their aerodromes, notes, checklists, routes planned on the map, flight plans, the logbook and the pilot profile — so a service of your own can use what you already keep in the flight bag.
It reads everything. Since 1.18.0 it also writes, but only with a key the pilot has allowed to: add hours to the logbook, build a flight plan from A to Z — planning, navigation log, ICAO plan, validation, filed, flown — and create or change aircraft, aerodrome cards, notes and checklists. See Writing to the account. The RogerATC AI plugin writes its own things — activation, sessions, live state, messages read — with any key.
The key reads everything the account holds, including the pilot profile — licence numbers, the medical certificate, a telephone — and the provider keys RogerATC uses. Keep it on a server. The API sends no CORS headers, on purpose, so a web page cannot call it: never put the key in a web page or in a mobile app.
The live reference, generated from the API's own code, is at api.rogeratc.app/docs, and the machine-readable OpenAPI 3.1 description at api.rogeratc.app/openapi.json. This page is checked against a copy of that description every time the site is built.
Quick start
Copy the key from Copilot EFB → Settings → API access and try it:
export ROGER_API_KEY="rat_live_…"
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/me
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aircraft
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/weatherGET /v1/me is the cheapest way to check that a key works: it says which account the key belongs to.
Your API key
Every Copilot EFB account has one personal key, from the moment the account is confirmed — there is nothing to apply for. It lives in Settings → API access, together with its usage.
| Moment | What happens |
|---|---|
| Account confirmed | The key is created. An account that predates keys gets one at its next sign-in. |
| Settings → API access | The key is shown, with its first characters (prefix) to tell keys apart without revealing them. |
| Allow changes through the API | Off for every key. On, the key may also write the pilot's records (Writing to the account). Checked on every request, so turning it off stops the next write. |
| Rotate | A new key replaces the old one, which stops working the moment the rotation returns. Every integration that used it needs the new one. The write permission is kept; an account reset rotates the key and turns it off. |
| Account paused | The key is suspended with the account and answers 401. Resuming the account restores it. |
| Account deleted | The key is deleted with everything else. |
Format: rat_live_ followed by 43 base64url characters (32 random bytes). The API never returns the key itself: GET /v1/me shows only its prefix and its dates.
If somebody may have seen the key — a screenshot, a shared document, a commit — rotate it. Rotation is immediate and costs nothing but updating your integrations.
Usage statistics
Settings → API access also shows how the key was used: requests per day and per endpoint over up to 90 days, how many were errors, and when the key was last used. Counters are per UTC day and per route template, such as GET /v1/aircraft/{id}.
Every request to an existing route made with a valid key is counted, whatever its status — a 404 for a record that is not there, a 400, a 429 — because that is exactly what the statistics are for. A path that is not a route, and any request without a valid key, cannot be attributed to an account and is not counted.
Authentication
Send the key on every request, in either header:
Authorization: Bearer rat_live_x3V…
X-API-Key: rat_live_x3V…Only GET /v1/health and the reference itself — /docs and /openapi.json — answer without a key.
A missing, malformed, unknown or rotated key, or the key of a paused or deleted account, answers 401 unauthorized with WWW-Authenticate: Bearer. The API does not say which of those it was.
Requests and responses
- Methods:
GETeverywhere;POST,PUT,PATCHandDELETEwhere the endpoints list them. HTTPS only (TLS 1.2 or later), JSON only. - Times are UTC, ISO 8601. Logbook durations are whole minutes.
- A value the app does not know is
nullor absent — never invented. - Responses with data carry
Cache-Control: no-store, private. - Every response carries
X-Request-Id, the same value asmeta.requestId. Quote it when something went wrong.
A single resource:
{
"data": {
"id": "ac-1",
"registration": "LV-XXX",
"icaoType": "C172",
"updatedAt": "2026-09-17T11:16:29.900Z",
"…": "…"
},
"meta": { "requestId": "Q2a8vg…", "generatedAt": "2026-09-17T15:02:11.410Z" }
}A collection:
{
"data": [ { "id": "…", "…": "…" } ],
"page": { "limit": 50, "total": 2, "nextCursor": null },
"meta": { "requestId": "…", "generatedAt": "…" }
}What a record is
A record is returned whole: every field the app stores, exactly as the EFB synced it, plus id and updatedAt, which are always present. Deleted records are never returned.
A field the app adds is in the API the day it syncs, with no new version. Ignore fields you do not recognise. The examples on this page are trimmed; a real record carries more.
Errors
{
"error": { "code": "not_found", "message": "No aircraft with id \"x\" in this account." },
"meta": { "requestId": "…", "generatedAt": "…" }
}| Status | code | When |
|---|---|---|
400 | bad_request | A parameter or a field is malformed; the message names it. |
401 | unauthorized | No key, a malformed or unknown key, a rotated key, a paused or deleted account. |
403 | insufficient_scope | A write with a key the pilot has not allowed to write. |
403 | account_suspended | A paused account, on POST /v1/plugin/activation and GET /v1/plugin/credentials only; every other route answers 401. |
404 | not_found | No such route, or no such record in this account. |
405 | method_not_allowed | A method the route does not take. Allow lists the ones it does. |
409 | conflict | A write that clashes with what is stored: a registration or an aerodrome the account already has, a flight plan whose flight is over, or a record that changed while the request was applied — read it and retry. |
409 | not_armed | A new transit run for a plan the pilot has not armed, on PUT /v1/plugin/transit-runs/{id}. |
410 | gone | A PUT of a plugin session the pilot deleted — stop sending it; or a PUT of a transit run the pilot deleted, or whose plan they deleted; or a create whose id or Idempotency-Key names a deleted record. |
412 | precondition_failed | If-Match names a version the record no longer is. ETag carries the current one. |
413 | payload_too_large | A body over its limit: 512 KB for a session, 32 KB for a live report, 8 KB for an activation, 400 KB for a transit run. |
415 | unsupported_media_type | A body that is not application/json. |
422 | unprocessable | Well-formed JSON the app would refuse. error.problems lists every problem as { field, code, message }; for a flight plan, field is the ICAO field number. |
429 | rate_limited | Over the per-key limit. Retry-After says how many seconds to wait. |
500 | internal | Our fault. Quote meta.requestId. |
503 | unavailable | A write could not be stored just now. Retry after Retry-After. |
Codes are stable; build on them. Messages are English prose for a developer and may change.
Paging and following changes
Collections take:
| Parameter | Meaning |
|---|---|
limit | 1–200, default 50. A page may hold fewer when records are large — a note can carry a drawing. |
cursor | Opaque. Pass page.nextCursor back to get the next page; null means there is none. |
updatedSince | ISO 8601. Only records changed after it. |
The cursor is an offset into the sorted collection, so a record written between two page requests can shift a page. To follow changes, use updatedSince with the newest updatedAt you have seen: that returns every change exactly once, whatever the order.
curl -s -H "X-API-Key: $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/aircraft?limit=100&updatedSince=2026-09-17T00:00:00Z"Rate limits
- Per key: 120 requests per minute. Above it,
429 rate_limitedwithRetry-Afterin seconds. - Whole API: 25 requests per second sustained, bursts of 50.
- Weather is cached for up to five minutes per aerodrome, however often you ask;
fetchedAtsays when it was fetched. - Writes: 1,000 records per account per UTC day — every create, update and delete is one. Above it,
429withRetry-Afterto the next 00:00 UTC; a refused write spends nothing. The cap exists because every write syncs down to every device the pilot owns. - Plugin sessions: 50 new session ids per account per UTC day. Updates to an existing id are unlimited.
Writing to the account
A key the pilot has allowed to write can change what the pilot authors: logbook entries, aircraft, aerodrome cards, notes, checklists, plannings and flight plans. Each write is stored exactly as a change made on one of the pilot's devices, so it appears on all of them at their next sync. The pilot profile, shared plannings, attachments and messages are not writable.
Writes are off for every key until the pilot turns on Copilot EFB → Settings → API access → Allow changes through the API. A read-only key gets 403 insufficient_scope. RogerATC needs no write permission.
| Action | How |
|---|---|
| Create | POST on the collection → 201 with the whole record, its ETag, and warnings or validation where the app has them. |
| Retry safely | Send Idempotency-Key (any 1–255 ASCII characters) or a UUID id in the body. A retry answers 200 with the stored record and Idempotent-Replayed: true. |
| Update | PATCH is a JSON Merge Patch: only what you name changes, null removes a field, a list is replaced whole. PUT replaces the record (not offered for plannings and flight plans). |
| Concurrency | Every single-record read and write carries ETag. Send it back as If-Match to make an update or delete conditional (412 if it changed); without it, the last write wins, as between two devices. |
| Delete | DELETE → 200 { id, deleted: true, alsoDeleted }, and 200 again on a retry. |
| Refused | 422 unprocessable lists every problem at once; nothing is written. |
Add hours to the logbook
One call adds a flight. With departureAt and arrivalAt and no times, the block time goes into the cell the flight's kind and role imply, exactly as the Logbook screen does it; GET /v1/logbook/totals counts it at once.
curl -X POST https://api.rogeratc.app/v1/logbook \
-H "Authorization: Bearer $ROGER_API_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: flight-2026-10-09-1" \
-d '{ "date": "2026-10-09", "departureAt": "2026-10-09T13:05:00Z", "arrivalAt": "2026-10-09T14:55:00Z",
"departureAerodrome": "SADF", "arrivalAerodrome": "SAAR", "kind": "crossCountry",
"registration": "LV-ABC", "landings": 1 }'{
"data": { "id": "…", "source": "manual", "departure": "SADF", "destination": "SAAR",
"log": { "date": "2026-10-09", "kind": "crossCountry", "role": "pilot",
"times": { "crossCountryDayPilot": 110, "…": 0 }, "landings": 1 },
"updatedAt": "…" },
"meta": { "requestId": "…", "generatedAt": "…" }
}A line the app would refuse is not written, and every problem is listed:
{
"error": { "code": "unprocessable", "message": "The logbook line has problems; nothing was written.",
"problems": [ { "field": "date", "code": "required", "message": "\"date\" is required: the flight’s date, YYYY-MM-DD." } ] },
"meta": { "requestId": "…", "generatedAt": "…" }
}A flight plan from A to Z
- The aircraft, once:
POST /v1/aircraft. - The planning — departure, route, destination, alternates, aircraft, time, level, fuel, wind:
POST /v1/plannings. - Its navigation log — legs, headings, times, fuel:
GET /v1/plannings/{id}/navlog. - The ICAO flight plan it becomes, as a draft with its validation:
POST /v1/plannings/{id}/flight-plan. - What only the pilot can state — persons on board, field 19:
PATCH /v1/flight-plans/{id}. - Check it as the app does:
GET /v1/flight-plans/{id}/validation. - Mark it filed — refused with
422while the validator reports an error:PATCH /v1/flight-plans/{id}. - After the flight, the hours:
POST /v1/logbook. - Close the plan as flown:
PATCH /v1/flight-plans/{id}.
export ROGER_API_KEY="rat_live_…" # a key with "Allow changes through the API" on
H=(-H "Authorization: Bearer $ROGER_API_KEY" -H "Content-Type: application/json")
API=https://api.rogeratc.app
# 1. The aircraft (once).
AC=$(curl -s -X POST "${H[@]}" $API/v1/aircraft -d '{"registration":"LV-ABC","icaoType":"C172",
"cruiseTas":105,"cruiseFuelBurn":32,"usableFuel":200,"taxiFuel":4,"volumeUnit":"l",
"equipmentCodes":"SDFGY","surveillanceCodes":"C"}' | jq -r .data.id)
# 2. The planning: route, aircraft, time, level, fuel, wind.
PL=$(curl -s -X POST "${H[@]}" $API/v1/plannings -d '{"departure":"SADF",
"route":[{"ident":"FDO","kind":"navaid"},{"airway":"W5","to":"ROS"}],"destination":"SAAR",
"alternates":["SAAV"],"aircraftId":"'$AC'","departureAt":"2026-10-10T13:00:00Z",
"cruiseAltitudeFt":4500,"fuelAtDeparture":150,"windSource":"manual",
"manualWind":{"fromTrueDeg":270,"speedKt":15}}' | jq -r .data.id)
# 3. Its navigation log.
curl -s "${H[@]}" $API/v1/plannings/$PL/navlog | jq '.data | {totalDistanceNm, totalTimeMin, tripFuel, fuelStatus}'
# 4. The ICAO flight plan it becomes (a draft, with its validation).
FP=$(curl -s -X POST "${H[@]}" -H "Idempotency-Key: fpl-$PL" $API/v1/plannings/$PL/flight-plan | jq -r .data.id)
# 5. What only the pilot can state: persons on board, field 19.
curl -s -X PATCH "${H[@]}" $API/v1/flight-plans/$FP -d '{"supplementary":{"personsOnBoard":2,
"pilotInCommand":"A. PILOT","contactPhone":"+10000000000"}}'
# 6. Check it as the app does.
curl -s "${H[@]}" $API/v1/flight-plans/$FP/validation | jq '.data | {filable, issues}'
# 7. Mark it filed (422 while the validator reports an error).
curl -s -X PATCH "${H[@]}" $API/v1/flight-plans/$FP -d '{"status":"filed"}'
# 8. After the flight: the hours, in the logbook.
curl -s -X POST "${H[@]}" $API/v1/logbook -d '{"date":"2026-10-10","departureAt":"2026-10-10T13:00:00Z",
"arrivalAt":"2026-10-10T14:20:00Z","departureAerodrome":"SADF","arrivalAerodrome":"SAAR",
"kind":"crossCountry","aircraftId":"'$AC'","landings":1}'
# 9. And close the plan.
curl -s -X PATCH "${H[@]}" $API/v1/flight-plans/$FP -d '{"status":"flown"}'The API marks a plan filed; it does not send it. Sending it to the ATS reporting office, signing it and fetching forecast winds stay in the app. A planning's navigation log uses a manual wind or none: a forecast wind is not fetched, and the log says so.
Endpoints
Every route except GET /v1/health needs the key; the ones that change the pilot's records need a key allowed to write. Collections are paged and sorted as stated under each one.
| Method | Path | Key | Returns |
|---|---|---|---|
| GET | /v1/health | no | Service health |
| GET | /v1/me | yes | The account and its key |
| GET | /v1/aerodromes | yes | Aerodrome cards (paged) |
| GET | /v1/aerodromes/{id} | yes | One card, by id or by identifier |
| GET | /v1/aerodromes/{id}/attachments/{attachmentId} | yes | Download link for a card attachment |
| GET | /v1/aerodrome-comments/{ident} | yes | Approved pilot comments on an aerodrome |
| POST | /v1/aerodromes | yes | Create a card, filled from the database (write) |
| PATCH | /v1/aerodromes/{id} | yes | Change a card (write) |
| PUT | /v1/aerodromes/{id} | yes | Replace a card (write) |
| DELETE | /v1/aerodromes/{id} | yes | Delete a card (write) |
| GET | /v1/aircraft | yes | Aircraft (paged) |
| GET | /v1/aircraft/{id} | yes | One aircraft |
| GET | /v1/aircraft/{id}/attachments/{attachmentId} | yes | Download link for an aircraft document |
| POST | /v1/aircraft | yes | Create an aircraft (write) |
| PATCH | /v1/aircraft/{id} | yes | Change an aircraft (write) |
| PUT | /v1/aircraft/{id} | yes | Replace an aircraft (write) |
| DELETE | /v1/aircraft/{id} | yes | Delete an aircraft and its checklists (write) |
| GET | /v1/weather | yes | METAR and TAF at every aerodrome of the pilot |
| GET | /v1/weather/{ident} | yes | METAR and TAF at one aerodrome |
| GET | /v1/aerodrome-knowledge/{ident} | yes | Everything the EFB knows about one aerodrome |
| GET | /v1/aerodrome-knowledge | yes | Aerodromes and the pilot's TMA frequencies around a position |
| GET | /v1/notes | yes | Notes (paged) |
| GET | /v1/notes/{id} | yes | One note |
| POST | /v1/notes | yes | Create a note (write) |
| PATCH | /v1/notes/{id} | yes | Change a note (write) |
| PUT | /v1/notes/{id} | yes | Replace a note (write) |
| DELETE | /v1/notes/{id} | yes | Delete a note (write) |
| GET | /v1/checklists | yes | Checklists (paged) |
| GET | /v1/checklists/{id} | yes | One checklist |
| POST | /v1/checklists | yes | Create a checklist (write) |
| PATCH | /v1/checklists/{id} | yes | Change a checklist (write) |
| PUT | /v1/checklists/{id} | yes | Replace a checklist (write) |
| DELETE | /v1/checklists/{id} | yes | Delete a checklist (write) |
| GET | /v1/check-flights | yes | Flight checks (paged) |
| GET | /v1/check-flights/{id} | yes | One flight |
| GET | /v1/flight-plans | yes | Flight plans (paged) |
| GET | /v1/flight-plans/{id} | yes | One flight plan |
| POST | /v1/flight-plans | yes | Create a plan from fields (write) |
| PATCH | /v1/flight-plans/{id} | yes | Change, file or close a plan (write) |
| DELETE | /v1/flight-plans/{id} | yes | Delete a plan (write) |
| GET | /v1/flight-plans/{id}/validation | yes | The app's validation and the FPL message |
| GET | /v1/plannings | yes | Plannings (paged) |
| GET | /v1/plannings/{id} | yes | One planning |
| POST | /v1/plannings | yes | Create a planning from departure, route, destination (write) |
| PATCH | /v1/plannings/{id} | yes | Change a planning (write) |
| DELETE | /v1/plannings/{id} | yes | Delete a planning (write) |
| GET | /v1/plannings/{id}/navlog | yes | Its navigation log, computed |
| POST | /v1/plannings/{id}/flight-plan | yes | Make the ICAO flight plan from it (write) |
| GET | /v1/shared-plannings | yes | Plannings shared with a copilot |
| GET | /v1/shared-plannings/{id} | yes | One shared planning |
| GET | /v1/airways | yes | ATS routes (airways) from AIP Argentina |
| GET | /v1/logbook | yes | Logbook entries (paged) |
| GET | /v1/logbook/totals | yes | Summed hours, in minutes |
| GET | /v1/logbook/export | yes | The logbook as a CSV file |
| GET | /v1/logbook/{id} | yes | One entry |
| GET | /v1/logbook/{id}/attachments/{attachmentId} | yes | Download link for a photo on an entry |
| POST | /v1/logbook | yes | Add hours: a new entry (write) |
| PATCH | /v1/logbook/{id} | yes | Change an entry (write) |
| PUT | /v1/logbook/{id} | yes | Replace an entry (write) |
| DELETE | /v1/logbook/{id} | yes | Delete an entry (write) |
| GET | /v1/ground-school | yes | The theory path and where the pilot is in it |
| GET | /v1/transit-plans | yes | Instructed transit session plans (paged) |
| GET | /v1/transit-plans/{id} | yes | One transit session plan |
| GET | /v1/transit-runs | yes | Runs of transit sessions the plugin reported (paged) |
| GET | /v1/transit-runs/{id} | yes | One run — the resume point after X-Plane closed |
| GET | /v1/pilot | yes | The pilot profile |
| POST | /v1/plugin/activation | yes | RogerATC's licence check: the account and the names of its keys |
| GET | /v1/plugin/credentials | yes | The provider keys RogerATC uses, from the pilot's Settings |
| GET | /v1/plugin/feedback | yes | An administrator's ratings of RogerATC turns, as a training dataset |
| POST | /v1/plugin/feedback/applied | yes | Mark ratings taken into a plugin version |
| GET | /v1/plugin/messages | yes | The pilot's unread messages, for the instructor to read aloud |
| POST | /v1/plugin/messages/{id}/read | yes | Mark one read, on every device |
| PUT | /v1/plugin/sessions/{id} | yes | Store a RogerATC AI session |
| PUT | /v1/plugin/live | yes | Report live state and collect waiting instructions |
| PUT | /v1/plugin/transit-runs/{id} | yes | Store a run of an instructed transit session |
| GET | /v1/plugin/sessions | yes | RogerATC AI sessions (paged) |
| GET | /v1/plugin/sessions/{id} | yes | One RogerATC AI session |
| GET | /v1/plugin/stats | yes | Totals over every RogerATC AI session |
Health
- GET
/v1/healthService health no key
No key, no data, not counted in the usage statistics. For uptime monitors.
curl -s https://api.rogeratc.app/v1/health{ "data": { "ok": true, "version": "1.0.0" }, "meta": { … } }Account
- GET
/v1/meThe account and its key
Which account a key belongs to. The key itself is never returned — only its prefix and its dates.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/me{
"data": {
"userId": "00000000-0000-0000-0000-000000000000",
"email": "…",
"displayName": "A. Pilot",
"accountCreatedAt": "2026-09-08T18:15:14.171Z",
"apiKey": {
"prefix": "rat_live_x3V9",
"createdAt": "2026-09-17T15:00:00.000Z",
"rotatedAt": null
}
},
"meta": { … }
}Aerodrome cards
- GET
/v1/aerodromesAerodrome cards (paged) - GET
/v1/aerodromes/{id}One card, by id or by identifier - GET
/v1/aerodromes/{id}/attachments/{attachmentId}Download link for a card attachment - GET
/v1/aerodrome-comments/{ident}Approved pilot comments on an aerodrome - POST
/v1/aerodromesCreate a card, filled from the database (write) - PATCH
/v1/aerodromes/{id}Change a card (write) - PUT
/v1/aerodromes/{id}Replace a card (write) - DELETE
/v1/aerodromes/{id}Delete a card (write)
The pilot's aerodrome cards: frequencies, contacts, VOR/DME, runways, taxiways, position, elevation, notes, and the NOTAM and MADHEL text the pilot copied onto the card. Sorted by code.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
{id} | The card id or the aerodrome identifier, case-insensitive: /v1/aerodromes/SADF, /v1/aerodromes/len. |
An identifier is the ICAO location indicator where the aerodrome has one, and the national three-letter code where it does not — as with most Argentine strips, such as LEN (Escobar) or SNY (San Nicolás).
taxiways is a list of { id, designator, surface, widthM, lighted, notes } typed by the pilot from the aerodrome chart, never pre-filled. An empty or absent list means none were entered on the card; it says nothing about the aerodrome itself.
These are the pilot's own cards, reference data typed from a chart. They are not the AIP.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodromes/SADF{
"data": {
"id": "7f0c…", "code": "SADF", "name": "San Fernando", "elevationFt": 10,
"frequencies": { "tower": "119.000", "ground": "121.850", "atis": null, "…": "…" },
"contacts": { "aroAisPhone": "…", "…": "…" },
"runways": [
{ "designator": "05/23", "lengthM": 1690, "widthM": 30, "surface": "ASP", "…": "…" }
],
"taxiways": [
{ "id": "…", "designator": "…", "surface": "…", "widthM": null,
"lighted": null, "notes": "…" }
],
"notam": "", "madhel": "", "notes": "",
"createdAt": "…", "updatedAt": "…"
},
"meta": { … }
}Attachments
attachments lists the diagrams, entry and exit procedures and photos the pilot attached: { id, name, contentType, bytes, kind, createdAt }, with kind diagram, procedures, photo or other. The card carries only this metadata; the files are in private storage. GET /v1/aerodromes/{id}/attachments/{attachmentId} returns one with a presigned HTTPS URL valid for 15 minutes: fetch it directly and without the key. 404 when the card does not list that id or the file has not been uploaded yet — an attachment added with no signal is uploaded at the next sync.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/aerodromes/SADF/attachments/0b7e…"{
"data": {
"id": "0b7e…", "name": "SADF diagrama.pdf", "contentType": "application/pdf",
"bytes": 812345, "kind": "diagram", "createdAt": "2026-09-18T12:00:00.000Z",
"url": "https://…/u/…?X-Amz-Signature=…",
"urlExpiresAt": "2026-09-18T12:15:00.000Z"
},
"meta": { … }
}Writing
code is resolved to the aerodrome's identity — EZE and SAEZ are one card — and a second card for the same aerodrome is 409. A new card is filled from the EFB's aerodrome database, as Add aerodrome does in the app, with your body over it. Writes take the card id; the GET also takes an identifier. Attachments are never written: files are uploaded from the app. Conventions in Writing to the account.
Pilots’ comments
GET /v1/aerodrome-comments/{ident} (1.33.0) returns what pilots wrote about an aerodrome once an administrator approved it, newest first, at most 100, plus this account’s own comments in any status (pending or rejected). Any code of the aerodrome finds it: SADF, FDO and sadf read the same list. authorName is the first name and the surname’s initial, or null. Text only: hasPhoto and hasFile say a photo or a shared diagram exists, and photoUrl, thumbUrl and file.url are always null here. Read-only; comments are written and moderated in the app.
Aircraft
- GET
/v1/aircraftAircraft (paged) - GET
/v1/aircraft/{id}One aircraft - GET
/v1/aircraft/{id}/attachments/{attachmentId}Download link for an aircraft document - POST
/v1/aircraftCreate an aircraft (write) - PATCH
/v1/aircraft/{id}Change an aircraft (write) - PUT
/v1/aircraft/{id}Replace an aircraft (write) - DELETE
/v1/aircraft/{id}Delete an aircraft and its checklists (write)
Every aircraft profile with every field — registration, ICAO type, equipment and surveillance codes, speeds, fuel, weights, arms and the envelope. Sorted by registration.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" "https://api.rogeratc.app/v1/aircraft?limit=20"Documents
attachments lists the aircraft's flight manual, documents and photos, in the same shape as a card's, with kind manual, document, photo or other. GET /v1/aircraft/{id}/attachments/{attachmentId} works exactly like the aerodrome one: a presigned URL for 15 minutes, fetched without the key, and 404 when it does not exist or has not been uploaded yet. Files may be up to 100 MB.
Writing
registration is required, and one the fleet already has (LV-ABC is lvabc) is 409. The closed lists — category, wake turbulence, units, fuel grade — are checked. DELETE also deletes the aircraft's checklists, as the app does, and lists them in alsoDeleted.
Weather
- GET
/v1/weatherMETAR and TAF at every aerodrome of the pilot - GET
/v1/weather/{ident}METAR and TAF at one aerodrome
The latest METAR and TAF, raw and decoded, for every aerodrome the pilot has: each aerodrome card and each aerodrome on the weather briefing. sources says which (aerodromeCard, briefing). /v1/weather/{ident} answers for any identifier, on the pilot's lists or not.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/weather{
"data": [
{
"ident": "SAEZ", "name": "Ezeiza", "sources": ["aerodromeCard", "briefing"],
"status": "ok",
"metar": {
"raw": "METAR SAEZ 171400Z 35009KT CAVOK 21/10 Q1023 NOSIG",
"observedAt": "2026-09-17T14:00:00.000Z",
"ageMinutes": 12,
"flightCategory": "VFR",
"decoded": { "wind": { … }, "ceilingAglFt": null, "unparsed": [], "…": "…" }
},
"taf": {
"raw": "TAF SAEZ 171100Z 1712/1812 …",
"issuedAt": "…", "validFrom": "…", "validTo": "…",
"decoded": { … }
},
"provider": "NOAA Aviation Weather Center (aviationweather.gov)",
"fetchedAt": "2026-09-17T14:12:03.000Z"
},
{
"ident": "LEN", "name": "Escobar", "sources": ["aerodromeCard"],
"status": "no_icao_indicator",
"metar": null, "taf": null, "provider": "…", "fetchedAt": null
}
],
"meta": { … }
}status | Meaning |
|---|---|
ok | A METAR, a TAF, or both. Each is dated; nothing is dropped for being old. |
no_report | NOAA was asked and has nothing for this indicator. |
no_icao_indicator | The aerodrome is keyed on a national code; there is no station to ask. |
unavailable | NOAA could not be reached. Not the same as no weather. |
Why nothing is invented
decoded is the EFB's own decoder output, so the API and the screen cannot disagree about a ceiling. Groups the decoder does not understand are listed in unparsed, never guessed.
A report is never dropped for being old: each carries its time and ageMinutes, and whether it is too old is your decision. And the four statuses are kept apart on purpose — an aerodrome with no station to ask, and a provider that could not be reached, are not an aerodrome with no weather. provider names the source on every item.
Aerodrome knowledge
- GET
/v1/aerodrome-knowledge/{ident}Everything the EFB knows about one aerodrome - GET
/v1/aerodrome-knowledgeAerodromes and the pilot's TMA frequencies around a position
One answer for one aerodrome, joined on every code it answers to (SADM, MOR, whatever the pilot typed on the card): card — the pilot's own card, whole, with its date; reference — the bundled OurAirports record; madhel — ANAC's MADHEL page, its prose kept as prose; notams — ANAC's NOTAMs in force, at most 25 with total; weather — as /v1/weather/{ident}. Built for the RogerATC AI instructor, open to any integration.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/aerodrome-knowledge/SADM
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/aerodrome-knowledge?lat=-34.68&lon=-58.64&radiusNm=20"{
"data": {
"ident": "SADM", "asked": "SADM", "icao": "SADM", "localCode": "MOR",
"name": "Morón Airport", "generatedAt": "2026-10-12T12:00:00.000Z",
"card": {
"source": "The pilot’s own aerodrome card in Copilot EFB",
"updatedAt": "2026-10-01T10:00:00.000Z",
"record": { "code": "MOR", "frequencies": { "twr": "118.500", "tma1": "119.900" },
"taxiways": [{ "designator": "A" }], "…": "…" }
},
"reference": { "source": "OurAirports (ourairports.com), public domain",
"runways": [{ "designator": "02/20", "…": "…" }],
"frequencies": [{ "type": "TWR", "description": "Moron Torre", "mhz": "118.500" }] },
"madhel": { "source": "ANAC Argentina — MADHEL …", "status": "record",
"fetchedAt": "2026-10-12T11:58:40.000Z", "record": { "particularNorms": { "content": "…" }, "…": "…" } },
"notams": { "source": "ANAC Argentina / EANA — AIS NOTAM …", "status": "none",
"fetchedAt": "…", "sourceUpdatedAtText": "…", "total": 0, "items": [] },
"weather": { "ident": "SADM", "status": "ok", "…": "…" }
},
"meta": { "requestId": "…", "generatedAt": "…" }
}status (MADHEL · NOTAMs) | Meaning |
|---|---|
record · notams | ANAC answered: the page, or the NOTAMs in force. |
none | ANAC's own, dated absence: no page under that code, or not in ANAC's NOTAM index. The only status that means there is nothing. |
unknown | Outside ANAC's remit — a field abroad, or with no national code. Nothing was asked. |
unavailable | ANAC could not be reached. Not the same as none. |
The position form, lists the aerodromes and the pilot's cards around a point, nearest first, each with distanceNm, and areaFrequencies: the TMA sector frequencies the pilot wrote on cards within the radius, each value once, naming the card it came from. It asks no upstream; call the {ident} form for MADHEL, NOTAMs and weather. 400 for a code that is not 3–4 letters or digits, or a position, radius or limit out of range; 404 when the code is in none of the reference, the pilot's cards or the MADHEL.
| Parameter | Meaning |
|---|---|
lat | Latitude, decimal degrees, −90 to 90. Required. |
lon | Longitude, decimal degrees, −180 to 180. Required. |
radiusNm | Nautical miles, 1–100. Default 25. |
limit | Aerodromes returned, 1–20. Default 8. |
Why nothing is merged
A frequency the pilot typed and one a database publishes are two claims by two parties, so every block keeps its own source and its own date and none is folded into another. Airspace is not here: it comes from openAIP with the pilot's own key, and our servers never call a provider with a pilot's key. ANAC's data is relayed verbatim and attributed, per request; ANAC publishes no licence for the MADHEL API (checked 2026-10-12).
Notes
- GET
/v1/notesNotes (paged) - GET
/v1/notes/{id}One note - POST
/v1/notesCreate a note (write) - PATCH
/v1/notes/{id}Change a note (write) - PUT
/v1/notes/{id}Replace a note (write) - DELETE
/v1/notes/{id}Delete a note (write)
The kneeboard: every note with every field, including a handwritten note's image as a PNG data URL (imageDataUrl). Newest change first. Nothing in a note is parsed.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/notesWriting
title, body, kind, an optional PNG imageDataUrl, and aircraftId or flightId of this account. A blank note is refused, as the app discards one.
Checklists
- GET
/v1/checklistsChecklists (paged) - GET
/v1/checklists/{id}One checklist - POST
/v1/checklistsCreate a checklist (write) - PATCH
/v1/checklists/{id}Change a checklist (write) - PUT
/v1/checklists/{id}Replace a checklist (write) - DELETE
/v1/checklists/{id}Delete a checklist (write)
Every checklist the pilot built from their aircraft's documentation, with its sections and items. Sorted by aircraft, then by the pilot's own order. The EFB ships no checklist content: every one of these was written by the pilot.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
aircraftId | Only the checklists of this aircraft — an id from GET /v1/aircraft. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/checklists?aircraftId=ac-1"Writing
It must name one of the pilot's aircraft. sections[].items[] are checked field by field — challenge is required, and type is challengeResponse, check, value or note. It goes last in the aircraft's order unless order says otherwise.
Flight checks
- GET
/v1/check-flightsFlight checks (paged) - GET
/v1/check-flights/{id}One flight
One record per flight an aircraft's checklists were run on: startedAt, completedAt (absent while the flight is still open — many lists are run in the air), lists in that day's order, and summary: { total, done, missing: [{ checklist, section, challenge, critical }] }. The summary is taken as the flight goes, so it still says what was left unticked after a list is edited or deleted. autoClosed: true marks a flight the app closed rather than the pilot: one left open for more than twelve hours is closed at its own last activity, never at the moment it was noticed.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and change tracking. |
aircraftId | Only that aircraft's flights — an id from GET /v1/aircraft. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/check-flights?aircraftId=ac-1"Flight plans
- GET
/v1/flight-plansFlight plans (paged) - GET
/v1/flight-plans/{id}One flight plan - POST
/v1/flight-plansCreate a plan from fields (write) - PATCH
/v1/flight-plans/{id}Change, file or close a plan (write) - DELETE
/v1/flight-plans/{id}Delete a plan (write) - GET
/v1/flight-plans/{id}/validationThe app's validation and the FPL message
Every ICAO flight plan with every field — items 7 to 19, the route points, the supplementary information and the filing address. Newest departureDate first. A plan made from a planning carries planningId.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/flight-plansWriting
POST builds a plan from fields, as the EFB's assistant does: the aerodromes resolved to their indicators, route as field 15 ("DCT FDO W5 ROS DCT"), the aircraft's prefill from aircraftId, departureAt into field 13 and DOF/, cruiseAltitudeFt to a level, and reuseFrom (a plan id, or "latest") for the standing details of an earlier plan. Unknown fields are 422.
PATCH changes it field by field. status filed is accepted only while the validator reports no error; flown and cancelled close it. A plan whose flight is over is read-only, as in the app — only its date or a closing status; anything else is 409. Every answer carries validation.
GET …/validation is the app's own check — ICAO Doc 4444 Appendix 2, plus the Argentine practice for plans in Argentina: each issue with its ICAO field, a severity and the app's catalogue code; filable; and the FPL message as it would be sent. Conventions in Writing to the account.
{
"data": { "region": "AR", "filable": false,
"issues": [ { "field": "19", "severity": "error", "code": "flightPlan.issues.picRequired",
"message": "Pilot in command is required." } ],
"displayStatus": "draft", "editable": true, "expiresAt": "2026-10-10T14:33:00.000Z",
"message": "(FPL-LVABC-VG\n-C172/L-SDFGY/C\n-SADF1300\n-N0105A045 DCT FDO W5 ROS DCT\n-SAAR0133 SAAV\n-…)" },
"meta": { "requestId": "…", "generatedAt": "…" }
}Plannings
- GET
/v1/planningsPlannings (paged) - GET
/v1/plannings/{id}One planning - POST
/v1/planningsCreate a planning from departure, route, destination (write) - PATCH
/v1/plannings/{id}Change a planning (write) - DELETE
/v1/plannings/{id}Delete a planning (write) - GET
/v1/plannings/{id}/navlogIts navigation log, computed - POST
/v1/plannings/{id}/flight-planMake the ICAO flight plan from it (write)
Every route the pilot planned on the map: the points in order with their positions, the aircraft, the planned departure, the altitude, fuel on board, the reserve and the wind choice, and the flight plan it became (flightPlanId). departure, destination and waypoints mirror points. Newest change first.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/planningsWriting
Route elements are an identifier ("PAL"), { ident, kind } where a code names two things, { airway, to } along a published airway from the point before, or { lat, lon, name }. An identifier the EFB does not know is 422 unknown_point, an airway that does not join the two points 422 not_on_airway: never guessed.
The navigation log is computed on request, never stored: per leg distance, tracks, magnetic variation, heading, ground speed, time, fuel and ETA, then totals, reserve, endurance and missing — what would unlock a figure that is absent. POST …/flight-plan turns the planning into an ICAO plan as the app's Create flight plan does: 201 with the draft, its validation, and the planning's flightPlanId. The whole sequence is in A flight plan from A to Z.
Shared plannings
- GET
/v1/shared-planningsPlannings shared with a copilot - GET
/v1/shared-plannings/{id}One shared planning
Plannings the pilot plans together with a copilot, as owner or as a guest who accepted. doc is what both edit; participants[].personal is each pilot's own half — their aircraft, fuel and the plan they made from it. Provider keys lent between them are never stored on a planning and never returned. Read-only.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/shared-planningsAirways
- GET
/v1/airwaysATS routes (airways) from AIP Argentina
Argentina's lower and upper ATS routes as the app draws them, built from AIP Argentina ENR 3.1, 3.2 and 4.4; source names each document's edition. Each route has its points in published order and, per segment, distance, magnetic tracks, upper, lower and minimum limits and lateral limits — null wherever the AIP table did not read cleanly. Check ENR 3 before flight.
| Parameter | Meaning |
|---|---|
airspace | lower or upper; both when absent. |
designator | One route: W5, UL780. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" "https://api.rogeratc.app/v1/airways?designator=W5"Logbook
- GET
/v1/logbookLogbook entries (paged) - GET
/v1/logbook/totalsSummed hours, in minutes - GET
/v1/logbook/exportThe logbook as a CSV file - GET
/v1/logbook/{id}One entry - GET
/v1/logbook/{id}/attachments/{attachmentId}Download link for a photo on an entry - POST
/v1/logbookAdd hours: a new entry (write) - PATCH
/v1/logbook/{id}Change an entry (write) - PUT
/v1/logbook/{id}Replace an entry (write) - DELETE
/v1/logbook/{id}Delete an entry (write)
Every flight in the logbook. The ANAC logbook line (RAAC 61.120) is under log: the eight flight-time cells, the discriminación, simulator time, landings, approaches and the purpose code. Newest log.date first.
Durations are whole minutes — never decimal hours, never hh:mm. 90 is an hour and a half; format it however your service needs.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging — see Paging and following changes. |
from | Totals only. First log.date counted, YYYY-MM-DD, inclusive. Optional. |
to | Totals only. Last log.date counted, inclusive. Optional. |
format | Export only, required: anac-cad (ANAC's sheet column for column; ANAC publishes no CAD import format), easa, foreflight or generic-full (every field). Answers text/csv, not JSON. |
zone | Export only: the IANA zone anac-cad clock times are written in (America/Argentina/Buenos_Aires). Default UTC; EASA and ForeFlight are always UTC. |
delimiter | Export only: semicolon (decimal comma, Excel in Spanish — the default for anac-cad) or comma. ForeFlight is always comma. |
totals | Export only: true adds a totals line (not for foreflight). Default false. |
dateFormat | Export only: dmy (default) or mdy, for anac-cad and easa dates. The others are ISO. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" "https://api.rogeratc.app/v1/logbook?limit=100"Totals
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/logbook/totals?from=2026-01-01&to=2026-12-31"{
"data": {
"unit": "minutes", "from": "2026-01-01", "to": "2026-12-31",
"totals": {
"flight": 5130, "pilot": 5130, "copilot": 0, "day": 4800, "night": 330,
"local": 1200, "crossCountry": 3930, "instructorGiven": 0,
"instrumentReal": 0, "instrumentHood": 60, "multiEngine": 0,
"simulator": 120, "landings": 61, "entries": 38
},
"logged": {
"unit": "tenths", "total": 856, "crossCountry": 656, "local": 200,
"pilot": 856, "copilot": 0, "day": 801, "night": 55, "simulator": 20,
"instructorGiven": 0, "instrumentReal": 0, "instrumentHood": 10,
"multiEngine": 0, "landings": 61, "entries": 38
}
},
"meta": { … }
}data.logged holds the figures the Logbook screen shows: each flight's decimal hours — its cells rounded to the nearest tenth (1:50 is 1.8), unless the pilot wrote their own figure (loggedTenths on the line) — summed so that crossCountry + local, pilot + copilot and day + night always equal total. In tenths of an hour ("unit": "tenths", integers: 18 is 1.8 h). simulator is separate and not part of the total. data.totals, in minutes, is unchanged.
Computed by the same function as the EFB's Logbook screen, so the two cannot disagree. The discriminación cells are a breakdown of hours already counted in the flight-time cells and are never added to flight; simulator time is not flight time. A flight with no logbook line is not counted — entries says how many were — and a missing cell counts as zero.
Writing
The body is one logbook line. date is required; kind is local (default), crossCountry or simulator; role is pilot (default) or copilot. Cells take whole minutes, or "1:45" and "1.75". The aircraft is aircraftId or the profile whose registration matches. It is validated as the Logbook screen validates a line, and the app's own warnings come back as warnings. Example in Add hours to the logbook.
Photos
attachments on an entry lists the photos the pilot assigned to the flight (always kind: "photo", at most twelve). GET /v1/logbook/{id}/attachments/{attachmentId} (1.36.0) works like the aerodrome one: the entry plus a presigned HTTPS link valid for 15 minutes, fetched without the API key; 404 when the entry does not list that id or the file has not been uploaded yet. Photos are added and removed in the app only, and deleting the entry deletes its photos.
Aviation theory
- GET
/v1/ground-schoolThe theory path and where the pilot is in it
Every lesson of Aviation theory (the EFB’s theory course), in path order, with the pilot’s progress in each: status (notStarted, inProgress, completed), when it was started and finished, the step they are on (position: intro, s:<section>, x:flashcards|practice|quiz, summary) and their best exercise scores. summary counts them and next names the next lesson. Lesson ids are stable; a lesson is added, never renamed. title reads exactly as on the app’s screen, in both languages.
findings maps each RogerATC debrief finding id to the lessons that explain it, most specific first — the same table the EFB’s debrief shows. Recommend only lessons with hasContent: true.
Not returned: the time spent studying and the days studied. Read scope only; progress moves only by the pilot’s taps in the app.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/ground-school{
"data": {
"summary": { "completed": 3, "inProgress": 1, "total": 154, "percent": 1 },
"next": "foundations.forcesAndMotion",
"lessons": [
{
"id": "foundations.cockpitArithmetic", "order": 0,
"level": "foundations", "category": "foundations",
"title": { "en": "Cockpit arithmetic: proportion, rates and tables",
"es": "Aritmética de cabina: proporciones, ritmos y tablas" },
"estimatedMinutes": 30, "hasContent": true, "prerequisites": [],
"status": "completed",
"startedAt": "2026-10-19T12:00:00.000Z",
"completedAt": "2026-10-19T12:41:00.000Z",
"lastActivityAt": "2026-10-19T12:41:00.000Z",
"position": "summary",
"exercises": {
"foundations.cockpitArithmetic/quiz": { "bestScore": 0.9, "passed": true, "attempts": 2 }
}
}
],
"findings": {
"fd-bank": ["aerodynamics.turnsAndLoadFactor", "foundations.forcesAndMotion"]
}
}
}Transit sessions
- GET
/v1/transit-plansInstructed transit session plans (paged) - GET
/v1/transit-plans/{id}One transit session plan - GET
/v1/transit-runsRuns of transit sessions the plugin reported (paged) - GET
/v1/transit-runs/{id}One run — the resume point after X-Plane closed
An instructed transit session (1.38.0) is a step-by-step training session the pilot plans in Copilot EFB and flies in X-Plane with RogerATC: the controller gives one part of the plan, the pilot flies it and reports, the controller gives the next. Two records, each with one writer.
transitPlan is what the pilot authored: the aircraft, the flight rules, departure and destination, up to 60 steps in order — each an action (the transit clearance, a phase of flight, one of the console's instructions or an instructor's manoeuvre), who gives it, how it ends (readback, a report or a measurement), hold laps, approach minima and targets — and the emergency and position-request settings. Most recently edited first. No write route: nothing but the pilot changes what a session asks them to fly.
transitRun is one execution, written by the server from the plugin's PUT /v1/plugin/transit-runs/{id}: the status, progress per step with what was said and what was measured (a measurement not taken is null, never 0), the interrupts (position requests, emergencies), and the transcript, up to 600 lines filed by step (transcriptDropped counts the rest). Newest startedAt first.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging. updatedSince is the way to follow a run in progress. |
Deleting a session in the app deletes the plan and every run of it: both then answer 404 here, and the plugin's next PUT for one of its runs answers 410.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/transit-plans/PLAN_ID
curl -s -H "Authorization: Bearer $ROGER_API_KEY" "https://api.rogeratc.app/v1/transit-runs?limit=5"Pilot profile
- GET
/v1/pilotThe pilot profile
Name, telephone, licences, ratings and their expiry, and the medical certificate — or data: null when the pilot has not created a profile. The same profile the EFB shows, and the most sensitive thing the key can read.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/pilotRogerATC AI plugin
RogerATC AI, the voice ATC plugin for X-Plane 12, is linked to the pilot's Copilot EFB account by this key: it activates with it at every start, fetches the provider keys the pilot keeps in the EFB, sends a summary of each simulator session — always the statistics, and the event log if the pilot chooses — and, with the live link on, reports its state and collects the instructor's instructions. The EFB stores the sessions in the account, so they appear on every device the pilot is signed in on.
With the same key the plugin reads what the pilot already keeps in the EFB, through the endpoints above, and the pilot's unread messages, which its instructor reads aloud. None of the plugin's routes needs the write permission.
RogerATC AI is in public beta. This section is the contract its EFB link is built against.
Activation
- POST
/v1/plugin/activationRogerATC's licence check: the account and the names of its keys
Called by the plugin at every start (client: "core") and by RogerATC Setup when the pilot links or tests the key (client: "setup"). A valid key on an account that is not paused is the licence. The answer says whose account it is and which provider keys it holds — never their values. The body is at most 8 KB; a paused account is 403 account_suspended.
curl -s -X POST https://api.rogeratc.app/v1/plugin/activation \
-H "Authorization: Bearer $ROGER_API_KEY" -H "Content-Type: application/json" \
-d '{ "schema": 1, "client": "setup", "installId": "9f1c2d3e-0000", "pluginVersion": "1.3.0-beta",
"os": "macos", "arch": "arm64" }'{
"schema": 1, "ok": true,
"account": { "id": "…", "name": "A. Pilot", "email": "pilot@example.com" },
"credentials": { "available": ["openai", "openaip"] },
"serverTime": "2026-10-09T13:00:00.000Z",
"data": { "…": "the same object, in the usual envelope" },
"meta": { "requestId": "…", "generatedAt": "…" }
}Provider keys
- GET
/v1/plugin/credentialsThe provider keys RogerATC uses, from the pilot's Settings
The keys the pilot entered in Copilot EFB → Settings → Keys used by RogerATC: openai (required), openaip, windy, flightradar24, tavily and, since 1.25.0, anthropic, xai and openrouter — the assistant's own keys, for a pilot who chooses one of them as RogerATC's language model. A plugin keeps only the names it knows. Only the ones present are returned, with Cache-Control: no-store. The server records that they were fetched and which names — never a value. Each key goes only to its own provider; RogerATC keeps it in the system keychain.
Turn feedback
- GET
/v1/plugin/feedbackAn administrator's ratings of RogerATC turns, as a training dataset - POST
/v1/plugin/feedback/appliedMark ratings taken into a plugin version
Since 1.22.0. An administrator rates RogerATC turns in the app, on the transcript of a live or archived session; this is how the plugin's side reads those ratings and says it has learned from them. A turn is one pilot transmission and everything that answered it. Each example carries the turn's lines, its context (language, region, plugin version, aircraft, aerodrome, station, the intent and template recognised), the rating — up, or down with a correction and its scope — an optional model review, and its status.
GET /v1/plugin/feedback, with status = pending (the default), applied or all, answers the dataset; any key, and only an administrator's account ever holds ratings, so anybody else gets an empty one. POST /v1/plugin/feedback/applied with { "ids": […], "version"?, "note"? } (at most 200 ids) marks them applied and needs a key allowed to write (403 insufficient_scope otherwise). Both are Cache-Control: no-store.
Messages
- GET
/v1/plugin/messagesThe pilot's unread messages, for the instructor to read aloud - POST
/v1/plugin/messages/{id}/readMark one read, on every device
The pilot's unread inbox, oldest first: the sender's name — never an address — whether it came from an administrator or to everyone, an optional subject, the body cut at 1,000 characters, and when it was sent. unread counts them all. Nothing else about messages is in the API: no sent copies, no threads, no sending.
| Parameter | Meaning |
|---|---|
limit | 1–20, default 10. |
POST …/read marks one read exactly as opening it in the app does, on every device. It answers 204 with no body — also when it was already read — and 404 for anything that is not this pilot's inbox.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" "https://api.rogeratc.app/v1/plugin/messages?limit=10"
curl -s -X POST -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/messages/MESSAGE_ID/read{
"data": [ { "id": "6f1c…", "from": "A. Copilot", "fromAdministrator": false, "broadcast": false,
"body": "Tomorrow 1330Z from SADF, let me know if you are coming.",
"sentAt": "2026-10-09T14:03:00.000Z" } ],
"unread": 3,
"meta": { "requestId": "…", "generatedAt": "…" }
}Store a session
- PUT
/v1/plugin/sessions/{id}Store a RogerATC AI session
An idempotent upsert of one whole session. Send it at the start, at a checkpoint every few minutes while something changed, and once at the end — always the whole session, always under the same id. A retry after a dropped connection is harmless.
| Parameter | Meaning |
|---|---|
{id} | The plugin's session id, stable for the flight: 3 to 128 characters of A–Z a–z 0–9 . _ -, starting with a letter or a digit. |
PUT /v1/plugin/sessions/5f0c2a4e-7d1b-4c6a-9d0e-2b8f1c3a6e77 HTTP/1.1
Host: api.rogeratc.app
Authorization: Bearer rat_live_…
Content-Type: application/json{
"schema": 1,
"status": "completed",
"startedAt": "2026-09-17T18:02:11Z",
"endedAt": "2026-09-17T19:14:40Z",
"pluginVersion": "0.4.0",
"protocolVersion": "1",
"simulator": "X-Plane 12.1.4",
"language": "es",
"region": "AR",
"dataSource": "both",
"aircraft": { "registration": "LV-XXX", "icaoType": "C172" },
"departure": "SADF",
"arrival": "SAAR",
"aerodromesVisited": ["SADF", "SAAR"],
"stats": {
"transmissions": 42, "fastPath": 30, "modelCalls": 12, "sayAgain": 2,
"readbacksCorrect": 17, "readbacksIncorrect": 1, "positionCorrections": 0,
"unprompted": 4, "emergencies": 0, "instructorQuestions": 3,
"meanResponseMs": 1850, "p95ResponseMs": 3400,
"byStation": { "ground": 9, "tower": 14, "approach": 11, "centre": 8 },
"byIntent": { "request_taxi": 2, "ready_departure": 1, "position_report": 6 }
},
"events": [
{
"at": "2026-09-17T18:04:02Z", "kind": "turn",
"station": "San Fernando Superficie", "intent": "request_taxi", "template": "taxi-clearance",
"heard": "San Fernando superficie, LV-XXX en plataforma, solicito rodaje",
"said": "LV-XXX, ruede a punto de espera pista 05, QNH 1018"
}
]
}Body fields
| Field | Required | Rules |
|---|---|---|
schema | yes | 1. |
startedAt | yes | ISO 8601. Not more than a day in the future. |
endedAt | no | ISO 8601, or null while flying. |
status | no | in_progress, completed or aborted. Absent: completed when endedAt is set, otherwise in_progress. |
pluginVersion, protocolVersion, simulator, language, region | no | Short strings, trimmed. language and region have their case normalised. |
dataSource | no | sim, both or efb — where the plugin took aerodrome data from. Anything else is stored as null. |
aircraft | no | { registration, icaoType }, upper-cased. |
departure, arrival | no | An aerodrome identifier: 3–4 of A–Z 0–9 (ICAO, or a national code where there is none). Anything else is stored as null. |
aerodromesVisited | no | Up to 20 identifiers, deduplicated. |
stats | no | The ten counters in the example, whole and non-negative (anything else counts as 0); meanResponseMs and p95ResponseMs or null; byStation up to 30 keys and byIntent up to 60, keys matching [a-z0-9][a-z0-9_.-]{0,39}, largest kept. |
events | no | Only with the event log enabled. Up to 200, newest kept. kind: turn, unprompted, silence, error or instructor; at required; station, intent, template; heard cut at 160 characters and said at 240. Events of an unknown kind or without a valid at are dropped. |
eventsDropped | no | What the plugin already dropped before sending; added to the server's own count. |
aiUsage | no | The session's AI usage, cumulative, one line per provider, model and kind (llm, stt, tts, search), at most 40: requests, tokens, audio seconds — the provider's own counts, never estimated. The EFB prices them so the pilot sees what their own keys are spending. Re-sending a summary never counts twice. |
Anything else in the body is ignored and not stored. Nothing derived from X-Plane's scenery or navigation data belongs in a session — and no audio and no provider keys.
Limits
- The body is at most 512 KB; above it,
413. - The stored session is at most 200 KB: the oldest events are removed until it fits, and
eventsDroppedcounts them. - One record per session — never one per radio call.
Responses
| Status | Body | Meaning |
|---|---|---|
201 | { id, status, receivedAt, eventsStored, eventsDropped } | The first time this id was stored. |
200 | the same | The stored copy was replaced. createdAt is kept from the first arrival. |
400 | error | A field broke a rule above; the message names it. |
410 | error gone | The pilot deleted this session in the EFB. Stop sending it — it will never be stored again. |
413 · 415 | error | Too large, or not JSON. |
401 · 429 | error | The key, the rate limit, or the quota of 50 new sessions a UTC day. A PUT every few minutes under the same id is far inside both. |
curl -s -X PUT \
-H "Authorization: Bearer $ROGER_API_KEY" \
-H "Content-Type: application/json" \
--data @session.json \
https://api.rogeratc.app/v1/plugin/sessions/5f0c2a4e-7d1b-4c6a-9d0e-2b8f1c3a6e77HTTP/1.1 201 Created
{
"data": {
"id": "5f0c2a4e-7d1b-4c6a-9d0e-2b8f1c3a6e77",
"status": "completed",
"receivedAt": "2026-09-17T19:14:42.018Z",
"eventsStored": 1,
"eventsDropped": 0
},
"meta": { … }
}The plugin's side of the contract
- The simulator never waits on the API. Requests leave from a queue on disk, in the background, with a short timeout and back-off, off the audio and simulator threads. A failure, a timeout or no network is silence — never a stalled simulator.
401means the key was rotated or the account paused: stop sending, and tell the pilot once.410means the pilot deleted that session: drop it from the queue and never send it again.429means wait forRetry-Afterbefore the next attempt.
Live link
- PUT
/v1/plugin/liveReport live state and collect waiting instructions
While the pilot flies with the live link on in the plugin (efb_live = on, off by default), the plugin calls this route every few seconds with its measured state — position, altitude, speeds, heading, on the ground or airborne, COM1, transponder, QNH, wind — and with the outcome of every instruction it dealt with. The answer carries the instructions an instructor left on the EFB's RogerATC console, and how long to wait before calling again (pollMs).
It is not a synced record: the state is overwritten on every call and the server forgets it after ten minutes. A track is never kept. Navaids, frequencies and runways do not travel: they come from the simulator's navigation data, whose licence forbids them leaving the pilot's machine, and the EFB computes them from its own public database.
Each instruction is handed over once. One the plugin has not collected within two minutes expires and is never delivered late. The plugin answers in its next report with spoken and the exact words the controller said, or refused and a reason (on_ground, unknown_navaid, no_dme…). The plugin's engine writes every word; the EFB only asks.
Since 1.38.0 the answer also carries transit: the armed transit session — { planId, armedAt, runId } — or null (nothing armed, an arm left untouched for 24 hours, or one whose plan was deleted). Read the plan with GET /v1/transit-plans/{id} and say nothing until the pilot calls for the transit; runId set means a run was started — read it with GET /v1/transit-runs/{id} and resume from currentStepIndex. Three instruction kinds control the session from the EFB: transitSkip { runId, stepId } (end the active step and give the next), transitAbort { runId } (end the session and restore anything injected) and transitEmergency { runId, emergency } (inject one emergency now). A plugin without transit sessions refuses them not_supported.
curl -X PUT https://api.rogeratc.app/v1/plugin/live \
-H "Authorization: Bearer $COPILOT_EFB_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "schema": 1, "sessionId": "2026-10-03_1415", "sentAt": "2026-10-03T14:15:02Z",
"aircraft": { "registration": "LV-XXX", "icaoType": "C172" },
"sim": { "paused": false, "phase": "cruise", "onGround": false,
"latDeg": -34.6, "lonDeg": -58.7, "altitudeFt": 2500, "headingMagDeg": 270,
"groundspeedKt": 95, "verticalSpeedFpm": 0, "…": "…" },
"aerodrome": { "ident": "SADF", "activeRunway": "05" },
"transcript": [], "acks": [] }'{
"data": {
"commands": [
{ "id": "1759500902000-x7Kq2m9A", "createdAt": "2026-10-03T14:15:00Z",
"request": { "kind": "holding", "navaid": "SFD", "inboundCourseDeg": 50,
"turn": "right", "legMinutes": null, "altitudeFt": 2500 } }
],
"pollMs": 2000,
"transit": { "planId": "3f0c…", "armedAt": "2026-10-21T13:55:00.000Z", "runId": null }
}
}Store a transit run
- PUT
/v1/plugin/transit-runs/{id}Store a run of an instructed transit session
The plugin's write: an idempotent upsert of one whole run — at the start, each time a step moves, on every interrupt and at the end — under the same id (3–128 of A–Z a–z 0–9 . _ -). The body is a run, schema: 1, at most 400 KB; unknown fields are dropped, currentStepIndex is clamped to the steps sent, and the oldest transcript lines go past 600 or 250 KB.
{
"schema": 1,
"planId": "3f0c…",
"planUpdatedAt": "2026-10-21T12:00:00.000Z",
"status": "in_progress",
"startedAt": "2026-10-21T14:00:00.000Z",
"currentStepIndex": 1,
"steps": [
{ "stepId": "s0a1b2c3d4e", "status": "done", "issuedAt": "…", "completedAt": "…", "completedBy": "readback",
"said": "LV-XXX autorizado a San Fernando…", "metrics": { "durationS": 42, "samples": 42, "readbackCorrect": true } },
{ "stepId": "s9z8y7x6w5v", "status": "active", "issuedAt": "…" }
],
"interrupts": [],
"transcript": [{ "at": "…", "who": "atc", "station": "Morón Torre", "text": "…", "stepId": "s0a1b2c3d4e" }]
}| Status | Meaning |
|---|---|
201 · 200 | Stored (the first time / after). data: { id, status, receivedAt, currentStepIndex }. |
400 | A malformed body or id, or a planId different from the one the run was started with. |
409 not_armed | A new run for a plan the pilot has not armed. A run starts only after the pilot taps Ready; the live answer's transit names the armed plan. Re-sending an existing run never needs the arm. |
410 gone | The pilot deleted this run, or its plan is missing or deleted. End the session and do not send it again. |
429 rate_limited | Past 20 new runs in a UTC day, or past 3,000 writes of one run (the run stays as last stored). |
The first PUT names the run on the arm (transit.runId), every PUT while in_progress renews the arm for 24 hours, and completed or aborted clears it. A run that is completed or aborted is final: a later PUT answers 200 with the stored run and changes nothing.
curl -s -X PUT -H "Authorization: Bearer $ROGER_API_KEY" -H "Content-Type: application/json" \
--data @run.json https://api.rogeratc.app/v1/plugin/transit-runs/RUN_IDRead sessions
- GET
/v1/plugin/sessionsRogerATC AI sessions (paged) - GET
/v1/plugin/sessions/{id}One RogerATC AI session
Every stored session, newest startedAt first, as stored: the body fields above plus id, source (rogeratc-plugin), durationMinutes (start to end, or to the last arrival while in progress), eventsDropped, receivedAt, createdAt and updatedAt.
| Parameter | Meaning |
|---|---|
limit · cursor · updatedSince | Paging. updatedSince is the way to follow sessions still in progress. |
curl -s -H "Authorization: Bearer $ROGER_API_KEY" \
"https://api.rogeratc.app/v1/plugin/sessions?updatedSince=2026-09-17T18:00:00Z"Totals
- GET
/v1/plugin/statsTotals over every RogerATC AI session
The same totals the EFB's RogerATC AI screen shows. minutes is the sum of every session's durationMinutes. meanResponseMs is weighted by each session's transmissions, and null when nothing was timed.
curl -s -H "Authorization: Bearer $ROGER_API_KEY" https://api.rogeratc.app/v1/plugin/stats{
"data": {
"sessions": 12,
"byStatus": { "in_progress": 0, "completed": 11, "aborted": 1 },
"minutes": 842, "transmissions": 506,
"readbacksCorrect": 201, "readbacksIncorrect": 9,
"sayAgain": 14, "emergencies": 1, "instructorQuestions": 37,
"meanResponseMs": 1910,
"firstStartedAt": "…", "lastStartedAt": "…",
"byStation": { "tower": 180, "ground": 120, "approach": 110, "centre": 96 },
"aerodromes": [{ "ident": "SADF", "sessions": 9 }],
"aircraft": [{ "label": "LV-XXX", "sessions": 10 }]
},
"meta": { … }
}Versions and changes
Paths carry the major version. New routes, new fields and new status values are additive and stay in /v1, so a client should ignore what it does not recognise. Anything that would break a client that follows this page goes to a new major version, and /v1 stays until its users have moved.
| Version | Date | Change |
|---|---|---|
1.50.0 | 2026-11-20 | The pilot profile may carry bloodGroup and emergencyContacts, and a planning aircraftRegistration for an aircraft outside the fleet. Records are returned whole, so no route changed. Additive. |
1.49.0 | 2026-11-20 | A dmeArc command may carry joinRadialDeg, the radial the arc is joined on (live link revision 3); the plugin's report adds a turbine's powerplant: engine kind, N1, N2, ITT, torque, the APU, fire warnings and hydraulics (protocol v24). All additive. |
1.48.0 | 2026-11-19 | Aerodrome cards may carry activities (gliders, parachuting, model aircraft, drones) and /v1/aerodrome-knowledge lists them in card.activities. Commands and transit steps accept the procedureTurn90 reversal (90°/270°, for training, not ICAO) and a step's metrics gain the hold as flown (entry, legs, fastest speed). The live report carries linkVersion: a command received during a pause is held and may be cancelled; the transitRefresh command, pool: true plans, each step's rev and the abandoned status make the training queue. Additive. |
1.47.0 | 2026-11-19 | GET /v1/aerodrome-knowledge gains two blocks: ils, the ILS the Argentine AIP publishes (AD 2.19) per runway — ident, localizer and glide path frequencies, category, angle, reference height and DME channel — with the document, its edition and date; and areaWeather, the aerodrome's FIR and the SIGMETs in force there. Additive. |
1.46.0 | 2026-11-18 | A transit session plan (GET /v1/transit-plans) may carry pilotLevel: "novice" (absent: expert), and its departure and destination may be the same aerodrome: a local session. Additive. |
1.45.0 | 2026-11-17 | GET /v1/pilot returns simbriefUsername, the pilot's SimBrief alias when they set one (not a secret). A plan imported from SimBrief carries its route in routeOverride with the SID first and the STAR last. Additive. |
1.44.0 | 2026-11-14 | PUT /v1/plugin/live accepts nine RogerATC protocol v23 fields: the NAV1 TO/FROM flag, bearing to the station, course and glideslope needles, ADF1, the HSI's source and needles, and the GPS leg. Additive. |
1.43.1 | 2026-11-13 | GET /v1/weather and the weather block of /v1/aerodrome-knowledge: when NOAA fails, a METAR or TAF the API already held is still answered, with the fetchedAt it was fetched at, and NOAA is not asked again for a minute. No shape change. |
1.43.0 | 2026-11-06 | PUT /v1/plugin/live accepts sixteen RogerATC protocol v22 fields (throttle, propeller lever and manifold pressure per engine, the cabin, pitot heat and ice, heading indicator, compass and suction, flight director and autopilot modes, the gear); sim.temperatureC and dewpointC are the air at the aeroplane. New debriefing finding fd-pitot-heat-icing. Additive. |
1.42.0 | 2026-11-04 | PUT /v1/plugin/live accepts sim.engineCount, engineRunning, propRpm and rudderRatio (RogerATC protocol v21). Additive. |
1.41.0 | 2026-10-28 | The session debriefing may carry two new findings: fd-squawk-mismatch (assigned, seconds) and fd-transponder-standby (seconds). Additive. |
1.40.0 | 2026-10-28 | PUT /v1/plugin/live accepts sim.rollDeg, pitchDeg, slipDeg, turnRateDegPerSec and loadFactorG (RogerATC protocol v20). Transit sessions gain manoeuvres, take-off and landing techniques, stopAndGo, the partialPower emergency, the refusal unsupported and new step metrics. Additive. |
1.39.0 | 2026-10-27 | PUT /v1/plugin/live accepts sim.trackTrueDeg, sim.fuelFlowKgPerHour and sim.maxTakeoffMassKg (RogerATC protocol v19). Additive. |
1.38.0 | 2026-10-21 | GET /v1/transit-plans, /v1/transit-plans/{id}, /v1/transit-runs and /v1/transit-runs/{id} — instructed transit sessions and their runs. PUT /v1/plugin/transit-runs/{id}, the plugin's write, with the new code 409 not_armed. PUT /v1/plugin/live answers transit. New instruction kinds transitSkip, transitAbort and transitEmergency. Additive. |
1.37.0 | 2026-10-19 | GET /v1/ground-school — the lessons of Aviation theory and the pilot’s progress in each, with the lessons that explain each debrief finding, for RogerATC’s instructor. Study time and study days are not returned. Additive. |
1.36.0 | 2026-10-17 | GET /v1/aerodrome-knowledge/{ident}: a well-formed code no source knows is 200 with known: false, not 404; new known and world. GET /v1/logbook/{id}/attachments/{attachmentId} for photos on a logbook entry. Comments gain subject, file and hasFile. PUT /v1/plugin/live takes sim.cloudLayers. Deleting a record deletes the files it listed. Additive. |
1.35.0 | 2026-10-16 | GET /v1/aerodrome-knowledge/{ident}: reference gains use, controlled, classificationSource, classificationAsOf and codePair; aerodrome cards may carry use and controlled. Additive. |
1.34.0 | 2026-10-16 | Aerodrome comments gain thumbUrl, always null here like photoUrl. Additive. |
1.33.0 | 2026-10-16 | GET /v1/aerodrome-comments/{ident} — approved pilot comments on an aerodrome, plus this account’s own. Plannings take refuel stops (refuel, refuelFuel); the navigation log adds segments; POST /v1/plannings/{id}/flight-plan takes leg. Additive. |
1.32.0 | 2026-10-15 | GET /v1/logbook/export: the EASA and ForeFlight date column is the UTC date of the off-block time. PATCH/PUT /v1/logbook/{id} keep an imported line’s origin. A correction and an addition. |
1.31.0 | 2026-10-15 | GET /v1/logbook/export?format= returns the logbook as CSV through the screen's own function: anac-cad (ANAC's sheet column for column; ANAC publishes no CAD import format), easa, foreflight or generic-full (every field). Lines may carry log.origin (imported from a photo or a CSV). Additive. |
1.30.0 | 2026-10-15 | Aircraft profiles may carry landingDistance and its unit, and the weight the POH distances are for (takeoffDistanceWeight, landingDistanceWeight). Additive. |
1.29.0 | 2026-10-15 | Turn feedback takes a note on a thumb up (confirmation), keeps the correction across a flip and counts pending and applied per rating (counts.byRating). Profiles may carry maxFuelImbalanceKg and fuelReserveMinutes; the debriefing has four more findings. Additive. |
1.28.0 | 2026-10-15 | A per-account switch for whether RogerATC may read the provider keys: off, GET /v1/plugin/credentials answers 403 credentials_disabled and activation carries credentials.allowed: false. Additive. |
1.27.0 | 2026-10-14 | PUT /v1/plugin/sessions/{id} accepts an optional debrief — the copilot's debriefing: minutes in the air, take-offs, landings and findings ranked safety first with their figures — stored on the session. Aircraft profiles may carry speeds.v1, flapRetractionHeightFt and turnbackMinimumAglFt, read by the take-off briefing. Additive. |
1.26.0 | 2026-10-14 | PUT /v1/plugin/live answers serverTime, to measure a command's age on the server's clock, and a command reaches only the session it was posted in. Turn-feedback examples carry updatedAt, and POST /v1/plugin/feedback/applied accepts seen and answers changed: a rating edited since it was read stays pending. At one instant, the pilot's transmission sorts before its answer. Activation always answers email as text. Additive. |
1.25.0 | 2026-10-14 | GET /v1/plugin/credentials also returns anthropic, xai and openrouter — the assistant's own keys — for RogerATC 1.9 beta's choice of language model, and the activation's credentials.available names them. Additive. |
1.24.0 | 2026-10-13 | Aerodrome cards: frequencies.tma, a list of { id, name, frequency } the pilot names, supersedes the fixed tma1…tma5; writes accept it and fold the old slots into it; /v1/aerodrome-knowledge area frequencies carry the pilot's name. Additive. |
1.23.0 | 2026-10-12 | PUT /v1/plugin/sessions/{id}: stats may carry retries, standbys and callbacks; GET /v1/plugin/stats sums them. Additive. |
1.22.0 | 2026-10-12 | GET /v1/plugin/feedback and POST /v1/plugin/feedback/applied — an administrator's turn ratings as a training dataset. Additive. |
1.21.0 | 2026-10-12 | Logbook writes accept a simulator session's simulatorDevice, simulatorClass, manoeuvres and manoeuvresOther. Additive. |
1.20.0 | 2026-10-12 | Shared plannings take up to three guests, each a viewer or an editor; each participant carries access. Additive. |
1.19.0 | 2026-10-12 | GET /v1/aerodrome-knowledge/{ident} — the pilot's card, the OurAirports reference, ANAC's MADHEL and NOTAMs, and the weather for one aerodrome, each sourced and dated; GET /v1/aerodrome-knowledge — aerodromes and the pilot's TMA frequencies around a position. Read-only, additive. |
1.18.0 | 2026-10-09 | Writes, with a key the pilot allowed to write: logbook entries (adding hours), aircraft, aerodrome cards, notes, checklists, plannings and flight plans; GET /v1/plannings/{id}/navlog, POST /v1/plannings/{id}/flight-plan, GET /v1/flight-plans/{id}/validation. Idempotency-Key, ETag and If-Match. New error codes insufficient_scope, conflict, precondition_failed, unprocessable, unavailable. 1,000 writes per account per day. |
1.17.0 | 2026-10-09 | GET /v1/plugin/messages and POST /v1/plugin/messages/{id}/read: the unread inbox, for RogerATC's instructor to read aloud. Plugin sessions accept aiUsage. Additive. |
1.16.0 | 2026-10-08 | Live link: twenty optional measured fields — the altimeter setting, wind layers, COM2 and standbys, fuel and mass, flaps, gear, autopilot, the simulator's traffic. A malformed path answers 400 instead of 500. A refused session no longer spends the daily quota. |
1.15.0 | 2026-10-07 | POST /v1/plugin/activation (RogerATC's licence check) and GET /v1/plugin/credentials (the provider keys it uses). New error code account_suspended, on those two routes only. Additive. |
1.14.0 | 2026-10-06 | Live link: ten IFR instruction kinds — bearing, direct, approach, vectors, circling, side-step, missed approach, departure, arrival, diversion — and new hold and course-reversal options. Additive. |
1.13.0 | 2026-10-06 | Airways carry segments: tracks, limits and minimum level per segment. A planning point may be a bare position. Additive. |
1.12.0 | 2026-10-05 | GET /v1/shared-plannings, GET /v1/shared-plannings/{id} and GET /v1/airways. A planning point may be a significant point and name the airway flown into it. Additive. |
1.11.0 | 2026-10-03 | GET /v1/plannings and GET /v1/plannings/{id}: the routes planned on the map. A flight plan made from a planning carries planningId. Additive. |
1.10.0 | 2026-10-03 | PUT /v1/plugin/live: the RogerATC AI live link — the simulator's measured state, and the instructor's instructions. The API's second write, with state that expires and never syncs. Additive. |
1.9.0 | 2026-09-24 | /v1/logbook/totals adds data.logged, the decimal hours in tenths that the Logbook screen shows. Lines may carry loggedTenths. Additive. |
1.8.0 | 2026-09-22 | Flight plans carry signatureDataUrl, that plan's signature. Flight checks carry autoClosed. Additive. |
1.7.0 | 2026-09-19 | Aircraft carry attachments — manuals, documents and photos — and GET /v1/aircraft/{id}/attachments/{attachmentId} returns a short-lived download link. Per-file limit: 100 MB. Additive. |
1.6.0 | 2026-09-18 | Flight checks: GET /v1/check-flights and GET /v1/check-flights/{id}. Additive. |
1.5.0 | 2026-09-18 | Aerodrome cards carry aids (radio and visual aids) and fuel.products (oils and additives). Additive. |
1.4.0 | 2026-09-18 | Aerodrome cards carry attachments, and GET /v1/aerodromes/{id}/attachments/{attachmentId} returns a short-lived download link. Additive. |
1.3.1 | 2026-09-17 | Security pass: least privilege for the API, a daily quota of new plugin sessions, and an account reset rotates its key. |
1.3.0 | 2026-09-17 | Aerodrome cards carry fuel. Additive. |
1.2.0 | 2026-09-17 | Checklists: GET /v1/checklists and GET /v1/checklists/{id}. RogerATC AI plugin sessions: PUT /v1/plugin/sessions/{id} (the first write), GET /v1/plugin/sessions, GET /v1/plugin/sessions/{id} and GET /v1/plugin/stats. New error codes gone, payload_too_large and unsupported_media_type. 405 lists the allowed methods. |
1.1.0 | 2026-09-17 | Aerodrome cards carry taxiways. Additive: no route and no existing field changed. |
1.0.0 | 2026-09-17 | First release: the personal key, and read-only routes for aerodromes, aircraft, weather, notes, flight plans, the logbook and its totals, and the pilot profile. |