OpenAPI Specification
The machine-readable OpenAPI 3.1 spec for the FlexRate API — download it for clients, codegen, or Postman/Insomnia.
A machine-readable OpenAPI 3.1 description of the FlexRate API is published alongside these docs.
Download
Import it into Postman, Insomnia, or an OpenAPI client generator to scaffold a typed client. The spec covers all four endpoints:
| Method | Path | Summary |
|---|---|---|
POST | /api/pricer/quote | Price a borrower scenario. |
GET | /api/pricer/programs | List Non-QM programs + doc types. |
GET | /api/programs | Cross-lender program catalog. |
GET | /api/programs/{slug}/matrix | Per-program matrix guidelines. |
Authentication
Every endpoint requires a bearer token (FLEXRATE_INTERNAL_TOKEN):
curl -H "Authorization: Bearer <FLEXRATE_INTERNAL_TOKEN>" \
https://api.example.com/api/pricer/programsSee Authentication for details.
Hand-authored references
The per-endpoint pages in this section (quote, programs, catalog, matrix) document request and response shapes in prose with examples. The spec above is the machine-readable companion — keep the two in sync when the API changes.
Interactive playground — follow-up
The hub now runs on fumadocs 16, which unblocks the interactive
fumadocs-openapi playground. Wiring its server-side schema preload
is tracked as a focused follow-up; until then, use the downloadable spec above
with your preferred API client.