v5

latestOpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Statistical Agencies

SIDRA aggregate data pull

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.

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

Path parameters

aggregate_idinteger required

SIDRA aggregate numeric id.

SIDRA aggregate numeric id.

Query parameters

periodsstring

Periods path-form value. Accepts -N (last N), YYYYMM, YYYYMM|YYYYMM, YYYY, or all.

Periods path-form value. Accepts -N (last N), YYYYMM, YYYYMM|YYYYMM, YYYY, or all.

variablesstring required

Variable id(s). Pipe-separated for multiple (e.g. 63 or 63|2266).

Variable id(s). Pipe-separated for multiple (e.g. 63 or 63|2266).

locationsstring

Localidades value. Territorial level prefixes: N1 Brasil, N2 region, N3 state, N6 municipality, N7 mesoregion. Use [all] for every unit at a level, or [id] for specific units (e.g. N3[35] Sao Paulo).

Localidades value. Territorial level prefixes: N1 Brasil, N2 region, N3 state, N6 municipality, N7 mesoregion. Use [all] for every unit at a level, or [id] for specific units (e.g. N3[35] Sao Paulo).

classificationstring nullable

Classificacao filter. Format <dim_id>[<cat_id>] or <dim_id>[all]. Multiple dimensions separated by pipe.

Classificacao filter. Format <dim_id>[<cat_id>] or <dim_id>[all]. Multiple dimensions separated by pipe.

Response

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

Example response

{
  "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": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}