> ## 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

> Search across transactions, balances, ledgers, and identities with filtering, sorting, and pagination.

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

<Note>
  If you're using the auto-provisioned `Enterprise Core` instance included with your Production License deployment, set the base URL to: `https://ENTERPRISE_PUBLIC_URL/core`.

  If you're connecting to a different Core instance, use the publicly accessible base URL for that instance instead.
</Note>

### Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: `X-blnk-key: <api-key>`.

Replace `<api-key>` with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: [Scoped API keys](/api-keys/overview) and [Secure your Blnk server](/advanced/secure-blnk).

<Info>Available in version 0.6.1 and later.</Info>

The Search API enables you to retrieve one or more records from your ledger with advanced filtering, sorting, and full-text search capabilities. Unlike standard GET endpoints, the Search API gives you more control over your results.

### Path Parameters

<ParamField path="collection" type="string" required>
  The collection to search. Supported values:

  * `transactions` - Search through all transaction records
  * `balances` - Find balance records across all ledgers
  * `ledgers` - Locate specific ledgers by name or metadata
  * `identities` - Search customer identity records
</ParamField>

### Body

<ParamField body="q" type="string" required>
  The search query text. Use `*` to return all records. Supports full-text search when combined with `query_by`. Learn more: [Querying](/search/typesense/querying)
</ParamField>

<ParamField body="query_by" type="string">
  Comma-separated list of fields to search in. When provided, performs field-specific searches. Learn more: [Querying](/search/typesense/querying)

  Examples:

  * `"source,destination"` - Search in source and destination fields
  * `"first_name,last_name,email"` - Search in identity name and email fields
</ParamField>

<ParamField body="filter_by" type="string">
  Filter conditions to refine results. Supports operators like `:=`, `:>`, `:<`, `:>=`, `:<=`, `:!=`, and ranges. Learn more: [Filtering](/search/typesense/filtering)

  Examples:

  * `"status:=APPLIED"` - Filter by exact status
  * `"amount:>1000"` - Filter by amount greater than 1000
  * `"status:=APPLIED && currency:=USD"` - Multiple conditions
  * `"created_at:[1704067200..1706745599]"` - Date range filter
</ParamField>

<ParamField body="sort_by" type="string">
  Sorting conditions for ordering results. Format: `field:direction` where direction is `asc` or `desc`. Multiple fields: `field1:desc,field2:asc`. Learn more: [Sorting](/search/typesense/sorting)

  Examples:

  * `"created_at:desc"` - Sort by creation date descending
  * `"amount:desc,created_at:asc"` - Sort by amount then date
</ParamField>

<ParamField body="page" type="integer">
  Page number for pagination. Starts at 1. Default: 1. Learn more: [Pagination](/search/typesense/pagination)
</ParamField>

<ParamField body="per_page" type="integer">
  Number of results per page. Maximum 250, default 10. Learn more: [Pagination](/search/typesense/pagination)
</ParamField>

### Response

<ResponseField name="found" type="integer">
  Total number of matching records.
</ResponseField>

<ResponseField name="hits" type="array">
  Array of search results. Each hit contains a `document` object with the record data and optional `highlights` for matched terms.

  <Expandable title="Hit object structure">
    <ResponseField name="document" type="object">
      The actual record data. Structure varies by collection type (transaction, balance, ledger, or identity).
    </ResponseField>

    <ResponseField name="highlights" type="array">
      Array of highlight objects showing where search terms matched in the document.
    </ResponseField>

    <ResponseField name="text_match" type="integer">
      Relevance score for the search match.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="out_of" type="integer">
  Total number of records in the collection (regardless of filters).
</ResponseField>

<ResponseField name="page" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="per_page" type="integer">
  Number of results per page.
</ResponseField>

<ResponseField name="search_time_ms" type="integer">
  Time taken to execute the search in milliseconds.
</ResponseField>

<ResponseField name="highlights" type="array">
  Search term highlighting information for matched fields. Only present when full-text search matches are found.
</ResponseField>

<RequestExample>
  ```bash theme={"system"}
  curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
    -H "X-Blnk-Key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "q": "*",
      "filter_by": "status:=APPLIED && currency:=USD",
      "sort_by": "created_at:desc",
      "page": 1,
      "per_page": 10
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "facet_counts": [],
    "found": 2,
    "hits": [
      {
        "document": {
          "amount": 532,
          "amount_string": "532",
          "atomic": false,
          "created_at": 1758116489,
          "currency": "USD",
          "description": "Test transaction",
          "destination": "bln_20666087-1355-4736-ba04-3ba92a7542b9",
          "effective_date": 1758116489,
          "id": "txn_cd728825-a6e1-4fae-9277-c3235a045ea5",
          "precise_amount": 53200,
          "precision": 100,
          "reference": "ref-001",
          "source": "bln_93fb50c2-969e-49c2-bb61-ef5ed245516e",
          "status": "APPLIED",
          "transaction_id": "txn_cd728825-a6e1-4fae-9277-c3235a045ea5"
        },
        "highlights": [],
        "text_match": 578730123365711993
      }
    ],
    "out_of": 232,
    "page": 1,
    "per_page": 10,
    "request_params": {
      "collection_name": "transactions",
      "per_page": 10,
      "q": "*"
    },
    "search_cutoff": false,
    "search_time_ms": 2
  }
  ```
</ResponseExample>

<Tip>
  For simple operations like retrieving a single record by ID or listing all records, use the standard GET endpoints. Use the Search API when you need filtering, sorting, or complex queries.
</Tip>

## 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>