Cloud-Player v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

cloud-player rest endpoints

Base URLs:

• https://api.cloud-player.io/

Authentication

• API Key (apiKey)
  • Parameter Name: tok_v1, in: cookie.

Default

accountRead

Code samples

GET https://api.cloud-player.io//account/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//account/{provider_id}/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//account/{provider_id}/{id}', params={

}, headers = headers)

print r.json()

GET /account/{provider_id}/{id}

Parameters

Parameter	In	Type	Required	Description
provider_id	path	string	true	Account provider id
id	path	string	true	Account id

Example responses

{
  "connected": true,
  "user_id": "string",
  "favourite_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description

allOf

Name	Type	Required	Description
» anonymous	any	false	No description

allOf

Name	Type	Required	Description
»» anonymous	any	false	No description

and

Name	Type	Required	Description
»» anonymous	object	false	No description
»»» connected	boolean	false	Connection status

and

Name	Type	Required	Description
»» anonymous	object	false	No description
»»» user_id	string	false	User id
»»» favourite_id	string	false	Favourite id
»»» created	string(date-time)	false	Account creation
»»» updated	string(date-time)	false	Account update

playlistSearch

Code samples

GET https://api.cloud-player.io//playlist/{provider_id}?account_id=string HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{provider_id}',
  method: 'get',
  data: '?account_id=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//playlist/{provider_id}', params={
  'account_id': 'string'
}, headers = headers)

print r.json()

GET /playlist/{provider_id}

Parameters

Parameter	In	Type	Required	Description
account_id	query	string	true	Account id
provider_id	path	string	true	Provider id

Example responses

[
  {
    "id": "string",
    "provider_id": "string",
    "account_id": null,
    "account_provider_id": "string",
    "description": "string",
    "follower_count": 0,
    "image": {
      "id": "string",
      "large": "string",
      "medium": "string",
      "small": "string"
    },
    "items": [
      {
        "id": "string",
        "playlist_id": "string",
        "playlist_provider_id": "string",
        "rank": null,
        "track_id": "string",
        "track_provider_id": "string",
        "created": "2018-04-17T17:14:29Z",
        "updated": "2018-04-17T17:14:29Z"
      }
    ],
    "public": true,
    "title": "string",
    "created": "2018-04-17T17:14:29Z",
    "updated": "2018-04-17T17:14:29Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist id
» provider_id	string	true	Provider id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» description	string	false	Playlist description
» follower_count	integer(int32)	false	Follower count
» image	object	false	No description
»» id	string	true	Image id
»» large	string	true	Large uri
»» medium	string	false	Medium uri
»» small	string	false	Small uri
» items	[object]	true	Playlist items
»» id	string	true	Playlist item id
»» playlist_id	string	true	Playlist id
»» playlist_provider_id	string	true	Provider id
»» rank	any	true	Playlist item rank
»» track_id	string	true	Track id
»» track_provider_id	string	true	Provider id
»» created	string(date-time)	false	Playlist item creation
»» updated	string(date-time)	false	Playlist item update
» public	boolean	false	Public state
» title	string	true	Playlist title
» created	string(date-time)	false	Playlist creation
» updated	string(date-time)	false	Playlist update

playlistCreate

Code samples

POST https://api.cloud-player.io//playlist/{provider_id} HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{provider_id}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.cloud-player.io//playlist/{provider_id}', params={

}, headers = headers)

print r.json()

POST /playlist/{provider_id}

Body parameter

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "description": "string",
  "follower_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "items": [
    {
      "id": "string",
      "playlist_id": "string",
      "playlist_provider_id": "string",
      "rank": null,
      "track_id": "string",
      "track_provider_id": "string",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ],
  "public": true,
  "title": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Parameters

