Skip to main content
This page provides practical examples of using Blnk’s Filter API. For information about filter syntax, operators, and available fields, see Database Filtering.

​
High-value applied transactions

Retrieve all applied transactions above $10,000, sorted by amount: 
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
  }'
Response
{
  "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: 
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
  }'
Response
{
  "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: 
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" }
    ]
  }'
Response
[
  {
    "transaction_id": "txn_q1_001",
    "amount": 5000,
    "currency": "USD",
    "status": "APPLIED",
    "created_at": "2024-02-14T09:00:00Z"
  }
]
Find all ledgers with “savings” in the name, sorted alphabetically: 
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"
  }'
Response
[
  {
    "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: 
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
  }'
Response
{
  "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 or join our Discord community.