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.7.0.tar.gz (109.4 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.7.0-py3-none-any.whl (302.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finos_ledger_api_client-0.7.0.tar.gz
  • Upload date:
  • Size: 109.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","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.7.0.tar.gz
Algorithm Hash digest
SHA256 d4fcb6e9c82269dec66edbebd301b3e6a22227c300ce45d2065876876b7f5ae0
MD5 c5da2e40d90416dc497857f6a0db8497
BLAKE2b-256 55c0788f5b79e3895e7d7ad1a5d9f0d4c2779bff8e7ab2750ed92cd52aca621a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finos_ledger_api_client-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 302.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 638ba480725cc93662eddf214ca9b9ffc136e3053d541d5696741e985020a13a
MD5 6f66b8c9a77c80a9ebcabc303f94ee19
BLAKE2b-256 7878a9661abceca44e7761efecfb177012558c556075b68b9104c01810ab6f45

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