Parameter	In	Type	Required	Description
id	body	string	true	Playlist id
provider_id	body	string	true	Provider id
account_id	body	any	true	No description
account_provider_id	body	string	true	Provider id
description	body	string	false	Playlist description
follower_count	body	integer(int32)	false	Follower count
image	body	object	false	No description
» id	body	string	true	Image id
» large	body	string	true	Large uri
» medium	body	string	false	Medium uri
» small	body	string	false	Small uri
items	body	[object]	true	Playlist items
» id	body	string	true	Playlist item id
» playlist_id	body	string	true	Playlist id
» playlist_provider_id	body	string	true	Provider id
» rank	body	any	true	Playlist item rank
» track_id	body	string	true	Track id
» track_provider_id	body	string	true	Provider id
» created	body	string(date-time)	false	Playlist item creation
» updated	body	string(date-time)	false	Playlist item update
public	body	boolean	false	Public state
title	body	string	true	Playlist title
created	body	string(date-time)	false	Playlist creation
updated	body	string(date-time)	false	Playlist update
provider_id	path	string	true	Provider id

Example responses

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "description": "string",
  "follower_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "items": [
    {
      "id": "string",
      "playlist_id": "string",
      "playlist_provider_id": "string",
      "rank": null,
      "track_id": "string",
      "track_provider_id": "string",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ],
  "public": true,
  "title": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist id
» provider_id	string	true	Provider id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» description	string	false	Playlist description
» follower_count	integer(int32)	false	Follower count
» image	object	false	No description
»» id	string	true	Image id
»» large	string	true	Large uri
»» medium	string	false	Medium uri
»» small	string	false	Small uri
» items	[object]	true	Playlist items
»» id	string	true	Playlist item id
»» playlist_id	string	true	Playlist id
»» playlist_provider_id	string	true	Provider id
»» rank	any	true	Playlist item rank
»» track_id	string	true	Track id
»» track_provider_id	string	true	Provider id
»» created	string(date-time)	false	Playlist item creation
»» updated	string(date-time)	false	Playlist item update
» public	boolean	false	Public state
» title	string	true	Playlist title
» created	string(date-time)	false	Playlist creation
» updated	string(date-time)	false	Playlist update

playlistRead

Code samples

GET https://api.cloud-player.io//playlist/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{provider_id}/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//playlist/{provider_id}/{id}', params={

}, headers = headers)

print r.json()

GET /playlist/{provider_id}/{id}

Parameters

Parameter	In	Type	Required	Description
provider_id	path	string	true	Provider id
id	path	string	true	Playlist id

Example responses

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "description": "string",
  "follower_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "items": [
    {
      "id": "string",
      "playlist_id": "string",
      "playlist_provider_id": "string",
      "rank": null,
      "track_id": "string",
      "track_provider_id": "string",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ],
  "public": true,
  "title": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist id
» provider_id	string	true	Provider id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» description	string	false	Playlist description
» follower_count	integer(int32)	false	Follower count
» image	object	false	No description
»» id	string	true	Image id
»» large	string	true	Large uri
»» medium	string	false	Medium uri
»» small	string	false	Small uri
» items	[object]	true	Playlist items
»» id	string	true	Playlist item id
»» playlist_id	string	true	Playlist id
»» playlist_provider_id	string	true	Provider id
»» rank	any	true	Playlist item rank
»» track_id	string	true	Track id
»» track_provider_id	string	true	Provider id
»» created	string(date-time)	false	Playlist item creation
»» updated	string(date-time)	false	Playlist item update
» public	boolean	false	Public state
» title	string	true	Playlist title
» created	string(date-time)	false	Playlist creation
» updated	string(date-time)	false	Playlist update

playlistUpdate

Code samples

PUT https://api.cloud-player.io//playlist/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{provider_id}/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.cloud-player.io//playlist/{provider_id}/{id}', params={

}, headers = headers)

print r.json()

PUT /playlist/{provider_id}/{id}

Body parameter

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "description": "string",
  "follower_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "items": [
    {
      "id": "string",
      "playlist_id": "string",
      "playlist_provider_id": "string",
      "rank": null,
      "track_id": "string",
      "track_provider_id": "string",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ],
  "public": true,
  "title": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Parameters

