---
title: "Deterministic series selection by facets"
method: GET
path: "/api/v1/macro/series"
tags: ["Economics"]
---

# Deterministic series selection by facets

`GET /api/v1/macro/series`

The series matching a facet selection - the same set every time, no text-match luck. Combine exact tags (tags=bis;france) with validated named facets: geo=, source=, frequency=, seasonality=, concept= (a value in the wrong facet is refused with the right one named). q= keeps a free-text constraint: the same q you faceted with on /api/v1/macro/facets, so counts seen there stay true here. exclude= removes tags; /api/v1/macro/facets shows what exists. Fetch any returned series from /api/v1/fred/series/{series_id}. TITLES ARE NOT UNIQUE - read `units` before choosing between identically titled series. Page with the returned next_offset, never your own arithmetic: later waves may annotate and filter rows, and next_offset is the upstream continuation point that stays correct.

## Query parameters

- `tags` string, nullable — Exact tag tokens, semicolon- or comma-joined. Unknown tags reach FRED and come back as 400 naming the offender.
- `q` string, nullable — Free-text constraint carried over from /macro/facets?q=... - keeps the selection inside that search.
- `exclude` string, nullable — Tags to exclude.
- `geo` string, nullable — Country/region facet value.
- `source` string, nullable — Originator facet value.
- `frequency` string, nullable — Frequency facet value.
- `seasonality` string, nullable — Seasonality facet value.
- `concept` string, nullable — Concept facet value(s), comma-joined.
- `measure` string, nullable — Filter by measure: index, level, money, money_saar, rate_pct, spread_pct, count, growth_pct, share_pct, ratio, price. Every row carries `measure` regardless; rows dropped by this filter are counted in filtered_out_by_measure. ambiguous and unclassified are visible values a concrete filter excludes.
- `order` 'popularity' | 'series_id' — popularity: most-used first. series_id: stable alphabetical, best for full walks.
- `limit` integer — Series per page (upstream ceiling, measured).
- `offset` integer — Upstream offset. Use the next_offset from the previous response.

## Response `200`

Matching series with units, frequency and popularity.

- EnvelopeMacroFacetSeriesData
  - `data` MacroFacetSeriesData, required
    - `total` integer, required — Series the upstream selection matched across all pages.
    - `returned` integer, required — Series in this page.
    - `offset` integer, required — Upstream offset this page starts at.
    - `next_offset` integer, nullable — Pass this as offset to continue; null when the selection is exhausted. Use it instead of your own arithmetic.
    - `selected` string[], required — The normalised include set.
    - `excluded` string[], required — The normalised exclude set.
    - `q` string, nullable — The free-text constraint in force, when one was passed.
    - `measure` string, nullable — The measure filter in force, when one was passed.
    - `filtered_out_by_measure` integer, nullable — Rows this page dropped by the measure filter; present only when measure= was passed.
    - `series` FacetSeriesRow[], required — Matching series.
      - `series_id` string, required — FRED series identifier - fetch it from /api/v1/fred/series/{series_id}.
      - `title` string, nullable — Display title. NOT unique - two series can share one title and differ only in units.
      - `units` string, nullable — Units of measure; the field that distinguishes identically titled series.
      - `measure` string, required — Classified measure: index, level, money, money_saar, rate_pct, spread_pct, count, growth_pct, share_pct, ratio, price, ambiguous or unclassified.
      - `frequency` string, nullable — Observation frequency (short form).
      - `seasonal_adjustment` string, nullable — Seasonal adjustment (short form).
      - `popularity` integer, nullable — FRED popularity score.
      - `in_catalog` boolean, required — Whether the series is in the curated catalog served by /macro/{country}/{section}.
    - `source` string, required — Upstream data source identifier.
    - `fetched_at` string, required — When this payload was retrieved upstream (also in meta.data_time).
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4c4530760ba1/schema)