NAV Navbar
Shell HTTP JavaScript Python PHP Java Ruby Go



Audius API Docs

The Audius API is entirely free to use. We ask that you adhere to the guidelines in this doc and always credit artists.

Selecting a Host

Code Sample

curl https://api.audius.co
GET https://api.audius.co HTTP/1.1

const sample = (arr) => arr[Math.floor(Math.random() * arr.length)]
const host = await fetch('https://api.audius.co')
  .then(r => r.json())
  .then(j => j.data)
  .then(d => sample(d))

import random
import requests

host = random.choice((requests.get('https://api.audius.co')).json()['data'])

Audius is a decentralized music streaming service. To use the API, you first select an API endpoint from the list of endpoints returned by:

https://api.audius.co

Once you've selected a host, all API requests can be sent directly to it. We recommend selecting a host each time your application starts up as availability may change over time.

For the following documention, we've selected one for you:

AUDIUS_API_HOST

Specifying App Name

If you're integrating the Audius API into an app in production, we ask that you include an &app_name=<YOUR-UNIQUE-APP-NAME> param with each query. Your unique app name is entirely up to you!



users

Get User

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}

Gets a single user by their user ID

Query Parameters

Name Type Required Description
id string true A User ID
app_name string false Your app name

Example Response

{
  "data": {
    "album_count": 0,
    "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
    "cover_photo": {
      "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
      "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
    },
    "followee_count": 26,
    "follower_count": 33254,
    "does_follow_current_user": false,
    "handle": "TeamBandL",
    "id": "nlGNe",
    "is_verified": true,
    "location": "Los Angeles, CA",
    "name": "Brownies & Lemonade",
    "playlist_count": 2,
    "profile_picture": {
      "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
      "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
      "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
    },
    "repost_count": 5,
    "track_count": 10,
    "is_deactivated": false,
    "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
    "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
    "supporter_count": 0,
    "supporting_count": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none user_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get User ID from Wallet

Code Sample

curl AUDIUS_API_HOST/v1/users/id?associated_wallet=0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/id?associated_wallet=0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/id?associated_wallet=0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/id',
  params: {
  'associated_wallet' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/id', params={
  'associated_wallet': '0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/id?associated_wallet=0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/id", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/id

Gets a User ID from an associated wallet address

Query Parameters

Name Type Required Description
associated_wallet string true Wallet address
app_name string false Your app name

Example Response

{
  "data": {
    "user_id": "nlGNe"
  }
}

Responses

Status Meaning Description Schema
200 OK none user_associated_wallet_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Search Users

Code Sample

curl AUDIUS_API_HOST/v1/users/search?query=Brownies&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/search?query=Brownies&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/search?query=Brownies&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/search',
  params: {
  'query' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/search', params={
  'query': 'Brownies',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/search?query=Brownies&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/search

Search for users that match the given query

Query Parameters

Name Type Required Description
query string true The search query
app_name string false Your app name

Example Response

{
  "data": [
    {
      "album_count": 0,
      "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
      "cover_photo": {
        "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
        "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
      },
      "followee_count": 26,
      "follower_count": 33254,
      "does_follow_current_user": false,
      "handle": "TeamBandL",
      "id": "nlGNe",
      "is_verified": true,
      "location": "Los Angeles, CA",
      "name": "Brownies & Lemonade",
      "playlist_count": 2,
      "profile_picture": {
        "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
      },
      "repost_count": 5,
      "track_count": 10,
      "is_deactivated": false,
      "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
      "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
      "supporter_count": 0,
      "supporting_count": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none user_search
400 Bad Request Bad request None
500 Internal Server Error Server error None

Verify ID Token

Code Sample

curl AUDIUS_API_HOST/v1/users/verify_token?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJrZWNjYWsyNTYifQ.eyJ1c2VySWQiOjE0MTYxMTUsImVtYWlsIjoiaXNhYWN0ZXN0NDUxQGdtYWlsLmNvbSIsIm5hbWUiOiJ0ZXN0aW5nMTIiLCJoYW5kbGUiOiJ0ZXN0dGVzdDQ1MSIsInZlcmlmaWVkIjpmYWxzZSwic3ViIjoxNDE2MTE1LCJpYXQiOjE2NTY1MTgzMzN9.MHhkZmYyYWY5ZThmNDAxZDUyZDlhNjUxNGRiOTg0ZjM5YjFhOTZkYmNmZmViZjMzZjNkNmEzMTk4OTVlZWE2MTZjNjg0NWIwOGEyOGQ4MTA4OTEyMTc4ZDU0ODRhZGU4M2I1Yzg4ZTUwM2Y3OGYzMDYzZjYxMmQxZDQwYTYwMGZmZDFi&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/verify_token?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJrZWNjYWsyNTYifQ.eyJ1c2VySWQiOjE0MTYxMTUsImVtYWlsIjoiaXNhYWN0ZXN0NDUxQGdtYWlsLmNvbSIsIm5hbWUiOiJ0ZXN0aW5nMTIiLCJoYW5kbGUiOiJ0ZXN0dGVzdDQ1MSIsInZlcmlmaWVkIjpmYWxzZSwic3ViIjoxNDE2MTE1LCJpYXQiOjE2NTY1MTgzMzN9.MHhkZmYyYWY5ZThmNDAxZDUyZDlhNjUxNGRiOTg0ZjM5YjFhOTZkYmNmZmViZjMzZjNkNmEzMTk4OTVlZWE2MTZjNjg0NWIwOGEyOGQ4MTA4OTEyMTc4ZDU0ODRhZGU4M2I1Yzg4ZTUwM2Y3OGYzMDYzZjYxMmQxZDQwYTYwMGZmZDFi&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/verify_token?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJrZWNjYWsyNTYifQ.eyJ1c2VySWQiOjE0MTYxMTUsImVtYWlsIjoiaXNhYWN0ZXN0NDUxQGdtYWlsLmNvbSIsIm5hbWUiOiJ0ZXN0aW5nMTIiLCJoYW5kbGUiOiJ0ZXN0dGVzdDQ1MSIsInZlcmlmaWVkIjpmYWxzZSwic3ViIjoxNDE2MTE1LCJpYXQiOjE2NTY1MTgzMzN9.MHhkZmYyYWY5ZThmNDAxZDUyZDlhNjUxNGRiOTg0ZjM5YjFhOTZkYmNmZmViZjMzZjNkNmEzMTk4OTVlZWE2MTZjNjg0NWIwOGEyOGQ4MTA4OTEyMTc4ZDU0ODRhZGU4M2I1Yzg4ZTUwM2Y3OGYzMDYzZjYxMmQxZDQwYTYwMGZmZDFi&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/verify_token',
  params: {
  'token' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/verify_token', params={
  'token': 'eyJ0eXAiOiJKV1QiLCJhbGciOiJrZWNjYWsyNTYifQ.eyJ1c2VySWQiOjE0MTYxMTUsImVtYWlsIjoiaXNhYWN0ZXN0NDUxQGdtYWlsLmNvbSIsIm5hbWUiOiJ0ZXN0aW5nMTIiLCJoYW5kbGUiOiJ0ZXN0dGVzdDQ1MSIsInZlcmlmaWVkIjpmYWxzZSwic3ViIjoxNDE2MTE1LCJpYXQiOjE2NTY1MTgzMzN9.MHhkZmYyYWY5ZThmNDAxZDUyZDlhNjUxNGRiOTg0ZjM5YjFhOTZkYmNmZmViZjMzZjNkNmEzMTk4OTVlZWE2MTZjNjg0NWIwOGEyOGQ4MTA4OTEyMTc4ZDU0ODRhZGU4M2I1Yzg4ZTUwM2Y3OGYzMDYzZjYxMmQxZDQwYTYwMGZmZDFi',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/verify_token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/verify_token?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJrZWNjYWsyNTYifQ.eyJ1c2VySWQiOjE0MTYxMTUsImVtYWlsIjoiaXNhYWN0ZXN0NDUxQGdtYWlsLmNvbSIsIm5hbWUiOiJ0ZXN0aW5nMTIiLCJoYW5kbGUiOiJ0ZXN0dGVzdDQ1MSIsInZlcmlmaWVkIjpmYWxzZSwic3ViIjoxNDE2MTE1LCJpYXQiOjE2NTY1MTgzMzN9.MHhkZmYyYWY5ZThmNDAxZDUyZDlhNjUxNGRiOTg0ZjM5YjFhOTZkYmNmZmViZjMzZjNkNmEzMTk4OTVlZWE2MTZjNjg0NWIwOGEyOGQ4MTA4OTEyMTc4ZDU0ODRhZGU4M2I1Yzg4ZTUwM2Y3OGYzMDYzZjYxMmQxZDQwYTYwMGZmZDFi&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/verify_token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/verify_token

Verify if the given jwt ID token was signed by the subject (user) in the payload

Query Parameters

Name Type Required Description
token string true JWT to verify
app_name string false Your app name

Example Response

{
  "data": {
    "userId": "1416115",
    "email": "isaactest451@gmail.com",
    "name": "testing12",
    "handle": "testtest451",
    "verified": false,
    "profilePicture": null,
    "sub": "1416115",
    "iat": "1656518333"
  }
}

Responses

Status Meaning Description Schema
200 OK none verify_token
400 Bad Request Bad input None
404 Not Found ID token not valid None
500 Internal Server Error Server error None

Get User's Connected Wallets

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe/connected_wallets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/connected_wallets

Get the User's ERC and SPL connected wallets

Query Parameters

Name Type Required Description
id string true A User ID
app_name string false Your app name

Example Response

{
  "data": {
    "erc_wallets": [
      "0x087F08462BbD30fC1775bBA3E58821F4CaD47b6b"
    ],
    "spl_wallets": []
  }
}

Responses

Status Meaning Description Schema
200 OK none connected_wallets_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get User's Favorite Tracks

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe/favorites?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe/favorites?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe/favorites?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe/favorites',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe/favorites', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe/favorites?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/favorites

Gets a user's favorite tracks

Query Parameters

Name Type Required Description
id string true A User ID
app_name string false Your app name

Example Response

{
  "data": [
    {
      "favorite_item_id": "ezYKz",
      "favorite_type": "SaveType.track",
      "user_id": "nlGNe"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none favorites_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get User's Reposts

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe/reposts?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe/reposts?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe/reposts?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe/reposts',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe/reposts', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe/reposts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe/reposts?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe/reposts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/reposts

Gets the given user's reposts

Query Parameters

Name Type Required Description
id string true A User ID
offset integer false The number of items to skip. Useful for pagination (page number * limit)
limit integer false The number of items to fetch
user_id string false The user ID of the user making the request
app_name string false Your app name

Example Response

{
  "data": [
    {
      "timestamp": "2021-05-03 02:48:00",
      "item_type": "track",
      "item": {
        "artwork": {
          "150x150": "https://creatornode3.audius.co/ipfs/QmWGQf6CnFJJ4he13eDF2vZwDyoaWcHL3HziQyaSPwVFd3/150x150.jpg",
          "480x480": "https://creatornode3.audius.co/ipfs/QmWGQf6CnFJJ4he13eDF2vZwDyoaWcHL3HziQyaSPwVFd3/480x480.jpg",
          "1000x1000": "https://creatornode3.audius.co/ipfs/QmWGQf6CnFJJ4he13eDF2vZwDyoaWcHL3HziQyaSPwVFd3/1000x1000.jpg"
        },
        "description": null,
        "genre": "Electronic",
        "id": "y7XX7",
        "mood": "Other",
        "release_date": "Sun Mar 28 2021 11:52:35 GMT-0700",
        "remix_of": {
          "tracks": null
        },
        "repost_count": 45,
        "favorite_count": 99,
        "tags": null,
        "title": "PAULINE HERR @ BROWNIES & LEMONADE OPEN AUX 1/30",
        "user": {
          "album_count": 1,
          "bio": "producer, singer, human\n\nsocials: @paulineherr",
          "cover_photo": {
            "640x": "https://creatornode3.audius.co/ipfs/QmZXwdQDq5QDJW3W17g4n4zXVjaDGDbvuzsMWqhis61W7h/640x.jpg",
            "2000x": "https://creatornode3.audius.co/ipfs/QmZXwdQDq5QDJW3W17g4n4zXVjaDGDbvuzsMWqhis61W7h/2000x.jpg"
          },
          "followee_count": 144,
          "follower_count": 33651,
          "does_follow_current_user": false,
          "handle": "paulineherr",
          "id": "eGEam",
          "is_verified": true,
          "location": "Burbank, CA",
          "name": "Pauline Herr",
          "playlist_count": 1,
          "profile_picture": {
            "150x150": "https://creatornode3.audius.co/ipfs/QmbqwCk1axAdXk9iFfeU48iu1P73ChUA3kxpeg7PJBRHsC/150x150.jpg",
            "480x480": "https://creatornode3.audius.co/ipfs/QmbqwCk1axAdXk9iFfeU48iu1P73ChUA3kxpeg7PJBRHsC/480x480.jpg",
            "1000x1000": "https://creatornode3.audius.co/ipfs/QmbqwCk1axAdXk9iFfeU48iu1P73ChUA3kxpeg7PJBRHsC/1000x1000.jpg"
          },
          "repost_count": 155,
          "track_count": 36,
          "is_deactivated": false,
          "erc_wallet": "0xf568ab060acd91fe4861e52136deb08ca1f26574",
          "spl_wallet": "3DeyiqjmCAtqPUzGX6MQP2C62kKRANy7LFvcBzUEHqPc",
          "supporter_count": 0,
          "supporting_count": 0
        },
        "duration": 1708,
        "downloadable": false,
        "play_count": 873,
        "permalink": "/paulineherr/pauline-herr-brownies-lemonade-open-aux-130-316935"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none reposts
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get Supporters

Code Sample

curl AUDIUS_API_HOST/v1/users/lzkyZ/supporters?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/lzkyZ/supporters?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/lzkyZ/supporters?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/lzkyZ/supporters',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/lzkyZ/supporters', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/lzkyZ/supporters', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/lzkyZ/supporters?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/lzkyZ/supporters", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/supporters

Gets the supporters of the given user

Query Parameters

Name Type Required Description
id string true A User ID
offset integer false The number of items to skip. Useful for pagination (page number * limit)
limit integer false The number of items to fetch
app_name string false Your app name

Example Response

{
  "data": [
    {
      "rank": 1,
      "amount": "6000000000000000000",
      "sender": {
        "album_count": 0,
        "bio": "Bebig Music is a record label part of treinta3tres records dedicated to dance commercial music.\nBebig Music is Dance!\nbebigmusic@gmail.com",
        "cover_photo": {
          "640x": "https://creatornode2.audius.co/ipfs/QmQRATHCJEiwsCu4f1rGjPefF8fcwYnGzv2wuiKFnA3hv2/640x.jpg",
          "2000x": "https://creatornode2.audius.co/ipfs/QmQRATHCJEiwsCu4f1rGjPefF8fcwYnGzv2wuiKFnA3hv2/2000x.jpg"
        },
        "followee_count": 57,
        "follower_count": 69,
        "does_follow_current_user": false,
        "handle": "bebigmusic",
        "id": "aW8mr",
        "is_verified": false,
        "location": "Barcelona",
        "name": "Bebig Music",
        "playlist_count": 0,
        "profile_picture": {
          "150x150": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/150x150.jpg",
          "480x480": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/480x480.jpg",
          "1000x1000": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/1000x1000.jpg"
        },
        "repost_count": 70,
        "track_count": 10,
        "is_deactivated": false,
        "erc_wallet": "0xcdc88b59fc7f2ea01ff6781bae25c1a59a2378cd",
        "spl_wallet": "3EDj16wey6nfw26LhEXTyVmCnvvAMw4ruHfc76kWKkq8",
        "supporter_count": 0,
        "supporting_count": 1
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none get_supporters

Get Supportings

Code Sample

curl AUDIUS_API_HOST/v1/users/aW8mr/supporting?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/aW8mr/supporting?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/aW8mr/supporting?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/aW8mr/supporting',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/aW8mr/supporting', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/aW8mr/supporting', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/aW8mr/supporting?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/aW8mr/supporting", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/supporting

Gets the users that the given user supports

Query Parameters

Name Type Required Description
id string true A User ID
offset integer false The number of items to skip. Useful for pagination (page number * limit)
limit integer false The number of items to fetch
app_name string false Your app name

Example Response

{
  "data": [
    {
      "rank": 1,
      "amount": "6000000000000000000",
      "receiver": {
        "album_count": 5,
        "bio": "Record label based in BCN serving cool house music to the world\ntreinta3tres\nBebig Music\nMassivefunk\ninfo@treinta3tres.com",
        "cover_photo": {
          "640x": "https://creatornode2.audius.co/ipfs/QmdHB2wg2inSdiUMYd693dxFB6qcgHnF4REoZQcsUogMJj/640x.jpg",
          "2000x": "https://creatornode2.audius.co/ipfs/QmdHB2wg2inSdiUMYd693dxFB6qcgHnF4REoZQcsUogMJj/2000x.jpg"
        },
        "followee_count": 13,
        "follower_count": 83,
        "does_follow_current_user": false,
        "handle": "treinta3tres",
        "id": "lzkyZ",
        "is_verified": false,
        "location": "Barcelona",
        "name": "treinta3tres",
        "playlist_count": 3,
        "profile_picture": {
          "150x150": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/150x150.jpg",
          "480x480": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/480x480.jpg",
          "1000x1000": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/1000x1000.jpg"
        },
        "repost_count": 21,
        "track_count": 52,
        "is_deactivated": false,
        "erc_wallet": "0xa18d959231ca5728fefbf7b45ddc87f44e0832db",
        "spl_wallet": "3Mm5mdBT3jtRifHpxBfJavRXyfM4G4kbV7KKrX2nj12M",
        "supporter_count": 2,
        "supporting_count": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none get_supporting

Get User's Most Used Track Tags

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe/tags?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe/tags?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe/tags?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe/tags',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe/tags', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe/tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe/tags?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe/tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/tags

Fetch most used tags in a user's tracks

Gets the most used track tags by a user.

Query Parameters

Name Type Required Description
id string true A User ID
limit integer false The number of items to fetch
user_id string false The user ID of the user making the request
app_name string false Your app name

Example Response

{
  "data": [
    "browniesandlemonade"
  ]
}

Responses

Status Meaning Description Schema
200 OK none tags_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get User's Tracks

Code Sample

curl AUDIUS_API_HOST/v1/users/nlGNe/tracks?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/users/nlGNe/tracks?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/users/nlGNe/tracks?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/users/nlGNe/tracks',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/users/nlGNe/tracks', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/users/nlGNe/tracks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/users/nlGNe/tracks?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/users/nlGNe/tracks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}/tracks

Gets the tracks created by a user using their user ID

Query Parameters

Name Type Required Description
id string true A User ID
offset integer false The number of items to skip. Useful for pagination (page number * limit)
limit integer false The number of items to fetch
user_id string false The user ID of the user making the request
sort string false Field to sort by
Available values:dateplays
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://creatornode.audius.co/ipfs/QmP47PX5vEMds7cddyz18VGo1bFSgS5jKNbpoeTdDTeBfY/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmP47PX5vEMds7cddyz18VGo1bFSgS5jKNbpoeTdDTeBfY/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmP47PX5vEMds7cddyz18VGo1bFSgS5jKNbpoeTdDTeBfY/1000x1000.jpg"
      },
      "description": "Dimension live from Brownies & Lemonade DNBNL on Nov. 10, 2021",
      "genre": "Drum & Bass",
      "id": "gJqxx",
      "mood": "Energizing",
      "release_date": "Fri Mar 04 2022 09:47:12 GMT-0800",
      "remix_of": {
        "tracks": null
      },
      "repost_count": 2466,
      "favorite_count": 2608,
      "tags": "browniesandlemonade,drumandbass,dnbnl,dimension",
      "title": "Dimension - Brownies and Lemonade Live in LA (Live Set)",
      "user": {
        "album_count": 0,
        "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
        "cover_photo": {
          "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
          "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
        },
        "followee_count": 26,
        "follower_count": 33254,
        "does_follow_current_user": false,
        "handle": "TeamBandL",
        "id": "nlGNe",
        "is_verified": true,
        "location": "Los Angeles, CA",
        "name": "Brownies & Lemonade",
        "playlist_count": 2,
        "profile_picture": {
          "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
          "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
          "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
        },
        "repost_count": 5,
        "track_count": 10,
        "is_deactivated": false,
        "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
        "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
        "supporter_count": 0,
        "supporting_count": 0
      },
      "duration": 4645,
      "downloadable": false,
      "play_count": 11058,
      "permalink": "/TeamBandL/dimension-brownies-and-lemonade-live-in-la-live-set-1"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none tracks_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

playlists

Get Playlist

Code Sample

curl AUDIUS_API_HOST/v1/playlists/DOPRl?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/playlists/DOPRl?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/playlists/DOPRl?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/playlists/DOPRl',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/playlists/DOPRl', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/playlists/DOPRl', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/playlists/DOPRl?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/playlists/DOPRl", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /playlists/{playlist_id}

Get a playlist by ID

Query Parameters

Name Type Required Description
playlist_id string true A Playlist ID
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/150x150.jpg",
        "480x480": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/480x480.jpg",
        "1000x1000": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/1000x1000.jpg"
      },
      "description": "All the latest hot & new tracks on Audius! Prepare to buckle in for a trip through various genres featuring artists you love and new artists you are about to discover.",
      "id": "DOPRl",
      "is_album": false,
      "playlist_name": "Hot & New on Audius 🔥",
      "repost_count": 1498,
      "favorite_count": 766076,
      "total_play_count": 24600,
      "user": {
        "album_count": 0,
        "bio": "The official Audius account!\n\nCreating a decentralized and open-source streaming music platform controlled by artists, fans, & developers.\n\nhttps://discord.gg/audius\nhttps://t.me/audiusannounce",
        "cover_photo": {
          "640x": "https://usermetadata.audius.co/ipfs/QmSeB4DY1qBtp9hbnmMwnkGepRY6tRrNQcgZU2oNk4SK1q/640x.jpg",
          "2000x": "https://usermetadata.audius.co/ipfs/QmSeB4DY1qBtp9hbnmMwnkGepRY6tRrNQcgZU2oNk4SK1q/2000x.jpg"
        },
        "followee_count": 525,
        "follower_count": 1033171,
        "does_follow_current_user": false,
        "handle": "Audius",
        "id": "eJ57D",
        "is_verified": true,
        "location": "SF & LA",
        "name": "Audius",
        "playlist_count": 4,
        "profile_picture": {
          "150x150": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/150x150.jpg",
          "480x480": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/480x480.jpg",
          "1000x1000": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/1000x1000.jpg"
        },
        "repost_count": 1529,
        "track_count": 0,
        "is_deactivated": false,
        "erc_wallet": "0x3256bd2d0b1984e7df4fa525017ad9ba48470760",
        "spl_wallet": "D1WXgUS2pnrVQTEqSGy2t2oxowahUL8Pw2Qy64CvTi79",
        "supporter_count": 0,
        "supporting_count": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none playlist_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Search Playlists

Code Sample

curl AUDIUS_API_HOST/v1/playlists/search?query=Hot & New&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/playlists/search?query=Hot & New&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/playlists/search?query=Hot & New&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/playlists/search',
  params: {
  'query' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/playlists/search', params={
  'query': 'Hot & New',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/playlists/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/playlists/search?query=Hot & New&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/playlists/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /playlists/search

Search for a playlist

Query Parameters

Name Type Required Description
query string true The search query
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/150x150.jpg",
        "480x480": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/480x480.jpg",
        "1000x1000": "https://usermetadata.audius.co/ipfs/Qmc7RFzLGgW3DUTgKK49LzxEwe3Lmb47q85ZwJJRVYTXPr/1000x1000.jpg"
      },
      "description": "All the latest hot & new tracks on Audius! Prepare to buckle in for a trip through various genres featuring artists you love and new artists you are about to discover.",
      "id": "DOPRl",
      "is_album": false,
      "playlist_name": "Hot & New on Audius 🔥",
      "repost_count": 1498,
      "favorite_count": 766071,
      "total_play_count": 24527,
      "user": {
        "album_count": 0,
        "bio": "The official Audius account!\n\nCreating a decentralized and open-source streaming music platform controlled by artists, fans, & developers.\n\nhttps://discord.gg/audius\nhttps://t.me/audiusannounce",
        "cover_photo": {
          "640x": "https://usermetadata.audius.co/ipfs/QmSeB4DY1qBtp9hbnmMwnkGepRY6tRrNQcgZU2oNk4SK1q/640x.jpg",
          "2000x": "https://usermetadata.audius.co/ipfs/QmSeB4DY1qBtp9hbnmMwnkGepRY6tRrNQcgZU2oNk4SK1q/2000x.jpg"
        },
        "followee_count": 525,
        "follower_count": 1033168,
        "does_follow_current_user": false,
        "handle": "Audius",
        "id": "eJ57D",
        "is_verified": true,
        "location": "SF & LA",
        "name": "Audius",
        "playlist_count": 4,
        "profile_picture": {
          "150x150": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/150x150.jpg",
          "480x480": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/480x480.jpg",
          "1000x1000": "https://usermetadata.audius.co/ipfs/QmNjJv1wQf2DJq3GNXjXzSL8UXFUGXfchg4NhL7UpbnF1f/1000x1000.jpg"
        },
        "repost_count": 1529,
        "track_count": 0,
        "is_deactivated": false,
        "erc_wallet": "0x3256bd2d0b1984e7df4fa525017ad9ba48470760",
        "spl_wallet": "D1WXgUS2pnrVQTEqSGy2t2oxowahUL8Pw2Qy64CvTi79",
        "supporter_count": 0,
        "supporting_count": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none playlist_search_result
400 Bad Request Bad request None
500 Internal Server Error Server error None

Code Sample

curl AUDIUS_API_HOST/v1/playlists/trending?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/playlists/trending?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/playlists/trending?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/playlists/trending',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/playlists/trending', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/playlists/trending', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/playlists/trending?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/playlists/trending", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /playlists/trending

Gets trending playlists for a time period

Name Type Required Description
time string false Calculate trending over a specified time range
Available values:weekmonthyearallTime
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://creatornode2.audius.co/ipfs/QmcF1dQdqnn5K49YTCyhR6aKX5kHqnMyVMpwi7dCBfNvsm/150x150.jpg",
        "480x480": "https://creatornode2.audius.co/ipfs/QmcF1dQdqnn5K49YTCyhR6aKX5kHqnMyVMpwi7dCBfNvsm/480x480.jpg",
        "1000x1000": "https://creatornode2.audius.co/ipfs/QmcF1dQdqnn5K49YTCyhR6aKX5kHqnMyVMpwi7dCBfNvsm/1000x1000.jpg"
      },
      "description": null,
      "id": "aAw5Q",
      "is_album": false,
      "playlist_name": "Chill Vibes  Lofi hip hop Music Deep ",
      "repost_count": 29,
      "favorite_count": 41,
      "total_play_count": 12695,
      "user": {
        "album_count": 0,
        "bio": "vibe music",
        "cover_photo": {
          "640x": "https://creatornode2.audius.co/ipfs/QmWx2iWSpAT3Z5oLSFB9DfxgppESkLBEB9oJpU1BKtPPZk/640x.jpg",
          "2000x": "https://creatornode2.audius.co/ipfs/QmWx2iWSpAT3Z5oLSFB9DfxgppESkLBEB9oJpU1BKtPPZk/2000x.jpg"
        },
        "followee_count": 17,
        "follower_count": 120,
        "does_follow_current_user": false,
        "handle": "vibemusic",
        "id": "7AG6P",
        "is_verified": false,
        "location": null,
        "name": "vibemusic",
        "playlist_count": 4,
        "profile_picture": {
          "150x150": "https://creatornode2.audius.co/ipfs/QmSbpL8UxnTgXJF6exg1t3JpnA7QM1YnTF2UEoK5CvNhTQ/150x150.jpg",
          "480x480": "https://creatornode2.audius.co/ipfs/QmSbpL8UxnTgXJF6exg1t3JpnA7QM1YnTF2UEoK5CvNhTQ/480x480.jpg",
          "1000x1000": "https://creatornode2.audius.co/ipfs/QmSbpL8UxnTgXJF6exg1t3JpnA7QM1YnTF2UEoK5CvNhTQ/1000x1000.jpg"
        },
        "repost_count": 179,
        "track_count": 3,
        "is_deactivated": false,
        "erc_wallet": "0xa83604a5a9bae53def1f4325f048d86afed13a6e",
        "spl_wallet": "XAcjNmSrsH8JHXynMhDF9erRpxgVN26g8zs3p6dUCGa",
        "supporter_count": 0,
        "supporting_count": 0
      }
    }
  ]
}
Status Meaning Description Schema
200 OK none trending_playlists_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get Playlist Tracks

Code Sample

curl AUDIUS_API_HOST/v1/playlists/DOPRl/tracks?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/playlists/DOPRl/tracks?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/playlists/DOPRl/tracks?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/playlists/DOPRl/tracks',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/playlists/DOPRl/tracks', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/playlists/DOPRl/tracks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/playlists/DOPRl/tracks?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/playlists/DOPRl/tracks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /playlists/{playlist_id}/tracks

Fetch tracks within a playlist.

Query Parameters

Name Type Required Description
playlist_id string true A Playlist ID
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://creatornode3.audius.co/ipfs/QmV1pQZdfmrMFG2E4GCPvTcC3JVXUejfdZ4W2rSa3jTjsZ/150x150.jpg",
        "480x480": "https://creatornode3.audius.co/ipfs/QmV1pQZdfmrMFG2E4GCPvTcC3JVXUejfdZ4W2rSa3jTjsZ/480x480.jpg",
        "1000x1000": "https://creatornode3.audius.co/ipfs/QmV1pQZdfmrMFG2E4GCPvTcC3JVXUejfdZ4W2rSa3jTjsZ/1000x1000.jpg"
      },
      "description": null,
      "genre": "Hip-Hop/Rap",
      "id": "W66jo",
      "mood": "Gritty",
      "release_date": "Fri Jun 24 2022 08:14:47 GMT-0700",
      "remix_of": {
        "tracks": null
      },
      "repost_count": 44,
      "favorite_count": 72,
      "tags": null,
      "title": "TAXIN",
      "user": {
        "album_count": 1,
        "bio": "$INGLES COLLECTION\nhttps://linktr.ee/DarnellW\n\nEach collector will receive 10% of the music royalties via UnitedMasters Splitpay. news.unitedmasters.com/blog/splitpay (Does not include licensing rights)",
        "cover_photo": {
          "640x": "https://creatornode3.audius.co/ipfs/QmdttfmkepBmhRN1SXN1HahhyURGkZTQvfvvnHFjFiTxS1/640x.jpg",
          "2000x": "https://creatornode3.audius.co/ipfs/QmdttfmkepBmhRN1SXN1HahhyURGkZTQvfvvnHFjFiTxS1/2000x.jpg"
        },
        "followee_count": 28,
        "follower_count": 28884,
        "does_follow_current_user": false,
        "handle": "DarnellWilliams",
        "id": "6EEYG",
        "is_verified": true,
        "location": "Los Angeles",
        "name": "Darnell William$",
        "playlist_count": 0,
        "profile_picture": {
          "150x150": "https://creatornode3.audius.co/ipfs/QmZJibTCb9ti4ZRr8myKcLXeE2yFMmvu7WPYZ7Nghp4yN3/150x150.jpg",
          "480x480": "https://creatornode3.audius.co/ipfs/QmZJibTCb9ti4ZRr8myKcLXeE2yFMmvu7WPYZ7Nghp4yN3/480x480.jpg",
          "1000x1000": "https://creatornode3.audius.co/ipfs/QmZJibTCb9ti4ZRr8myKcLXeE2yFMmvu7WPYZ7Nghp4yN3/1000x1000.jpg"
        },
        "repost_count": 2,
        "track_count": 19,
        "is_deactivated": false,
        "erc_wallet": "0x1a994e5b35526111e7aa92fece1815f5099c72b2",
        "spl_wallet": "5rnytbVtJiV1fqkUPHZhFngPsmEFgjpjJWSg2oLCt2ut",
        "supporter_count": 0,
        "supporting_count": 0
      },
      "duration": 166,
      "downloadable": false,
      "play_count": 5814,
      "permalink": "/DarnellWilliams/taxin"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none playlist_tracks_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

tracks

Get Track

Code Sample

curl AUDIUS_API_HOST/v1/tracks/D7KyD?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/tracks/D7KyD?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/tracks/D7KyD?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/tracks/D7KyD',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/tracks/D7KyD', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tracks/D7KyD', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tracks/D7KyD?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tracks/D7KyD", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tracks/{track_id}

Gets a track by ID

Query Parameters

Name Type Required Description
track_id string true A Track ID
app_name string false Your app name

Example Response

{
  "data": {
    "artwork": {
      "150x150": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/150x150.jpg",
      "480x480": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/480x480.jpg",
      "1000x1000": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/1000x1000.jpg"
    },
    "description": "@baauer b2b @partyfavor live set at Brownies & Lemonade Block Party LA at The Shrine on 7.3.19.",
    "genre": "Electronic",
    "id": "D7KyD",
    "mood": "Fiery",
    "release_date": "Mon Sep 23 2019 12:35:10 GMT-0700",
    "remix_of": {
      "tracks": null
    },
    "repost_count": 397,
    "favorite_count": 867,
    "tags": "baauer,partyfavor,browniesandlemonade,live",
    "title": "Paauer | Baauer B2B Party Favor | B&L Block Party LA (Live Set)",
    "user": {
      "album_count": 0,
      "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
      "cover_photo": {
        "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
        "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
      },
      "followee_count": 26,
      "follower_count": 33254,
      "does_follow_current_user": false,
      "handle": "TeamBandL",
      "id": "nlGNe",
      "is_verified": true,
      "location": "Los Angeles, CA",
      "name": "Brownies & Lemonade",
      "playlist_count": 2,
      "profile_picture": {
        "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
      },
      "repost_count": 5,
      "track_count": 10,
      "is_deactivated": false,
      "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
      "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
      "supporter_count": 0,
      "supporting_count": 0
    },
    "duration": 5265,
    "downloadable": false,
    "play_count": 333597,
    "permalink": "/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725"
  }
}

Responses

Status Meaning Description Schema
200 OK none track_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Get Bulk Tracks

Code Sample

curl AUDIUS_API_HOST/v1/tracks?permalink=/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/tracks?permalink=/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/tracks?permalink=/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/tracks',
  params: {
  'permalink' => 'array[string]',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/tracks', params={
  'permalink': '/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tracks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tracks?permalink=/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tracks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tracks

Gets a list of tracks using their IDs or permalinks

Query Parameters

Name Type Required Description
permalink array[string] false The permalink of the track(s)
id array[string] false The ID of the track(s)
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/1000x1000.jpg"
      },
      "description": "@baauer b2b @partyfavor live set at Brownies & Lemonade Block Party LA at The Shrine on 7.3.19.",
      "genre": "Electronic",
      "id": "D7KyD",
      "mood": "Fiery",
      "release_date": "Mon Sep 23 2019 12:35:10 GMT-0700",
      "remix_of": {
        "tracks": null
      },
      "repost_count": 397,
      "favorite_count": 867,
      "tags": "baauer,partyfavor,browniesandlemonade,live",
      "title": "Paauer | Baauer B2B Party Favor | B&L Block Party LA (Live Set)",
      "user": {
        "album_count": 0,
        "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
        "cover_photo": {
          "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
          "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
        },
        "followee_count": 26,
        "follower_count": 33254,
        "does_follow_current_user": false,
        "handle": "TeamBandL",
        "id": "nlGNe",
        "is_verified": true,
        "location": "Los Angeles, CA",
        "name": "Brownies & Lemonade",
        "playlist_count": 2,
        "profile_picture": {
          "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
          "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
          "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
        },
        "repost_count": 5,
        "track_count": 10,
        "is_deactivated": false,
        "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
        "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
        "supporter_count": 0,
        "supporting_count": 0
      },
      "duration": 5265,
      "downloadable": false,
      "play_count": 333597,
      "permalink": "/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none tracks_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Search Tracks

Code Sample

curl AUDIUS_API_HOST/v1/tracks/search?query=baauer b2b&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/tracks/search?query=baauer b2b&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/tracks/search?query=baauer b2b&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/tracks/search',
  params: {
  'query' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/tracks/search', params={
  'query': 'baauer b2b',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tracks/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tracks/search?query=baauer b2b&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tracks/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tracks/search

Search for a track or tracks

Query Parameters

Name Type Required Description
query string true The search query
only_downloadable string false Return only downloadable tracks
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmVJjA6zXhDZn3BjcjYa33P9NDiPZj7Vyq9TCx1bHjvHmG/1000x1000.jpg"
      },
      "description": "@baauer b2b @partyfavor live set at Brownies & Lemonade Block Party LA at The Shrine on 7.3.19.",
      "genre": "Electronic",
      "id": "D7KyD",
      "mood": "Fiery",
      "release_date": "Mon Sep 23 2019 12:35:10 GMT-0700",
      "remix_of": {
        "tracks": null
      },
      "repost_count": 397,
      "favorite_count": 866,
      "tags": "baauer,partyfavor,browniesandlemonade,live",
      "title": "Paauer | Baauer B2B Party Favor | B&L Block Party LA (Live Set)",
      "user": {
        "album_count": 0,
        "bio": "Makin' moves & keeping you on your toes.\nlinktr.ee/browniesandlemonade",
        "cover_photo": {
          "640x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/640x.jpg",
          "2000x": "https://creatornode.audius.co/ipfs/QmcVZH5C2ygxoVS4ihPBJrkFrS1Ua6YJB5srNtXafPzihZ/2000x.jpg"
        },
        "followee_count": 26,
        "follower_count": 33254,
        "does_follow_current_user": false,
        "handle": "TeamBandL",
        "id": "nlGNe",
        "is_verified": true,
        "location": "Los Angeles, CA",
        "name": "Brownies & Lemonade",
        "playlist_count": 2,
        "profile_picture": {
          "150x150": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/150x150.jpg",
          "480x480": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/480x480.jpg",
          "1000x1000": "https://creatornode.audius.co/ipfs/QmU9L4beAM96MpiNqqVTZdiDiCRTeBku1AJCh3NXrE5PxV/1000x1000.jpg"
        },
        "repost_count": 5,
        "track_count": 10,
        "is_deactivated": false,
        "erc_wallet": "0x8bc337e467cec1e7b05e54c7d1f90814a78d259e",
        "spl_wallet": "WXBYqzejMr5qxmuDrvVTDQopr7vdZt5szsoSSb3EvQH",
        "supporter_count": 0,
        "supporting_count": 0
      },
      "duration": 5265,
      "downloadable": false,
      "play_count": 333592,
      "permalink": "/TeamBandL/paauer-|-baauer-b2b-party-favor-|-bl-block-party-la-live-set-725"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none track_search
400 Bad Request Bad request None
500 Internal Server Error Server error None

Code Sample

curl AUDIUS_API_HOST/v1/tracks/trending?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/tracks/trending?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/tracks/trending?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/tracks/trending',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/tracks/trending', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tracks/trending', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tracks/trending?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tracks/trending", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tracks/trending

Gets the top 100 trending (most popular) tracks on Audius

Name Type Required Description
genre string false Filter trending to a specified genre
time string false Calculate trending over a specified time range
Available values:weekmonthyearallTime
app_name string false Your app name

Example Response

{
  "data": [
    {
      "artwork": {
        "150x150": "https://content-node.audius.co/ipfs/QmThWr4yetmRZGpj5QAVGCYPpJF2oPSLjrq6epND41a1zY/150x150.jpg",
        "480x480": "https://content-node.audius.co/ipfs/QmThWr4yetmRZGpj5QAVGCYPpJF2oPSLjrq6epND41a1zY/480x480.jpg",
        "1000x1000": "https://content-node.audius.co/ipfs/QmThWr4yetmRZGpj5QAVGCYPpJF2oPSLjrq6epND41a1zY/1000x1000.jpg"
      },
      "description": "Follow me on social media!\nOfficial Website: www.nosammusic.com\nMerch: www.nosam.store\nInstagram: www.instagram.com/nosammusic\nTik Tok: www.tiktok.com/@nosam\nYoutube: www.youtube.com/c/nosam\nTwitter: www.twitter.com/nosammusic\nFacebook: www.facebook.com/nosammusic\nSoundCloud: https://soundcloud.com/nosam\nSnapchat: nosammusic",
      "genre": "Electronic",
      "id": "3Rva0",
      "mood": "Energizing",
      "release_date": "Tue Jun 21 2022 10:17:17 GMT-0700",
      "remix_of": {
        "tracks": null
      },
      "repost_count": 51,
      "favorite_count": 95,
      "tags": "sleepatnight,nosam,edm,progressivehouse,trap,dance,2022,festival,newmusic",
      "title": "Sleep at Night",
      "user": {
        "album_count": 0,
        "bio": "‘Sleep At Night’ out now!",
        "cover_photo": {
          "640x": "https://content-node.audius.co/ipfs/QmZEB1yfgUH4XShdaAnnhYS8N5sveBTKMn4gdEpSG92LWt/640x.jpg",
          "2000x": "https://content-node.audius.co/ipfs/QmZEB1yfgUH4XShdaAnnhYS8N5sveBTKMn4gdEpSG92LWt/2000x.jpg"
        },
        "followee_count": 8,
        "follower_count": 1289,
        "does_follow_current_user": false,
        "handle": "nosammusic",
        "id": "z87gz",
        "is_verified": true,
        "location": "Los Angeles, CA",
        "name": "NOSAM",
        "playlist_count": 2,
        "profile_picture": {
          "150x150": "https://content-node.audius.co/ipfs/QmY4ZjXJezD7X7zGhShTt7yk1At1GXLdefx8R6jjJi6QYn/150x150.jpg",
          "480x480": "https://content-node.audius.co/ipfs/QmY4ZjXJezD7X7zGhShTt7yk1At1GXLdefx8R6jjJi6QYn/480x480.jpg",
          "1000x1000": "https://content-node.audius.co/ipfs/QmY4ZjXJezD7X7zGhShTt7yk1At1GXLdefx8R6jjJi6QYn/1000x1000.jpg"
        },
        "repost_count": 0,
        "track_count": 11,
        "is_deactivated": false,
        "erc_wallet": "0x8cbf545775594b2884aa1421de59e96d16696641",
        "spl_wallet": "7KVcTkoYNJLShQcFG3w4nbfFFxfUPj6ho1httTt5ZpRT",
        "supporter_count": 0,
        "supporting_count": 0
      },
      "duration": 236,
      "downloadable": false,
      "play_count": 10927,
      "permalink": "/nosammusic/sleep-at-night"
    }
  ]
}
Status Meaning Description Schema
200 OK none tracks_response
400 Bad Request Bad request None
500 Internal Server Error Server error None

Stream Track

Code Sample

curl AUDIUS_API_HOST/v1/tracks/D7KyD/stream?app_name=EXAMPLEAPP

GET AUDIUS_API_HOST/v1/tracks/D7KyD/stream?app_name=EXAMPLEAPP HTTP/1.1


fetch('AUDIUS_API_HOST/v1/tracks/D7KyD/stream?app_name=EXAMPLEAPP',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get 'AUDIUS_API_HOST/v1/tracks/D7KyD/stream',
  params: {
  'app_name' => 'string'
}

p JSON.parse(result)

import requests

r = requests.get('AUDIUS_API_HOST/v1/tracks/D7KyD/stream', params={
  'app_name': 'EXAMPLEAPP'
})

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tracks/D7KyD/stream', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tracks/D7KyD/stream?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tracks/D7KyD/stream", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tracks/{track_id}/stream

Get the streamable MP3 file of a track

This endpoint accepts the Range header for streaming. https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests

Query Parameters

Name Type Required Description
track_id string true A Track ID
app_name string false Your app name

Responses

Status Meaning Description Schema
200 OK Success None
216 Unknown Partial content None
400 Bad Request Bad request None
416 Range Not Satisfiable Content range invalid None
500 Internal Server Error Server error None

tips

Get Tips

Code Sample

curl AUDIUS_API_HOST/v1/tips?app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/tips?app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/tips?app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/tips',
  params: {
  'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/tips', params={
  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/tips', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/tips?app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/tips", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tips

Gets the most recent tips on the network

Query Parameters

Name Type Required Description
offset integer false The number of items to skip. Useful for pagination (page number * limit)
limit integer false The number of items to fetch
user_id string false The user ID of the user making the request
receiver_min_followers integer false Only include tips to recipients that have this many followers
receiver_is_verified boolean false Only include tips to recipients that are verified
current_user_follows string false Only include tips involving the user's followers in the given capacity. Requires user_id to be set.
Available values:senderreceiversender_or_receiver
unique_by string false Only include the most recent tip for a user was involved in the given capacity.
Available values:senderreceiver
app_name string false Your app name

Detailed descriptions

unique_by: Only include the most recent tip for a user was involved in the given capacity.

Eg. 'sender' will ensure that each tip returned has a unique sender, using the most recent tip sent by a user if that user has sent multiple tips.

Example Response

{
  "data": [
    {
      "amount": "6000000000000000000",
      "sender": {
        "album_count": 0,
        "bio": "Bebig Music is a record label part of treinta3tres records dedicated to dance commercial music.\nBebig Music is Dance!\nbebigmusic@gmail.com",
        "cover_photo": {
          "640x": "https://creatornode2.audius.co/ipfs/QmQRATHCJEiwsCu4f1rGjPefF8fcwYnGzv2wuiKFnA3hv2/640x.jpg",
          "2000x": "https://creatornode2.audius.co/ipfs/QmQRATHCJEiwsCu4f1rGjPefF8fcwYnGzv2wuiKFnA3hv2/2000x.jpg"
        },
        "followee_count": 57,
        "follower_count": 69,
        "does_follow_current_user": false,
        "handle": "bebigmusic",
        "id": "aW8mr",
        "is_verified": false,
        "location": "Barcelona",
        "name": "Bebig Music",
        "playlist_count": 0,
        "profile_picture": {
          "150x150": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/150x150.jpg",
          "480x480": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/480x480.jpg",
          "1000x1000": "https://creatornode2.audius.co/ipfs/QmXrmgMy5fwfr6q6ucU4qkvwkq8cvFXfbms32NNctZDmoB/1000x1000.jpg"
        },
        "repost_count": 70,
        "track_count": 10,
        "is_deactivated": false,
        "erc_wallet": "0xcdc88b59fc7f2ea01ff6781bae25c1a59a2378cd",
        "spl_wallet": "3EDj16wey6nfw26LhEXTyVmCnvvAMw4ruHfc76kWKkq8",
        "supporter_count": 0,
        "supporting_count": 1
      },
      "receiver": {
        "album_count": 5,
        "bio": "Record label based in BCN serving cool house music to the world\ntreinta3tres\nBebig Music\nMassivefunk\ninfo@treinta3tres.com",
        "cover_photo": {
          "640x": "https://creatornode2.audius.co/ipfs/QmdHB2wg2inSdiUMYd693dxFB6qcgHnF4REoZQcsUogMJj/640x.jpg",
          "2000x": "https://creatornode2.audius.co/ipfs/QmdHB2wg2inSdiUMYd693dxFB6qcgHnF4REoZQcsUogMJj/2000x.jpg"
        },
        "followee_count": 13,
        "follower_count": 83,
        "does_follow_current_user": false,
        "handle": "treinta3tres",
        "id": "lzkyZ",
        "is_verified": false,
        "location": "Barcelona",
        "name": "treinta3tres",
        "playlist_count": 3,
        "profile_picture": {
          "150x150": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/150x150.jpg",
          "480x480": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/480x480.jpg",
          "1000x1000": "https://creatornode2.audius.co/ipfs/QmdJJf81jjRhpmrj2JzeMEzDNbPKfrUWkECE3NjfWnLDMr/1000x1000.jpg"
        },
        "repost_count": 21,
        "track_count": 52,
        "is_deactivated": false,
        "erc_wallet": "0xa18d959231ca5728fefbf7b45ddc87f44e0832db",
        "spl_wallet": "3Mm5mdBT3jtRifHpxBfJavRXyfM4G4kbV7KKrX2nj12M",
        "supporter_count": 2,
        "supporting_count": 0
      },
      "created_at": "2022-06-27 11:53:12"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none get_tips_response

resolve

Resolve

Code Sample

curl AUDIUS_API_HOST/v1/resolve?url=https://audius.co/camouflybeats/hypermantra-86216&app_name=EXAMPLEAPP 


GET AUDIUS_API_HOST/v1/resolve?url=https://audius.co/camouflybeats/hypermantra-86216&app_name=EXAMPLEAPP HTTP/1.1


const headers = {
  'Accept':'application/json'
};

fetch('AUDIUS_API_HOST/v1/resolve?url=https://audius.co/camouflybeats/hypermantra-86216&app_name=EXAMPLEAPP',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'AUDIUS_API_HOST/v1/resolve',
  params: {
  'url' => 'string',
'app_name' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('AUDIUS_API_HOST/v1/resolve', params={
  'url': 'https://audius.co/camouflybeats/hypermantra-86216',  'app_name': 'EXAMPLEAPP'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','AUDIUS_API_HOST/v1/resolve', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("AUDIUS_API_HOST/v1/resolve?url=https://audius.co/camouflybeats/hypermantra-86216&app_name=EXAMPLEAPP");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "AUDIUS_API_HOST/v1/resolve", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /resolve

Resolves and redirects a provided Audius app URL to the API resource URL it represents

This endpoint allows you to lookup and access API resources when you only know the audius.co URL. Tracks, Playlists, and Users are supported.

Query Parameters

Name Type Required Description
url string true URL to resolve. Either fully formed URL (https://audius.co) or just the absolute path
app_name string false Your app name

Example Response

{
  "data": {
    "artwork": {
      "150x150": "https://creatornode.audius.co/ipfs/QmRSVdvMkVnV4UhGNQzNm8pJLLsGwQXyZkCp1dAMYfZx9d/150x150.jpg",
      "480x480": "https://creatornode.audius.co/ipfs/QmRSVdvMkVnV4UhGNQzNm8pJLLsGwQXyZkCp1dAMYfZx9d/480x480.jpg",
      "1000x1000": "https://creatornode.audius.co/ipfs/QmRSVdvMkVnV4UhGNQzNm8pJLLsGwQXyZkCp1dAMYfZx9d/1000x1000.jpg"
    },
    "description": "HYPERMANTRA.\n1 play, 7 chapters, no breaks.\n\nget it here: http://tiny.cc/hypermantra\n\npremiered on Ä Live 8/22.\n\ncredits: ilian, the salsoul orchestra, brian bennett, 100% pure poison, you & explosion band, yuji ohno, frank ocean.",
    "genre": "Electronic",
    "id": "V4W8r",
    "mood": "Yearning",
    "release_date": "Mon Aug 24 2020 21:08:36 GMT+0200",
    "remix_of": {
      "tracks": null
    },
    "repost_count": 78,
    "favorite_count": 171,
    "tags": null,
    "title": "HYPERMANTRA",
    "user": {
      "album_count": 0,
      "bio": "kawaii bounce 🌟\n\nmy sample pack: gum.co/camocandybox1\n\nheader by paprikaworm",
      "cover_photo": {
        "640x": "https://creatornode.audius.co/ipfs/QmS3mXLjrmm5i61CWzJHSmQcwKPNQw92rTWC36nCsqF3uU/640x.jpg",
        "2000x": "https://creatornode.audius.co/ipfs/QmS3mXLjrmm5i61CWzJHSmQcwKPNQw92rTWC36nCsqF3uU/2000x.jpg"
      },
      "followee_count": 204,
      "follower_count": 16997,
      "does_follow_current_user": false,
      "handle": "camouflybeats",
      "id": "nd6JD",
      "is_verified": false,
      "location": "",
      "name": "camoufly 🌟",
      "playlist_count": 4,
      "profile_picture": {
        "150x150": "https://creatornode.audius.co/ipfs/QmZDEwMQbKFAgGMbM6YLRvvnqy1SjVqK6k7yPks4sdCEh4/150x150.jpg",
        "480x480": "https://creatornode.audius.co/ipfs/QmZDEwMQbKFAgGMbM6YLRvvnqy1SjVqK6k7yPks4sdCEh4/480x480.jpg",
        "1000x1000": "https://creatornode.audius.co/ipfs/QmZDEwMQbKFAgGMbM6YLRvvnqy1SjVqK6k7yPks4sdCEh4/1000x1000.jpg"
      },
      "repost_count": 157,
      "track_count": 64,
      "is_deactivated": false,
      "erc_wallet": "0xa65a69a3c38b55b9a3f83266bcc36fe6950cd85f",
      "spl_wallet": "2bnJKYk6WnseedNWkDEACmS5563uxLCrSRAsQqora947",
      "supporter_count": 0,
      "supporting_count": 0
    },
    "duration": 1741,
    "downloadable": false,
    "play_count": 12867,
    "permalink": "/camouflybeats/hypermantra-86216"
  }
}

Responses

Status Meaning Description Schema
200 OK none None
302 Found Internal redirect None

Response Schema

Schemas

The following are examples of response formats you can expect to receive from the API.

user_response

{
  "properties": {
    "data": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data user false none none

user

{
  "required": [
    "album_count",
    "followee_count",
    "follower_count",
    "handle",
    "id",
    "is_deactivated",
    "is_verified",
    "name",
    "playlist_count",
    "repost_count",
    "spl_wallet",
    "supporter_count",
    "supporting_count",
    "track_count"
  ],
  "properties": {
    "album_count": {
      "type": "integer"
    },
    "bio": {
      "type": "string"
    },
    "cover_photo": {
      "properties": {
        "640x": {
          "type": "string"
        },
        "2000x": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "followee_count": {
      "type": "integer"
    },
    "follower_count": {
      "type": "integer"
    },
    "does_follow_current_user": {
      "type": "boolean"
    },
    "handle": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "is_verified": {
      "type": "boolean"
    },
    "location": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "playlist_count": {
      "type": "integer"
    },
    "profile_picture": {
      "properties": {
        "150x150": {
          "type": "string"
        },
        "480x480": {
          "type": "string"
        },
        "1000x1000": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "repost_count": {
      "type": "integer"
    },
    "track_count": {
      "type": "integer"
    },
    "is_deactivated": {
      "type": "boolean"
    },
    "erc_wallet": {
      "type": "string"
    },
    "spl_wallet": {
      "type": "string"
    },
    "supporter_count": {
      "type": "integer"
    },
    "supporting_count": {
      "type": "integer"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
album_count integer true none none
bio string false none none
cover_photo cover_photo false none none
followee_count integer true none none
follower_count integer true none none
does_follow_current_user boolean false none none
handle string true none none
id string true none none
is_verified boolean true none none
location string false none none
name string true none none
playlist_count integer true none none
profile_picture profile_picture false none none
repost_count integer true none none
track_count integer true none none
is_deactivated boolean true none none
erc_wallet string false none none
spl_wallet string true none none
supporter_count integer true none none
supporting_count integer true none none

cover_photo

{
  "properties": {
    "640x": {
      "type": "string"
    },
    "2000x": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
640x string false none none
2000x string false none none

profile_picture

{
  "properties": {
    "150x150": {
      "type": "string"
    },
    "480x480": {
      "type": "string"
    },
    "1000x1000": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
150x150 string false none none
480x480 string false none none
1000x1000 string false none none

tracks_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "duration",
          "favorite_count",
          "id",
          "play_count",
          "repost_count",
          "title",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "genre": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "mood": {
            "type": "string"
          },
          "release_date": {
            "type": "string"
          },
          "remix_of": {
            "properties": {
              "tracks": {
                "type": "array",
                "items": {
                  "required": [
                    "parent_track_id"
                  ],
                  "properties": {
                    "parent_track_id": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "type": "object"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "tags": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "duration": {
            "type": "integer"
          },
          "downloadable": {
            "type": "boolean"
          },
          "play_count": {
            "type": "integer"
          },
          "permalink": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [Track] false none none

Track

{
  "required": [
    "duration",
    "favorite_count",
    "id",
    "play_count",
    "repost_count",
    "title",
    "user"
  ],
  "properties": {
    "artwork": {
      "properties": {
        "150x150": {
          "type": "string"
        },
        "480x480": {
          "type": "string"
        },
        "1000x1000": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "description": {
      "type": "string"
    },
    "genre": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "mood": {
      "type": "string"
    },
    "release_date": {
      "type": "string"
    },
    "remix_of": {
      "properties": {
        "tracks": {
          "type": "array",
          "items": {
            "required": [
              "parent_track_id"
            ],
            "properties": {
              "parent_track_id": {
                "type": "string"
              }
            },
            "type": "object"
          }
        }
      },
      "type": "object"
    },
    "repost_count": {
      "type": "integer"
    },
    "favorite_count": {
      "type": "integer"
    },
    "tags": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "user": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "duration": {
      "type": "integer"
    },
    "downloadable": {
      "type": "boolean"
    },
    "play_count": {
      "type": "integer"
    },
    "permalink": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
artwork track_artwork false none none
description string false none none
genre string false none none
id string true none none
mood string false none none
release_date string false none none
remix_of remix_parent false none none
repost_count integer true none none
favorite_count integer true none none
tags string false none none
title string true none none
user user true none none
duration integer true none none
downloadable boolean false none none
play_count integer true none none
permalink string false none none

track_artwork

{
  "properties": {
    "150x150": {
      "type": "string"
    },
    "480x480": {
      "type": "string"
    },
    "1000x1000": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
150x150 string false none none
480x480 string false none none
1000x1000 string false none none

remix_parent

{
  "properties": {
    "tracks": {
      "type": "array",
      "items": {
        "required": [
          "parent_track_id"
        ],
        "properties": {
          "parent_track_id": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
tracks [track_element] false none none

track_element

{
  "required": [
    "parent_track_id"
  ],
  "properties": {
    "parent_track_id": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
parent_track_id string true none none

reposts

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "properties": {
          "timestamp": {
            "type": "string"
          },
          "item_type": {
            "type": "object"
          },
          "item": {
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [activity] false none none

activity

{
  "properties": {
    "timestamp": {
      "type": "string"
    },
    "item_type": {
      "type": "object"
    },
    "item": {
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
timestamp string false none none
item_type object false none none
item object false none none

favorites_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "favorite_item_id",
          "favorite_type",
          "user_id"
        ],
        "properties": {
          "favorite_item_id": {
            "type": "string"
          },
          "favorite_type": {
            "type": "string"
          },
          "user_id": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [favorite] false none none

favorite

{
  "required": [
    "favorite_item_id",
    "favorite_type",
    "user_id"
  ],
  "properties": {
    "favorite_item_id": {
      "type": "string"
    },
    "favorite_type": {
      "type": "string"
    },
    "user_id": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
favorite_item_id string true none none
favorite_type string true none none
user_id string true none none

tags_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [string] false none none

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "album_count",
          "followee_count",
          "follower_count",
          "handle",
          "id",
          "is_deactivated",
          "is_verified",
          "name",
          "playlist_count",
          "repost_count",
          "spl_wallet",
          "supporter_count",
          "supporting_count",
          "track_count"
        ],
        "properties": {
          "album_count": {
            "type": "integer"
          },
          "bio": {
            "type": "string"
          },
          "cover_photo": {
            "properties": {
              "640x": {
                "type": "string"
              },
              "2000x": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "followee_count": {
            "type": "integer"
          },
          "follower_count": {
            "type": "integer"
          },
          "does_follow_current_user": {
            "type": "boolean"
          },
          "handle": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "is_verified": {
            "type": "boolean"
          },
          "location": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "playlist_count": {
            "type": "integer"
          },
          "profile_picture": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "repost_count": {
            "type": "integer"
          },
          "track_count": {
            "type": "integer"
          },
          "is_deactivated": {
            "type": "boolean"
          },
          "erc_wallet": {
            "type": "string"
          },
          "spl_wallet": {
            "type": "string"
          },
          "supporter_count": {
            "type": "integer"
          },
          "supporting_count": {
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [user] false none none

user_associated_wallet_response

{
  "properties": {
    "data": {
      "properties": {
        "user_id": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data encoded_user_id false none none

encoded_user_id

{
  "properties": {
    "user_id": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
user_id string false none none

connected_wallets_response

{
  "properties": {
    "data": {
      "required": [
        "erc_wallets",
        "spl_wallets"
      ],
      "properties": {
        "erc_wallets": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "spl_wallets": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data connected_wallets false none none

connected_wallets

{
  "required": [
    "erc_wallets",
    "spl_wallets"
  ],
  "properties": {
    "erc_wallets": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "spl_wallets": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
erc_wallets [string] true none none
spl_wallets [string] true none none

get_supporters

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "amount",
          "rank",
          "sender"
        ],
        "properties": {
          "rank": {
            "type": "integer"
          },
          "amount": {
            "type": "string"
          },
          "sender": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [supporter] false none none

supporter

{
  "required": [
    "amount",
    "rank",
    "sender"
  ],
  "properties": {
    "rank": {
      "type": "integer"
    },
    "amount": {
      "type": "string"
    },
    "sender": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
rank integer true none none
amount string true none none
sender user true none none

get_supporting

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "amount",
          "rank",
          "receiver"
        ],
        "properties": {
          "rank": {
            "type": "integer"
          },
          "amount": {
            "type": "string"
          },
          "receiver": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [supporting] false none none

supporting

{
  "required": [
    "amount",
    "rank",
    "receiver"
  ],
  "properties": {
    "rank": {
      "type": "integer"
    },
    "amount": {
      "type": "string"
    },
    "receiver": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
rank integer true none none
amount string true none none
receiver user true none none

verify_token

{
  "properties": {
    "data": {
      "required": [
        "email",
        "handle",
        "iat",
        "name",
        "sub",
        "userId",
        "verified"
      ],
      "properties": {
        "userId": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "handle": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        },
        "profilePicture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            },
            "misc": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "sub": {
          "type": "string"
        },
        "iat": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data decoded_user_token false none none

decoded_user_token

{
  "required": [
    "email",
    "handle",
    "iat",
    "name",
    "sub",
    "userId",
    "verified"
  ],
  "properties": {
    "userId": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "handle": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    },
    "profilePicture": {
      "properties": {
        "150x150": {
          "type": "string"
        },
        "480x480": {
          "type": "string"
        },
        "1000x1000": {
          "type": "string"
        },
        "misc": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "sub": {
      "type": "string"
    },
    "iat": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
userId string true none none
email string true none none
name string true none none
handle string true none none
verified boolean true none none
profilePicture profilePicture false none none
sub string true none none
iat string true none none

profilePicture

{
  "properties": {
    "150x150": {
      "type": "string"
    },
    "480x480": {
      "type": "string"
    },
    "1000x1000": {
      "type": "string"
    },
    "misc": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
150x150 string false none none
480x480 string false none none
1000x1000 string false none none
misc string false none none

playlist_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "favorite_count",
          "id",
          "is_album",
          "playlist_name",
          "repost_count",
          "total_play_count",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "is_album": {
            "type": "boolean"
          },
          "playlist_name": {
            "type": "string"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "total_play_count": {
            "type": "integer"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [playlist] false none none

playlist

{
  "required": [
    "favorite_count",
    "id",
    "is_album",
    "playlist_name",
    "repost_count",
    "total_play_count",
    "user"
  ],
  "properties": {
    "artwork": {
      "properties": {
        "150x150": {
          "type": "string"
        },
        "480x480": {
          "type": "string"
        },
        "1000x1000": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "is_album": {
      "type": "boolean"
    },
    "playlist_name": {
      "type": "string"
    },
    "repost_count": {
      "type": "integer"
    },
    "favorite_count": {
      "type": "integer"
    },
    "total_play_count": {
      "type": "integer"
    },
    "user": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
artwork playlist_artwork false none none
description string false none none
id string true none none
is_album boolean true none none
playlist_name string true none none
repost_count integer true none none
favorite_count integer true none none
total_play_count integer true none none
user user true none none

playlist_artwork

{
  "properties": {
    "150x150": {
      "type": "string"
    },
    "480x480": {
      "type": "string"
    },
    "1000x1000": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
150x150 string false none none
480x480 string false none none
1000x1000 string false none none

playlist_tracks_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "duration",
          "favorite_count",
          "id",
          "play_count",
          "repost_count",
          "title",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "genre": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "mood": {
            "type": "string"
          },
          "release_date": {
            "type": "string"
          },
          "remix_of": {
            "properties": {
              "tracks": {
                "type": "array",
                "items": {
                  "required": [
                    "parent_track_id"
                  ],
                  "properties": {
                    "parent_track_id": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "type": "object"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "tags": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "duration": {
            "type": "integer"
          },
          "downloadable": {
            "type": "boolean"
          },
          "play_count": {
            "type": "integer"
          },
          "permalink": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [Track] false none none

playlist_search_result

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "favorite_count",
          "id",
          "is_album",
          "playlist_name",
          "repost_count",
          "total_play_count",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "is_album": {
            "type": "boolean"
          },
          "playlist_name": {
            "type": "string"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "total_play_count": {
            "type": "integer"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [playlist] false none none

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "favorite_count",
          "id",
          "is_album",
          "playlist_name",
          "repost_count",
          "total_play_count",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "is_album": {
            "type": "boolean"
          },
          "playlist_name": {
            "type": "string"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "total_play_count": {
            "type": "integer"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [playlist] false none none

track_response

{
  "properties": {
    "data": {
      "required": [
        "duration",
        "favorite_count",
        "id",
        "play_count",
        "repost_count",
        "title",
        "user"
      ],
      "properties": {
        "artwork": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "description": {
          "type": "string"
        },
        "genre": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "mood": {
          "type": "string"
        },
        "release_date": {
          "type": "string"
        },
        "remix_of": {
          "properties": {
            "tracks": {
              "type": "array",
              "items": {
                "required": [
                  "parent_track_id"
                ],
                "properties": {
                  "parent_track_id": {
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "favorite_count": {
          "type": "integer"
        },
        "tags": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "user": {
          "required": [
            "album_count",
            "followee_count",
            "follower_count",
            "handle",
            "id",
            "is_deactivated",
            "is_verified",
            "name",
            "playlist_count",
            "repost_count",
            "spl_wallet",
            "supporter_count",
            "supporting_count",
            "track_count"
          ],
          "properties": {
            "album_count": {
              "type": "integer"
            },
            "bio": {
              "type": "string"
            },
            "cover_photo": {
              "properties": {
                "640x": {
                  "type": "string"
                },
                "2000x": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "followee_count": {
              "type": "integer"
            },
            "follower_count": {
              "type": "integer"
            },
            "does_follow_current_user": {
              "type": "boolean"
            },
            "handle": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "is_verified": {
              "type": "boolean"
            },
            "location": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "playlist_count": {
              "type": "integer"
            },
            "profile_picture": {
              "properties": {
                "150x150": {
                  "type": "string"
                },
                "480x480": {
                  "type": "string"
                },
                "1000x1000": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "repost_count": {
              "type": "integer"
            },
            "track_count": {
              "type": "integer"
            },
            "is_deactivated": {
              "type": "boolean"
            },
            "erc_wallet": {
              "type": "string"
            },
            "spl_wallet": {
              "type": "string"
            },
            "supporter_count": {
              "type": "integer"
            },
            "supporting_count": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "duration": {
          "type": "integer"
        },
        "downloadable": {
          "type": "boolean"
        },
        "play_count": {
          "type": "integer"
        },
        "permalink": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data Track false none none

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "duration",
          "favorite_count",
          "id",
          "play_count",
          "repost_count",
          "title",
          "user"
        ],
        "properties": {
          "artwork": {
            "properties": {
              "150x150": {
                "type": "string"
              },
              "480x480": {
                "type": "string"
              },
              "1000x1000": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "genre": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "mood": {
            "type": "string"
          },
          "release_date": {
            "type": "string"
          },
          "remix_of": {
            "properties": {
              "tracks": {
                "type": "array",
                "items": {
                  "required": [
                    "parent_track_id"
                  ],
                  "properties": {
                    "parent_track_id": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "type": "object"
          },
          "repost_count": {
            "type": "integer"
          },
          "favorite_count": {
            "type": "integer"
          },
          "tags": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "user": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "duration": {
            "type": "integer"
          },
          "downloadable": {
            "type": "boolean"
          },
          "play_count": {
            "type": "integer"
          },
          "permalink": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [Track] false none none

get_tips_response

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "amount",
          "created_at"
        ],
        "properties": {
          "amount": {
            "type": "string"
          },
          "sender": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "receiver": {
            "required": [
              "album_count",
              "followee_count",
              "follower_count",
              "handle",
              "id",
              "is_deactivated",
              "is_verified",
              "name",
              "playlist_count",
              "repost_count",
              "spl_wallet",
              "supporter_count",
              "supporting_count",
              "track_count"
            ],
            "properties": {
              "album_count": {
                "type": "integer"
              },
              "bio": {
                "type": "string"
              },
              "cover_photo": {
                "properties": {
                  "640x": {
                    "type": "string"
                  },
                  "2000x": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "followee_count": {
                "type": "integer"
              },
              "follower_count": {
                "type": "integer"
              },
              "does_follow_current_user": {
                "type": "boolean"
              },
              "handle": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "is_verified": {
                "type": "boolean"
              },
              "location": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "playlist_count": {
                "type": "integer"
              },
              "profile_picture": {
                "properties": {
                  "150x150": {
                    "type": "string"
                  },
                  "480x480": {
                    "type": "string"
                  },
                  "1000x1000": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "repost_count": {
                "type": "integer"
              },
              "track_count": {
                "type": "integer"
              },
              "is_deactivated": {
                "type": "boolean"
              },
              "erc_wallet": {
                "type": "string"
              },
              "spl_wallet": {
                "type": "string"
              },
              "supporter_count": {
                "type": "integer"
              },
              "supporting_count": {
                "type": "integer"
              }
            },
            "type": "object"
          },
          "created_at": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
data [tip] false none none

tip

{
  "required": [
    "amount",
    "created_at"
  ],
  "properties": {
    "amount": {
      "type": "string"
    },
    "sender": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "receiver": {
      "required": [
        "album_count",
        "followee_count",
        "follower_count",
        "handle",
        "id",
        "is_deactivated",
        "is_verified",
        "name",
        "playlist_count",
        "repost_count",
        "spl_wallet",
        "supporter_count",
        "supporting_count",
        "track_count"
      ],
      "properties": {
        "album_count": {
          "type": "integer"
        },
        "bio": {
          "type": "string"
        },
        "cover_photo": {
          "properties": {
            "640x": {
              "type": "string"
            },
            "2000x": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "followee_count": {
          "type": "integer"
        },
        "follower_count": {
          "type": "integer"
        },
        "does_follow_current_user": {
          "type": "boolean"
        },
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "is_verified": {
          "type": "boolean"
        },
        "location": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "playlist_count": {
          "type": "integer"
        },
        "profile_picture": {
          "properties": {
            "150x150": {
              "type": "string"
            },
            "480x480": {
              "type": "string"
            },
            "1000x1000": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "repost_count": {
          "type": "integer"
        },
        "track_count": {
          "type": "integer"
        },
        "is_deactivated": {
          "type": "boolean"
        },
        "erc_wallet": {
          "type": "string"
        },
        "spl_wallet": {
          "type": "string"
        },
        "supporter_count": {
          "type": "integer"
        },
        "supporting_count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "created_at": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name Type Required Restrictions Description
amount string true none none
sender user false none none
receiver user false none none
created_at string true none none