Search via Typesense

Run full-text search across your ledger data with the TypeScript SDK.

POST/search/{collection}

Use blnk.Search.search to search records in a collection.

Call the method

const response = await blnk.Search.search(
  {
    q: 'payment',
    query_by: 'description',
    per_page: 20,
  },
  'transactions',
);

Field	Type	Description
`q`	`string`	Search query text. Use `*` to return all records.
`query_by`	`string`	Comma-separated list of fields to search in.
`filter_by`	`string`	Filter conditions to refine results.
`sort_by`	`string`	Sort order, for example `created_at:desc`.
`page`	`number`	Page number, starting at 1.
`per_page`	`number`	Results per page. Max 250, defaults to 10.
`collection`	`string`	Collection to search: `ledgers`, `transactions`, `balances`, or `identities`.

Use the search results

Read response.data.hits for matching documents. Each hit includes a document and optional highlights and text_match score.

Response

{
  "found": 2,
  "out_of": 232,
  "page": 1,
  "request_params": {
    "collection_name": "transactions",
    "per_page": 10,
    "q": "payment"
  },
  "search_time_ms": 2,
  "facet_counts": [],
  "search_cutoff": false,
  "hits": [
    {
      "document": {
        "id": "txn_cd728825-a6e1-4fae-9277-c3235a045ea5",
        "transaction_id": "txn_cd728825-a6e1-4fae-9277-c3235a045ea5",
        "amount": 532,
        "currency": "USD",
        "description": "Test transaction",
        "source": "bln_93fb50c2-969e-49c2-bb61-ef5ed245516e",
        "destination": "bln_20666087-1355-4736-ba04-3ba92a7542b9",
        "status": "APPLIED",
        "created_at": 1758116489
      },
      "highlights": [],
      "text_match": 578730123365711993
    }
  ]
}

Field	Type	Description
`found`	`number`	Number of records matching the query.
`out_of`	`number`	Total records in the collection.
`page`	`number`	Current page number.
`search_time_ms`	`number`	Time taken to run the search, in milliseconds.
`hits`	`object[]`	Array of results, each with a `document` and optional `highlights` and `text_match`.