Examples

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
  }'

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',
);

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,
})

response = 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",
)

ApiResponse<JsonNode> response = blnk.search().filter(
    FilterParams.create()
        .filters(List.of(
            FilterCondition.create()
            .field("status")
            .operator("eq")
            .value("APPLIED"),
            FilterCondition.create()
            .field("amount")
            .operator("gte")
            .value(10000)
        ))
        .sortBy("amount")
        .sortOrder("desc")
        .limit(50),
    "transactions");

Response

{
  "data": [
    {
      "transaction_id": "txn_6164573b-6cc8-45a4-ad2e-7b4ba6a60f7d",
      "amount": 15000,
      "currency": "USD",
      "status": "APPLIED",
      "source": "bln_28edb3e5-c168-4127-a1c4-16274e7a28d3",
      "destination": "bln_ebcd230f-6265-4d4a-a4ca-45974c47f746",
      "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
  }'

const response = await blnk.Search.filter(
  {
    filters: [
      {
        field: 'currency',
        operator: 'eq',
        value: 'USD',
      },
      {
        field: 'balance',
        operator: 'gt',
        value: 0,
      },
    ],
    include_count: true,
  },
  'balances',
);

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,
})

response = blnk.search.filter(
  {
    "filters": [
      {
        "field": "currency",
        "operator": "eq",
        "value": "USD",
      },
      {
        "field": "balance",
        "operator": "gt",
        "value": 0,
      },
    ],
    "include_count": True,
  },
  "balances",
)

ApiResponse<JsonNode> response = blnk.search().filter(
    FilterParams.create()
        .filters(List.of(
            FilterCondition.create()
            .field("currency")
            .operator("eq")
            .value("USD"),
            FilterCondition.create()
            .field("balance")
            .operator("gt")
            .value(0)
        ))
        .includeCount(true),
    "balances");

Response

{
  "data": [
    {
      "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
      "currency": "USD",
      "balance": 50000,
      "credit_balance": 75000,
      "debit_balance": 25000,
      "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc"
    }
  ],
  "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" }
    ]
  }'

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',
);

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"},
    },
})

response = blnk.search.filter(
  {
    "filters": [
      {
        "field": "created_at",
        "operator": "gte",
        "value": "2024-01-01",
      },
      {
        "field": "created_at",
        "operator": "lt",
        "value": "2024-04-01",
      },
    ],
  },
  "transactions",
)

ApiResponse<JsonNode> response = blnk.search().filter(
    FilterParams.create()
        .filters(List.of(
            FilterCondition.create()
            .field("created_at")
            .operator("gte")
            .value("2024-01-01"),
            FilterCondition.create()
            .field("created_at")
            .operator("lt")
            .value("2024-04-01")
        )),
    "transactions");

Response

[
  {
    "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:

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"
  }'

const response = await blnk.Search.filter(
  {
    filters: [
      {
        field: 'name',
        operator: 'ilike',
        value: '%savings%',
      },
    ],
    sort_by: 'name',
    sort_order: 'asc',
  },
  'ledgers',
);

results, resp, err := client.Ledger.Filter(blnkgo.FilterParams{
    Filters: []blnkgo.Filter{
        {Field: "name", Operator: blnkgo.OpILike, Value: "%savings%"},
    },
    SortBy: "name",
    SortOrder: "asc",
})

response = blnk.search.filter(
  {
    "filters": [
      {
        "field": "name",
        "operator": "ilike",
        "value": "%savings%",
      },
    ],
    "sort_by": "name",
    "sort_order": "asc",
  },
  "ledgers",
)

ApiResponse<JsonNode> response = blnk.search().filter(
    FilterParams.create()
        .filters(List.of(
            FilterCondition.create()
            .field("name")
            .operator("ilike")
            .value("%savings%")
        ))
        .sortBy("name")
        .sortOrder("asc"),
    "ledgers");

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_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f" }
    ],
    "include_count": true,
    "limit": 100
  }'

const response = await blnk.Search.filter(
  {
    filters: [
      {
        field: 'balance_id',
        operator: 'eq',
        value: 'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
      },
    ],
    include_count: true,
    limit: 100,
  },
  'transactions',
);

results, resp, err := client.Transaction.Filter(blnkgo.FilterParams{
    Filters: []blnkgo.Filter{
        {
            Field: "balance_id",
            Operator: blnkgo.OpEqual,
            Value: "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
        },
    },
    IncludeCount: true,
    Limit: 100,
})

response = blnk.search.filter(
  {
    "filters": [
      {
        "field": "balance_id",
        "operator": "eq",
        "value": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
      },
    ],
    "include_count": True,
    "limit": 100,
  },
  "transactions",
)

ApiResponse<JsonNode> response = blnk.search().filter(
    FilterParams.create()
        .filters(List.of(
            FilterCondition.create()
            .field("balance_id")
            .operator("eq")
            .value("bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f")
        ))
        .includeCount(true)
        .limit(100),
    "transactions");

Response

{
  "data": [
    {
      "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
      "amount": 1000,
      "currency": "USD",
      "status": "APPLIED",
      "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
      "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.

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Webhooks

API keys

Guides

Configuration

Advanced

Migration guides

High-value applied transactions

USD balances with positive balance

Transactions in date range

Multiple currencies with pattern search

Transactions by balance

Need help?

​High-value applied transactions

​USD balances with positive balance

​Transactions in date range

​Multiple currencies with pattern search

​Transactions by balance

​Need help?

High-value applied transactions

USD balances with positive balance

Transactions in date range

Multiple currencies with pattern search

Transactions by balance

Need help?