API documentation

Endpoints, parameters, and request bodies. Pulled from the live OpenAPI spec. (browser path: /api/proxy/v3/api-docs)

Try the API on your tenant

Static reference

The live OpenAPI spec was not reachable, falling back to the built-in reference.

# RateStack API

Base URL (browser): /api/proxy

All proxied requests are authenticated server-side via your session cookie.

## POST /v1/pricing
Submit a `LoanInput` (borrower, loan, property, transaction, execution) and
receive an array of `PriceQuote` objects with adjustment trace.

```json
{
  "borrower": { "fico": 740 },
  "loan": { "loanAmount": 400000, "loanType": "CONFORMING", "amortizationType": "FIXED" },
  "property": { "attachmentType": "DETACHED", "constructionMethod": "SITE_BUILT", "projectLegalStructureType": "NONE", "projectClassificationIdentifier": "NA", "pudIndicator": false, "financedNumberOfUnits": 1, "propertyEstateType": "FEE_SIMPLE", "occupancy": "PRIMARY", "state": "CA" },
  "transaction": { "type": "PURCHASE" },
  "execution": { "lockPeriodDays": 30 }
}
```

## GET /v1/api-keys, POST /v1/api-keys, DELETE /v1/api-keys/{id}
Manage API keys for your organization. The plaintext key is returned only on
creation — store it immediately.

## GET /v1/webhooks, POST /v1/webhooks, DELETE /v1/webhooks/{id}
Manage webhook subscriptions. Each delivery is signed with HMAC-SHA256 using
the subscription secret.