Parameter	In	Type	Required	Description
id	body	string	true	Playlist id
provider_id	body	string	true	Provider id
account_id	body	any	true	No description
account_provider_id	body	string	true	Provider id
description	body	string	false	Playlist description
follower_count	body	integer(int32)	false	Follower count
image	body	object	false	No description
» id	body	string	true	Image id
» large	body	string	true	Large uri
» medium	body	string	false	Medium uri
» small	body	string	false	Small uri
items	body	[object]	true	Playlist items
» id	body	string	true	Playlist item id
» playlist_id	body	string	true	Playlist id
» playlist_provider_id	body	string	true	Provider id
» rank	body	any	true	Playlist item rank
» track_id	body	string	true	Track id
» track_provider_id	body	string	true	Provider id
» created	body	string(date-time)	false	Playlist item creation
» updated	body	string(date-time)	false	Playlist item update
public	body	boolean	false	Public state
title	body	string	true	Playlist title
created	body	string(date-time)	false	Playlist creation
updated	body	string(date-time)	false	Playlist update
provider_id	path	string	true	Provider id
id	path	string	true	Playlist id

Example responses

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "description": "string",
  "follower_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "items": [
    {
      "id": "string",
      "playlist_id": "string",
      "playlist_provider_id": "string",
      "rank": null,
      "track_id": "string",
      "track_provider_id": "string",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ],
  "public": true,
  "title": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist id
» provider_id	string	true	Provider id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» description	string	false	Playlist description
» follower_count	integer(int32)	false	Follower count
» image	object	false	No description
»» id	string	true	Image id
»» large	string	true	Large uri
»» medium	string	false	Medium uri
»» small	string	false	Small uri
» items	[object]	true	Playlist items
»» id	string	true	Playlist item id
»» playlist_id	string	true	Playlist id
»» playlist_provider_id	string	true	Provider id
»» rank	any	true	Playlist item rank
»» track_id	string	true	Track id
»» track_provider_id	string	true	Provider id
»» created	string(date-time)	false	Playlist item creation
»» updated	string(date-time)	false	Playlist item update
» public	boolean	false	Public state
» title	string	true	Playlist title
» created	string(date-time)	false	Playlist creation
» updated	string(date-time)	false	Playlist update

playlistDelete

Code samples

DELETE https://api.cloud-player.io//playlist/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{provider_id}/{id}',
  method: 'delete',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.delete('https://api.cloud-player.io//playlist/{provider_id}/{id}', params={

)

print r.json()

DELETE /playlist/{provider_id}/{id}

Parameters

Parameter	In	Type	Required	Description
provider_id	path	string	true	Provider id
id	path	string	true	Playlist id

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

playlistItemCreate

Code samples

POST https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item', params={

}, headers = headers)

print r.json()

POST /playlist/{playlist_provider_id}/{playlist_id}/item

Body parameter

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Parameters

Parameter	In	Type	Required	Description
id	body	string	true	Playlist item id
playlist_id	body	string	true	Playlist id
playlist_provider_id	body	string	true	Provider id
rank	body	any	true	Playlist item rank
track_id	body	string	true	Track id
track_provider_id	body	string	true	Provider id
created	body	string(date-time)	false	Playlist item creation
updated	body	string(date-time)	false	Playlist item update
playlist_provider_id	path	string	true	Playlist provider id
playlist_id	path	string	true	Playlist id

Example responses

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist item id
» playlist_id	string	true	Playlist id
» playlist_provider_id	string	true	Provider id
» rank	any	true	Playlist item rank
» track_id	string	true	Track id
» track_provider_id	string	true	Provider id
» created	string(date-time)	false	Playlist item creation
» updated	string(date-time)	false	Playlist item update

playlistItemSearch

Code samples

