Mood by ID

GET 
/v0/moods/:moodId

Get mood details

Request

Path Parameters

moodId stringrequired

Mood id

Query Parameters

expand string

Possible values: [tracks]

Add parameter if tracks should be included in the response

limit int32

Max number of entries returned in the response, default 50 and max 100

offset int32

Index of the entry track in the response

Responses

200

Track mood response

application/json

Schema

Schema

id stringrequired
name stringrequired

images

object

default stringnullable

L stringnullable

M stringnullable

S stringnullable

XS stringnullable

tracks

object

tracks

object[]

required

Array [

id stringrequired

Unique ID of the track

mainArtists string[]required

The main artist that created the track.

featuredArtists string[]required

Additional artists that contributed to the track.

title stringrequired

Title of the track

bpm int32required

Beats per minute for the track.

length int32required

Track length in seconds

moods

object[]

required

Lists the moods of the track.

Array [

id stringrequired

Unique ID of the mood

name stringrequired

Name of the mood

]

genres

object[]

required

Lists the genres of the track.

Array [

id stringrequired

name stringrequired

parent

object

id stringrequired

Unique ID of the parent genre

name stringrequired

Name of the parent genre

]

images

object

default stringnullable

L stringnullable

M stringnullable

S stringnullable

XS stringnullable

waveformUrl stringrequired

Reference to the waveform as a json object.

hasVocals booleannullable

Set to true if the track has vocals. Set to false for instrumental tracks.

added stringrequired

The date the track was released in the format YYYY-mm-dd.

tierOption stringnullable

Possible values: [PAID, FREE]

isExplicit booleannullable

isPreviewOnly boolean

]

pagination

object

required

page int32required

limit int32required

offset int32

links

object

required

next stringnullable

prev stringnullable

aggregations

object

moods

object[]

Array [

id string

name string

count int32

]

genres

object[]

Array [

id string

name string

count int32

]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "images": {
    "default": "string",
    "L": "string",
    "M": "string",
    "S": "string",
    "XS": "string"
  },
  "tracks": {
    "tracks": [
      {
        "id": "string",
        "mainArtists": [
          "string"
        ],
        "featuredArtists": [
          "string"
        ],
        "title": "string",
        "bpm": 0,
        "length": 0,
        "moods": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "genres": [
          {
            "id": "string",
            "name": "string",
            "parent": {
              "id": "string",
              "name": "string"
            }
          }
        ],
        "images": {
          "default": "string",
          "L": "string",
          "M": "string",
          "S": "string",
          "XS": "string"
        },
        "waveformUrl": "string",
        "hasVocals": true,
        "added": "string",
        "tierOption": "PAID",
        "isExplicit": true,
        "isPreviewOnly": true
      }
    ],
    "pagination": {
      "page": 0,
      "limit": 0,
      "offset": 0
    },
    "links": {
      "next": "string",
      "prev": "string"
    },
    "aggregations": {
      "moods": [
        {
          "id": "string",
          "name": "string",
          "count": 0
        }
      ],
      "genres": [
        {
          "id": "string",
          "name": "string",
          "count": 0
        }
      ]
    }
  }
}

Example

{
  "id": "happy",
  "name": "Happy",
  "images": {
    "default": "https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg",
    "L": "https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=1050&h=1050&fit=fill&q=90&fm=jpg",
    "M": "https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=600&h=600&fit=fill&q=90&fm=jpg",
    "S": "https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg",
    "XS": "https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=128&h=128&fit=fill&q=90&fm=jpg"
  }
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Invalid credentials"
}

404

Mood was not found

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Mood was not found"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Rate limit exceeded"
}

Loading...