Streamer profile
GET /v1/streamer · Secret or public key · scope profile:read
Your public profile: nickname, name, avatar and the donation page link.
Loading the reference…
Parameters, responses and fields as tables
Responses
Section titled “Responses”200— OK400— A parameter is invalid, or the key was sent in the request address:invalid_parameter,token_in_query401— The key is missing, unknown, deleted or expired:missing_token,invalid_token,token_expired403— Wrong kind of key, the key lacks theprofile:readscope, or the public key came from an address that is not in its list:wrong_token_type,insufficient_scope,origin_not_allowed429— Rate limit exceeded:rate_limited500— The request failed on our side:internal_error503— The API is temporarily unavailable:service_unavailable
Example response
Section titled “Example response”{ "id": "str_5b0c2f4e-8d61-4f43-9a7e-2f1d3c6b9a10", "slug": "teststreamer", "displayName": "Test Streamer", "avatarUrl": "https://storage.donatty.com/avatars/teststreamer.png", "donatePageUrl": "https://donatty.com/teststreamer"}Schemas
Section titled “Schemas”Streamer
Section titled “Streamer”| Field | Type | Description |
|---|---|---|
id |
string | Streamer identifier, str_…. |
slug |
string | Nickname: the last part of the donation page address. |
displayName |
string | The name donors see. |
avatarUrl |
string (URI) or null | Avatar link; null when there is no avatar. |
donatePageUrl |
string (URI) | Donation page link. |