---
title: "Facet navigation over every FRED series"
method: GET
path: "/api/v1/macro/facets"
tags: ["Economics"]
---

# Facet navigation over every FRED series

`GET /api/v1/macro/facets`

Narrow the ~800,000-series FRED catalogue by facets instead of guessing words. Eight facets: geo, source, frequency, seasonality, geo_type, concept, license, release. Call with no arguments for the top values of every facet; pass tags= (semicolon-joined, e.g. tags=bis;france) to see what remains after that selection; pass q= to facet a free-text search; pass BOTH to drill down inside the search - they compose. Every value carries the exact `tag` token - paste it straight into tags= here or on /api/v1/macro/series (carry the same q= there too), which returns the matching series themselves.

## Query parameters

- `tags` string, nullable — Current selection, semicolon- or comma-joined exact tag tokens (e.g. bis;france). Composes with q: together they drill down inside the search.
- `q` string, nullable — Free-text seed: facets of the series matching this search. Composes with tags.
- `group` string, nullable — Return one facet only: geo, source, frequency, seasonality, geo_type, concept, license or release.
- `limit` integer — Values per facet.

## Response `200`

Facet values with series counts, grouped by facet.

- EnvelopeMacroFacetsData
  - `data` MacroFacetsData, required
    - `facets` object, required — Facet name -> values, ordered by series_count.
    - `selected` string[], required — The normalised current selection.
    - `q` string, nullable — The free-text constraint in force; carry it to /macro/series to keep the counts true.
    - `series_count` integer, nullable — Series matching the current selection; present only when a selection or q exists.
    - `facet_values_truncated` boolean, nullable — Present and true only if the tag listing hit the internal page cap; values may be incomplete.
    - `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)