GET https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item', params={

}, headers = headers)

print r.json()

GET /playlist/{playlist_provider_id}/{playlist_id}/item

Parameters

Parameter	In	Type	Required	Description
playlist_provider_id	path	string	true	Playlist provider id
playlist_id	path	string	true	Playlist id

Example responses

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist item id
» playlist_id	string	true	Playlist id
» playlist_provider_id	string	true	Provider id
» rank	any	true	Playlist item rank
» track_id	string	true	Track id
» track_provider_id	string	true	Provider id
» created	string(date-time)	false	Playlist item creation
» updated	string(date-time)	false	Playlist item update

playlistItemRead

Code samples

GET https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}', params={

}, headers = headers)

print r.json()

GET /playlist/{playlist_provider_id}/{playlist_id}/item/{id}

Parameters

Parameter	In	Type	Required	Description
playlist_provider_id	path	string	true	Playlist provider id
playlist_id	path	string	true	Playlist id
id	path	string	true	Playlist item id

Example responses

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist item id
» playlist_id	string	true	Playlist id
» playlist_provider_id	string	true	Provider id
» rank	any	true	Playlist item rank
» track_id	string	true	Track id
» track_provider_id	string	true	Provider id
» created	string(date-time)	false	Playlist item creation
» updated	string(date-time)	false	Playlist item update

playlistItemUpdate

Code samples

PUT https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}', params={

}, headers = headers)

print r.json()

PUT /playlist/{playlist_provider_id}/{playlist_id}/item/{id}

Body parameter

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Parameters

Parameter	In	Type	Required	Description
id	body	string	true	Playlist item id
playlist_id	body	string	true	Playlist id
playlist_provider_id	body	string	true	Provider id
rank	body	any	true	Playlist item rank
track_id	body	string	true	Track id
track_provider_id	body	string	true	Provider id
created	body	string(date-time)	false	Playlist item creation
updated	body	string(date-time)	false	Playlist item update
playlist_provider_id	path	string	true	Playlist provider id
playlist_id	path	string	true	Playlist id
id	path	string	true	Playlist item id

Example responses

{
  "id": "string",
  "playlist_id": "string",
  "playlist_provider_id": "string",
  "rank": null,
  "track_id": "string",
  "track_provider_id": "string",
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Playlist item id
» playlist_id	string	true	Playlist id
» playlist_provider_id	string	true	Provider id
» rank	any	true	Playlist item rank
» track_id	string	true	Track id
» track_provider_id	string	true	Provider id
» created	string(date-time)	false	Playlist item creation
» updated	string(date-time)	false	Playlist item update

playlistItemDelete

Code samples

DELETE https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}',
  method: 'delete',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.delete('https://api.cloud-player.io//playlist/{playlist_provider_id}/{playlist_id}/item/{id}', params={

)

print r.json()

DELETE /playlist/{playlist_provider_id}/{playlist_id}/item/{id}

Parameters

Parameter	In	Type	Required	Description
playlist_provider_id	path	string	true	Playlist provider id
playlist_id	path	string	true	Playlist id
id	path	string	true	Playlist item id

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

favouriteRead

Code samples

GET https://api.cloud-player.io//favourite/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{provider_id}/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//favourite/{provider_id}/{id}', params={

}, headers = headers)

print r.json()

GET /favourite/{provider_id}/{id}

Parameters

Parameter	In	Type	Required	Description
provider_id	path	string	true	Provider id
id	path	string	true	Favourite id

Example responses

{
  "id": "string",
  "provider_id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "items": [
    null
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Favourite id
» provider_id	string	true	Provider id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» items	[any]	true	Favourite items

favouriteItemCreate

Code samples

POST https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json

var headers = {
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item', params={

}, headers = headers)

print r.json()

POST /favourite/{favourite_provider_id}/{favourite_id}/item

Body parameter

null

Parameters

