---
title: "SIDRA aggregate catalog"
method: GET
path: "/api/v1/statistical-agencies/ibge/catalog"
tags: ["Statistical Agencies"]
---

# SIDRA aggregate catalog

`GET /api/v1/statistical-agencies/ibge/catalog`

Catalog of SIDRA aggregated-tables (9,239 aggregates across 69 pesquisa groups). The upstream `api/v3/agregados` endpoint ignores query filters, so Sugra applies them client-side: `pesquisa` matches the 2-letter pesquisa code (e.g. `CD` for Censo Demografico), and `search` is a case-insensitive substring match on aggregate names. Source: Instituto Brasileiro de Geografia e Estatistica (IBGE).

## Query parameters

- `pesquisa` string, nullable — Pesquisa (research) 2-letter code filter (e.g. `CD` Censo Demografico, `PA` agricultural production, `CN` national accounts).
- `search` string, nullable — Case-insensitive substring match on aggregate `nome` (Portuguese).
- `limit` integer — Maximum aggregates returned after filtering.
- `offset` integer — Number of aggregates to skip before returning.

## Response `200`

Filtered SIDRA catalog with total / count / pagination.

- EnvelopeIbgeCatalogPayload
  - `data` IbgeCatalogPayload, required — SIDRA aggregate catalog - 9,239 aggregates across 69 pesquisa groups. Client-side filter parameters (`pesquisa`, `search`) are applied by Sugra because the upstream `api/v3/agregados` endpoint ignores all query filters.
    - `aggregates` IbgeAggregateEntry[], required — Flat list of aggregates after pesquisa / substring filters are applied.
      - `id` string, required — Numeric aggregate identifier used in SIDRA URLs (string form).
      - `nome` string, required — Aggregate name in Portuguese, as published by IBGE.
      - `pesquisa_id` string, nullable — 2-char pesquisa (research) code the aggregate belongs to (e.g. `CD` for Censo Demografico).
      - `pesquisa_nome` string, nullable — Pesquisa name (e.g. `Indice Nacional de Precos ao Consumidor Amplo`).
    - `count` integer, required — Number of aggregates in `aggregates` after filtering.
    - `total` integer, required — Total aggregates available upstream before filtering (9,239 expected).
    - `pesquisa_filter` string, nullable — Applied pesquisa filter (2-char code), if any.
    - `search` string, nullable — Applied substring search (case-insensitive match on `nome`), if any.
    - `limit` integer, required — Pagination limit applied by Sugra.
    - `offset` integer, required — Pagination offset applied by Sugra.
  - `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/d3e3d9c28132/schema)