Get a list of livestream segments for a user

GET

/xrpc/place.stream.live.getLiveUsers

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 100

before

string format: date-time

Responses

200

Success

object

streams

Array<object>

object

uri

required

string format: uri

cid

required

string format: cid

author

required

object

did

required

string format: did

handle

required

string format: handle

displayName

string

<= 640 characters

avatar

string format: uri

associated

object

lists

integer

feedgens

integer

starterPacks

integer

labeler

boolean

chat

object

allowIncoming

required

string

viewer

Metadata about the requesting account’s relationship with the subject account. Only has meaningful content for authed requests.

object

muted

boolean

mutedByList

object

uri

required

string format: uri

cid

required

string format: cid

name

required

string

>= 1 characters <= 64 characters

purpose

required

string

avatar

string format: uri

listItemCount

integer

labels

Array<object>

Metadata tag on an atproto resource (eg, repo or record).

object

ver

The AT Protocol version of the label object.

integer

src

required

DID of the actor who created this label.

string format: did

uri

required

AT URI of the record, repository (account), or other resource that this label applies to.

string format: uri

cid

Optionally, CID specifying the specific version of ‘uri’ resource this label applies to.

string format: cid

val

required

The short string name of the value or type of this label.

string

<= 128 characters

neg

If true, this is a negation label, overwriting a previous label.

boolean

cts

required

Timestamp when this label was created.

string format: date-time

exp

Timestamp at which this label expires (no longer applies).

string format: date-time

sig

Signature of dag-cbor encoded label.

string format: byte

viewer

object

muted

boolean

blocked

string format: uri

indexedAt

string format: date-time

blockedBy

boolean

blocking

string format: uri

blockingByList

object

uri

required

string format: uri

cid

required

string format: cid

name

required

string

>= 1 characters <= 64 characters

purpose

required

string

avatar

string format: uri

listItemCount

integer

labels

Array<object>

Metadata tag on an atproto resource (eg, repo or record).

object

ver

The AT Protocol version of the label object.

integer

src

required

DID of the actor who created this label.

string format: did

uri

required

AT URI of the record, repository (account), or other resource that this label applies to.

string format: uri

cid

Optionally, CID specifying the specific version of ‘uri’ resource this label applies to.

string format: cid

val

required

The short string name of the value or type of this label.

string

<= 128 characters

neg

If true, this is a negation label, overwriting a previous label.

boolean

cts

required

Timestamp when this label was created.

string format: date-time

exp

Timestamp at which this label expires (no longer applies).

string format: date-time

sig

Signature of dag-cbor encoded label.

string format: byte

viewer

object

muted

boolean

blocked

string format: uri

indexedAt

string format: date-time

following

string format: uri

followedBy

string format: uri

knownFollowers

The subject’s followers whom you also follow

object

count

required

integer

followers

required

Array<object> recursive

labels

Array<object>

Metadata tag on an atproto resource (eg, repo or record).

object

ver

The AT Protocol version of the label object.

integer

src

required

DID of the actor who created this label.

string format: did

uri

required

AT URI of the record, repository (account), or other resource that this label applies to.

string format: uri

cid

Optionally, CID specifying the specific version of ‘uri’ resource this label applies to.

string format: cid

val

required

The short string name of the value or type of this label.

string

<= 128 characters

neg

If true, this is a negation label, overwriting a previous label.

boolean

cts

required

Timestamp when this label was created.

string format: date-time

exp

Timestamp at which this label expires (no longer applies).

string format: date-time

sig

Signature of dag-cbor encoded label.

string format: byte

createdAt

string format: date-time

verification

Represents the verification information about the user this object is attached to.

object

verifications

required

All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included.

Array<object>

An individual verification for an associated subject.

object

issuer

required

The user who issued this verification.

string format: did

uri

required

The AT-URI of the verification record.

string format: uri

isValid

required

True if the verification passes validation, otherwise false.

boolean

createdAt

required

Timestamp when the verification was created.

string format: date-time

verifiedStatus

required

The user’s status as a verified account.

string

trustedVerifierStatus

required

The user’s status as a trusted verifier.

string

status

object

status

required

The status for the account.

string

record

required

embed

One of:

object

object

external

required

object

uri

required

string format: uri

title

required

string

description

required

string

thumb

string format: uri

expiresAt

The date when this status will expire. The application might choose to no longer return the status after expiration.

string format: date-time

isActive

True if the status is not expired, false if it is expired. Only present if expiration was set.

boolean

record

required

indexedAt

required

string format: date-time

viewerCount

The number of viewers watching this livestream. Use when you can’t reasonably use #viewerCount directly.

object

count

required

integer