Parameter	In	Type	Required	Description
favourite_provider_id	path	string	true	Favourite provider id
favourite_id	path	string	true	Favourite id

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

favouriteItemSearch

Code samples

GET https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item',
  method: 'get',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.get('https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item', params={

)

print r.json()

GET /favourite/{favourite_provider_id}/{favourite_id}/item

Parameters

Parameter	In	Type	Required	Description
favourite_provider_id	path	string	true	Favourite provider id
favourite_id	path	string	true	Favourite id

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

favouriteItemRead

Code samples

GET https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}',
  method: 'get',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.get('https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}', params={

)

print r.json()

GET /favourite/{favourite_provider_id}/{favourite_id}/item/{id}

Parameters

Parameter	In	Type	Required	Description
favourite_provider_id	path	string	true	Favourite provider id
favourite_id	path	string	true	Favourite id
id	path	string	true	Favourite item id

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

favouriteItemUpdate

Code samples

PUT https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json

var headers = {
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}', params={

}, headers = headers)

print r.json()

PUT /favourite/{favourite_provider_id}/{favourite_id}/item/{id}

Body parameter

null

Parameters

Parameter	In	Type	Required	Description
favourite_provider_id	path	string	true	Favourite provider id
favourite_id	path	string	true	Favourite id
id	path	string	true	Favourite item id

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

favouriteItemDelete

Code samples

DELETE https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id} HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}',
  method: 'delete',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.delete('https://api.cloud-player.io//favourite/{favourite_provider_id}/{favourite_id}/item/{id}', params={

)

print r.json()

DELETE /favourite/{favourite_provider_id}/{favourite_id}/item/{id}

Parameters

Parameter	In	Type	Required	Description
favourite_provider_id	path	string	true	Favourite provider id
favourite_id	path	string	true	Favourite id
id	path	string	true	Favourite item id

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

providerSearch

Code samples

GET https://api.cloud-player.io//provider HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//provider',
  method: 'get',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.get('https://api.cloud-player.io//provider', params={

)

print r.json()

GET /provider

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

providerRead

Code samples

GET https://api.cloud-player.io//provider/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//provider/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//provider/{id}', params={

}, headers = headers)

print r.json()

GET /provider/{id}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	Provider id

Example responses

{
  "id": "string",
  "client_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Provider id
» client_id	string	false	Provider client id

sessionCreate

Code samples

POST https://api.cloud-player.io//session HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json

var headers = {
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//session',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://api.cloud-player.io//session', params={

}, headers = headers)

print r.json()

POST /session

Body parameter

{
  "system": "string",
  "browser": "string",
  "screen": "string"
}

Parameters

Parameter	In	Type	Required	Description
system	body	string	true	Session system
browser	body	string	true	Session browser
screen	body	string	true	Session screen

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

tokenCreate

Code samples

POST https://api.cloud-player.io//token HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//token',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.cloud-player.io//token', params={

}, headers = headers)

print r.json()

POST /token

Example responses

{
  "id": "string",
  "claimed": false,
  "account_id": null,
  "account_provider_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Token

Name	Type	Required	Description
» id	string	true	Token id
» claimed	boolean	true	Claim status
» account_id	any	true	No description
» account_provider_id	string	true	Provider id

tokenRead

Code samples

GET https://api.cloud-player.io//token/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//token/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//token/{id}', params={

}, headers = headers)

print r.json()

GET /token/{id}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	Token id

Example responses

{
  "id": "string",
  "claimed": false,
  "account_id": null,
  "account_provider_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Token

Name	Type	Required	Description
» id	string	true	Token id
» claimed	boolean	true	Claim status
» account_id	any	true	No description
» account_provider_id	string	true	Provider id

tokenUpdate

Code samples

PUT https://api.cloud-player.io//token/{id} HTTP/1.1
Host: api.cloud-player.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//token/{id}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.cloud-player.io//token/{id}', params={

}, headers = headers)

print r.json()

PUT /token/{id}

