RetroLedger API Docs

Reference

Endpoints

Routes and query parameters are on the left. A runnable request example for each route is on the right.

GET/v1/meta

Discover API version info, supported filters, and canonical endpoint paths.

Query Parameters

No query parameters.

const response = await fetch("https://api.retroledger.com/v1/meta", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);

GET/v1/platforms

List active platforms available through the API.

Query Parameters

No query parameters.

const response = await fetch("https://api.retroledger.com/v1/platforms", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);

GET/v1/games

Fetch paginated games with aggregate pricing and search or platform filters.

Query Parameters

platformstring

Platform code such as NES, SNES, N64, GB, GBC, GEN, or SMS.

qstring

Title or slug search.

conditionstring

Filter metrics to a condition such as loose or cib.

daysinteger

Rolling lookback window for price metrics.

limitinteger

Page size, up to 500.

offsetinteger

Offset-based pagination.

reviewStatusstring

approved, pending, rejected, or all.

sortBystring

title, liquidity, revenue, avgPrice, or latestSale.

const response = await fetch("https://api.retroledger.com/v1/games?platform=GEN&sortBy=latestSale&limit=25", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);

GET/v1/games/:slug

Fetch a single game with summary metrics and condition breakdowns.

Query Parameters

conditionstring

Optional condition filter for metrics.

daysinteger

Rolling lookback window for summary metrics.

reviewStatusstring

approved, pending, rejected, or all.

const response = await fetch("https://api.retroledger.com/v1/games/sonic-the-hedgehog-genesis?days=180", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);

GET/v1/games/:slug/prices

Fetch paginated historical sales for one game.

Query Parameters

conditionstring

Optional condition filter.

daysinteger

Rolling lookback window for historical sales.

reviewStatusstring

approved, pending, rejected, or all.

limitinteger

Page size, up to 500.

offsetinteger

Offset-based pagination.

const response = await fetch("https://api.retroledger.com/v1/games/sonic-the-hedgehog-genesis/prices?condition=loose&days=365&limit=50", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);

GET/v1/prices/:gameSlug

Legacy alias for the single-game price history route.

Query Parameters

conditionstring

Optional condition filter.

daysinteger

Rolling lookback window for historical sales.

reviewStatusstring

approved, pending, rejected, or all.

limitinteger

Page size, up to 500.

offsetinteger

Offset-based pagination.

const response = await fetch("https://api.retroledger.com/v1/prices/sonic-the-hedgehog-genesis?days=90", {
  headers: {
    "x-api-key": process.env.RETROLEDGER_API_KEY!,
  },
});

const data = await response.json();
console.log(data);