at.adsb.broadcast.subscribeEvents

adsb.at

Documentation

Subscribe to realtime events from this receiver station.

main subscription

Subscribe to realtime events from this receiver station.

Parameters

cursor integer Optional

Not currently used for backfill. Reserved for future use.

Message Types

Open union
#event #identity #info

Errors

FutureCursor
ConsumerTooSlow
View raw schema 
{
  "type": "subscription",
  "errors": [
    {
      "name": "FutureCursor"
    },
    {
      "name": "ConsumerTooSlow"
    }
  ],
  "message": {
    "schema": {
      "refs": [
        "#event",
        "#identity",
        "#info"
      ],
      "type": "union"
    }
  },
  "parameters": {
    "type": "params",
    "properties": {
      "cursor": {
        "type": "integer",
        "description": "Not currently used for backfill. Reserved for future use."
      }
    }
  },
  "description": "Subscribe to realtime events from this receiver station."
}
broadcastOp object

A single operation within a broadcast event.

Properties

action string Required

The type of operation.

maxLength: 16 bytes
Known values: create, update, delete
record unknown Required

The record payload. Shape determined by record's $type field.

View raw schema 
{
  "type": "object",
  "required": [
    "action",
    "record"
  ],
  "properties": {
    "action": {
      "type": "string",
      "maxLength": 16,
      "description": "The type of operation.",
      "knownValues": [
        "create",
        "update",
        "delete"
      ]
    },
    "record": {
      "type": "unknown",
      "description": "The record payload. Shape determined by record's $type field."
    }
  },
  "description": "A single operation within a broadcast event."
}
event object

A batch of operations from a single poll cycle.

Properties

ops array of ref#broadcastOp Required

List of operations in this batch.

seq integer Required

The stream sequence number of this message.

time string datetime Required

Timestamp of the poll cycle that produced this batch.

View raw schema 
{
  "type": "object",
  "required": [
    "seq",
    "station",
    "time",
    "ops"
  ],
  "properties": {
    "ops": {
      "type": "array",
      "items": {
        "ref": "#broadcastOp",
        "type": "ref"
      },
      "description": "List of operations in this batch."
    },
    "seq": {
      "type": "integer",
      "description": "The stream sequence number of this message."
    },
    "time": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp of the poll cycle that produced this batch."
    },
    "station": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to the emitting receiver's at.adsb.receiver.station record."
    }
  },
  "description": "A batch of operations from a single poll cycle."
}
identity object

Represents a station coming online or updating its identity.

Properties

did string did Required

DID of the station.

seq integer Required

The stream sequence number of this message.

time string datetime Required

Timestamp of when this identity event was produced.

View raw schema 
{
  "type": "object",
  "required": [
    "seq",
    "did",
    "time"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "DID of the station."
    },
    "seq": {
      "type": "integer",
      "description": "The stream sequence number of this message."
    },
    "time": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp of when this identity event was produced."
    },
    "station": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to the station record."
    }
  },
  "description": "Represents a station coming online or updating its identity."
}
info object

No description available.

Properties

message string Optional

Human-readable info message.

maxLength: 1024 bytes
name string Required

Operational info message name.

maxLength: 64 bytes
Known values: OutdatedCursor
View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "Operational info message name.",
      "knownValues": [
        "OutdatedCursor"
      ]
    },
    "message": {
      "type": "string",
      "maxLength": 1024,
      "description": "Human-readable info message."
    }
  }
}

Lexicon Garden

@