Goldilocks PC API

API reference

Versioned catalogue data for regions, retailers, taxonomies, and active PC listings.

Authentication

Send the shared API key with every request to /api/v1. 

X-API-Key: your-api-key

OpenAPI

The machine-readable API contract is available as JSON.

View openapi.json

Endpoints

Method Path Purpose
GET /api/v1/regions List active regions.
GET /api/v1/retailers List active retailers for the resolved region.
GET /api/v1/taxonomies List taxonomy filters and active options.
GET /api/v1/listings List visible listings with filters, sort, limit, and offset.
GET /api/v1/listings/{id} Fetch one visible listing by id.

Listing Filters

  • region, q, min_price, max_price
  • stock_status, budget, use_case, resolution
  • preferences, taxonomy_options, sort, limit, offset

Errors

401 Unauthorized
{ "error": "unauthorized" }
404 Not Found
{ "error": "not_found" }
429 Rate Limited
{ "error": "rate_limited" }