---
title: "Every served series, flat, in one call — with ranked search."
method: GET
path: "/v1/catalog"
---

# Every served series, flat, in one call — with ranked search.

`GET /v1/catalog`

## Request

- Base URL: `https://starwell.dev/api/starwell`
- URL: `https://starwell.dev/api/starwell/v1/catalog`
- Auth: one of:
  - HTTP bearer
  - none

The right first call for agents: search across series ids, indicators, geographies, and dataset titles, then fetch or pin what you found. Pages with limit + offset; meta.hasMore says whether a next page exists.

## Query parameters

- `q` string
- `source` string
- `limit` integer
- `offset` integer

## Response `200`

OK

- object
  - `success` true, required
  - `data` CatalogEntry[], required
    - `source` string
    - `sourceName` string
    - `authority` string, nullable
    - `termsUrl` string, nullable
    - `seriesId` string: Source-native id practitioners already use (e.g. 'UNRATE', 'v41690973').
    - `indicator` string
    - `unit` string, nullable
    - `frequency` string, nullable
    - `geography` string, nullable
    - `startPeriod` string, date, nullable
    - `endPeriod` string, date, nullable
    - `verificationStatus` 'passing' | 'stale' | 'failing' | 'unverified'
    - `lastVerifiedAt` string, date-time, nullable
    - `licenseCode` string
    - `attributionText` string, nullable
    - `redistributable` boolean
    - `datasetExternalId` string
    - `datasetTitle` string
    - `datasetUrl` string, nullable
  - `meta` object
    - `count` integer: Rows in THIS response.
    - `total` integer: Rows matching the query across all pages.
    - `offset` integer: The offset this page starts at (echoed back).
    - `hasMore` boolean: True when rows exist past this page — fetch them with offset = offset + the number of rows returned here.
    - `q` string: Echoed back when a search ran.
    - `datasetMatches` object[]: Top-20 hits from the wider dataset index. First page only (offset=0) — it is not a slice of data.

## Other responses

- `400`: Invalid parameters.

---

[API](https://skmtc.dev/starwell/apis/starwell-api.md) · [All operations](https://skmtc.dev/starwell/apis/starwell-api/llms.txt) · [OpenAPI document](https://skmtc.dev/starwell/apis/starwell-api/revisions/faaa9f35d4e6?raw)