OceanSync External WebSocket API v0.2.0

Beta, authenticated streaming API.

The service does not retain messages for replay. Messages can be lost when there are no connected clients, and during restarts, deployments and client reconnects.

Cloud Run limits the lifetime of each WebSocket request. During a graceful service shutdown, the service closes connections with WebSocket code 1012 and reason Service Restart. Clients must reconnect when a connection closes and should use exponential backoff with jitter.

Servers

  • wss://v1.ws.api.oceansync.com/wssserver1
    Security:
    • HTTP
      • Scheme: bearer

      Opaque OceanSync API token supplied in the Authorization header during the WebSocket handshake.

Operations

  • RECEIVE /ais/nmea

    The first beta channel provides unchanged AIS NMEA text frames. It is a subscribe-only WebSocket stream: clients do not send subscription commands after connecting.

    Receive unchanged AIS NMEA lines as WebSocket text frames.

    Each WebSocket text frame contains exactly one NMEA line received from the upstream AIS stream. The service adds no receiver metadata or newline.

    Operation IDreceiveAisNmea

    Available only on servers:

    Additional security requirements:
    • HTTP
      • Scheme: bearer

      Opaque OceanSync API token supplied in the Authorization header during the WebSocket handshake.

    Accepts the following message:

    AIS NMEA line

    One unchanged AIS NMEA line.

    Message IDnmeaLine
    string

    Exact UTF-8 NMEA line without an added newline. Multipart NMEA messages remain separate frames and are not assembled by this API.

    Examples

Messages

  • #1AIS NMEA line

    One unchanged AIS NMEA line.

    Message IDNmeaLine
    string

    Exact UTF-8 NMEA line without an added newline. Multipart NMEA messages remain separate frames and are not assembled by this API.