OpenAPI Specification

The Banklyze API is fully described by an OpenAPI 3.1 specification. Use it to generate client libraries, import into API tools, or explore endpoints interactively.

Spec URL

https://api.banklyze.com/v1/openapi.json

Interactive Documentation

The API server hosts two interactive documentation UIs, powered directly by the OpenAPI spec:

• Swagger UI — https://api.banklyze.com/v1/docs — Interactive “Try It” interface for testing endpoints directly
• ReDoc — https://api.banklyze.com/v1/redoc — Clean, three-panel reference documentation

Generate Client Libraries

Python

Use openapi-python-client to generate a fully typed Python client with async support:

# Install the generator
pip install openapi-python-client

# Generate a typed Python client
openapi-python-client generate --url https://api.banklyze.com/v1/openapi.json

TypeScript

Use openapi-typescript to generate TypeScript type definitions from the spec:

# Install openapi-typescript
npm install -D openapi-typescript

# Generate TypeScript types from the spec
npx openapi-typescript https://api.banklyze.com/v1/openapi.json -o ./src/api/banklyze.d.ts

Postman

Import the OpenAPI spec directly into Postman to get a pre-configured collection with all endpoints, parameters, and example bodies:

# Option 1: Import directly from URL in Postman
# File → Import → Link → paste:
https://api.banklyze.com/v1/openapi.json

# Option 2: Download and import
curl -o banklyze-openapi.json https://api.banklyze.com/v1/openapi.json