Skip to main content
GET
/
v1
/
streamer
/
search
Search streamers
curl --request GET \
  --url http://localhost:8787/v1/streamer/search \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "profile_image": "<string>",
    "followers": 123,
    "description": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Optional bearer token enforced when the Worker is configured with an API token.

Query Parameters

​
q
string

Search phrase. Empty defaults to all streamers.

​
limit
integer
default:20

Maximum number of results to return.

Required range: 1 <= x <= 100

Response

Successful response

​
id
string
​
name
string
​
display_name
string
​
profile_image
string<uri> | null
​
followers
integer
​
description
string | null