Skip to content

place.stream.badge.getValidBadges

Lexicon Version: 1

Type: query

Get valid badges for the authenticated user, optionally in the context of a specific streamer’s chat

Parameters:

NameTypeReq’dDescriptionConstraints
streamerstringOptional DID of the streamer for context-specific badges (mod, vip, etc)Format: did

Output:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
badgesArray of place.stream.badge.defs#badgeView

{
"lexicon": 1,
"id": "place.stream.badge.getValidBadges",
"defs": {
"main": {
"type": "query",
"description": "Get valid badges for the authenticated user, optionally in the context of a specific streamer's chat",
"parameters": {
"type": "params",
"properties": {
"streamer": {
"type": "string",
"format": "did",
"description": "Optional DID of the streamer for context-specific badges (mod, vip, etc)"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["badges"],
"properties": {
"badges": {
"type": "array",
"items": {
"type": "ref",
"ref": "place.stream.badge.defs#badgeView"
}
}
}
}
}
}
}
}