Skip to main content

FinOS Ledger API client — the OpenAPI-generated Ledger API client + a dynamic tag.operation façade and typed error taxonomy (Spec 037 / FINOS-246)

Project description

ledger-api-client

A standalone Python client for the FinOS Ledger API (import name finos.ledger_api_client). Extracted from finos-automation-sdk (Spec 037 / FINOS-246) so both the SDK and apps/platform-api can call the Ledger API without pulling the whole automation SDK.

from finos.ledger_api_client import LedgerApiClient

async with LedgerApiClient(base_url, jwt) as client:
    ledgers = await client.api.ledgers.list_ledgers()
    one = await client.api.ledgers.get_ledger(ledger_id="led_1")
  • client.api.<tag>.<op>(...) — operations are reflected by tag from the OpenAPI-generated client under _generated/, so nothing is hand-written and nothing needs re-writing when the client is regenerated.
  • Each call returns the parsed 2xx body or raises a typed error (finos.ledger_api_client.errors): 401→AuthenticationError, 403→AuthorizationError, 404→NotFoundError, 409→ConflictError, 422→ValidationError, 5xx/other→ServerError.
  • Both base_url and jwt are always required (no env fallback). The client never mints and never talks to an auth provider.

Standalone by design: depends only on httpx + attrs + python-dateutil — no finos.shared, no fastapi — so finos-automation-sdk stays pip-installable on Windmill.

See AGENTS.md for the full package guide and regeneration steps.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finos_ledger_api_client-0.6.0.tar.gz (109.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finos_ledger_api_client-0.6.0-py3-none-any.whl (302.4 kB view details)

Uploaded Python 3

File details

Details for the file finos_ledger_api_client-0.6.0.tar.gz.

File metadata

  • Download URL: finos_ledger_api_client-0.6.0.tar.gz
  • Upload date:
  • Size: 109.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for finos_ledger_api_client-0.6.0.tar.gz
Algorithm Hash digest
SHA256 79d09806915294d5f79e993d951c39e2d6162c0a2f542e6c2e9e62580e511c32
MD5 8cd1edf43f9b3724770701f11d4824b0
BLAKE2b-256 f262aa503bbae2033d42bbe770bab60c6ae58aafe1cffc8831769f2a17884175

See more details on using hashes here.

File details

Details for the file finos_ledger_api_client-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: finos_ledger_api_client-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 302.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for finos_ledger_api_client-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f1560bb45db6a0bc1311da44501db9d38c14c1cae5e5ae23d8d8e62d0581cdd
MD5 b217a64957c33a1d7fb750bcefbee2e4
BLAKE2b-256 442b6a8f0c49e9deebb10a80e8f3cae5429f5f832486edd2fba1c8d475412870

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page