> ## 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.
# Examples
> Practical examples of using Blnk's Filter API to query transactions, balances, ledgers, and other collections.
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 ;
};
This page provides practical examples of using Blnk's Filter API. For information about filter syntax, operators, and available fields, see [Database Filtering](/search/db/filtering).
***
## High-value applied transactions
Retrieve all applied transactions above \$10,000, sorted by amount:
```bash cURL wrap theme={"system"}
curl -X POST "https://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": "amount", "operator": "gte", "value": 10000 }
],
"sort_by": "amount",
"sort_order": "desc",
"limit": 50
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.filter(
{
filters: [
{
field: 'status',
operator: 'eq',
value: 'APPLIED',
},
{
field: 'amount',
operator: 'gte',
value: 10000,
},
],
sort_by: 'amount',
sort_order: 'desc',
limit: 50,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Transaction.Filter(blnkgo.FilterParams{
Filters: []blnkgo.Filter{
{Field: "status", Operator: blnkgo.OpEqual, Value: "APPLIED"},
{Field: "amount", Operator: blnkgo.OpGTE, Value: 10000},
},
SortBy: "amount",
SortOrder: "desc",
Limit: 50,
})
```
```json Response wrap 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"
}
]
}
```
***
## USD balances with positive balance
Find all USD balances with a positive balance and include the total count:
```bash cURL wrap theme={"system"}
curl -X POST "https://YOUR_BLNK_INSTANCE_URL/balances/filter" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{ "field": "currency", "operator": "eq", "value": "USD" },
{ "field": "balance", "operator": "gt", "value": 0 }
],
"include_count": true
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.filter(
{
filters: [
{
field: 'currency',
operator: 'eq',
value: 'USD',
},
{
field: 'balance',
operator: 'gt',
value: 0,
},
],
include_count: true,
},
'balances',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.LedgerBalance.Filter(blnkgo.FilterParams{
Filters: []blnkgo.Filter{
{Field: "currency", Operator: blnkgo.OpEqual, Value: "USD"},
{Field: "balance", Operator: blnkgo.OpGT, Value: 0},
},
IncludeCount: true,
})
```
```json Response wrap theme={"system"}
{
"data": [
{
"balance_id": "bln_xyz789",
"currency": "USD",
"balance": 50000,
"credit_balance": 75000,
"debit_balance": 25000,
"ledger_id": "ldg_main001"
}
],
"total_count": 42
}
```
***
## Transactions in date range
Retrieve transactions from Q1 2024:
```bash cURL wrap theme={"system"}
curl -X POST "https://YOUR_BLNK_INSTANCE_URL/transactions/filter" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{ "field": "created_at", "operator": "gte", "value": "2024-01-01" },
{ "field": "created_at", "operator": "lt", "value": "2024-04-01" }
]
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.filter(
{
filters: [
{
field: 'created_at',
operator: 'gte',
value: '2024-01-01',
},
{
field: 'created_at',
operator: 'lt',
value: '2024-04-01',
},
],
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Transaction.Filter(blnkgo.FilterParams{
Filters: []blnkgo.Filter{
{Field: "created_at", Operator: blnkgo.OpGTE, Value: "2024-01-01"},
{Field: "created_at", Operator: blnkgo.OpLT, Value: "2024-04-01"},
},
})
```
```json Response wrap theme={"system"}
[
{
"transaction_id": "txn_q1_001",
"amount": 5000,
"currency": "USD",
"status": "APPLIED",
"created_at": "2024-02-14T09:00:00Z"
}
]
```
***
## Multiple currencies with pattern search
Find all ledgers with "savings" in the name, sorted alphabetically:
```bash cURL wrap theme={"system"}
curl -X POST "https://YOUR_BLNK_INSTANCE_URL/ledgers/filter" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{ "field": "name", "operator": "ilike", "value": "%savings%" }
],
"sort_by": "name",
"sort_order": "asc"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.filter(
{
filters: [
{
field: 'name',
operator: 'ilike',
value: '%savings%',
},
],
sort_by: 'name',
sort_order: 'asc',
},
'ledgers',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Ledger.Filter(blnkgo.FilterParams{
Filters: []blnkgo.Filter{
{Field: "name", Operator: blnkgo.OpILike, Value: "%savings%"},
},
SortBy: "name",
SortOrder: "asc",
})
```
```json Response wrap theme={"system"}
[
{
"ledger_id": "ldg_savings_001",
"name": "Customer Savings Accounts",
"created_at": "2024-01-01T00:00:00Z"
},
{
"ledger_id": "ldg_savings_002",
"name": "High-Yield Savings",
"created_at": "2024-03-15T00:00:00Z"
}
]
```
***
## Transactions by balance
Find all transactions for a specific balance with pagination:
```bash cURL wrap theme={"system"}
curl -X POST "https://YOUR_BLNK_INSTANCE_URL/transactions/filter" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{ "field": "balance_id", "operator": "eq", "value": "bln_abc123" }
],
"include_count": true,
"limit": 100
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.filter(
{
filters: [
{
field: 'balance_id',
operator: 'eq',
value: 'bln_abc123',
},
],
include_count: true,
limit: 100,
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Transaction.Filter(blnkgo.FilterParams{
Filters: []blnkgo.Filter{
{Field: "balance_id", Operator: blnkgo.OpEqual, Value: "bln_abc123"},
},
IncludeCount: true,
Limit: 100,
})
```
```json Response wrap theme={"system"}
{
"data": [
{
"transaction_id": "txn_001",
"amount": 1000,
"currency": "USD",
"status": "APPLIED",
"balance_id": "bln_abc123",
"created_at": "2024-01-15T10:30:00Z"
}
],
"total_count": 250
}
```
***
## 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.