Songlist API

Version: 2.0.0

Export

Download

Download JSONDownload YAML

Copy URL

get/me/favorite-streamers

List the authenticated user's favorite streamers with status, admin, and last-request metadata

Authorization

Required scopes

  • user.favorite.readRead user favorite songs

Parameters

NameInTypeRequiredDescription
statusesquerystring[]NoFilter to favorites in these statuses (empty = both)
sortquerystring
last_liverecent_request
NoSort order

Responses

200OK

application/json

Schema

GetFavoriteStreamersResponseBody

$schemastring

A URL to the JSON Schema for this object.

itemsFavoriteStreamerDetail[]required

Array items:

FavoriteStreamerDetail

displayNamestringrequired
favoritedAtstringrequired
isAdminbooleanrequired
isLivebooleanrequired
lastLiveAtstring
lastRequestAtstring
liveStartedAtstring
platformstringrequired
profileImageUrlstring
streamerIdintegerrequired
usernamestringrequired
totalintegerrequired

Example

{
  "$schema": "https://example.com",
  "items": [
    {
      "displayName": "string",
      "favoritedAt": "2024-01-01T00:00:00Z",
      "isAdmin": true,
      "isLive": true,
      "lastLiveAt": "2024-01-01T00:00:00Z",
      "lastRequestAt": "2024-01-01T00:00:00Z",
      "liveStartedAt": "2024-01-01T00:00:00Z",
      "platform": "string",
      "profileImageUrl": "string",
      "streamerId": 0,
      "username": "string"
    }
  ],
  "total": 0
}
401Unauthorized

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}
422Unprocessable Entity

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}
500Internal Server Error

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}