Skip to content
Spotted Docs Spotted Docs
DocumentationAPI Reference
API Reference
Me
Player

Transfer Playback

client.me.player.transfer(PlayerTransferParams { device_ids, play, published } body, RequestOptionsoptions?): void
PUT/me/player

Transfer playback to a new device and optionally begin playback. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints.

ParametersExpand Collapse
body: PlayerTransferParams { device_ids, play, published }
device_ids: Array<string>

A JSON array containing the ID of the device on which playback should be started/transferred.
For example:{device_ids:["74ASZWbe4lXaubB36ztrGX"]}
Note: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return 400 Bad Request

play?: boolean

true: ensure playback happens on new device.
false or not provided: keep the current playback state.

published?: boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Transfer Playback 

import Spotted from 'spotted-ts';

const client = new Spotted({
  accessToken: process.env['SPOTIFY_ACCESS_TOKEN'], // This is the default and can be omitted
});

await client.me.player.transfer({ device_ids: ['74ASZWbe4lXaubB36ztrGX'] });
Returns Examples