Deezer Public API (v2)

A modern, modular, and type-safe Node.js wrapper for the Deezer Public API.

📖 Read the Documentation | 🛡️ Quality Assurance

Features

• TypeScript Native: Full type definitions for all API entities.
• Zero Runtime Dependencies: No external packages required at runtime (minimal footprint).
• Schema Integrity: Response types validated against live API snapshots.
• Native Fetch: Uses standard Node.js fetch (Node 18+).
• Custom Fetch Injection: Support for custom fetch implementations (Proxies, Agent, etc.).
• Image Resizing: Built-in utility for dynamic Deezer image URL resizing.
• Dual Build: Supports both ESM (import) and CJS (require) via unbuild.
• Enhanced Pagination: Easy navigation with next() and prev() helpers.
• Fluent Search: Chainable builder() for complex queries.
• Rate Limiting: Built-in throttling (50 req / 5s).

Installation

npm install deezer-public-api

Usage

ESM (Modern)

import { DeezerPublicApi } from 'deezer-public-api';
const deezer = new DeezerPublicApi();

// Object-based arguments for better readability
const album = await deezer.album({ id: 302127 });

// Using the Fluent Search Builder
const query = deezer.search.builder('Daft Punk')
  .album('Discovery')
  .build();

const results = await deezer.search.artist({ q: query });

// Easy Pagination
if (results.next) {
  const nextBatch = await results.next();
}

// Image Resizing Utility
const resizedUrl = deezer.utils.changeImageSize(album.cover, 500);

Custom Fetch Injection

import { DeezerPublicApi } from 'deezer-public-api';
import { Agent } from 'https-proxy-agent';

const deezer = new DeezerPublicApi({
  fetch: (url, init) => fetch(url, { 
    ...init, 
    agent: new Agent('http://proxy:8080') 
  })
});

Available methods

Album

• album({ id, limit, index })
• album.comments({ id, limit, index })
• album.fans({ id, limit, index })
• album.tracks({ id, limit, index })

Artist

• artist({ id, limit, index })
• artist.top({ id, limit, index })
• artist.albums({ id, limit, index })
• artist.comments({ id, limit, index })
• artist.fans({ id, limit, index })
• artist.related({ id, limit, index })
• artist.radio({ id, limit, index })
• artist.playlists({ id, limit, index })

Chart

• chart({ limit, index })
• chart.tracks({ limit, index })
• chart.albums({ limit, index })
• chart.artists({ limit, index })
• chart.playlists({ limit, index })
• chart.podcasts({ limit, index })

Comment

• comment({ id, limit, index })

Editorial

• editorial({ id, limit, index })
• editorial.selection({ id, date, limit, index })
• editorial.charts({ id, limit, index })
• editorial.releases({ id, limit, index })

Episode

• episode({ id, limit, index })

Genre

• genre({ id, limit, index })
• genre.artists({ id, limit, index })
• genre.podcasts({ id, limit, index })
• genre.radios({ id, limit, index })

Infos

• infos()

Options

• options()

Playlist

• playlist({ id, limit, index })
• playlist.comments({ id, limit, index })
• playlist.fans({ id, limit, index })
• playlist.tracks({ id, limit, index })
• playlist.radio({ id, limit, index })

Podcast

• podcast({ id, limit, index })
• podcast.episodes({ id, limit, index })

Radio

• radio({ id, limit, index })
• radio.genres({ limit, index })
• radio.top({ limit, index })
• radio.lists({ limit, index })
• radio.tracks({ id, limit, index })

Track

• track({ id, limit, index })
• track.alternative({ id, limit, index })

User

• user({ id, limit, index })
• user.albums({ id, limit, index })
• user.artists({ id, limit, index })
• user.charts({ id, limit, index })
• user.charts.tracks({ id, limit, index })
• user.charts.albums({ id, limit, index })
• user.charts.playlists({ id, limit, index })
• user.charts.artists({ id, limit, index })
• user.flow({ id, limit, index })
• user.followings({ id, limit, index })
• user.followers({ id, limit, index })
• user.playlists({ id, limit, index })
• user.podcasts({ id, limit, index })
• user.radios({ id, limit, index })
• user.tracks({ id, limit, index })

Search

• search({ q, order, limit, index, strict })
• search.artist({ q, order, limit, index, strict })
• search.playlist({ q, order, limit, index, strict })
• search.podcast({ q, order, limit, index, strict })
• search.radio({ q, order, limit, index, strict })
• search.track({ q, order, limit, index, strict })
• search.user({ q, order, limit, index, strict })
• search.album({ q, order, limit, index, strict })