> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search via Typesense

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

export const CtaCallout = props => {
  const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
  const handleCtaClick = () => {
    if (typeof window === "undefined" || !trackingEvent) {
      return;
    }
    try {
      window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
        detail: {
          name: trackingEvent,
          href
        }
      }));
    } catch {}
    try {
      window.posthog?.capture?.(trackingEvent, {
        href
      });
    } catch {}
    const gaPayload = {
      cta_href: href
    };
    try {
      window.gtag?.("event", trackingEvent, gaPayload);
    } catch {}
    try {
      window.dataLayer = window.dataLayer || [];
      window.dataLayer.push({
        event: trackingEvent,
        ...gaPayload
      });
    } catch {}
  };
  const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
  const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
  const linkRel = isExternal ? rel : undefined;
  return <section className="cta-callout not-prose relative my-8 w-full min-w-0 overflow-hidden rounded-xl border border-zinc-200 p-5 dark:border-white/10">
      <div className="cta-callout-noise" aria-hidden="true" />
      <div className="cta-callout-layout">
        {title ? <div className="cta-callout-title-row">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 28 28" width="14" height="14" className="cta-callout-icon shrink-0 text-zinc-800 dark:text-zinc-200" aria-hidden="true">
              <g fill="none" fillRule="nonzero">
                <path d="M28 0v28H0V0h28ZM14.691833333333335 27.134333333333334l-0.012833333333333334 0.0023333333333333335 -0.08283333333333333 0.04083333333333334 -0.023333333333333334 0.004666666666666667 -0.016333333333333335 -0.004666666666666667 -0.08283333333333333 -0.04083333333333334c-0.011666666666666667 -0.004666666666666667 -0.022166666666666668 -0.0011666666666666668 -0.028000000000000004 0.005833333333333334l-0.004666666666666667 0.011666666666666667 -0.019833333333333335 0.49933333333333335 0.005833333333333334 0.023333333333333334 0.011666666666666667 0.015166666666666667 0.12133333333333333 0.08633333333333333 0.0175 0.004666666666666667 0.014000000000000002 -0.004666666666666667 0.12133333333333333 -0.08633333333333333 0.014000000000000002 -0.018666666666666668 0.004666666666666667 -0.019833333333333335 -0.019833333333333335 -0.4981666666666667c-0.0023333333333333335 -0.011666666666666667 -0.0105 -0.019833333333333335 -0.019833333333333335 -0.021Zm0.3091666666666667 -0.13183333333333336 -0.015166666666666667 0.0023333333333333335 -0.21583333333333335 0.1085 -0.011666666666666667 0.011666666666666667 -0.0035000000000000005 0.012833333333333334 0.021 0.5016666666666667 0.005833333333333334 0.014000000000000002 0.009333333333333334 0.008166666666666668 0.23450000000000004 0.1085c0.014000000000000002 0.004666666666666667 0.026833333333333334 0 0.03383333333333334 -0.009333333333333334l0.004666666666666667 -0.016333333333333335 -0.03966666666666667 -0.7163333333333334c-0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.023333333333333334 -0.023333333333333334 -0.025666666666666667Zm-0.8341666666666667 0.0023333333333333335a0.026833333333333334 0.026833333333334334 0 0 0 -0.0315 0.007000000000000001l-0.007000000000000001 0.016333333333333335 -0.03966666666666667 0.7163333333333334c0 0.014000000000000002 0.008166666666666668 0.023333333333333334 0.019833333333333335 0.028000000000000004l0.0175 -0.0023333333333333335 0.23450000000000004 -0.1085 0.011666666666666667 -0.009333333333333334 0.004666666666666667 -0.012833333333333334 0.019833333333333335 -0.5016666666666667 -0.0035000000000000005 -0.014000000000000002 -0.011666666666666667 -0.011666666666666667 -0.21466666666666667 -0.10733333333333334Z" strokeWidth="1.1667" />
                <path fill="currentColor" d="M14 2.916666666666667A1.75 1.75 0 0 1 15.750000000000002 4.666666666666667v6.302333333333334L21.207666666666668 7.816666666666667a1.75 1.75 0 0 1 1.75 3.031L17.5 14l5.457666666666667 3.151166666666667a1.75 1.75 0 0 1 -1.75 3.031l-5.457666666666667 -3.1500000000000004V23.333333333333336a1.75 1.75 0 0 1 -3.5 0v-6.302333333333334L6.792333333333334 20.183333333333337a1.75 1.75 0 1 1 -1.75 -3.031L10.5 14 5.042333333333334 10.848833333333333a1.75 1.75 0 0 1 1.75 -3.031l5.457666666666667 3.1500000000000004V4.666666666666667A1.75 1.75 0 0 1 14 2.916666666666667Z" strokeWidth="1.1667" />
              </g>
            </svg>
            <p className="cta-callout-title min-w-0 font-semibold text-zinc-800 dark:text-zinc-200">
              {title}
            </p>
          </div> : null}
        <div className={`cta-callout-body text-sm leading-normal text-zinc-800 dark:text-zinc-200${title ? " cta-callout-body--indented" : ""}`}>
          {children}
        </div>
        <a href={href} target={target} rel={linkRel} onClick={handleCtaClick} data-docs-cta={trackingEvent || undefined} className="cta-callout-button inline-flex items-center justify-center gap-1 rounded-full bg-white px-3 py-1.5 text-sm font-semibold transition hover:bg-zinc-100 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-white/50 dark:bg-white dark:hover:bg-zinc-200">
          {buttonLabel}
          <span className="cta-callout-button-arrow" aria-hidden="true">
            →
          </span>
        </a>
      </div>
    </section>;
};

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

<Steps>
  <Step title="Call the method">
    ```go client.Search.SearchDocument theme={"system"}
    searchResult, resp, err := 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`. |
  </Step>

  <Step title="Use the search results">
    Read `searchResult.Hits` for matching documents. Each hit includes a `Document` with fields such as `TransactionID`, `Amount`, and `Status`.
  </Step>

  <Step title="Response">
    ```json 201 Created wrap expandable theme={"system"}
    {
      "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`. |
  </Step>
</Steps>

***

## Related docs

<CardGroup cols={2}>
  <Card title="How search works" icon="magnifying-glass" href="/search/typesense/introduction">
    Query syntax, indexing, and use cases.
  </Card>

  <Card title="Search via Typesense" icon="book-open" href="/reference/search-typesense">
    HTTP request and response schema.
  </Card>
</CardGroup>

***

## 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](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).

<CtaCallout title="Connect your ledger to Blnk Cloud" href="https://cloud.blnkfinance.com/auth/sign-up?utm_source=blnk_docs&utm_medium=documentation&utm_campaign=need-help" buttonLabel="Open Blnk Cloud" trackingEvent="clicked_cloud_signup">
  Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.
</CtaCallout>
