Pular para o conteúdo principal

Paginação

Endpoints GET que retornam listas de objetos suportam paginação para controlar o volume de dados retornados.

observação

O GET /orders/fetchConciliationOrders usa um formato próprio (até 1.000 por página, com hasMore e paginationToken em texto). Veja a seção Conciliação.

Como funciona​

Quando uma resposta possui mais registros disponíveis, o campo paginationToken retorna true. Envie este token na próxima requisição para obter a próxima página.

Parâmetros​

ParâmetroTipoDescrição
limitintegerNúmero máximo de registros por página. Máximo: 100 (exceto fetchConciliationOrders, ver abaixo)
paginationTokenstringToken recebido na resposta anterior para buscar a próxima página

Exemplo de Fluxo​

1. Primeira requisição:

curl "https://api-caas-it-sandbox.liqi.app.br/account/fetchProfiles?limit=10" \
-H "Authorization: Bearer {token}"

Resposta:

{
"paginationToken": true,
"data": [
{"id": "01J1...", "profile": "cliente-1", ...},
{"id": "01J2...", "profile": "cliente-2", ...}
]
}

2. Próxima página (enquanto paginationToken for true):

curl "https://api-caas-it-sandbox.liqi.app.br/account/fetchProfiles?limit=10&paginationToken=..." \
-H "Authorization: Bearer {token}"

Última página (paginationToken retorna false):

{
"paginationToken": false,
"data": [...]
}

Endpoints Paginados​

Os seguintes endpoints suportam paginação:

  • GET /account/fetchProfiles
  • GET /wallet/fetchBalances
  • GET /wallet/fetchStatement
  • GET /wallet/fetchStatementCategory
  • GET /market/fetchExchanges
  • GET /market/fetchTickers
  • GET /orders/fetchOrders
  • GET /transactions/transfers
  • GET /transactions/balances
  • GET /orders/fetchConciliationOrders (formato próprio, ver abaixo)

Conciliação: GET /orders/fetchConciliationOrders​

Este endpoint pagina num formato diferente dos demais, pensado para baixar janelas grandes:

CampoOndeDescrição
limitqueryRegistros por página. Padrão 100, máximo 1.000. Valor acima de 1.000 é tratado como 1.000
hasMorerespostatrue enquanto houver próxima página
paginationTokenresposta / queryTexto opaco da próxima página. Só vem quando hasMore é true; envie como recebido
totalCountrespostaTotal de ordens da janela, independente da página

Não há limite de páginas: continue pedindo enquanto hasMore for true. Para janelas grandes, use limit=1000 e confira, ao final, se a quantidade recebida bate com totalCount. A ordem das páginas é estável (por horário de execução e, no empate, pelo id da ordem).

Detalhes em fetchConciliationOrders.

dica

Quando o parâmetro limit não é informado, o padrão é 100 objetos por página.