Skip to content
← Back to Home

API Reference

High-level overview of Howfar API endpoints and conventions.

Last updated: December 15, 2025

Overview

Howfar uses the Next.js App Router. API routes live under src/app/api/** and are deployed as serverless functions (or edge functions where configured).

API structure

  • /api/auth/* — authentication (register/login/logout/refresh, WebAuthn)
  • /api/wallets, /api/transactions — finance primitives
  • /api/payments/* — payment providers + webhooks
  • /api/admin/* — privileged admin operations

Health endpoints

  • GET /api/health — liveness
  • GET /api/ready — readiness (checks dependencies where configured)
  • GET /api/metrics — Prometheus metrics

API contracts

OpenAPI specs are maintained in the repository (see openapi.next.yaml and openapi.yaml). You can validate them locally using npm run openapi:next:check and npm run openapi:v2:check.

For access questions or keys, contact Support.

Need help? Visit Support or Contact.

API Reference | Howfar — HOWFAR