Documentation / Start here
Paging
Walking through long lists with page numbers or a cursor.
Lists come in pages
Endpoints that return a list answer 50 records at a time. Ask for up to 200 with per_page.
Two ways to move on
- A cursor (fastest): send
cursorwith thenext_cursorfrom the last answer, until it comes back asnull. A cursor answer counts nothing, so it stays quick on big lists. - Page numbers: send
page=2,page=3and so on. The first answer saystotalandtotal_pages.
GET /v1/games?competition=cp_4f2k9qxa&per_page=200
GET /v1/games?competition=cp_4f2k9qxa&per_page=200&cursor=eyJvIjoyMDAsIm4iOjIwMH0
What meta carries
| Field | Meaning |
|---|---|
count | Records in this answer. |
next_cursor | Send it as cursor for the next records, or null at the end. |
page, per_page | Where you are. |
total, total_pages | How many there are (not sent on a cursor answer). |
next_page, prev_page | The neighbouring page numbers, or null. |