{ "openapi": "3.1.0", "info": { "title": "AIS-catcher", "version": "v0.70", "description": "Vessels, places and events as this station hears them. Positions are what ships broadcast; not for navigation.\n\nEvery list answers {\"data\": [...], \"meta\": {...}}: meta.next is the request for the next page, null on the last. A list that changes over time also gives meta.poll, the request for what came after, to send again later. A cursor is opaque: send it back as it came. A cursor that points at what is no longer kept is answered 410: start again without it. Times are UTC, and units are in the field names. A field that is not known is null. Errors are problem details (RFC 9457). A server with keys takes them as Authorization: Bearer." }, "tags": [ { "name": "Vessels", "description": "The vessels heard lately, one in full, its track and its visits" }, { "name": "Places", "description": "Ports, terminals, berths and zones, the vessels inside and the visits" }, { "name": "Events", "description": "Safety messages, new destinations and statuses, arrivals and departures" }, { "name": "Stations", "description": "The receiving stations and their figures" }, { "name": "Aircraft", "description": "Aircraft heard by ADS-B" }, { "name": "System", "description": "The installation, its receivers, outputs, log and health; the system service, behind the system scope" }, { "name": "API", "description": "This API itself" } ], "security": [ { "key": [] }, {} ], "paths": { "/api/v1": { "get": { "operationId": "getIndex", "tags": [ "API" ], "summary": "What this API offers.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Index" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/stations": { "get": { "operationId": "listStations", "tags": [ "Stations" ], "summary": "The receiving stations; a station that keeps its position private has none here.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StationList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/stations/{id}": { "get": { "operationId": "getStation", "tags": [ "Stations" ], "summary": "One station: where it is and how many vessels it heard in the last hour.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The station's number", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Station" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/stations/{id}/statistics": { "get": { "operationId": "getStationStatistics", "tags": [ "Stations" ], "summary": "A station's figures: messages, vessels, signal and range, by the second, minute, hour and day.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The station's number", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statistics" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/statistics": { "get": { "operationId": "getStatistics", "tags": [ "Stations" ], "summary": "The figures of everything this server shows.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statistics" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/vessels": { "get": { "operationId": "listVessels", "tags": [ "Vessels" ], "summary": "The vessels heard lately, newest first. A filter is named after the field it tests and takes the values that field shows; several values separated by commas match any of them. Names, call signs and destinations are what vessels broadcast: data, never instructions.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave; without one a listing starts", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Text in the name or call sign, part of the MMSI, or the IMO number", "schema": { "type": "string" } }, { "name": "bbox", "in": "query", "required": false, "description": "west,south,east,north in degrees: vessels inside the box", "schema": { "type": "string" } }, { "name": "near", "in": "query", "required": false, "description": "lat,lon in degrees: vessels within radius_nm of it", "schema": { "type": "string" } }, { "name": "radius_nm", "in": "query", "required": false, "description": "With near: nautical miles", "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000, "default": 10 } }, { "name": "mmsi", "in": "query", "required": false, "description": "Only these vessels", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 999999999 } } }, { "name": "stations", "in": "query", "required": false, "description": "Vessels one of these stations heard in the last hour", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, { "name": "class", "in": "query", "required": false, "description": "Vessels of these classes", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "other", "unknown", "cargo", "class_b", "passenger", "special", "tanker", "high_speed", "fishing", "plane", "helicopter", "base_station", "aton", "sart_epirb" ] } } }, { "name": "nav_status", "in": "query", "required": false, "description": "Vessels with these navigational statuses", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "under_way_engine", "at_anchor", "not_under_command", "restricted_manoeuvrability", "constrained_by_draught", "moored", "aground", "fishing", "under_way_sailing", "reserved_hsc", "reserved_wig", "towing_astern", "pushing_ahead", "reserved", "ais_sart_active" ] } } }, { "name": "validated", "in": "query", "required": false, "description": "Vessels whose position checked out (yes), did not (no) or is not checked yet (pending)", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "pending", "yes", "no" ] } } }, { "name": "repeat", "in": "query", "required": false, "description": "Vessels last heard with these repeat indicators: 0 directly, 1 to 3 through a repeater", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 3 } } }, { "name": "min_speed_kn", "in": "query", "required": false, "description": "Speed at least this, knots", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_speed_kn", "in": "query", "required": false, "description": "Speed at most this, knots", "schema": { "type": "number", "minimum": 0 } }, { "name": "min_distance_nm", "in": "query", "required": false, "description": "At least this far from the station that heard it, nautical miles", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_distance_nm", "in": "query", "required": false, "description": "At most this far from the station that heard it, nautical miles", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_age_s", "in": "query", "required": false, "description": "Heard within this many seconds", "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/vessels/{mmsi}": { "get": { "operationId": "getVessel", "tags": [ "Vessels" ], "summary": "One vessel in full, with its recent changes, visits and the port it is bound for.", "parameters": [ { "name": "mmsi", "in": "path", "required": true, "description": "The vessel's MMSI", "schema": { "type": "integer", "minimum": 0, "maximum": 999999999 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselDetail" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/vessels/{mmsi}/track": { "get": { "operationId": "getVesselTrack", "tags": [ "Vessels" ], "summary": "Where a vessel went: its positions with speed, course and heading, oldest first.", "parameters": [ { "name": "mmsi", "in": "path", "required": true, "description": "The vessel's MMSI", "schema": { "type": "integer", "minimum": 0, "maximum": 999999999 } }, { "name": "since", "in": "query", "required": false, "description": "From this UTC time, such as 2026-10-19T14:00:00Z, or seconds since 1970", "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "description": "geojson answers one GeoJSON Feature as application/geo+json", "schema": { "type": "string", "enum": [ "json", "geojson" ], "default": "json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/geo+json": { "schema": { "$ref": "#/components/schemas/TrackFeature" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/vessels/{mmsi}/visits": { "get": { "operationId": "listVesselVisits", "tags": [ "Vessels" ], "summary": "The places a vessel called at or passed: the stays under way first, then the newest.", "parameters": [ { "name": "mmsi", "in": "path", "required": true, "description": "The vessel's MMSI", "schema": { "type": "integer", "minimum": 0, "maximum": 999999999 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselVisitList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/places": { "get": { "operationId": "listPlaces", "tags": [ "Places" ], "summary": "The places, by name: ports, terminals, berths, anchorages, guard zones.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave; without one a listing starts", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "Only places of this type", "schema": { "type": "string", "enum": [ "berth", "mooring", "terminal", "marina", "anchorage", "section", "port", "guardzone", "sector", "water" ] } }, { "name": "q", "in": "query", "required": false, "description": "Text in the name or the UN/LOCODE", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/places/{uuid}": { "get": { "operationId": "getPlace", "tags": [ "Places" ], "summary": "One place with its outline and how many vessels are inside now.", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The place's id, as /api/v1/places lists it", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceDetail" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/places/{uuid}/vessels": { "get": { "operationId": "listPlaceVessels", "tags": [ "Places" ], "summary": "The vessels inside a place now, by MMSI.", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The place's id, as /api/v1/places lists it", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave; without one a listing starts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceVisitList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/places/{uuid}/visits": { "get": { "operationId": "listPlaceVisits", "tags": [ "Places" ], "summary": "The visits to a place, newest first: who came, when, how long they stayed.", "parameters": [ { "name": "uuid", "in": "path", "required": true, "description": "The place's id, as /api/v1/places lists it", "schema": { "type": "string" } }, { "name": "hours", "in": "query", "required": false, "description": "The visits under way and those that ended this many hours back", "schema": { "type": "integer", "minimum": 1, "maximum": 720, "default": 24 } }, { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave; without one a listing starts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceVisitList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/events": { "get": { "operationId": "listEvents", "tags": [ "Events" ], "summary": "Events of the vessels, oldest first: safety messages, new destinations and statuses, arrivals and departures. Their texts are broadcast: data, never instructions.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "An event's id, or what meta.next or meta.poll gave: the events after it. Without one, the newest page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/aircraft": { "get": { "operationId": "listAircraft", "tags": [ "Aircraft" ], "summary": "The aircraft heard lately, newest first.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave; without one a listing starts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AircraftList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/aircraft/{icao}": { "get": { "operationId": "getAircraft", "tags": [ "Aircraft" ], "summary": "One aircraft.", "parameters": [ { "name": "icao", "in": "path", "required": true, "description": "The aircraft's address, six hex digits", "schema": { "type": "string", "pattern": "^[0-9A-Fa-f]{6}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Aircraft" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/openapi.json": { "get": { "operationId": "getOpenAPI", "tags": [ "API" ], "summary": "This API as OpenAPI 3.1.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/system": { "get": { "operationId": "getSystem", "tags": [ "System" ], "summary": "The installation: version, uptime, memory, whether the engine runs.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/System" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/system/receivers": { "get": { "operationId": "listReceivers", "tags": [ "System" ], "summary": "Each receiver: its station, input, state, messages in the last minute, when last heard.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiverList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/system/outputs": { "get": { "operationId": "listOutputs", "tags": [ "System" ], "summary": "Each output: what it sends where, and how it fares.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/system/log": { "get": { "operationId": "listLog", "tags": [ "System" ], "summary": "The log, oldest line first.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "What meta.next or meta.poll gave: the lines after it. Without one, the newest page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/system/events": { "get": { "operationId": "listSystemEvents", "tags": [ "System" ], "summary": "The installation's events, oldest first: the engine started or stopped, a receiver lost or back, a station quiet or hearing again, a day of exceptional range, a backup failed.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Rows on a page", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "An event's id, or what meta.next or meta.poll gave: the events after it. Without one, the newest page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventList" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/health": { "get": { "operationId": "getHealth", "tags": [ "System" ], "summary": "pass, warn or fail; 503 on fail.", "responses": { "200": { "description": "OK", "content": { "application/health+json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "default": { "description": "A problem (RFC 9457)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } } }, "components": { "securitySchemes": { "key": { "type": "http", "scheme": "bearer", "description": "A key of the server, when it has keys: a server on 127.0.0.1 without keys needs none" } }, "schemas": { "Problem": { "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "type": { "type": "string", "description": "about:blank: the title says what kind of problem it is" }, "title": { "type": "string", "description": "The kind of problem, the same for every problem of its kind: Bad request, Unauthorized, Forbidden, Not found, Method not allowed, Gone" }, "status": { "type": "integer", "description": "The HTTP status" }, "detail": { "type": "string", "description": "What went wrong with this request, for people" } } }, "ListMeta": { "type": "object", "required": [ "count", "complete", "next" ], "properties": { "count": { "type": "integer", "description": "The rows on this page" }, "complete": { "type": "boolean", "description": "True on the last page, where next is null" }, "next": { "type": [ "string", "null" ], "description": "The request for the next page; null on the last" } } }, "FeedMeta": { "type": "object", "required": [ "count", "complete", "next", "poll" ], "properties": { "count": { "type": "integer", "description": "The rows on this page" }, "complete": { "type": "boolean", "description": "True when nothing more is kept after this page, and next is null" }, "next": { "type": [ "string", "null" ], "description": "The request for the next page; null when this one ends at the newest" }, "poll": { "type": "string", "description": "The request for what comes after this page, to send again later" } } }, "VesselListMeta": { "type": "object", "required": [ "count", "complete", "next", "poll", "full", "time", "expire_s" ], "properties": { "count": { "type": "integer", "description": "The rows on this page" }, "complete": { "type": "boolean", "description": "True on the last page of a listing, where next is null" }, "next": { "type": [ "string", "null" ], "description": "The request for the next page; null on the last" }, "poll": { "type": "string", "description": "The request for what changed since this listing began, to send again later; it lists only the vessels heard since" }, "full": { "type": "boolean", "description": "True when the listing is the whole picture: a client that follows poll drops what it holds and keeps what follows" }, "time": { "type": "string", "format": "date-time", "description": "When this page was taken" }, "expire_s": { "type": "integer", "description": "A vessel not heard for this many seconds is gone; a client that follows poll drops it itself" } } }, "AircraftListMeta": { "type": "object", "required": [ "count", "complete", "next", "poll", "time" ], "properties": { "count": { "type": "integer", "description": "The rows on this page" }, "complete": { "type": "boolean", "description": "True on the last page of a listing, where next is null" }, "next": { "type": [ "string", "null" ], "description": "The request for the next page; null on the last" }, "poll": { "type": "string", "description": "The request for the aircraft heard since this listing began, to send again later. An aircraft is gone a minute after its last message, five minutes on the ground" }, "time": { "type": "string", "format": "date-time", "description": "When this page was taken" } } }, "Index": { "type": "object", "required": [ "name", "api", "resources", "openapi" ], "properties": { "name": { "type": "string", "description": "AIS-catcher" }, "api": { "type": "string", "description": "The version of this API: v1" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "The routes this server offers" }, "openapi": { "type": "string", "description": "Where this API is described as OpenAPI 3.1" }, "notice": { "type": "string", "description": "What the data is not fit for" } } }, "Station": { "type": "object", "required": [ "id", "name", "lat", "lon", "position_source", "position_time", "alt_m", "mmsi", "vessels_last_hour" ], "properties": { "id": { "type": "integer", "description": "The station's number, as inputs and streams name it" }, "name": { "type": [ "string", "null" ], "description": "Its name; null when it has none" }, "lat": { "type": [ "number", "null" ], "description": "Where it is now, degrees; null when it keeps its position private or has none" }, "lon": { "type": [ "number", "null" ], "description": "Where it is now, degrees" }, "position_source": { "enum": [ "configured", "gps", "vessel", null ], "description": "Where the position comes from: the configuration, GPS on its input, or the vessel it rides" }, "position_time": { "type": [ "string", "null" ], "format": "date-time", "description": "When the position was last told" }, "alt_m": { "type": [ "number", "null" ], "description": "The antenna's altitude, metres" }, "mmsi": { "type": [ "integer", "null" ], "description": "The vessel it rides; null on land" }, "vessels_last_hour": { "type": "integer", "description": "The vessels it heard in the last hour that this server shows" } } }, "Figures": { "type": "object", "required": [ "messages", "vessels", "errors", "level_min_db", "level_max_db", "ppm", "max_distance_nm", "active_minutes", "furthest", "channels", "message_types", "range_nm" ], "properties": { "messages": { "type": "integer", "description": "Messages received" }, "vessels": { "type": [ "integer", "null" ], "description": "Vessels heard in the period, added up over stations; null for total and session, which do not count them" }, "errors": { "type": "object", "description": "Messages with each kind of fault", "properties": { "flagged": { "type": "integer", "description": "Marked as faulty by the decoder" }, "undersized": { "type": "integer", "description": "Shorter than their type" }, "oversized": { "type": "integer", "description": "Longer than their type" }, "checksum": { "type": "integer", "description": "With a wrong NMEA checksum" } } }, "level_min_db": { "type": [ "number", "null" ], "description": "The weakest signal, dB" }, "level_max_db": { "type": [ "number", "null" ], "description": "The strongest signal, dB" }, "ppm": { "type": [ "number", "null" ], "description": "The mean frequency offset, parts per million" }, "max_distance_nm": { "type": [ "number", "null" ], "description": "The farthest validated position, nautical miles" }, "active_minutes": { "type": "integer", "description": "The minutes of the period in which a message came in, so the share of time the station heard; 0 in slots by the second. For several stations, the most of any one" }, "furthest": { "type": "array", "description": "The farthest vessels of the period, each once, the farthest first, up to three; the farthest of total holds the station's range record", "items": { "type": "object", "required": [ "mmsi", "distance_nm", "bearing_deg", "time" ], "properties": { "mmsi": { "type": "integer", "description": "The vessel's MMSI" }, "distance_nm": { "type": "number", "description": "Its farthest validated position, nautical miles" }, "bearing_deg": { "type": [ "number", "null" ], "description": "From the station, degrees" }, "time": { "type": "string", "format": "date-time", "description": "When it was there" } } } }, "channels": { "type": "object", "description": "Messages per AIS channel", "properties": { "A": { "type": "integer" }, "B": { "type": "integer" }, "C": { "type": "integer" }, "D": { "type": "integer" } } }, "message_types": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Messages per message type, under the type's number; types not heard are left out" }, "range_nm": { "type": "object", "description": "The farthest validated position by bearing from the station, nautical miles; 0 where nothing was heard", "properties": { "sector_deg": { "type": "integer", "description": "The width of a sector: entry i covers bearings from i times this" }, "class_a": { "type": "array", "items": { "type": "number" }, "description": "Class A transponders" }, "class_b": { "type": "array", "items": { "type": "number" }, "description": "Class B transponders" } } } } }, "Slot": { "allOf": [ { "type": "object", "required": [ "time" ], "properties": { "time": { "type": "string", "format": "date-time", "description": "When the slot begins" } } }, { "$ref": "#/components/schemas/Figures" } ] }, "Statistics": { "type": "object", "required": [ "stations", "time", "messages_per_second", "total", "session", "last_minute", "last_hour", "last_day", "history", "week", "levels_by_distance", "propagation" ], "properties": { "stations": { "type": [ "array", "null" ], "items": { "type": "integer" }, "description": "The stations these figures add up; null for everything the server hears" }, "time": { "type": "string", "format": "date-time", "description": "When these figures were taken" }, "messages_per_second": { "type": "number", "description": "Messages a second over the last minute" }, "total": { "$ref": "#/components/schemas/Figures", "description": "Since the figures were first kept, across restarts when they are backed up" }, "session": { "$ref": "#/components/schemas/Figures", "description": "Since AIS-catcher started" }, "last_minute": { "$ref": "#/components/schemas/Figures", "description": "The last whole minute" }, "last_hour": { "$ref": "#/components/schemas/Figures", "description": "The last whole hour" }, "last_day": { "$ref": "#/components/schemas/Figures", "description": "The last whole UTC day" }, "history": { "type": "object", "description": "The figures by the slot, oldest first", "properties": { "second": { "type": "array", "items": { "$ref": "#/components/schemas/Slot" }, "description": "By the second, the last minute" }, "minute": { "type": "array", "items": { "$ref": "#/components/schemas/Slot" }, "description": "By the minute, the last hour" }, "hour": { "type": "array", "items": { "$ref": "#/components/schemas/Slot" }, "description": "By the hour, the last day" }, "day": { "type": "array", "items": { "$ref": "#/components/schemas/Slot" }, "description": "By the UTC day, the last 90 days" } } }, "week": { "type": "object", "description": "The usual vessels an hour by UTC weekday and hour, from the hours a message came in: for each weekday 24 values, hour 0 first, null for an hour never heard in. Kept across restarts", "properties": { "monday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "tuesday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "wednesday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "thursday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "friday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "saturday": { "type": "array", "items": { "type": [ "number", "null" ] } }, "sunday": { "type": "array", "items": { "type": [ "number", "null" ] } } } }, "levels_by_distance": { "type": "object", "description": "The mean signal level by the distance a message came from, to tune an antenna by: validated positions heard directly, no aids to navigation", "properties": { "band_nm": { "type": "integer", "description": "The width of a band, nautical miles" }, "total": { "type": "array", "items": { "$ref": "#/components/schemas/LevelBand" }, "description": "Since the figures were first kept" }, "session": { "type": "array", "items": { "$ref": "#/components/schemas/LevelBand" }, "description": "Since AIS-catcher started, to compare before and after a change" } } }, "propagation": { "type": "array", "items": { "$ref": "#/components/schemas/PropagationDay" }, "description": "The days of the last 90 with exceptional range, such as tropospheric ducting brings, oldest first: the day's farthest position at least twice the usual and 20 NM beyond it, and a third vessel beyond one and a half times the usual" } } }, "LevelBand": { "type": "object", "required": [ "from_nm", "to_nm", "level_db", "messages" ], "properties": { "from_nm": { "type": "integer", "description": "Where the band begins, nautical miles" }, "to_nm": { "type": [ "integer", "null" ], "description": "Where it ends; null for the last, which holds all beyond" }, "level_db": { "type": [ "number", "null" ], "description": "The mean signal level, dB; null without messages" }, "messages": { "type": "integer", "description": "The messages in the band" } } }, "PropagationDay": { "type": "object", "required": [ "day", "max_distance_nm", "usual_nm" ], "properties": { "day": { "type": "string", "format": "date-time", "description": "The UTC day, at its start" }, "max_distance_nm": { "type": "number", "description": "Its farthest validated position, nautical miles" }, "usual_nm": { "type": "number", "description": "The usual range: the median of the farthest positions of the 30 days before" } } }, "Vessel": { "type": "object", "required": [ "mmsi", "name", "callsign", "imo", "eni", "destination", "class", "ship_type", "mmsi_type", "country", "lat", "lon", "distance_nm", "bearing_deg", "speed_kn", "course_deg", "heading_deg", "nav_status", "to_bow_m", "to_stern_m", "to_port_m", "to_starboard_m", "draught_m", "eta", "validated", "repeat", "approximate", "virtual_aid", "channels", "transponder", "vendor_id", "model", "serial", "level_db", "ppm", "altitude_m", "received_stations", "messages", "message_types", "binary_messages", "station_aboard", "last_seen", "age_s", "stations" ], "properties": { "mmsi": { "type": "integer", "description": "The vessel's MMSI" }, "name": { "type": [ "string", "null" ], "description": "The name it broadcasts" }, "callsign": { "type": [ "string", "null" ], "description": "Its call sign" }, "imo": { "type": [ "integer", "null" ], "description": "Its IMO number, kept only when the check digit holds" }, "eni": { "type": [ "string", "null" ], "description": "Its European inland number, eight digits" }, "destination": { "type": [ "string", "null" ], "description": "The destination it broadcasts" }, "class": { "enum": [ "other", "unknown", "cargo", "class_b", "passenger", "special", "tanker", "high_speed", "fishing", "plane", "helicopter", "base_station", "aton", "sart_epirb" ], "description": "What it is, as the map draws it" }, "ship_type": { "type": [ "integer", "null" ], "description": "The AIS ship and cargo type, 1 to 99, or an inland ERI type of four digits" }, "mmsi_type": { "enum": [ "other", "class_a", "class_b", "base_station", "sar_aircraft", "sart_epirb", "aton" ], "description": "What kind of station its MMSI and messages say it is" }, "country": { "type": [ "string", "null" ], "description": "The flag from the MMSI, ISO 3166 alpha-2" }, "lat": { "type": [ "number", "null" ], "description": "Its last position, degrees" }, "lon": { "type": [ "number", "null" ], "description": "Its last position, degrees" }, "distance_nm": { "type": [ "number", "null" ], "description": "From the station that heard it, nautical miles" }, "bearing_deg": { "type": [ "number", "null" ], "description": "From the station that heard it, degrees" }, "speed_kn": { "type": [ "number", "null" ], "description": "Speed over ground, knots" }, "course_deg": { "type": [ "number", "null" ], "description": "Course over ground, degrees" }, "heading_deg": { "type": [ "number", "null" ], "description": "True heading, degrees" }, "nav_status": { "enum": [ "under_way_engine", "at_anchor", "not_under_command", "restricted_manoeuvrability", "constrained_by_draught", "moored", "aground", "fishing", "under_way_sailing", "reserved_hsc", "reserved_wig", "towing_astern", "pushing_ahead", "reserved", "ais_sart_active", null ], "description": "Its navigational status" }, "to_bow_m": { "type": [ "number", "null" ], "description": "From the position reference to the bow, metres" }, "to_stern_m": { "type": [ "number", "null" ], "description": "From the position reference to the stern, metres" }, "to_port_m": { "type": [ "number", "null" ], "description": "From the position reference to port, metres" }, "to_starboard_m": { "type": [ "number", "null" ], "description": "From the position reference to starboard, metres" }, "draught_m": { "type": [ "number", "null" ], "description": "Its draught, metres" }, "eta": { "type": [ "object", "null" ], "description": "The ETA it broadcasts, UTC and without a year", "properties": { "month": { "type": [ "integer", "null" ] }, "day": { "type": [ "integer", "null" ] }, "hour": { "type": [ "integer", "null" ] }, "minute": { "type": [ "integer", "null" ] } } }, "validated": { "enum": [ "pending", "yes", "no" ], "description": "Whether its position checked out against the one before (yes), did not (no), or is not checked yet (pending)" }, "repeat": { "type": "integer", "description": "The repeat indicator of its last message: 0 heard directly, 1 to 3 through a repeater" }, "approximate": { "type": "boolean", "description": "The position comes from a long-range message (type 27) and is rough" }, "virtual_aid": { "type": "boolean", "description": "An aid to navigation that exists only as a broadcast" }, "channels": { "type": "array", "items": { "enum": [ "A", "B", "C", "D" ] }, "description": "The AIS channels it was heard on" }, "transponder": { "type": "object", "description": "What the transponder says of itself; null where it has not said", "properties": { "unit": { "enum": [ "sotdma", "carrier_sense", null ], "description": "Class B: a SOTDMA or a carrier-sense unit" }, "raim": { "type": [ "boolean", "null" ], "description": "RAIM in use" }, "dte_ready": { "type": [ "boolean", "null" ], "description": "A display is connected" }, "assigned": { "type": [ "boolean", "null" ], "description": "In assigned mode" }, "display": { "type": [ "boolean", "null" ], "description": "Class B: has a display" }, "dsc": { "type": [ "boolean", "null" ], "description": "Class B: has DSC" }, "whole_band": { "type": [ "boolean", "null" ], "description": "Class B: can use the whole marine band" }, "message_22": { "type": [ "boolean", "null" ], "description": "Class B: takes channel management (message 22)" }, "off_position": { "type": [ "boolean", "null" ], "description": "An aid to navigation off its charted position" }, "special_manoeuvre": { "type": [ "boolean", "null" ], "description": "Engaged in a special manoeuvre" } } }, "vendor_id": { "type": [ "string", "null" ], "description": "The maker's id from a static report (type 24)" }, "model": { "type": [ "integer", "null" ], "description": "The unit's model code from a static report" }, "serial": { "type": [ "integer", "null" ], "description": "The unit's serial number from a static report" }, "level_db": { "type": [ "number", "null" ], "description": "The signal level of its last message, dB" }, "ppm": { "type": [ "number", "null" ], "description": "The frequency offset of its last message, parts per million" }, "altitude_m": { "type": [ "number", "null" ], "description": "A SAR aircraft's altitude, metres" }, "received_stations": { "type": [ "integer", "null" ], "description": "The stations a base station says it receives" }, "messages": { "type": "integer", "description": "The messages heard from it" }, "message_types": { "type": "array", "items": { "type": "integer" }, "description": "The message types heard from it" }, "binary_messages": { "type": [ "object", "null" ], "description": "The binary messages it sent lately", "properties": { "count": { "type": "integer", "description": "How many, up to 15" }, "kind": { "enum": [ "text", "persons", "meteo", "aton", "signal", "area", "lock", "safety" ], "description": "What the newest is about" }, "acknowledgement": { "type": "boolean", "description": "One asks for an acknowledgement" }, "newest": { "enum": [ "under_15_min", "under_30_min", "older" ], "description": "How long ago the newest came" } } }, "station_aboard": { "type": [ "integer", "null" ], "description": "The station riding this vessel" }, "last_seen": { "type": "string", "format": "date-time", "description": "When it was last heard" }, "age_s": { "type": "integer", "description": "Seconds since it was last heard" }, "stations": { "type": "array", "description": "The stations that heard it, the most recent first, up to four", "items": { "type": "object", "required": [ "id", "last_heard" ], "properties": { "id": { "type": "integer", "description": "The station's number" }, "last_heard": { "type": "string", "format": "date-time", "description": "When that station last heard it" } } } } } }, "Change": { "type": "object", "required": [ "time", "field", "from", "to", "initial" ], "properties": { "time": { "type": "string", "format": "date-time", "description": "When it changed" }, "field": { "enum": [ "draught_m", "nav_status", "name", "callsign", "destination", "eta" ], "description": "The field of the vessel that changed, under its name there" }, "from": { "description": "What it was, as the field has it; null where not kept" }, "to": { "description": "What it became, as the field has it" }, "initial": { "type": "boolean", "description": "The first value heard, not a change" } } }, "PlaceRef": { "type": "object", "required": [ "uuid", "name", "type", "unlocode", "country" ], "properties": { "uuid": { "type": "string", "description": "The place's id" }, "name": { "type": "string", "description": "Its name" }, "type": { "enum": [ "berth", "mooring", "terminal", "marina", "anchorage", "section", "port", "guardzone", "sector", "water" ], "description": "What kind of place" }, "unlocode": { "type": [ "string", "null" ], "description": "Its UN/LOCODE" }, "country": { "type": [ "string", "null" ], "description": "Its country, ISO 3166 alpha-2" } } }, "Stay": { "type": "object", "required": [ "entered", "entered_observed", "left", "left_observed", "inside", "call", "stopped_min" ], "properties": { "entered": { "type": "string", "format": "date-time", "description": "When the vessel came in; when nobody saw it, the latest it can have been" }, "entered_observed": { "type": "boolean", "description": "Whether the entry was seen, or entered is a bound" }, "left": { "type": [ "string", "null" ], "format": "date-time", "description": "When it left; null while it is inside" }, "left_observed": { "type": [ "boolean", "null" ], "description": "Whether the exit was seen; null while it is inside" }, "inside": { "type": "boolean", "description": "Inside now" }, "call": { "type": "boolean", "description": "A call, not a pass: it stopped where the place asks for a stop" }, "stopped_min": { "type": "integer", "description": "Minutes it lay still" } } }, "VesselVisit": { "allOf": [ { "type": "object", "required": [ "place" ], "properties": { "place": { "$ref": "#/components/schemas/PlaceRef" } } }, { "$ref": "#/components/schemas/Stay" } ] }, "PlaceVisit": { "allOf": [ { "type": "object", "required": [ "mmsi", "name" ], "properties": { "mmsi": { "type": "integer", "description": "The vessel's MMSI" }, "name": { "type": [ "string", "null" ], "description": "The name it broadcasts" } } }, { "$ref": "#/components/schemas/Stay" } ] }, "VesselDetail": { "allOf": [ { "$ref": "#/components/schemas/Vessel" }, { "type": "object", "required": [ "destination_port", "changes", "visits" ], "properties": { "destination_port": { "type": [ "object", "null" ], "description": "The port its destination names, when one is recognised", "properties": { "unlocode": { "type": "string", "description": "The port's UN/LOCODE" }, "place": { "type": [ "string", "null" ], "description": "The place's id when the catalogue has the port" }, "name": { "type": [ "string", "null" ], "description": "The port's name" }, "country": { "type": "string", "description": "Its country, ISO 3166 alpha-2" }, "lat": { "type": [ "number", "null" ], "description": "Where the port is, degrees" }, "lon": { "type": [ "number", "null" ], "description": "Where the port is, degrees" } } }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/Change" }, "description": "What it reported differently lately, the newest first" }, "visits": { "type": "array", "items": { "$ref": "#/components/schemas/VesselVisit" }, "description": "The places it called at or passed: the stays under way first, then the newest" } } } ] }, "TrackPoint": { "type": "object", "required": [ "time", "lat", "lon", "speed_kn", "course_deg", "heading_deg" ], "properties": { "time": { "type": "string", "format": "date-time", "description": "When the vessel was here" }, "lat": { "type": "number", "description": "Degrees" }, "lon": { "type": "number", "description": "Degrees" }, "until": { "type": "string", "format": "date-time", "description": "Only for a vessel that lay still: until when it lay here" }, "speed_kn": { "type": [ "number", "null" ], "description": "Speed over ground, knots" }, "course_deg": { "type": [ "number", "null" ], "description": "Course over ground, degrees" }, "heading_deg": { "type": [ "integer", "null" ], "description": "True heading, degrees" } } }, "TrackFeature": { "type": "object", "required": [ "type", "geometry", "properties" ], "description": "The track as one GeoJSON Feature", "properties": { "type": { "const": "Feature" }, "geometry": { "type": "object", "properties": { "type": { "const": "LineString" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "description": "lon, lat" } } } }, "properties": { "type": "object", "properties": { "mmsi": { "type": "integer", "description": "The vessel's MMSI" }, "times": { "type": "array", "items": { "type": "string", "format": "date-time" }, "description": "When it was at each point" } } } } }, "Place": { "type": "object", "required": [ "uuid", "name", "type", "category", "unlocode", "country", "part_of", "lat", "lon", "has_outline" ], "properties": { "uuid": { "type": "string", "description": "The place's id, the same in every catalogue that has it" }, "name": { "type": "string", "description": "Its name" }, "type": { "enum": [ "berth", "mooring", "terminal", "marina", "anchorage", "section", "port", "guardzone", "sector", "water" ], "description": "What kind of place" }, "category": { "type": [ "string", "null" ], "description": "What it is for, such as container or tanker" }, "unlocode": { "type": [ "string", "null" ], "description": "Its UN/LOCODE" }, "country": { "type": [ "string", "null" ], "description": "Its country, ISO 3166 alpha-2" }, "part_of": { "type": [ "string", "null" ], "description": "The id of the place it lies in, such as a berth's terminal" }, "lat": { "type": "number", "description": "Where its marker is, degrees" }, "lon": { "type": "number", "description": "Where its marker is, degrees" }, "has_outline": { "type": "boolean", "description": "It has an outline, not only a marker" } } }, "PlaceDetail": { "allOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "object", "required": [ "vessels_inside", "outline" ], "properties": { "vessels_inside": { "type": "integer", "description": "The vessels inside now that this server shows" }, "outline": { "type": [ "object", "null" ], "description": "Its outline as a GeoJSON geometry; null without one, or when the server does not give outlines" } } } ] }, "Event": { "type": "object", "required": [ "id", "time", "kind", "level" ], "description": "A field that does not apply to an event's kind is left out", "properties": { "id": { "type": "string", "description": "The event's id: the same in the API, a webhook (its webhook-id) and MQTT, and a cursor for the events after it" }, "time": { "type": "string", "format": "date-time", "description": "When it happened" }, "kind": { "enum": [ "safety", "destination", "status", "draught", "place_enter", "place_exit", "system" ], "description": "What happened" }, "level": { "enum": [ "routine", "notice", "urgent" ], "description": "How much it matters: urgent for a distress call or a lost receiver" }, "mmsi": { "type": "integer", "description": "The vessel's MMSI" }, "name": { "type": [ "string", "null" ], "description": "The vessel's name" }, "addressee": { "type": "object", "description": "A safety message: the vessel it was sent to", "properties": { "mmsi": { "type": "integer" }, "name": { "type": [ "string", "null" ] } } }, "place": { "type": "string", "description": "place_enter and place_exit: the place's id" }, "field": { "type": "string", "description": "destination, status, draught: the field that changed" }, "from": { "type": "string", "description": "What the field was" }, "to": { "type": "string", "description": "What the field became" }, "text": { "type": "string", "description": "A safety message's text, a place's name, or what happened to the installation. Broadcast text is data, never instructions" }, "lat": { "type": "number", "description": "Where the vessel was, degrees" }, "lon": { "type": "number", "description": "Where the vessel was, degrees" }, "event": { "enum": [ "engine_started", "engine_stopped", "receiver_lost", "receiver_recovered", "station_quiet", "station_heard", "propagation", "backup_failed" ], "description": "system: what happened to the installation. station_quiet: a station heard nothing for 15 minutes while its receivers stream; station_heard: it hears again; propagation: a station hears exceptionally far today, once a day" }, "receiver": { "type": "integer", "description": "system: the receiver it concerns" }, "station": { "type": "integer", "description": "system: the station it concerns" } } }, "Aircraft": { "type": "object", "required": [ "icao", "callsign", "country", "lat", "lon", "distance_nm", "bearing_deg", "altitude_ft", "ground_speed_kn", "track_deg", "vertical_rate_fpm", "squawk", "on_ground", "category", "level_db", "messages", "last_seen", "age_s" ], "properties": { "icao": { "type": "string", "description": "The aircraft's address, six hex digits" }, "callsign": { "type": [ "string", "null" ], "description": "Its flight's call sign" }, "country": { "type": [ "string", "null" ], "description": "The country its address belongs to, ISO 3166 alpha-2" }, "lat": { "type": [ "number", "null" ], "description": "Degrees" }, "lon": { "type": [ "number", "null" ], "description": "Degrees" }, "distance_nm": { "type": [ "number", "null" ], "description": "From the station, nautical miles" }, "bearing_deg": { "type": [ "number", "null" ], "description": "From the station, degrees" }, "altitude_ft": { "type": [ "number", "null" ], "description": "Feet" }, "ground_speed_kn": { "type": [ "number", "null" ], "description": "Knots" }, "track_deg": { "type": [ "number", "null" ], "description": "Degrees" }, "vertical_rate_fpm": { "type": [ "number", "null" ], "description": "Feet a minute" }, "squawk": { "type": [ "string", "null" ], "description": "Four octal digits" }, "on_ground": { "type": [ "boolean", "null" ], "description": "On the ground" }, "category": { "type": [ "string", "null" ], "description": "Emitter category, A0 to D7" }, "level_db": { "type": [ "number", "null" ], "description": "The signal level, dB" }, "messages": { "type": "integer", "description": "Messages heard from it" }, "last_seen": { "type": "string", "format": "date-time", "description": "When it was last heard" }, "age_s": { "type": "integer", "description": "Seconds since it was last heard" } } }, "System": { "type": "object", "required": [ "name", "version", "describe", "build_date", "os", "hardware", "uptime_s", "memory_bytes", "received_bytes", "engine", "resources" ], "properties": { "name": { "type": "string" }, "version": { "type": "string", "description": "The release" }, "describe": { "type": "string", "description": "The build, as git describes it" }, "build_date": { "type": "string" }, "os": { "type": "string" }, "hardware": { "type": "string" }, "uptime_s": { "type": "integer", "description": "Seconds since AIS-catcher started" }, "memory_bytes": { "type": "integer", "description": "Memory in use" }, "received_bytes": { "type": "integer", "description": "Bytes from every input" }, "engine": { "type": "object", "properties": { "running": { "type": "boolean", "description": "Whether the engine runs" }, "uptime_s": { "type": "integer", "description": "Seconds since the engine started, while it runs" }, "receivers": { "type": "integer", "description": "How many receivers it has" } } }, "resources": { "type": "array", "items": { "type": "string" }, "description": "The system's other routes" } } }, "Receiver": { "type": "object", "required": [ "index", "station", "input", "label", "state", "messages", "messages_last_minute", "last_heard", "last_heard_age_s" ], "properties": { "index": { "type": "integer", "description": "Its place among the inputs" }, "station": { "type": "integer", "description": "The station it belongs to" }, "input": { "type": "string", "description": "The kind of input" }, "label": { "type": "string", "description": "The device or the receiver's own name" }, "state": { "enum": [ "starting", "streaming", "lost" ], "description": "starting until its device delivers, lost when it stopped by itself" }, "messages": { "type": "integer", "description": "Messages since the engine started" }, "messages_last_minute": { "type": "integer", "description": "Messages in the last minute" }, "last_heard": { "type": [ "string", "null" ], "format": "date-time", "description": "When its station last heard a vessel" }, "last_heard_age_s": { "type": [ "integer", "null" ], "description": "Seconds since then" } } }, "Output": { "type": "object", "description": "An output as the engine describes it: its kind, where it sends and its counts", "additionalProperties": true }, "LogLine": { "type": "object", "required": [ "id", "time", "level", "message" ], "properties": { "id": { "type": "string", "description": "The line's id, a cursor for the lines after it" }, "time": { "type": "string", "format": "date-time", "description": "When it was logged" }, "level": { "enum": [ "debug", "info", "warning", "error", "critical" ] }, "message": { "type": "string" } } }, "Health": { "type": "object", "required": [ "status", "checks" ], "properties": { "status": { "enum": [ "pass", "warn", "fail" ], "description": "fail when the engine does not run or a receiver lost its device, warn when a station heard nothing for 15 minutes" }, "checks": { "type": "object", "description": "engine, and receiver: for each receiver", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "status": { "enum": [ "pass", "warn", "fail" ] }, "componentId": { "type": "string", "description": "The receiver's station" }, "output": { "type": "string", "description": "What is wrong" } } } } } } }, "StationList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Station" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "VesselList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Vessel" } }, "meta": { "$ref": "#/components/schemas/VesselListMeta" } } }, "Track": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TrackPoint" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "VesselVisitList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VesselVisit" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "PlaceList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Place" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "PlaceVisitList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceVisit" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "EventList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "$ref": "#/components/schemas/FeedMeta" } } }, "AircraftList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Aircraft" } }, "meta": { "$ref": "#/components/schemas/AircraftListMeta" } } }, "ReceiverList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Receiver" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "OutputList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Output" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } }, "LogList": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LogLine" } }, "meta": { "$ref": "#/components/schemas/FeedMeta" } } } } } }