---
title: "Sugra Catalog filter vocabulary and counts"
method: GET
path: "/api/v1/catalog/facets"
tags: ["Catalog"]
---

# Sugra Catalog filter vocabulary and counts

`GET /api/v1/catalog/facets`

The catalog's filter vocabulary - distinct sectors and countries for equities, categories and families for ETFs, and categories for indices, each with a count - plus coverage ratios, the build timestamp, and headline counts of companies, listings, ETFs, funds, and indices. Use this to populate filter controls and show catalog scale.

## Response `200`

Facet value lists with counts, coverage ratios, build timestamp, and headline counts.

- EnvelopeCatalogFacetsData
  - `data` CatalogFacetsData, required
    - `sectors` CatalogCountry[], nullable
      - `value` string, nullable
      - `count` union
        - integer
        - number
    - `countries` CatalogCountry[], nullable
      - `value` string, nullable
      - `count` union
        - integer
        - number
    - `etf_categories` CatalogCountry[], nullable
      - `value` string, nullable
      - `count` union
        - integer
        - number
    - `etf_families` CatalogCountry[], nullable
      - `value` string, nullable
      - `count` union
        - integer
        - number
    - `index_categories` CatalogCountry[], nullable
      - `value` string, nullable
      - `count` union
        - integer
        - number
    - `coverage` Coverage
      - `sector` string, nullable
      - `country` string, nullable
      - `industry` string, nullable
    - `built_at` string, nullable
    - `counts` Counts
      - `companies` union
        - integer
        - number
      - `listings` union
        - integer
        - number
      - `etfs` union
        - integer
        - number
      - `funds` union
        - integer
        - number
      - `indices` union
        - integer
        - number
  - `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.
- `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/revisions/914af3d38c7c/schema)