API cookbook

Save and rerun scenarios

Per-borrower scenarios you can rerun in one click. Default-scenario-per-LO speeds the daily flow.

RTBy RateStack TeamPublished2026-03-05Reviewed2026-03-05

beginnercURL

# Create a scenario for a borrower
curl -fsS -X POST "https://api.ratestack.com/v1/scenarios?ownerUserId=$ME" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Smith — primary purchase",
    "input": { ... loan input ... },
    "isDefault": false
  }'

# Rerun later
curl -fsS -X POST "https://api.ratestack.com/v1/scenarios/$ID/touch" \
  -H "X-API-Key: $KEY"
# returns the scenario; pass its input to /v1/pricing/mode for fresh quotes

All recipes