Skip to content

API Reference

LibreFolio provides a comprehensive RESTful API built with FastAPI.

Interactive Documentation

When the LibreFolio server is running, you can access the auto-generated interactive documentation. These pages allow you to explore the API endpoints, see the expected request/response schemas, and even execute requests directly from your browser.

  • 🚀 Swagger UI : Best for exploring and testing endpoints.
  • 💻 ReDoc: Best for reading the documentation in a structured format.

Dynamic Route Generation

FastAPI generates the API routes dynamically at startup based on the Python function definitions. This ensures that the documentation is always perfectly in sync with the code.

The API is structured into routers, each handling a specific domain:

  • /auth: Authentication (login, token refresh).
  • /users: User management.
  • /assets: Asset management (CRUD, price history).
  • /transactions: Transaction management.
  • /portfolio: Portfolio analysis and metrics.
  • /fx: Foreign exchange operations.
  • /brim: Broker report import.

Pydantic Schemas

The API uses Pydantic models for data validation and serialization. These schemas define the structure of the data exchanged between the frontend and backend. You can find the schema definitions in the backend/app/schemas/ directory.