### Start Blnk Watch Service (Direct Download)

Source: https://docs.blnkfinance.com/watch/deployment

Starts the Blnk Watch service after installation and environment variable configuration.

```start
blnk-watch start
```

--------------------------------

### Install blnk-watch using go install

Source: https://docs.blnkfinance.com/watch/commands

Builds and installs the blnk-watch binary into your Go path from the project root. This method is an alternative to using 'make'.

```bash
go install ./cmd/blnk-watch
```

--------------------------------

### Backend Install Event Handler

Source: https://docs.blnkfinance.com/cloud/apps/installation

Example of a Node.js backend route handler for processing Blnk Cloud install events. It saves installation details, including an encrypted API key, to a database.

```javascript
app.post("/api/callback", async (req, res) => {
  const event = req.body;

  if (event.idempotency_key?.startsWith("install:")) {

    // Never persist the raw `api_key` in your database " encrypt it at rest (see Codebase setup).
    await installs.save({
      installed_app_id: event.installed_app_id,
      app_id: event.app_id,
      instance_id: event.instance_id,
      api_key_encrypted: encryptSecret(event.api_key),
      api_key_prefix: event.api_key_prefix,
      granted_permissions: event.granted_permissions,
      status: "active",
      idempotency_key: event.idempotency_key
    });

    return res.status(200).json({ ok: true });
  }
});
```

--------------------------------

### View a Balance Monitor using Go

Source: https://docs.blnkfinance.com/balances/balance-monitoring

Fetch a balance monitor using the Blnk Go client library. This example shows how to get a monitor by its ID and handle potential errors.

```go
monitor, resp, err := client.BalanceMonitor.Get("mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0")
```

--------------------------------

### Start Blnk Server with Docker Compose

Source: https://docs.blnkfinance.com/home/install

Initiate the Blnk server for your self-hosted installation using Docker Compose. This command will build and start all necessary services defined in your Docker configuration.

```bash
docker compose up
```

--------------------------------

### Install Blnk Go SDK

Source: https://docs.blnkfinance.com/sdks/go

Install the Blnk Go SDK into your Go project. Ensure you have Go 1.22 or later.

```bash
go mod init blnk-quickstart
go get github.com/blnkfinance/blnk-go
```

--------------------------------

### Cloud Proxy API Examples

Source: https://docs.blnkfinance.com/cloud/apps/app-logic

Examples of how to call Core endpoints using the Cloud Proxy API.

```bash
GET https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=inst_...
```

```bash
POST https://api.cloud.blnkfinance.com/proxy/transactions?instance_id=inst_...
```

--------------------------------

### Core API Endpoints Examples

Source: https://docs.blnkfinance.com/cloud/apps/app-logic

Examples of how endpoints are called directly on Core.

```bash
GET http://localhost:5001/ledgers
```

```bash
POST http://localhost:5001/transactions
```

--------------------------------

### Get Tokenized Fields

Source: https://docs.blnkfinance.com/sdks/typescript/identities/get-tokenized-fields

This example demonstrates how to use the TypeScript SDK to check which identity fields are tokenized. Ensure the SDK is properly installed and imported.

```typescript
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.026833333333334334 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}

```

--------------------------------

### Install and Start Blnk Watch Service

Source: https://docs.blnkfinance.com/watch/quick-start

Install Blnk Watch using a curl command and start the service. The service defaults to listening on port 8081.

```bash
curl -fsSL https://blnkfinance.xyz/install/watch | bash
blnk-watch start
```

--------------------------------

### Start Blnk Watch Service (Build from Source)

Source: https://docs.blnkfinance.com/watch/deployment

Runs the compiled Blnk Watch binary with the start command. This assumes you are in the Watch project root directory.

```start
./blnk-watch -command=start
```

--------------------------------

### Install blnk-watch using make

Source: https://docs.blnkfinance.com/watch/commands

Builds the blnk-watch binary and installs it into your Go binary path. This is useful for running the command directly from your shell.

```bash
make install
```

--------------------------------

### Build Blnk Watch from Source (Windows)

Source: https://docs.blnkfinance.com/watch/quick-start

Clone the Watch repository and build the executable using 'go build' on Windows systems, then start the service.

```bash
git clone https://github.com/blnkfinance/watch && cd watch
go build -o blnk-watch ./cmd/blnk-watch
./blnk-watch start
```

--------------------------------

### Data API Example: Filtered Transactions

Source: https://docs.blnkfinance.com/cloud/apps/app-logic

Example of a GET request to read transactions with status and currency filters using the Cloud Data API.

```bash
curl -X GET "https://api.cloud.blnkfinance.com/data/transactions?instance_id=inst_...&status_eq=APPLIED&currency_eq=USD" \
  -H "Authorization: Bearer blnk_..." \
  -H "Content-Type: application/json"
```

