Paginação
A API usa paginação por page/limit e, em alguns recursos, por cursor/li.
Padrões
page + limit
Usado em vários listadores, por exemplo monitoramentos e alguns históricos.
GET /v1/monitoramentos/processos?page=1&limit=20cursor + li
Usado em listagens que espelham paginação da fonte, como:
GET /v1/processos?cpf_cnpj=00000000000&limit=100Quando há próxima página, a resposta de /v1/processos pode incluir:
{
"data": {
"links": {
"next": {
"href": "https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=00000000000&limit=100&cursor=CURSOR&li=LI",
"cursor": "CURSOR",
"li": "LI"
}
}
}
}Regra de ouro
Siga
data.links.next.hrefexatamente.
Não reconstruacursorelimanualmente a partir de outros campos.
Limites específicos
GET /v1/processos
GET /v1/processoslimitaceito: 50 ou 100- valor padrão no handler: 100
limitinválido → HTTP 422INVALID_LIMIT
Certificados
- listagem com limite de página definido no handler (máximo documentado no OpenAPI/handler: 20 itens por página)
Consulte a referência de cada endpoint para parâmetros exatos.
Exemplo de loop seguro (TypeScript)
const apiKey = process.env.BUSCAPROCESSOS_API_KEY!;
let url: string | null =
"https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=00000000000&limit=100";
while (url) {
const res = await fetch(url, {
headers: { "x-api-key": apiKey },
});
const body = await res.json();
if (!res.ok) throw new Error(JSON.stringify(body));
// processar body.data.processos
url = body?.data?.links?.next?.href ?? null;
}Custos e paginação
Páginas adicionais de alguns recursos podem gerar novo consumo.
Trate paginação como decisão explícita de produto, não como loop ilimitado.