OpenAPI Specification

The Financeable Aggregation API is fully documented using the OpenAPI 3.0 specification (formerly known as Swagger). This allows you to generate client libraries in any programming language and explore the API using various tools.

Interactive API Reference

Explore the complete API reference with interactive examples:

Loading API Reference...

Accessing the Specification

The OpenAPI specification is available at:

https://docs.financeable.com.au/docs/aggregation-api/spec

You can download it directly or use it with various OpenAPI-compatible tools.

Environment-Specific URLs

The spec URL depends on your environment:

Production: https://docs.financeable.com.au/docs/aggregation-api/spec
Development: https://dev.docs.financeable.com.au/docs/aggregation-api/spec
Local: http://localhost:3000/docs/aggregation-api/spec (when running docs locally)

For CLI tools and imports: Use the production URL unless you're testing with local changes.

For offline use: Download the spec file using curl or your browser:

# Download spec for offline use
curl -o spec.yaml https://docs.financeable.com.au/docs/aggregation-api/spec

# Then use locally
openapi-generator-cli generate -i ./spec.yaml -g python -o ./client

Generating Client Libraries

You can generate type-safe client libraries for your preferred programming language using the OpenAPI specification.

Using OpenAPI Generator

OpenAPI Generator supports over 50 programming languages.

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate a Python client
openapi-generator-cli generate \
  -i https://docs.financeable.com.au/docs/aggregation-api/spec \
  -g python \
  -o ./financeable-client-python

# Generate a Java client
openapi-generator-cli generate \
  -i https://docs.financeable.com.au/docs/aggregation-api/spec \
  -g java \
  -o ./financeable-client-java

# Generate a Go client
openapi-generator-cli generate \
  -i https://docs.financeable.com.au/docs/aggregation-api/spec \
  -g go \
  -o ./financeable-client-go

Tip: If you're actively developing and testing spec changes locally, you can use your local docs URL:

# Using local development server
openapi-generator-cli generate \
  -i http://localhost:3000/docs/aggregation-api/spec \
  -g python \
  -o ./financeable-client-python

Supported Languages

OpenAPI Generator supports many languages including:

Python
Java
Go
Ruby
PHP
C#
Kotlin
Swift
Rust
And many more...

See the full list of generators for all supported languages.

Exploring the API

Swagger UI

You can explore the API interactively using Swagger UI:

# Run Swagger UI locally with Docker
docker run -p 8080:8080 \
  -e SWAGGER_JSON=/spec.yaml \
  -v $(pwd)/spec.yaml:/spec.yaml \
  swaggerapi/swagger-ui

Then open http://localhost:8080 in your browser.

Postman

Import the OpenAPI specification directly into Postman:

Open Postman
Click "Import" in the top left
Select "Link" and enter: https://docs.financeable.com.au/docs/aggregation-api/spec
Postman will create a collection with all API endpoints

Insomnia

Insomnia also supports importing OpenAPI specifications:

Open Insomnia
Click "Create" → "Import From" → "URL"
Enter: https://docs.financeable.com.au/docs/aggregation-api/spec

API Documentation Tools

You can generate static API documentation from the OpenAPI spec:

Using Redoc

npx @redocly/cli build-docs spec.yaml \
  --output docs/index.html

Using Swagger UI Static

npx swagger-ui-dist spec.yaml

Validation and Testing

Use the OpenAPI specification to validate your API requests and responses:

# Install openapi-validator
npm install -g ibm-openapi-validator

# Validate the spec
ibm-openapi-validator spec.yaml

Mock Server

Generate a mock API server for testing:

# Using Prism
npx @stoplight/prism-cli mock spec.yaml

This creates a mock server that returns example responses based on the OpenAPI specification.

Next Steps

Use the TypeScript SDK for the easiest integration
Review Authentication to set up OAuth 2.0