--------------------------------

### Data API Example: Read Transactions

Source: https://docs.blnkfinance.com/cloud/apps/app-logic

Example of a GET request to read transactions using the Cloud Data API, including authorization and content type headers.

```bash
curl -X GET "https://api.cloud.blnkfinance.com/data/transactions?instance_id=inst_..." \
  -H "Authorization: Bearer blnk_..." \
  -H "Content-Type: application/json"
```

--------------------------------

### Start Blnk Watch using Make

Source: https://docs.blnkfinance.com/watch/commands

Execute the default 'start' command using the make utility. This is a simplified way to run Watch, typically for default configurations.

```bash
make start
```

--------------------------------

### Example: Filtering Transactions Request

Source: https://docs.blnkfinance.com/cloud/proxy/data-api

This example shows how to combine multiple filter operators in a single GET request to retrieve transactions within a specific date range and amount.

```bash
GET /data/transactions?
  instance_id=YOUR_INSTANCE_ID&
  currency_eq=USD&
  amount_gte=50&
  amount_lte=500&
  created_at_between=2025-01-01T00:00:00%7C2025-01-31T23:59:59Z
```

--------------------------------

### Initialize Blnk Go Client

Source: https://docs.blnkfinance.com/sdks/go

Parse your Blnk base URL and create a client instance. Provide your API key if authentication is required; use nil for local development without auth. Configure optional settings like timeout and retry.

```go
baseURL, _ := url.Parse("http://localhost:5001/")
apiKey := "your_api_key"
client := blnkgo.NewClient(
	baseURL,
	&apiKey,
	blnkgo.WithTimeout(10*time.Second),
	blnkgo.WithRetry(2),
)
```

--------------------------------

### cURL Request Example

Source: https://docs.blnkfinance.com/cloud/reference/data-api

Example of how to make a GET request to the Data API to retrieve transactions. Ensure you replace YOUR_INSTANCE_ID and YOUR_ACCESS_TOKEN with your actual values. The Authorization header requires the `data:read` scope.

```bash
curl -X GET 'https://api.cloud.blnkfinance.com/data/transactions?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=20' \
    -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

--------------------------------

### Connect to Blnk Core Instance

Source: https://docs.blnkfinance.com/cli/using-blnk-core

Use this command to point the CLI at a Core instance, store your API key locally, and confirm the instance responds. Run this after installation or when switching environments.

```bash
blnk connect [url]
```

--------------------------------

### Get First 25 Transactions

Source: https://docs.blnkfinance.com/search/typesense/pagination

This example demonstrates how to retrieve the first 25 transactions by setting 'page' to 1 and 'per_page' to 25.

```APIDOC
## Get First 25 Transactions

### Description
Retrieves the first 25 transactions from the search results.

### Method
POST

### Endpoint
`/search/transactions`

### Parameters
#### Query Parameters
- `page` (integer) - Required - The page number to retrieve. Set to 1 for the first page.
- `per_page` (integer) - Required - The number of results to return per page. Set to 25 for this example.

#### Request Body
- `q` (string) - Required - The search query. `"*"` searches for all documents.
- `page` (integer) - Required - The page number.
- `per_page` (integer) - Required - The number of results per page.

### Request Example
```json
{
  "q": "*",
  "page": 1,
  "per_page": 25
}
```

### Response
#### Success Response (200)
- `results` (array) - A list of transaction documents.
- `total_results` (integer) - The total number of transactions found.
- `page` (integer) - The current page number.
- `per_page` (integer) - The number of results per page.

#### Response Example
```json
{
  "results": [
    {
      "id": "txn_123",
      "amount": 100.50,
      "currency": "USD",
      "status": "completed"
    }
    // ... more transactions
  ],
  "total_results": 150,
  "page": 1,
  "per_page": 25
}
```
```

--------------------------------

### Fetch Reconciliation Data

Source: https://docs.blnkfinance.com/sdks/typescript/reconciliation/get-reconciliations

Use this function to get the status and match counts for reconciliations. Ensure the Blnk Finance SDK is properly installed and configured.

```typescript
import { Blnk } from "@blnk/sdk";

const blnk = new Blnk("YOUR_API_KEY");

async function getReconciliations() {
  try {
    const reconciliations = await blnk.reconciliation.getReconciliations();
    console.log(reconciliations);
  } catch (error) {
    console.error("Error fetching reconciliations:", error);
  }
}
```

--------------------------------

### Complete Cloud Proxy API Request

Source: https://docs.blnkfinance.com/cloud/apps/app-logic

A full example of a GET request to list ledgers using the Cloud Proxy API, including headers.

```bash
curl -X GET "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=inst_..." \
  -H "Authorization: Bearer blnk_..." \
  -H "Content-Type: application/json"
