Songlist API
Version: 2.0.0
Export
/learn-listGet the learn list
Authorization
Required scopes
streamer.learn-list.readRead the streamer learn list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| streamer_id | query | string | No | If not provided, 'streamer_name' and 'platform' are required |
| streamer_name | query | string | No | Required if streamer_id is not supplied |
| platform_id | query | string | No | Platform-specific channel ID. Requires 'platform' |
| platform | query | string kicknonetwitchyoutube | No | Required if streamer_name or platform_id is supplied |
| statuses | query | string[] | No | - |
| include_learned | query | boolean | No | - |
| limit | query | integer | No | - |
| page | query | integer | No | - |
Responses
200OK
application/json
Schema
LearnListResponseBody
A URL to the JSON Schema for this object.
Array items:
LearnListSong
A URL to the JSON Schema for this object.
Example
{
"$schema": "https://example.com",
"items": [
{
"$schema": "https://example.com",
"addedBySource": "string",
"addedByUserId": 0,
"artist": "string",
"createdAt": "2024-01-01T00:00:00Z",
"id": "string",
"learnedAt": "2024-01-01T00:00:00Z",
"learnedSongId": 0,
"note": "string",
"status": "string",
"streamerId": 0,
"title": "string",
"updatedAt": "2024-01-01T00:00:00Z",
"voteTotal": 0
}
],
"summary": {
"approved": 0,
"learned": 0,
"pending": 0,
"rejected": 0
},
"tokensPerVote": 0,
"viewer": {
"budget": 0,
"remaining": 0,
"used": 0
}
}400Bad Request
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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"
}403Forbidden
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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"
}