Presence Object

Requesting Presence Data

HTTP API

Typically when calling the HTTP API to fetch presence data for users, the response will include presence objects.

GET https://tether.eggwite.moe/v1/presence/{userID}

{
  success: true,
  data: {
    // PresenceData
    ...
  }
}

WebSocket Gateway

WS ws://tether.eggwite.moe/socket

{
  "op": 2,
  "d": {
    "subscribe_to_ids": ["123456789012345678", "987654321098765432"]
  }
}

When subscribed to user IDs via the WebSocket gateway, presence updates will include presence objects in the d field of PRESENCE_UPDATE and user_id, useful when watching multiple users.

{
  "op": 0,
  "seq": 123,
  "t": "PRESENCE_UPDATE",
   "d": {
    "user_id": "123456789012345678",
    "data": {
      // PresenceData
      ...
  }
}

Diagram

The diagram represents the relational structure of the typical response presence object returned by the Tether API. More details on the specific fields and properties can be found at Presence Data Model.