```

--------------------------------

### Example usage of `blnk ledgers list`

Source: https://docs.blnkfinance.com/cli/help

Demonstrates how to list ledgers, including options for pagination and filtering.

```bash
blnk ledgers list
```

```bash
blnk ledgers l --page 2 --per-page 20
```

```bash
blnk ledgers l --ledger-id ldg_abc123
```

--------------------------------

### Get Alert Response Example

Source: https://docs.blnkfinance.com/cloud/home/alerts-api

This JSON object represents a single alert fetched from the API. It includes details such as ID, title, description, status, and timestamps.

```json
{
    "anomaly_id": "ano_8a380fd1-0289-46d1-bc76-aa17a510a64e",
    "title": "Balance threshold exceeded",
    "description": "Account balance has exceeded the maximum allowed limit.",
    "type": "Balance",
    "assigned_to": "jerrys enebeli",
    "escalated_to": [
      "user_01K4EX0BRXHNNGCRVT2TPNK07W"
    ],
    "status": "FLAGGED",
    "created_at": "2026-01-15T09:22:37.55763+01:00",
    "updated_at": "2026-01-15T09:26:03.094425+01:00",
    "affected_balances": [
      "bln_20f02af6-3728-4d37-9b5a-c7ed080f09df"
    ],
    "affected_identities": [],
    "affected_transactions": []
  }
```

--------------------------------

### Initialize Blnk Client and Create Transaction

Source: https://docs.blnkfinance.com/sdks/typescript/start/quick-start

Create a sample script to initialize the Blnk client using API keys and base URL from environment variables, then create a transaction. Requires a running Blnk Core instance.

```javascript
const { BlnkInit } = require('@blnkfinance/blnk-typescript');

const blnk = BlnkInit(process.env.BLNK_API_KEY ?? '', {
  baseUrl: process.env.BLNK_BASE_URL ?? 'http://localhost:5001',
});

async function main() {
  const response = await blnk.Transactions.create({
    precise_amount: 100000,
    reference: 'first_txn_001',
    currency: 'USD',
    precision: 100,
    source: '@FundingPool',
    destination: '@MyBalance',
    description: 'My first Blnk transaction',
    allow_overdraft: true,
  });

  if (response.status !== 201 || !response.data) {
    throw new Error(response.message);
  }

  console.log(JSON.stringify(response.data, null, 2));
}

main();

```

--------------------------------

### Initiate Ledger Creation

Source: https://docs.blnkfinance.com/cli/ledgers

Run this command to start the interactive ledger creation. You will be prompted for the ledger name and metadata.

```bash
blnk ledgers create
```

--------------------------------

### Get a Specific Ledger by ID

Source: https://docs.blnkfinance.com/cli/ledgers

Run this command to retrieve details for a ledger identified by its unique ID. This example shows how to fetch a ledger with a specific ID.

```bash
blnk ledgers list --id ldg_46074f0e-898d-4b48-bced-d647816168c0
```

--------------------------------

### Set Up App Routes with Express

Source: https://docs.blnkfinance.com/cloud/apps/codebase-setup

Use Express to define POST routes for handling install/uninstall callbacks and generating portal URLs. Ensure each route exists and returns a response.

```typescript
import express from "express";

const router = express.Router();

router.post("/api/callback", async (req, res) => {
  // Handle install and uninstall events
});

router.post("/api/portal", async (req, res) => {
  // Create a short-lived portal URL
});
```

--------------------------------

### Get help for a Blnk CLI subcommand

Source: https://docs.blnkfinance.com/cli/help

To view options and examples for a specific subcommand, such as `ledgers list`, use `blnk [resource] [subcommand] --help`.

```bash
blnk ledgers list --help
```

--------------------------------

### Get Balance by Indicator with TypeScript SDK

Source: https://docs.blnkfinance.com/sdks/typescript/ledger-balances/get-balance-by-indicator

Use this snippet to retrieve a specific ledger balance by its indicator. Ensure you have the Blnk Finance TypeScript SDK installed and configured.

```typescript
import { Blnk } from "@blnk/sdk";

const blnk = new Blnk({
  apiKey: "YOUR_API_KEY",
  // other options
});

async function getBalanceByIndicator(indicator: string) {
  try {
    const balance = await blnk.ledger.getBalanceByIndicator(indicator);
    console.log(balance);
    return balance;
  } catch (error) {
    console.error("Error fetching balance:", error);
    throw error;
  }
}

