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.4.0.tar.gz (105.8 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.4.0-py3-none-any.whl (295.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finos_ledger_api_client-0.4.0.tar.gz
  • Upload date:
  • Size: 105.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.4.0.tar.gz
Algorithm Hash digest
SHA256 6f92575e1b4cb71d47b45f427e0826e1b601f1dc1c27a268109b17b9e8476870
MD5 426e0cacc0907d62324b02ae5b00b0fe
BLAKE2b-256 ffafba1b0105b4fb64d2920a1c9668cf72231a5b000753e6d58918a3291a6ee6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finos_ledger_api_client-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 295.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7a14da0efb55742a49ae68cda94e3b2339370a46156386b95727d71ee01d96f
MD5 50062030152ce55b05584c70b754dd30
BLAKE2b-256 3a8f779b6cd98c1d076c5571fcde8a42645d26b8fc37df33f0758276b6fb8262

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