CNPJ API

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âmetroPadrãoRegra
limite20inteiro entre 1 e 100
offset0inteiro 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: categoria em nao_previdenciario, fgts ou previdenciario;
  • imóveis CAFIR: uf e municipio;
  • créditos ativos RFB: uf e ano_mes no formato AAAAMM;
  • todas as coleções paginadas: limite e offset.

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.

Nesta página