Paginação, filtros e busca
Limites, offset, filtros existentes e recursos que a API ainda não oferece.
Listagens aceitam paginação por offset:
| Parâmetro | Padrão | Regra |
|---|---|---|
limite | 20 | inteiro entre 1 e 100 |
offset | 0 | inteiro igual ou maior que zero |
{
"itens": [],
"paginacao": { "limite": 20, "offset": 0, "total": 0 },
"fonte": { "status": "disponivel", "versao": "..." }
}Para percorrer uma coleção, avance offset += limite enquanto offset + itens.length < total. Como snapshots podem mudar, guarde fonte.versao quando precisar auditar uma extração longa.
Filtros existentes
- dívidas PGFN:
categoriaemnao_previdenciario,fgtsouprevidenciario; - imóveis CAFIR:
ufemunicipio; - créditos ativos RFB:
ufeano_mesno formatoAAAAMM; - todas as coleções paginadas:
limiteeoffset.
Os formatos, enumerações e limites exatos vêm do OpenAPI e aparecem na referência.
O que não existe
Não há busca por razão social/nome fantasia, ordenação escolhida pelo cliente, cursores, filtros genéricos ou linguagem de consulta. A ordem atual é determinada por cada consulta SQL e não deve ser usada como contrato até ser explicitada no OpenAPI.