Songlist API

Version: 2.0.0

Export

Download

Download JSON Download YAML

Copy URL

get/attributes

Get attributes

Authorization

Requires a valid access token (no specific scope)

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
include_song_counts	query	boolean	No	-
include_hidden	query	boolean	No	Include inactive attributes, attributes hidden from the filter menu, and the attribute overriding the New badge. Requires streamer access.

Responses

200OK

application/json

Schema

GetAttributesResponseBody

$schemastring

A URL to the JSON Schema for this object.

itemsAttributeSummary[]required

Array items:

AttributeSummary

activebooleanrequired

activeSongsintegerrequired

bypassRequestLimitsbooleanrequired

followerOnlybooleanrequired

idintegerrequired

imagestringrequired

minAmountintegerrequired

namestringrequired

overrideNewbooleanrequired

priorityintegerrequired

restrictionsAttributeRestrictionsrequired

kickKickRestrictions

twitchTwitchRestrictions

followerbooleanrequired

sub_tierstringrequired

subscriberbooleanrequired

vipbooleanrequired

youtubeYoutubeRestrictions

membership_levelsobjectrequired

subscriberbooleanrequired

showbooleanrequired

showSelectorbooleanrequired

songOrderingintegerrequired

streamerIdintegerrequired

subTierstringrequired

subscriberOnlybooleanrequired

totalSongsintegerrequired

totalintegerrequired

Example

{
  "$schema": "https://example.com",
  "items": [
    {
      "active": true,
      "activeSongs": 0,
      "bypassRequestLimits": true,
      "followerOnly": true,
      "id": 0,
      "image": "string",
      "minAmount": 0,
      "name": "string",
      "overrideNew": true,
      "priority": 0,
      "restrictions": {
        "kick": {},
        "twitch": {
          "follower": true,
          "sub_tier": "string",
          "subscriber": true,
          "vip": true
        },
        "youtube": {
          "membership_levels": {},
          "subscriber": true
        }
      },
      "show": true,
      "showSelector": true,
      "songOrdering": 0,
      "streamerId": 0,
      "subTier": "string",
      "subscriberOnly": true,
      "totalSongs": 0
    }
  ],
  "total": 0
}

400Bad Request

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"
}

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"
}

403Forbidden

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"
}

404Not Found

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"
}