Paging
Endpoints that can return many results return them a page at a time. There are two styles, and rate search doesn't page at all.
| Endpoint | Ask with | The answer says |
|---|---|---|
GET /quotes | page (from 1) and size (default 25, at most 200) | total, page, size in data |
GET /unlocations, GET /unlocations/iata_codes | limit (default 100, at most 100) and offset | meta.pagination |
GET /drayage/rates | limit (default 25, at most 100) and offset | data.pagination |
GET /drayage/locations | limit (default 5, at most 10) | No more pages: refine q instead |
GET /rate-search | No paging: every result comes back | Use limitToTopN to keep only the cheapest |
Pages by number
curl -G "https://api-dev.highqube.ai/quotes" \
-H "Authorization: Bearer $HIGHQUBE_API_KEY" \
-d page=2 -d size=25
data.total is how many quotes match on every page. There are more pages while page × size is less than total.
Pages by offset
curl -G "https://api-dev.highqube.ai/unlocations" \
-H "Authorization: Bearer $HIGHQUBE_API_KEY" \
-d search=Shanghai -d limit=1 -d offset=1
"meta": {
"pagination": {
"limit": 1,
"offset": 1,
"total_count": 6,
"returned_count": 1,
"order_by": "created_at"
}
}
The next page starts at offset + returned_count. You have them all when that reaches total_count.

