REST API overview

REST endpoints used internally by HEVN CLI.

The Generated API Reference below is a curated subset of the HEVN OpenAPI schema (https://api.hevn.finance/openapi.json): endpoint pages, request examples, and an interactive API Playground.

Base URL

The generated OpenAPI reference uses:

https://api.hevn.finance

The CLI builds requests from the configured API base URL:

https://api.hevn.finance/api/v1

The base URL can be selected through HEVN_ENV, saved login config, or HEVN_BASE_URL.

export HEVN_ENV=prod
export HEVN_BASE_URL=https://api.hevn.finance/api/v1

API clients

Client	Auth mode	Used for
AppApi	HEVN API key (X-Api-Key)	Account, profile, contacts, invoices, contracts, banks, cards, KYB, balance, quotes, transfers, transactions
PublicApi	Public	FX rates and public invoices

Request behavior

All requests:

• send Accept: application/json,
• send the configured API key for authenticated clients,
• use a 60 second HTTP timeout,
• send query parameters only when their values are not None,
• parse non-empty responses as JSON,
• raise a CLI HevnError for HTTP status codes >= 400.

When --debug or HEVN_DEBUG=1 is enabled, error output can include the generated curl command.

Mutating HTTP methods (POST, PUT, PATCH, DELETE) are intercepted by --dry-run / HEVN_DRY_RUN=1 before the network call is made.

Common response handling

The CLI does not enforce a shared backend response schema across endpoints. It passes backend JSON through to command formatters and wraps --json / --yaml command output in a CLI envelope.

For integration code, use the endpoint-specific objects returned by the backend and treat fields shown in command output as convenience projections rather than exhaustive schemas.

Endpoint index

Authentication

Header modes, login config, and idempotency headers.