STstarlink
Stream

Get telemetry

Required permission: Device telemetry, View.<br/>Get telemetry data of size 'batchSize'. Data is retrieved for all devices of the account associated with the used API credentials. Can be called repeatedly to generate a stream of data. See https://starlink.readme.io/docs/telemetry-api for more.

post/public/v2/telemetry/stream

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/telemetry/stream
  • Auth
    HTTP bearer

Request body

batchSizeinteger

The number of device data records to return per batch. Max 65000. Default 1000.

maxLingerMsinteger

The maximum amount of time in milliseconds to block for while collecting device data records. Max 65000 (65s). Default 15000 (15s).

Response

Latest batch of data retrieved from devices

Changes

No recorded changes to this operation across all 1 revision of this API.