AIS

AIS AIVDM websocket

DESC

A streaming websocket endpoint which exports received AIS messages as NMEA AIVDM sentences, for integration with OpenCPN and other AIS tools.

Each AIS message is sent as a websocket text message containing one or more AIVDM sentences, each followed by \r\n. Messages longer than one sentence are split into numbered sentence groups, as in the NMEA standard. Messages from all AIS datasources are included. Messages sent by the client are ignored.

ROLES
readonly AIS
ADDED
API added 2026-10
URI
/phy/AIS/raw.ws
METHODS
WEBSOCKET UPGRADE
URI
PARAMETERS
user string OPTIONAL

Login user ID; most websocket client APIs do not support basic-auth, cookies, or other header-based login methods.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

password string OPTIONAL

Password associated with the user.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

KISMET string OPTIONAL

An API key or session token key.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

EXAMPLE
websocat ws://user:password@localhost:2501/phy/AIS/raw.ws

AIS AIVDM by datasource

DESC

Websocket stream of the AIS messages received by a single datasource, as NMEA AIVDM sentences in the same format as the AIS AIVDM websocket.

Messages sent by the client are ignored.

ROLES
readonly AIS
ADDED
API added 2026-10
URI
/datasource/by-uuid/{UUID}/ais_raw.ws
METHODS
WEBSOCKET UPGRADE
URI
PARAMETERS
UUID string REQUIRED

Datasource UUID

user string OPTIONAL

Login user ID; most websocket client APIs do not support basic-auth, cookies, or other header-based login methods.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

password string OPTIONAL

Password associated with the user.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

KISMET string OPTIONAL

An API key or session token key.

You must provide either user and password GET variables, or an API token or logins ession token via the KISMET GET variable.

RESPONSES
500
Invalid UUID

AIS map data

DESC
AIS stations seen in the past 30 minutes, with the bounding box of their locations, for drawing a map. This is the endpoint used by the AIS map in the Kismet web UI. The window is longer than for ADSB, because AIS stations report less often; anchored vessels can be minutes apart.
ROLES
readonly
ADDED
API added 2026-10
URI
/phy/AIS/map_data.json
/phy/AIS/map_data.ekjson
/phy/AIS/map_data.prettyjson
METHODS
GET POST
JSON
PARAMETERS

This endpoint takes additional parameters by using a `POST` request and supplying a JSON document or json form variable.

You can find more information about API parameters here.

fields field simplification OPTIONAL

Kismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.

You can read more about the field simplification API and how to use it here.

RETURN

JSON object containing:

FieldContent
kismet.ais.map.min_lat, kismet.ais.map.max_latLatitude range of the stations
kismet.ais.map.min_lon, kismet.ais.map.max_lonLongitude range of the stations
kismet.ais.map.devicesList of device records

If no AIS stations have been seen, an object with kismet.common.error is returned instead.

RESPONSES
200
Success