Search

Search via Typesense

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

POST/search/{collection}

Use client.Search.SearchDocument to search records in a collection.

Call the method

searchResult, _, _ := client.Search.SearchDocument(
	blnkgo.SearchParams{
		Q: "payment",
		QueryBy: "description",
		PerPage: 20,
	},
	blnkgo.Transactions,
)
FieldTypeDescription
QstringSearch query text. Use * to return all records.
QueryBystringComma-separated list of fields to search in.
FilterBystringFilter conditions to refine results.
SortBystringSort order, for example created_at:desc.
PageintPage number, starting at 1.
PerPageintResults per page. Max 250, defaults to 10.
resourceblnkgo.ResourceTypeCollection to search: Transactions, Balances, Ledgers, or Identities.

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

Go response (*blnkgo.SearchResponse)

FieldTypeDescription
FoundintNumber of records matching the query.
OutOfintTotal records in the collection.
PageintCurrent page number.
SearchTimeMsintTime taken to run the search, in milliseconds.
Hits[]blnkgo.SearchHitArray of results, each with a Document field.