Body parameter

{
  "id": "string",
  "claimed": false,
  "account_id": null,
  "account_provider_id": "string"
}

Parameters

Parameter	In	Type	Required	Description
id	body	string	true	Token id
claimed	body	boolean	true	Claim status
account_id	body	any	true	No description
account_provider_id	body	string	true	Provider id
id	path	string	true	Token id

Example responses

{
  "id": "string",
  "claimed": false,
  "account_id": null,
  "account_provider_id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Token

Name	Type	Required	Description
» id	string	true	Token id
» claimed	boolean	true	Claim status
» account_id	any	true	No description
» account_provider_id	string	true	Provider id

trackRead

Code samples

GET https://api.cloud-player.io//track/{provider_id}/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//track/{provider_id}/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//track/{provider_id}/{id}', params={

}, headers = headers)

print r.json()

GET /track/{provider_id}/{id}

Parameters

Parameter	In	Type	Required	Description
provider_id	path	string	true	Provider id
id	path	string	true	Track id

Example responses

{
  "id": "string",
  "provider_id": "string",
  "account": {
    "id": "string",
    "provider_id": "string",
    "image": {
      "id": "string",
      "large": "string",
      "medium": "string",
      "small": "string"
    },
    "title": "string"
  },
  "aspect_ratio": 0,
  "duration": 0,
  "favourite_count": 0,
  "image": {
    "id": "string",
    "large": "string",
    "medium": "string",
    "small": "string"
  },
  "play_count": 0,
  "title": "string",
  "created": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Track id
» provider_id	string	true	Provider id
» account	object	true	No description
»» id	string	true	Account id
»» provider_id	string	true	Provider id
»» image	object	false	No description
»»» id	string	true	Image id
»»» large	string	true	Large uri
»»» medium	string	false	Medium uri
»»» small	string	false	Small uri
»» title	string	false	Account title
» aspect_ratio	number(double)	false	Player aspect ratio
» duration	integer(int32)	false	Track duration
» favourite_count	integer(int32)	false	Favourite count
» image	object	false	No description
»» id	string	true	Image id
»» large	string	true	Large uri
»» medium	string	false	Medium uri
»» small	string	false	Small uri
» play_count	integer(int32)	false	Play count
» title	string	true	Track title
» created	string(date-time)	false	Track creation

trackCommentSearch

Code samples

GET https://api.cloud-player.io//track/{track_provider_id}/{track_id}/comment HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//track/{track_provider_id}/{track_id}/comment',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//track/{track_provider_id}/{track_id}/comment', params={

}, headers = headers)

print r.json()

GET /track/{track_provider_id}/{track_id}/comment

Parameters

Parameter	In	Type	Required	Description
track_provider_id	path	string	true	Track provider id
track_id	path	string	true	Track id

Example responses

[
  {
    "id": "string",
    "provider_id": "string",
    "account": {
      "id": "string",
      "provider_id": "string",
      "image": {
        "id": "string",
        "large": "string",
        "medium": "string",
        "small": "string"
      },
      "title": "string"
    },
    "body": "string",
    "timestamp": 0,
    "track_id": "string",
    "track_provider_id": "string",
    "created": "2018-04-17T17:14:29Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Track comment id
» provider_id	string	true	Provider id
» account	object	false	No description
»» id	string	true	Account id
»» provider_id	string	true	Provider id
»» image	object	false	No description
»»» id	string	true	Image id
»»» large	string	true	Large uri
»»» medium	string	false	Medium uri
»»» small	string	false	Small uri
»» title	string	false	Account title
» body	string	false	Track comment body
» timestamp	integer(int32)	false	Track comment timestamp
» track_id	string	false	Track id
» track_provider_id	string	false	Provider id
» created	string(date-time)	false	Track comment creation

userRead

Code samples

GET https://api.cloud-player.io//user/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//user/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//user/{id}', params={

}, headers = headers)

print r.json()

