Paginação
Endpoints GET que retornam listas de objetos suportam paginação para controlar o volume de dados retornados.
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âmetro | Tipo | Descrição |
|---|---|---|
limit | integer | Número máximo de registros por página. Máximo: 100 (exceto fetchConciliationOrders, ver abaixo) |
paginationToken | string | Token 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/fetchProfilesGET /wallet/fetchBalancesGET /wallet/fetchStatementGET /wallet/fetchStatementCategoryGET /market/fetchExchangesGET /market/fetchTickersGET /orders/fetchOrdersGET /transactions/transfersGET /transactions/balancesGET /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:
| Campo | Onde | Descrição |
|---|---|---|
limit | query | Registros por página. Padrão 100, máximo 1.000. Valor acima de 1.000 é tratado como 1.000 |
hasMore | resposta | true enquanto houver próxima página |
paginationToken | resposta / query | Texto opaco da próxima página. Só vem quando hasMore é true; envie como recebido |
totalCount | resposta | Total 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.
Quando o parâmetro limit não é informado, o padrão é 100 objetos por página.