Pagination
List endpoints answer one page at a time. You choose the page with page and its size with limit, both query parameters. The two API versions differ in the defaults and in the envelope.
An endpoint that returns a whole set at once (for example, List Balances) says so on its page and takes neither parameter.
v3
| Parameter | Default | Rule |
|---|---|---|
page | 1 | Pages count from 1. A page below 1 reads page 1. |
limit | 25 | At most 100. A larger value is read as 100, not refused. |
GET /v3/customers?page=2&limit=50
The response is the list envelope:
{
"data": [],
"page": 2,
"limit": 50,
"total_items": 120,
"total_pages": 3
}
| Field | Is |
|---|---|
data | The items on this page. |
page | The page answered. |
limit | The page size actually used: 100 when you asked for more. |
total_items | How many items match, across every page. |
total_pages | How many pages of limit items that makes. |
To read everything, ask for page=1, then the next page, until page reaches total_pages. next_cursor and prev_cursor are reserved for cursor pagination and are not returned yet.
Lists that take filters list them on their own page. Where a list takes the search parameter q, it needs at least 3 characters (a shorter one answers 422). Only List Customers can be reordered; see Sorting.
v2
| Parameter | Default | Rule |
|---|---|---|
page | 1 | Pages count from 1. |
limit | 100 | Items per page. |
search | none | Where the endpoint lists it: a search text of 3 to 255 characters. |
GET /api/v2/crypto/wallets?page=2&limit=50
{
"data": [],
"page": 2,
"limit": 50,
"total": 120
}
| Field | Is |
|---|---|
data | The items on this page. |
page | The page answered. |
limit | The page size. |
total | How many items match, across every page. |
Some v2 endpoints leave out page, limit or total when its value is 0, so read a missing one as 0. v2 has no total_pages: the last page is the one where page × limit reaches total.
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!