GET /user/{id}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	User id

Example responses

{
  "id": "string",
  "accounts": [
    {
      "id": "string",
      "provider_id": "string",
      "image": {
        "id": "string",
        "large": "string",
        "medium": "string",
        "small": "string"
      },
      "title": "string",
      "connected": true
    }
  ],
  "created": "2018-04-17T17:14:29Z",
  "updated": "2018-04-17T17:14:29Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

User

Name	Type	Required	Description
» id	string	true	User id
» accounts	[allOf]	true	Connected accounts

allOf

Name	Type	Required	Description
»» anonymous	object	false	No description
»»» id	string	true	Account id
»»» provider_id	string	true	Provider id
»»» image	object	false	No description
»»»» id	string	true	Image id
»»»» large	string	true	Large uri
»»»» medium	string	false	Medium uri
»»»» small	string	false	Small uri
»»» title	string	false	Account title

and

Name	Type	Required	Description
»» anonymous	object	false	No description
»»» connected	boolean	false	Connection status

continued

Name	Type	Required	Description
»» created	string(date-time)	false	User creation
»» updated	string(date-time)	false	User update

soundcloudAuth

Code samples

GET https://api.cloud-player.io//soundcloud HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//soundcloud',
  method: 'get',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.get('https://api.cloud-player.io//soundcloud', params={

)

print r.json()

GET /soundcloud

Responses

Status	Meaning	Description	Schema
200	OK	Callback endpoint that shows a popup closer	None

youtubeAuth

Code samples

GET https://api.cloud-player.io//youtube HTTP/1.1
Host: api.cloud-player.io

$.ajax({
  url: 'https://api.cloud-player.io//youtube',
  method: 'get',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests

r = requests.get('https://api.cloud-player.io//youtube', params={

)

print r.json()

GET /youtube

Responses

Status	Meaning	Description	Schema
200	OK	Callback endpoint that shows a popup closer	None

Draft

historyRead

Code samples

GET https://api.cloud-player.io//history/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//history/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//history/{id}', params={

}, headers = headers)

print r.json()

GET /history/{id}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	History id

Example responses

{
  "id": "string",
  "account_id": null,
  "account_provider_id": "string",
  "playbacks": [
    {
      "id": "string",
      "previous": "string",
      "next": "string",
      "progress": 0,
      "status": "completed",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	History id
» account_id	any	true	No description
» account_provider_id	string	true	Provider id
» playbacks	[object]	true	List of playbacks
»» id	string	true	Playback id
»» previous	string	false	Playback id
»» next	string	false	Playback id
»» progress	number(double)	false	Playback progress
»» status	string	true	Playback status
»» created	string(date-time)	false	Playback creation
»» updated	string(date-time)	false	Playback update

Enumerated Values

Property	Value
status	completed
status	skipped
status	current
status	queued
status	suggested

queueRead

Code samples

GET https://api.cloud-player.io//queue/{id} HTTP/1.1
Host: api.cloud-player.io

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.cloud-player.io//queue/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.cloud-player.io//queue/{id}', params={

}, headers = headers)

print r.json()

GET /queue/{id}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	Queue id

Example responses

{
  "id": "string",
  "account_id": null,
  "playbacks": [
    {
      "id": "string",
      "previous": "string",
      "next": "string",
      "progress": 0,
      "status": "completed",
      "created": "2018-04-17T17:14:29Z",
      "updated": "2018-04-17T17:14:29Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Description
» id	string	true	Queue id
» account_id	any	true	No description
» playbacks	[object]	true	List of playbacks
»» id	string	true	Playback id
»» previous	string	false	Playback id
»» next	string	false	Playback id
»» progress	number(double)	false	Playback progress
»» status	string	true	Playback status
»» created	string(date-time)	false	Playback creation
»» updated	string(date-time)	false	Playback update

Enumerated Values

Property	Value
status	completed
status	skipped
status	current
status	queued
status	suggested