Skip to main content

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

Project description

platform-api-client

A standalone Python client for the FinOS Platform API (import name finos.platform_api_client, distribution finos-platform-api-client). Extracted from finos-automation-sdk (FINOS-246) so the SDK — and any other consumer — can call the Platform API without pulling the whole automation SDK. Mirrors finos-ledger-api-client in shape.

from finos.platform_api_client import PlatformApiClient

async with PlatformApiClient(base_url, jwt) as client:
    users = await client.api.users.list_users()
    one = await client.api.users.get_user(user_id="usr_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.platform_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_platform_api_client-0.5.0.tar.gz (84.7 kB view details)

Uploaded Source

Built Distribution

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

finos_platform_api_client-0.5.0-py3-none-any.whl (211.9 kB view details)

Uploaded Python 3

File details

Details for the file finos_platform_api_client-0.5.0.tar.gz.

File metadata

  • Download URL: finos_platform_api_client-0.5.0.tar.gz
  • Upload date:
  • Size: 84.7 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_platform_api_client-0.5.0.tar.gz
Algorithm Hash digest
SHA256 3142c14a4ca0bb64425f93c4788809ab61c2c3afdfdc077f6027743494d95f07
MD5 673e80b0918001422ea347ebef3daedf
BLAKE2b-256 24612403fc1effa6ac008d859a8731df19bbe20c2ce1b23e787ac69bbb920b4a

See more details on using hashes here.

File details

Details for the file finos_platform_api_client-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: finos_platform_api_client-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 211.9 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_platform_api_client-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd0feb2d71df7dd308a9f58d9d49c595cab764f7868ad866668233e9c856663d
MD5 4fca06553f0185ba19f83f2c31b44824
BLAKE2b-256 736ed7055805c4b177bd4054e7664a5f25a24f838b05f1e97b39bdd8e60c03fa

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