AisStream

Unofficial Elixir client for the AISStream WebSocket API. Not affiliated with aisstream.io.

permessage-deflate compression
reconnection with backoff (1-30 s) and keepalive pings
every message sent to a process as {:aisstream, message} (decoded JSON)

Installation

Requires Elixir 1.18+.

def deps do
  [{:aisstream, "~> 0.1"}]
end

Usage

You need an AISStream API key.

{:ok, _pid} =
  AisStream.start_link(
    api_key: System.fetch_env!("AISSTREAM_API_KEY"),
    bounding_boxes: [[[43.0, 7.5], [44.6, 10.5]]],
    filter_message_types: ["PositionReport"],
    to: self()
  )

receive do
  {:aisstream, %{"MessageType" => "PositionReport", "Message" => %{"PositionReport" => report}}} ->
    IO.inspect(report["UserID"], label: "MMSI")
end

children = [
  {AisStream,
   api_key: fn -> System.fetch_env!("AISSTREAM_API_KEY") end,
   bounding_boxes: boxes,
   to: MyApp.AisConsumer}
]

Options

Option	Required	Description
`:api_key`	yes	AISStream API key, or a zero-arity function returning it
`:bounding_boxes`	yes	List of boxes, each `[[lat1, lon1], [lat2, lon2]]`
`:filter_message_types`	no	List of message types, e.g. `["PositionReport"]`
`:to`	yes	pid or registered name receiving the messages
`:name`	no	Name to register the client process under
`:ping_interval`	no	Keepalive interval in ms, default `30_000`
`:max_queue_len`	no	Drop messages while the local `:to` has this many queued, default `nil` (no limit)
`:url`	no	Default `wss://stream.aisstream.io/v0/stream`

Notes:

If :to is a pid, the client stops when it exits; if it is a name with no process registered, messages are dropped.
:max_queue_len is a best-effort safeguard for consumers that can afford to lose messages, not backpressure. It only applies to local processes and logs a warning at most once a minute while dropping.
The API key is redacted from crash reports. Under a supervisor pass it as a function, so it stays out of supervisor reports too.
AISStream closes the connection without an error on an invalid key: the client keeps retrying and logs it.

Development

mix test
AISSTREAM_API_KEY=<key> mix test --include live

License

MIT, see LICENSE.

Next Page → Changelog