> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Pagination
> Navigate through large search result sets efficiently using page and per_page parameters
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return ;
};
The `page` and `per_page` parameters control how search results are divided into manageable chunks. This is essential for handling large datasets efficiently and improving application performance.
***
## Quick start
Here's how to get the first 25 transactions:
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"page": 1,
"per_page": 25
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: "*",
page: 1,
per_page: 25,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", Page: 1, PerPage: 25},
blnkgo.Transactions,
)
```
***
## Pagination parameters
| Parameter | Description | Default | Range/Limit | Type |
| :--------- | :------------------------------------------ | :------ | :------------- | :-------- |
| `page` | Specifies which page of results to retrieve | `1` | Minimum: `1` | `integer` |
| `per_page` | Number of records returned in each page | `10` | Maximum: `250` | `integer` |
```bash theme={"system"}
# Examples
{
"page": 1, # First page (default)
"per_page": 50 # 50 results per page
}
{
"page": 3, # Third page
"per_page": 250 # Maximum results per page
}
```
***
## Common pagination patterns
Start with the first page and a reasonable page size.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"page": 1,
"per_page": 50
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: "*",
page: 1,
per_page: 50,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", Page: 1, PerPage: 50},
blnkgo.Transactions,
)
```
Jump to a specific page when you know the approximate location of your data.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/balances" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"page": 5,
"per_page": 100
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: "*",
page: 5,
per_page: 100,
},
'balances',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", Page: 5, PerPage: 100},
blnkgo.Balances,
)
```
Use maximum page size for bulk data processing.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"filter_by": "created_at:[1720310400..1720396800]",
"page": 1,
"per_page": 250
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: "*",
filter_by: "created_at:[1720310400..1720396800]",
page: 1,
per_page: 250,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", FilterBy: "created_at:[1720310400..1720396800]", Page: 1, PerPage: 250},
blnkgo.Transactions,
)
```
Paginate through sorted results for consistent ordering across pages.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"sort_by": "created_at:desc",
"page": 2,
"per_page": 20
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: "*",
sort_by: "created_at:desc",
page: 2,
per_page: 20,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", SortBy: "created_at:desc", Page: 2, PerPage: 20},
blnkgo.Transactions,
)
```
***
## Response structure
The pagination information is included in every search response:
```json theme={"system"}
{
"found": 1247,
"hits": [
// ... result objects
],
"out_of": 5000,
"page": 2,
"request_params": {
"per_page": 50
},
"search_time_ms": 3
}
```
### Key response fields
| Field | Description | Type |
| :------- | :---------------------------------------------- | :-------- |
| `found` | Number of records matching your search criteria | `integer` |
| `out_of` | Total number of records in the collection | `integer` |
| `page` | Current page number | `integer` |
| `hits` | Array of result objects for the current page | `array` |
***
## Best practices
* **Start with reasonable page sizes**: Use 20-50 records for UI display, 100-250 for data processing.
* **Always sort paginated results**: Use `sort_by` to ensure consistent ordering across pages.
* **Handle empty pages gracefully**: Check if `hits` array is empty before processing results.
* **Monitor performance**: Larger page sizes may impact response time.
***
## Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.