SDK / @jackmorgan/phaser-catalog

Catalog SDK

A tiny typed client for the Phaser REST API. No wallet code, no streaming logic — just browse, search, and read catalog data.

v1.2.0 4.2 kB gz

Install

terminal
$ npm install @jackmorgan/phaser-catalog
init.ts
import { CatalogClient } from "@jackmorgan/phaser-catalog";
const catalog = new CatalogClient({ token: process.env.PHASER_JWT });

Methods

MethodReturnsDescription
tracks(q?)Paginated<Track>List tracks.
track(id)TrackSingle track.
artists(q?)Paginated<Artist>Browse artists.
albums(q?)Paginated<Album>Album list.
playlists(q?)Paginated<Playlist>Curated + user playlists.
search(q)SearchResultFuzzy search.
me()UserCurrent user (JWT).

Pagination

Every list endpoint uses cursor pagination. Pass nextCursor for next page.

types.d.ts
type Paginated<T> = {
  data:       T[];
  nextCursor: string | null;
  total:      number;
};

Errors

ClassHTTPMeaning
PhaserNotFound404Resource doesn't exist.
PhaserRateLimit429Too many requests.
PhaserAuthRequired401Missing JWT.
PhaserValidation400Invalid query.