Skip to main content
Use the ledgers command to browse ledger containers, open one record by ID, and create new ledgers on your connected Core instance. Ledgers group balances and transactions; start here when you need a ledger_id for balance setup.
CommandAliasDescription
listlBrowse all ledgers in a table; add --id to fetch one
createcCreate a ledger via interactive prompts

list

See every ledger on your connected Core instance in a paginated table with ID, name, and created time. Use this when you need a ledger_id before creating balances or when auditing how your books are partitioned.
blnk ledgers list [options]
Options
OptionTypeDefaultDescription
--{field}stringFilter by any indexed field. Quote comma-separated values for multiple matches.
-p, --pageinteger1Page number.
--per-pageinteger10Results per page.
-h, --helpbooleanShow help for this command.
Usage
1

List all ledgers

Run the command to view a paginated table of ledgers:
blnk ledgers list
Paginate with -p and --per-page:
blnk ledgers list --page 2 --per-page 3
200 Success
┌----------------   ----------------   ----------------------------┐
│ ID              │ Name             │ Created At                  │
| --------------- | ---------------- | --------------------------- |
│ ldg_46074f0e... │ EUR Operations   │ 2026-05-23T17:07:49.876192Z │
│ ldg_0b89c4c5... │ Card Programs    │ 2026-05-23T17:07:49.709619Z │
│ ldg_6a55c36f... │ Savings Accounts │ 2026-05-23T17:07:44.97366Z  │
└----------------   ----------------   ----------------------------┘
3 results found
Page 1/1

list --id

Resolve one ledger by ledger_id, including its name and meta_data. Pass --json to print the same payload your application receives from the Core API.
blnk ledgers list --id <ledger-id> [options]
Options
OptionTypeRequiredDescription
--idstringYesLedger ID to fetch (for example ldg_46074f0e-898d-4b48-bced-d647816168c0).
--jsonbooleanNoPrint the full API object as JSON instead of a formatted summary.
-h, --helpbooleanNoShow help for this command.
Usage
1

Get one ledger

Run the command with a ledger ID:
blnk ledgers list --id ldg_46074f0e-898d-4b48-bced-d647816168c0
Ledger details:
  name: EUR Operations
  ledger_id: ldg_46074f0e-898d-4b48-bced-d647816168c0
  created_at: 2026-05-23T17:07:49Z

create

Add a ledger container through guided prompts for name and optional JSON metadata. Create ledgers first when you are standing up a new product, region, or currency scope. Balances and transactions hang off a ledger.
blnk ledgers create [options]
Arguments The CLI prompts for these values. They are not passed on the command line.
ArgumentTypeRequiredDescription
namestringYesLedger name. Prompt: ledger name >
meta_dataobjectNoOptional metadata as JSON. Prompt: metadata (json) >. Press Enter to skip.
Options
OptionTypeDescription
--jsonbooleanAfter a successful create, print the full API response as JSON.
-h, --helpbooleanShow help for this command.
Usage
1

Create new ledger

Run the command:
blnk ledgers create
The CLI prompts for each argument:
ledger name >
metadata (json) >
Press Enter at the metadata prompt to leave it empty.
2

Ledger created

Ledger created:
  name: My Ledger
  ledger_id: ldg_abc123
  created_at: 2026-05-23T17:07:49Z