> ## 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.
# Search via DB
> Filter ledgers, balances, transactions, and identities using Blnk's Filter API with direct database queries.
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 Filter API lets you retrieve records from any collection using server-side filters with a clean JSON interface. Use it when you need precise, composable queries without the overhead of Typesense.
If you're using the auto-provisioned `Enterprise Core` instance included with your Production License deployment, set the base URL to: `https://ENTERPRISE_PUBLIC_URL/core`.
If you're connecting to a different Core instance, use the publicly accessible base URL for that instance instead.
### Authorization
If set, the API uses an API key for authentication. Include the following header in your requests: `X-blnk-key: `.
Replace `` with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.
See also: [Scoped API keys](/api-keys/overview) and [Secure your Blnk server](/advanced/secure-blnk).
### Path Parameters
The collection to filter. Supported values:
* `ledgers` - Filter ledgers by name or metadata
* `balances` - Filter balance records across all ledgers
* `transactions` - Filter transaction records
* `identities` - Filter customer identity records
### Body
Array of filter objects. Each object has `field`, `operator`, and optionally `value` or `values`. Learn more: [Search via DB docs](/search/db/filtering)
Examples:
* `[{"field": "status", "operator": "eq", "value": "APPLIED"}]` - Exact match
* `[{"field": "currency", "operator": "in", "values": ["USD", "EUR"]}]` - Multiple values
Combines multiple filters with `and` or `or`. Default: `and`.
Field to sort by. Only indexed fields are sortable. Default: `created_at`. Learn more: [Performance Tuning](/search/db/performance)
Sort direction: `asc` or `desc`. Default: `desc`.
Include total count in response. May impact performance on large datasets. Default: `false`.
Max records to return. Default: 20, max: 100.
Records to skip for pagination. Default: 0.
### Response
Array of matching records. Structure varies by collection type (ledger, balance, transaction, or identity).
Total number of matching records. Only present when `include_count` is `true`.
```bash theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/transactions/filter" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{ "field": "status", "operator": "eq", "value": "APPLIED" },
{ "field": "currency", "operator": "in", "values": ["USD", "EUR"] }
],
"logical_operator": "and",
"sort_by": "created_at",
"sort_order": "desc",
"include_count": true,
"limit": 20,
"offset": 0
}'
```
```json 200 theme={"system"}
{
"data": [
{
"transaction_id": "txn_abc123",
"amount": 15000,
"currency": "USD",
"status": "APPLIED",
"source": "bln_source123",
"destination": "bln_dest456",
"created_at": "2024-01-15T10:30:00Z"
}
],
"total_count": 150
}
```
```json 400 theme={"system"}
{
"error": "Invalid filter: invalid operator 'resembles' for field 'amount': must be one of eq, ne, gt, gte, lt, lte, in, between, like, ilike, isnull, isnotnull",
"error_detail": {
"code": "GEN_BAD_REQUEST",
"message": "Invalid filter: invalid operator 'resembles' for field 'amount': must be one of eq, ne, gt, gte, lt, lte, in, between, like, ilike, isnull, isnotnull"
}
}
```
For full-text search, advanced faceting, or querying across millions of records, use [Search via Typesense](/reference/search-typesense) instead.
## 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.