SIDRA aggregate data pull

GET

/api/v1/statistical-agencies/ibge/aggregates/{aggregate_id}/data

Last modified:2026-05-10 09:22:39

Maintainer:Not configured

OperationId:statistical_agencies_ibge_aggregates_aggregate_id_data

Generic SIDRA data fetch. Parameters map to the upstream path-form query /api/v3/agregados/{id}/periodos/{P}/variaveis/{V}?localidades=...&classificacao=.... Returns flat rows (one per variable x locality x period); missing upstream values (..., -) coerce to null. When an aggregate declares a classification dimension and the caller omits it, SIDRA returns 500 - inspect /metadata first.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '/api/v1/statistical-agencies/ibge/aggregates/1737/data?periods=202601%7C202602%7C202603&variables=63&locations=N1[all]&classification=undefined' \
--header 'x-api-key: <api-key>'

Responses

🟢200

application/json

Flat observation rows with variable, locality, period, value and classification tuple.

Bodyapplication/json

Example

{
    "data": {
        "aggregate_id": 0,
        "periods": "string",
        "variables": "string",
        "locations": "string",
        "classification": "string",
        "observations": [
            {
                "variavel": "string",
                "variavel_id": "string",
                "unidade": "string",
                "localidade": "string",
                "localidade_id": "string",
                "nivel_territorial": "string",
                "classificacao": null,
                "periodo": "string",
                "valor": 0,
                "valor_raw": "string"
            }
        ],
        "count": 0
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "source": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true
    }
}

🟠401

🟠422

🟠429

🔴503

Modified at 2026-05-10 09:22:39

SIDRA aggregate period list

Brazilian headline CPI (IPCA) monthly variation