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,
)
| Field | Type | Description |
|---|---|---|
Q | string | Search query text. Use * to return all records. |
QueryBy | string | Comma-separated list of fields to search in. |
FilterBy | string | Filter conditions to refine results. |
SortBy | string | Sort order, for example created_at:desc. |
Page | int | Page number, starting at 1. |
PerPage | int | Results per page. Max 250, defaults to 10. |
resource | blnkgo.ResourceType | Collection 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)
| Field | Type | Description |
|---|---|---|
Found | int | Number of records matching the query. |
OutOf | int | Total records in the collection. |
Page | int | Current page number. |
SearchTimeMs | int | Time taken to run the search, in milliseconds. |
Hits | []blnkgo.SearchHit | Array of results, each with a Document field. |