getBalanceByIndicator("some-indicator");
```

--------------------------------

### Run sync-once using make

Source: https://docs.blnkfinance.com/watch/commands

Execute the default 'sync-once' command using the 'make' utility. For custom batch sizes, use the binary directly.

```bash
make sync-once
```

--------------------------------

### Uninstall Event Payload Example

Source: https://docs.blnkfinance.com/cloud/apps/installation

This JSON object represents the payload received when a user uninstalls an app. It contains details about the installation, app, instance, and the timestamp of the uninstall.

```json
{
  "installed_app_id": "instapp_...",
  "app_id": "app_...",
  "instance_id": "inst_...",
  "uninstalled_at": "2026-04-21T12:00:00Z",
  "idempotency_key": "uninstall:instapp_..."
}
```

--------------------------------

### Build Blnk Watch from Source (macOS/Linux)

Source: https://docs.blnkfinance.com/watch/quick-start

Clone the Watch repository and build the executable using 'make start' on macOS or Linux systems.

```bash
git clone https://github.com/blnkfinance/watch && cd watch
make start
```

--------------------------------

### Example: Fetch Balance Details

Source: https://docs.blnkfinance.com/cloud/proxy/data-api

Retrieve specific details for a balance using its unique ID. Ensure your access token and instance ID are correctly provided.

```bash
curl -X GET "https://api.cloud.blnkfinance.com/data/balances/bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f?instance_id=YOUR_INSTANCE_ID" \
    -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
```

--------------------------------

### Search Transactions by Date Range

Source: https://docs.blnkfinance.com/search/typesense/introduction

Retrieve transactions within a specific date range for reporting or auditing. This example uses Unix timestamps to define the start and end of the period, sorting results by creation date.

```bash
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": "created_at:[1704067200..1706745599]",
    "sort_by": "created_at:desc"
  }'
```

```typescript
const response = await blnk.Search.search(
  {
    q: "*",
    filter_by: "created_at:[1704067200..1706745599]",
    sort_by: "created_at:desc",
  },
  'transactions',
);
```

```go
results, resp, err := client.Search.SearchDocument(
  blnkgo.SearchParams{Q: "*", FilterBy: "created_at:[1704067200..1706745599]", SortBy: "created_at:desc"},
  blnkgo.Transactions,
)
```

--------------------------------

### Enter Instance URL and API Key

Source: https://docs.blnkfinance.com/cli/using-blnk-core

When prompted, enter the instance URL and API key. Press Enter at the API key prompt to skip if your instance does not require a key.

```text
url >
api key >
```

--------------------------------

### Confirm Blnk CLI Installation

Source: https://docs.blnkfinance.com/cli/install

Confirm your Blnk CLI installation by checking the installed version.

```bash
blnk --version
```

--------------------------------

### Run sync-once with default batch size using Go binary

Source: https://docs.blnkfinance.com/watch/commands

Execute the 'sync-once' command with the default batch size of 1000 transactions using the Go binary from the project directory.

```bash
./blnk-watch -command=sync-once
```

--------------------------------

### Install Blnk CLI Globally

Source: https://docs.blnkfinance.com/cli/install

Install and update the Blnk CLI globally using npm. Ensure Node.js and npm are installed on your machine.

```bash
npm i -g @blnkfinance/blnk-cli
```

--------------------------------

### Create a Balance Monitor

Source: https://docs.blnkfinance.com/sdks/go

Use the Create method from the BalanceMonitor client to set up a new balance monitor. Specify the BalanceID and the condition to monitor.

```go
monitor, resp, err := client.BalanceMonitor.Create(blnkgo.MonitorData{
    BalanceID: "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    Condition: blnkgo.MonitorCondition{
        Field:     "credit_balance",
        Operator:  blnkgo.OperatorGreaterThan,
        Value:     1000,
        Precision: 100,
    },
})
```

--------------------------------

### Run Blnk.finance Enterprise Docker Image

Source: https://docs.blnkfinance.com/cloud/start/deploy

Start the Blnk.finance enterprise stack using the Docker image. Ensure to map the host port to ENTERPRISE_PUBLIC_PORT and use an environment file for configuration.

```bash
docker run -d \
  --name blnk-enterprise \
  -p 8080:8080 \
  --env-file ./enterprise.env \
  ghcr.io/blnkfinance/blnk-enterprise:0.1.10
```

--------------------------------

### GET /reconciliation/:reconciliation_id

Source: https://docs.blnkfinance.com/cloud/reference/proxy-api

Get details of a reconciliation.

```APIDOC
## GET /reconciliation/:reconciliation_id

### Description
Retrieve details for a specific reconciliation process.

### Method
GET

### Endpoint
/reconciliation/:reconciliation_id

### Parameters
#### Path Parameters
- **reconciliation_id** (string) - Required - The ID of the reconciliation.

### Response
#### Success Response (200)
- Response structure matches the corresponding Core endpoint.
```