Skip to main content

​
API Reference

This section documents all public-facing BeatPass API endpoints. Browse the OpenAPI specification or explore specific API domains:

​
API Documentation

Dashboard API

Producer dashboard metrics, track performance, and upload insights.

Insights API

Analytics and insights for tracks, albums, and artists.

Commerce & Licensing

Purchases, licenses, Stripe Connect, and exclusive presets.

Messaging API

Direct messages, conversations, and real-time features.

Beat Requests API

Custom beat request marketplace and fulfillment.

Social API

Following, reposts, user library, and social graph.

Content API

Tracks, albums, artists, lyrics, fingerprinting, Audio Recon, and Backstage producer requests.

Search & Discovery

Search, genres, tags, radio, and leaderboards.

Producer Intelligence

XP, achievements, social analytics, and charts.

​
OpenAPI Explorer

The API reference uses the BeatPass OpenAPI specification to provide interactive documentation for all endpoints. Browse by category in the Endpoint Explorer section of the navigation.
Base URL: https://open.beatpass.ca/api/v1

​
Using the API Explorer

1

Select an Endpoint

Expand the Endpoint Explorer in the sidebar and choose a category:
  • Search — Full-text search across content
  • Tracks — Track listing, details, and management
  • Artists — Artist profiles and followers
  • Albums — Album management
  • Playlists — Playlist CRUD and collaboration
  • License Certificates — License generation and verification
  • And more…
2

Review Parameters

Each endpoint shows required and optional parameters, request body schemas, and example values.
3

Try It Out

Use the Try It feature to test endpoints directly. Enter your Bearer token in the Authorization field for authenticated endpoints.
4

Check Responses

Response schemas show the expected data structure. Error responses (401, 403, 404, 422) are documented for each endpoint.

​
Authentication & Access Tiers

The data you receive depends on your authentication level:

Public (No Token)

Minimal DataUnauthenticated requests return minimal data only — just enough to identify resources:
  • Tracks: id, name, image, created_at, duration_text, model_type
  • Artists/Genres: id, name, model_type
No pricing, plays, licensing, or internal fields are included.
Rich DataAuthenticated requests with a valid Bearer token return rich API data including pricing, play counts, BPM, key/scale, licensing type, and more.
API access is invite-only. Developer tokens are granted on a case-by-case basis. To request access, contact contact@beatpass.ca. See Authentication for details.

​
Using the Playground

To get rich responses from the API playground, you must have an approved developer token:
  1. Once approved, go to Account Settings → Developers on open.beatpass.ca to generate a token
  2. Click the Authorization button in the playground
  3. Enter your token (without the Bearer prefix — Mintlify adds it automatically)
  4. Send your request
Without a token, public endpoints return minimal data only (id, name, image, model_type). To get rich responses with pricing, plays, BPM, and licensing data, enter your approved developer token.

​
Quick Examples

​
Public Request (Minimal Data)

# Returns minimal track data (id, name, image, artists only)
curl "https://open.beatpass.ca/api/v1/tracks" \
  -H "Accept: application/json"

​
Authenticated Request (Rich Data)

# Returns full track data (pricing, plays, BPM, licensing, etc.)
curl "https://open.beatpass.ca/api/v1/tracks" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

​
JavaScript Example

const response = await fetch('https://open.beatpass.ca/api/v1/tracks/3629', {
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN_HERE'
  }
});
const data = await response.json();
console.log(data.track.name); // "ZOOM"

​
Endpoint Categories

These endpoints work without authentication (enhanced data when logged in):

Search

Optional Auth Full-text search across all content types.

Tracks

Read: Optional Track listing and details.

Artists

Read: Optional Artist profiles and followers.

Albums

Read: Optional Album listing and metadata.
The Insights API provides focused, domain-specific analytics endpoints with standardized error handling and export capabilities.

Authentication

Authentication methods and token generation.

Error Catalog

Error codes and resolutions.
Last modified on February 26, 2026