BeatPass Documentation - Help Center & Developer Docs

Get information about albums, artists, playlists, tracks or users that match a keyword string.

curl --request GET \
  --url https://open.beatpass.ca/api/v1/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://open.beatpass.ca/api/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.beatpass.ca/api/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://open.beatpass.ca/api/v1/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "query": "led zeppelin",
  "results": {
    "artists": {
      "id": 123,
      "name": "Led Zeppelin",
      "image_small": "https://example.com/image1.jpg",
      "verified": true
    },
    "albums": {
      "id": 123,
      "name": "Coda",
      "image": "https://example.com/image1.jpg",
      "release_date": "1982-11-19",
      "description": "<string>",
      "tracks": [
        {
          "id": 123,
          "name": "Hey Hey What Can I Do",
          "release_date": "1982-11-19",
          "image": "https://example.com/image1.jpg",
          "duration": 5645848548,
          "description": "<string>",
          "artists": [
            {
              "id": 123,
              "name": "Led Zeppelin",
              "image_small": "https://example.com/image1.jpg",
              "verified": true
            }
          ]
        }
      ],
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "tracks": {
      "id": 123,
      "name": "Hey Hey What Can I Do",
      "release_date": "1982-11-19",
      "image": "https://example.com/image1.jpg",
      "duration": 5645848548,
      "description": "<string>",
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "playlists": {
      "id": 123,
      "name": "Some Playlist",
      "public": true,
      "collaborative": false,
      "image": "https://example.com/image1.jpg",
      "description": "<string>"
    },
    "users": {
      "id": 123,
      "display_name": "<string>",
      "avatar": "<string>"
    }
  }
}

GET

Get information about albums, artists, playlists, tracks or users that match a keyword string.

curl --request GET \
  --url https://open.beatpass.ca/api/v1/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://open.beatpass.ca/api/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.beatpass.ca/api/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://open.beatpass.ca/api/v1/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "query": "led zeppelin",
  "results": {
    "artists": {
      "id": 123,
      "name": "Led Zeppelin",
      "image_small": "https://example.com/image1.jpg",
      "verified": true
    },
    "albums": {
      "id": 123,
      "name": "Coda",
      "image": "https://example.com/image1.jpg",
      "release_date": "1982-11-19",
      "description": "<string>",
      "tracks": [
        {
          "id": 123,
          "name": "Hey Hey What Can I Do",
          "release_date": "1982-11-19",
          "image": "https://example.com/image1.jpg",
          "duration": 5645848548,
          "description": "<string>",
          "artists": [
            {
              "id": 123,
              "name": "Led Zeppelin",
              "image_small": "https://example.com/image1.jpg",
              "verified": true
            }
          ]
        }
      ],
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "tracks": {
      "id": 123,
      "name": "Hey Hey What Can I Do",
      "release_date": "1982-11-19",
      "image": "https://example.com/image1.jpg",
      "duration": 5645848548,
      "description": "<string>",
      "artists": [
        {
          "id": 123,
          "name": "Led Zeppelin",
          "image_small": "https://example.com/image1.jpg",
          "verified": true
        }
      ]
    },
    "playlists": {
      "id": 123,
      "name": "Some Playlist",
      "public": true,
      "collaborative": false,
      "image": "https://example.com/image1.jpg",
      "description": "<string>"
    },
    "users": {
      "id": 123,
      "display_name": "<string>",
      "avatar": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

API access is invite-only. Contact contact@beatpass.ca to request access. Once approved, generate tokens from Account Settings → Developers. Include as: Authorization: Bearer {token}. Tokens expire after 90 days.

Query Parameters

query

string

Search query keywords

Example:

"led zeppelin"

types

string

A comma-separated list of item types to search across. Valid types are: album , artist, playlist, track, and user. Search results include hits from all the specified types.

Example:

"artist,album,track"

limit

integer

default:3

Maximum number of results to return. The limit is applied within each type, not on the total response.

Example:

3

Response

For each type provided in the type parameter, the response body contains an array of artist, album, track, playlist and user objects in JSON.

status

string

Example:

"success"

query

string

Example:

"led zeppelin"

results

object

Show child attributes

Last modified on August 4, 2026

Introduction

Core Concepts

API Reference

Search

Playlists

Artists

Albums

Tracks

Tags

Genres

Users

Auth

License Certificates

Audio Fingerprinting

Playlist Collaboration

Reposts

Track Plays

Radio

Cover Art

Track Purchases

Beat Requests

Producer Intelligence

User Library

Leaderboards

Messaging

Collections

Stripe Connect

Exclusive Licenses

Coupons

Notifications

Get information about albums, artists, playlists, tracks or users that match a keyword string.

Authorizations

Query Parameters

Response