Interface SpotifyNodeParameters

Source
interface SpotifyNodeParameters {
    additionalFields?:
        | { description?: string; public?: boolean }
        | { position?: number };
    country?: string;
    filters?:
        | {
            country?: | "AF"
            | "AX"
            | "AL"
            | "DZ"
            | "AS"
            | "AD"
            | "AO"
            | "AI"
            | "AQ"
            | "AG"
            | "AR"
            | "AM"
            | "AW"
            | "AU"
            | "AT"
            | "AZ"
            | "BS"
            | "BH"
            | "BD"
            | "BB"
            | "BY"
            | "BE"
            | "BZ"
            | "BJ"
            | "BM"
            | "BT"
            | "BO"
            | "BQ"
            | "BA"
            | "BW"
            | "BV"
            | "BR"
            | "IO"
            | "BN"
            | "BG"
            | "BF"
            | "BI"
            | "CV"
            | "KH"
            | "CM"
            | "CA"
            | "KY"
            | "CF"
            | "TD"
            | "CL"
            | "CN"
            | "CX"
            | "CC"
            | "CO"
            | "KM"
            | "CG"
            | "CD"
            | "CK"
            | "CR"
            | "CI"
            | "HR"
            | "CU"
            | "CW"
            | "CY"
            | "CZ"
            | "DK"
            | "DJ"
            | "DM"
            | "DO"
            | "EC"
            | "EG"
            | "SV"
            | "GQ"
            | "ER"
            | "EE"
            | "SZ"
            | "ET"
            | "FK"
            | "FO"
            | "FJ"
            | "FI"
            | "FR"
            | "GF"
            | "PF"
            | "TF"
            | "GA"
            | "GM"
            | "GE"
            | "DE"
            | "GH"
            | "GI"
            | "GR"
            | "GL"
            | "GD"
            | "GP"
            | "GU"
            | "GT"
            | "GG"
            | "GN"
            | "GW"
            | "GY"
            | "HT"
            | "HM"
            | "VA"
            | "HN"
            | "HK"
            | "HU"
            | "IS"
            | "IN"
            | "ID"
            | "IR"
            | "IQ"
            | "IE"
            | "IM"
            | "IL"
            | "IT"
            | "JM"
            | "JP"
            | "JE"
            | "JO"
            | "KZ"
            | "KE"
            | "KI"
            | "KP"
            | "KR"
            | "KW"
            | "KG"
            | "LA"
            | "LV"
            | "LB"
            | "LS"
            | "LR"
            | "LY"
            | "LI"
            | "LT"
            | "LU"
            | "MO"
            | "MG"
            | "MW"
            | "MY"
            | "MV"
            | "ML"
            | "MT"
            | "MH"
            | "MQ"
            | "MR"
            | "MU"
            | "YT"
            | "MX"
            | "FM"
            | "MD"
            | "MC"
            | "MN"
            | "ME"
            | "MS"
            | "MA"
            | "MZ"
            | "MM"
            | "NA"
            | "NR"
            | "NP"
            | "NL"
            | "NC"
            | "NZ"
            | "NI"
            | "NE"
            | "NG"
            | "NU"
            | "NF"
            | "MK"
            | "MP"
            | "NO"
            | "OM"
            | "PK"
            | "PW"
            | "PS"
            | "PA"
            | "PG"
            | "PY"
            | "PE"
            | "PH"
            | "PN"
            | "PL"
            | "PT"
            | "PR"
            | "QA"
            | "RE"
            | "RO"
            | "RU"
            | "RW"
            | "BL"
            | "SH"
            | "KN"
            | "LC"
            | "MF"
            | "PM"
            | "VC"
            | "WS"
            | "SM"
            | "ST"
            | "SA"
            | "SN"
            | "RS"
            | "SC"
            | "SL"
            | "SG"
            | "SX"
            | "SK"
            | "SI"
            | "SB"
            | "SO"
            | "ZA"
            | "GS"
            | "SS"
            | "ES"
            | "LK"
            | "SD"
            | "SR"
            | "SJ"
            | "SE"
            | "CH"
            | "SY"
            | "TW"
            | "TJ"
            | "TZ"
            | "TH"
            | "TL"
            | "TG"
            | "TK"
            | "TO"
            | "TT"
            | "TN"
            | "TR"
            | "TM"
            | "TC"
            | "TV"
            | "UG"
            | "UA"
            | "AE"
            | "GB"
            | "UM"
            | "US"
            | "UY"
            | "UZ"
            | "VU"
            | "VE"
            | "VN"
            | "VG"
            | "VI"
            | "WF"
            | "EH"
            | "YE"
            | "ZM"
            | "ZW";
        }
        | {
            market?: | "AF"
            | "AX"
            | "AL"
            | "DZ"
            | "AS"
            | "AD"
            | "AO"
            | "AI"
            | "AQ"
            | "AG"
            | "AR"
            | "AM"
            | "AW"
            | "AU"
            | "AT"
            | "AZ"
            | "BS"
            | "BH"
            | "BD"
            | "BB"
            | "BY"
            | "BE"
            | "BZ"
            | "BJ"
            | "BM"
            | "BT"
            | "BO"
            | "BQ"
            | "BA"
            | "BW"
            | "BV"
            | "BR"
            | "IO"
            | "BN"
            | "BG"
            | "BF"
            | "BI"
            | "CV"
            | "KH"
            | "CM"
            | "CA"
            | "KY"
            | "CF"
            | "TD"
            | "CL"
            | "CN"
            | "CX"
            | "CC"
            | "CO"
            | "KM"
            | "CG"
            | "CD"
            | "CK"
            | "CR"
            | "CI"
            | "HR"
            | "CU"
            | "CW"
            | "CY"
            | "CZ"
            | "DK"
            | "DJ"
            | "DM"
            | "DO"
            | "EC"
            | "EG"
            | "SV"
            | "GQ"
            | "ER"
            | "EE"
            | "SZ"
            | "ET"
            | "FK"
            | "FO"
            | "FJ"
            | "FI"
            | "FR"
            | "GF"
            | "PF"
            | "TF"
            | "GA"
            | "GM"
            | "GE"
            | "DE"
            | "GH"
            | "GI"
            | "GR"
            | "GL"
            | "GD"
            | "GP"
            | "GU"
            | "GT"
            | "GG"
            | "GN"
            | "GW"
            | "GY"
            | "HT"
            | "HM"
            | "VA"
            | "HN"
            | "HK"
            | "HU"
            | "IS"
            | "IN"
            | "ID"
            | "IR"
            | "IQ"
            | "IE"
            | "IM"
            | "IL"
            | "IT"
            | "JM"
            | "JP"
            | "JE"
            | "JO"
            | "KZ"
            | "KE"
            | "KI"
            | "KP"
            | "KR"
            | "KW"
            | "KG"
            | "LA"
            | "LV"
            | "LB"
            | "LS"
            | "LR"
            | "LY"
            | "LI"
            | "LT"
            | "LU"
            | "MO"
            | "MG"
            | "MW"
            | "MY"
            | "MV"
            | "ML"
            | "MT"
            | "MH"
            | "MQ"
            | "MR"
            | "MU"
            | "YT"
            | "MX"
            | "FM"
            | "MD"
            | "MC"
            | "MN"
            | "ME"
            | "MS"
            | "MA"
            | "MZ"
            | "MM"
            | "NA"
            | "NR"
            | "NP"
            | "NL"
            | "NC"
            | "NZ"
            | "NI"
            | "NE"
            | "NG"
            | "NU"
            | "NF"
            | "MK"
            | "MP"
            | "NO"
            | "OM"
            | "PK"
            | "PW"
            | "PS"
            | "PA"
            | "PG"
            | "PY"
            | "PE"
            | "PH"
            | "PN"
            | "PL"
            | "PT"
            | "PR"
            | "QA"
            | "RE"
            | "RO"
            | "RU"
            | "RW"
            | "BL"
            | "SH"
            | "KN"
            | "LC"
            | "MF"
            | "PM"
            | "VC"
            | "WS"
            | "SM"
            | "ST"
            | "SA"
            | "SN"
            | "RS"
            | "SC"
            | "SL"
            | "SG"
            | "SX"
            | "SK"
            | "SI"
            | "SB"
            | "SO"
            | "ZA"
            | "GS"
            | "SS"
            | "ES"
            | "LK"
            | "SD"
            | "SR"
            | "SJ"
            | "SE"
            | "CH"
            | "SY"
            | "TW"
            | "TJ"
            | "TZ"
            | "TH"
            | "TL"
            | "TG"
            | "TK"
            | "TO"
            | "TT"
            | "TN"
            | "TR"
            | "TM"
            | "TC"
            | "TV"
            | "UG"
            | "UA"
            | "AE"
            | "GB"
            | "UM"
            | "US"
            | "UY"
            | "UZ"
            | "VU"
            | "VE"
            | "VN"
            | "VG"
            | "VI"
            | "WF"
            | "EH"
            | "YE"
            | "ZM"
            | "ZW";
        };
    id?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "add"
    | "delete"
    | "search"
    | "pause"
    | "volume"
    | "addSongToQueue"
    | "currentlyPlaying"
    | "nextSong"
    | "previousSong"
    | "recentlyPlayed"
    | "resume"
    | "startMusic"
    | "getNewReleases"
    | "getTracks"
    | "getAlbums"
    | "getRelatedArtists"
    | "getTopTracks"
    | "getUserPlaylists"
    | "getAudioFeatures"
    | "getLikedTracks"
    | "getFollowingArtists";
    query?: string;
    resource?: | "track"
    | "album"
    | "artist"
    | "library"
    | "myData"
    | "player"
    | "playlist";
    returnAll?: boolean;
    trackID?: string;
    volumePercent?: number;
}

