Hoi 👋🏻 kunnen we je helpen?

Zoeken

Paginering en filteren

Article author
Shannon Bolink-Tieman
  • Bijgewerkt

Lijst-endpoints in de Hix API ondersteunen paginering via queryparameters. Grote datasets worden automatisch opgesplitst in pagina's.

Pagineringsparameters

ParameterTypeStandaardBeschrijving
pageinteger1Paginanummer (begint bij 1)
limitinteger15Aantal resultaten per pagina (min: 1)

Voorbeeld

GET /api/v1/companies?page=2&limit=25

Paginering in de response

Elke lijst-response bevat een meta-object:

{
  "data": [ ... ],
  "meta": {
    "current_page": 2,
    "last_page": 8,
    "per_page": 25,
    "total": 192
  }
}
VeldBeschrijving
current_pageDe huidige pagina
last_pageHet totaal aantal paginas
per_pageAantal resultaten per pagina
totalTotaal aantal resultaten over alle paginas

Alle paginas ophalen

Herhaal requests met oplopende page-waarde totdat current_page === last_page:

page = 1
while True:
    response = get(f"/api/v1/companies?page={page}&limit=100")
    process(response["data"])
    if response["meta"]["current_page"] >= response["meta"]["last_page"]:
        break
    page += 1