# OpenAPI Spec

Machine-readable API specification for programmatic integration. The document follows the
OpenAPI 3 standard and describes every public `/v1` endpoint, its parameters and the
authentication schemes, so you can explore the API in tools like Swagger UI or Postman and
generate typed clients in any language.

## Document URL

`https://api.vantafin.com/v1/openapi.json`

The spec is served without authentication so tooling can fetch it before you have a key.

## Fetch it

```bash
curl https://api.vantafin.com/v1/openapi.json
```

## Generate a client

```bash
# Generate a typed client in any language from the spec
npx @openapitools/openapi-generator-cli generate \
  -i https://api.vantafin.com/v1/openapi.json \
  -g typescript-fetch \
  -o ./vantafin-client
```

## Authentication

All endpoints accept a Vantafin API key via the `X-API-Key` header, an
`Authorization: Bearer` header, or the `apiKey` query parameter. The base server is
`https://api.vantafin.com`.