Properties§

Source§

readonly additionalFields?:
    | { description?: string; public?: boolean }
    | { position?: number }

Default: {}

Source§

readonly country?: string

Top tracks in which country? Enter the postal abbreviation Default: "US"

Source§

readonly filters?:
    | {
        country?: | "AF"
        | "AX"
        | "AL"
        | "DZ"
        | "AS"
        | "AD"
        | "AO"
        | "AI"
        | "AQ"
        | "AG"
        | "AR"
        | "AM"
        | "AW"
        | "AU"
        | "AT"
        | "AZ"
        | "BS"
        | "BH"
        | "BD"
        | "BB"
        | "BY"
        | "BE"
        | "BZ"
        | "BJ"
        | "BM"
        | "BT"
        | "BO"
        | "BQ"
        | "BA"
        | "BW"
        | "BV"
        | "BR"
        | "IO"
        | "BN"
        | "BG"
        | "BF"
        | "BI"
        | "CV"
        | "KH"
        | "CM"
        | "CA"
        | "KY"
        | "CF"
        | "TD"
        | "CL"
        | "CN"
        | "CX"
        | "CC"
        | "CO"
        | "KM"
        | "CG"
        | "CD"
        | "CK"
        | "CR"
        | "CI"
        | "HR"
        | "CU"
        | "CW"
        | "CY"
        | "CZ"
        | "DK"
        | "DJ"
        | "DM"
        | "DO"
        | "EC"
        | "EG"
        | "SV"
        | "GQ"
        | "ER"
        | "EE"
        | "SZ"
        | "ET"
        | "FK"
        | "FO"
        | "FJ"
        | "FI"
        | "FR"
        | "GF"
        | "PF"
        | "TF"
        | "GA"
        | "GM"
        | "GE"
        | "DE"
        | "GH"
        | "GI"
        | "GR"
        | "GL"
        | "GD"
        | "GP"
        | "GU"
        | "GT"
        | "GG"
        | "GN"
        | "GW"
        | "GY"
        | "HT"
        | "HM"
        | "VA"
        | "HN"
        | "HK"
        | "HU"
        | "IS"
        | "IN"
        | "ID"
        | "IR"
        | "IQ"
        | "IE"
        | "IM"
        | "IL"
        | "IT"
        | "JM"
        | "JP"
        | "JE"
        | "JO"
        | "KZ"
        | "KE"
        | "KI"
        | "KP"
        | "KR"
        | "KW"
        | "KG"
        | "LA"
        | "LV"
        | "LB"
        | "LS"
        | "LR"
        | "LY"
        | "LI"
        | "LT"
        | "LU"
        | "MO"
        | "MG"
        | "MW"
        | "MY"
        | "MV"
        | "ML"
        | "MT"
        | "MH"
        | "MQ"
        | "MR"
        | "MU"
        | "YT"
        | "MX"
        | "FM"
        | "MD"
        | "MC"
        | "MN"
        | "ME"
        | "MS"
        | "MA"
        | "MZ"
        | "MM"
        | "NA"
        | "NR"
        | "NP"
        | "NL"
        | "NC"
        | "NZ"
        | "NI"
        | "NE"
        | "NG"
        | "NU"
        | "NF"
        | "MK"
        | "MP"
        | "NO"
        | "OM"
        | "PK"
        | "PW"
        | "PS"
        | "PA"
        | "PG"
        | "PY"
        | "PE"
        | "PH"
        | "PN"
        | "PL"
        | "PT"
        | "PR"
        | "QA"
        | "RE"
        | "RO"
        | "RU"
        | "RW"
        | "BL"
        | "SH"
        | "KN"
        | "LC"
        | "MF"
        | "PM"
        | "VC"
        | "WS"
        | "SM"
        | "ST"
        | "SA"
        | "SN"
        | "RS"
        | "SC"
        | "SL"
        | "SG"
        | "SX"
        | "SK"
        | "SI"
        | "SB"
        | "SO"
        | "ZA"
        | "GS"
        | "SS"
        | "ES"
        | "LK"
        | "SD"
        | "SR"
        | "SJ"
        | "SE"
        | "CH"
        | "SY"
        | "TW"
        | "TJ"
        | "TZ"
        | "TH"
        | "TL"
        | "TG"
        | "TK"
        | "TO"
        | "TT"
        | "TN"
        | "TR"
        | "TM"
        | "TC"
        | "TV"
        | "UG"
        | "UA"
        | "AE"
        | "GB"
        | "UM"
        | "US"
        | "UY"
        | "UZ"
        | "VU"
        | "VE"
        | "VN"
        | "VG"
        | "VI"
        | "WF"
        | "EH"
        | "YE"
        | "ZM"
        | "ZW";
    }
    | {
        market?: | "AF"
        | "AX"
        | "AL"
        | "DZ"
        | "AS"
        | "AD"
        | "AO"
        | "AI"
        | "AQ"
        | "AG"
        | "AR"
        | "AM"
        | "AW"
        | "AU"
        | "AT"
        | "AZ"
        | "BS"
        | "BH"
        | "BD"
        | "BB"
        | "BY"
        | "BE"
        | "BZ"
        | "BJ"
        | "BM"
        | "BT"
        | "BO"
        | "BQ"
        | "BA"
        | "BW"
        | "BV"
        | "BR"
        | "IO"
        | "BN"
        | "BG"
        | "BF"
        | "BI"
        | "CV"
        | "KH"
        | "CM"
        | "CA"
        | "KY"
        | "CF"
        | "TD"
        | "CL"
        | "CN"
        | "CX"
        | "CC"
        | "CO"
        | "KM"
        | "CG"
        | "CD"
        | "CK"
        | "CR"
        | "CI"
        | "HR"
        | "CU"
        | "CW"
        | "CY"
        | "CZ"
        | "DK"
        | "DJ"
        | "DM"
        | "DO"
        | "EC"
        | "EG"
        | "SV"
        | "GQ"
        | "ER"
        | "EE"
        | "SZ"
        | "ET"
        | "FK"
        | "FO"
        | "FJ"
        | "FI"
        | "FR"
        | "GF"
        | "PF"
        | "TF"
        | "GA"
        | "GM"
        | "GE"
        | "DE"
        | "GH"
        | "GI"
        | "GR"
        | "GL"
        | "GD"
        | "GP"
        | "GU"
        | "GT"
        | "GG"
        | "GN"
        | "GW"
        | "GY"
        | "HT"
        | "HM"
        | "VA"
        | "HN"
        | "HK"
        | "HU"
        | "IS"
        | "IN"
        | "ID"
        | "IR"
        | "IQ"
        | "IE"
        | "IM"
        | "IL"
        | "IT"
        | "JM"
        | "JP"
        | "JE"
        | "JO"
        | "KZ"
        | "KE"
        | "KI"
        | "KP"
        | "KR"
        | "KW"
        | "KG"
        | "LA"
        | "LV"
        | "LB"
        | "LS"
        | "LR"
        | "LY"
        | "LI"
        | "LT"
        | "LU"
        | "MO"
        | "MG"
        | "MW"
        | "MY"
        | "MV"
        | "ML"
        | "MT"
        | "MH"
        | "MQ"
        | "MR"
        | "MU"
        | "YT"
        | "MX"
        | "FM"
        | "MD"
        | "MC"
        | "MN"
        | "ME"
        | "MS"
        | "MA"
        | "MZ"
        | "MM"
        | "NA"
        | "NR"
        | "NP"
        | "NL"
        | "NC"
        | "NZ"
        | "NI"
        | "NE"
        | "NG"
        | "NU"
        | "NF"
        | "MK"
        | "MP"
        | "NO"
        | "OM"
        | "PK"
        | "PW"
        | "PS"
        | "PA"
        | "PG"
        | "PY"
        | "PE"
        | "PH"
        | "PN"
        | "PL"
        | "PT"
        | "PR"
        | "QA"
        | "RE"
        | "RO"
        | "RU"
        | "RW"
        | "BL"
        | "SH"
        | "KN"
        | "LC"
        | "MF"
        | "PM"
        | "VC"
        | "WS"
        | "SM"
        | "ST"
        | "SA"
        | "SN"
        | "RS"
        | "SC"
        | "SL"
        | "SG"
        | "SX"
        | "SK"
        | "SI"
        | "SB"
        | "SO"
        | "ZA"
        | "GS"
        | "SS"
        | "ES"
        | "LK"
        | "SD"
        | "SR"
        | "SJ"
        | "SE"
        | "CH"
        | "SY"
        | "TW"
        | "TJ"
        | "TZ"
        | "TH"
        | "TL"
        | "TG"
        | "TK"
        | "TO"
        | "TT"
        | "TN"
        | "TR"
        | "TM"
        | "TC"
        | "TV"
        | "UG"
        | "UA"
        | "AE"
        | "GB"
        | "UM"
        | "US"
        | "UY"
        | "UZ"
        | "VU"
        | "VE"
        | "VN"
        | "VG"
        | "VI"
        | "WF"
        | "EH"
        | "YE"
        | "ZM"
        | "ZW";
    }

Default: {}

Source§

readonly id?: string

Enter a playlist, artist, or album URI or ID

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

Source§

readonly name?: string

Name of the playlist to create

Source§

readonly operation?:
    | "create"
    | "get"
    | "add"
    | "delete"
    | "search"
    | "pause"
    | "volume"
    | "addSongToQueue"
    | "currentlyPlaying"
    | "nextSong"
    | "previousSong"
    | "recentlyPlayed"
    | "resume"
    | "startMusic"
    | "getNewReleases"
    | "getTracks"
    | "getAlbums"
    | "getRelatedArtists"
    | "getTopTracks"
    | "getUserPlaylists"
    | "getAudioFeatures"
    | "getLikedTracks"
    | "getFollowingArtists"

Default: "addSongToQueue"

Source§

readonly query?: string

The keyword term to search for

Source§

readonly resource?:
    | "track"
    | "album"
    | "artist"
    | "library"
    | "myData"
    | "player"
    | "playlist"

Default: "player"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly trackID?: string

The track's Spotify URI or its ID. The track to add/delete from the playlist.

Source§

readonly volumePercent?: number

The volume percentage to set Default: 50 Type options: {"minValue":0,"maxValue":100}