---
title: "Monte Carlo"
method: POST
path: "/monte-carlo"
---

# Monte Carlo

`POST /monte-carlo`

## Request

- Base URL: `https://api.terravue.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.terravue.app/monte-carlo`
- Auth: none declared

## Request body

- MonteCarloRequest
  - `inputs` SimulateRequest, required
    - `homePrice` number, required
    - `downPaymentPct` number, required
    - `loanTermYears` integer, required
    - `closingCostPct` number, required
    - `propertyTaxRate` number, required
    - `insuranceRate` number, required
    - `hoaMonthly` number, required
    - `maintenanceRate` number, required
    - `maintenanceRamp` number
    - `pmiRate` number, required
    - `mortgageType` 'fixed' | 'arm', required
    - `fixedRate` number, required
    - `armInitialRate` number, required
    - `armFixedYears` integer, required
    - `armPostRate` number, required
    - `armCapInitial` number, required
    - `armCapPeriodic` number, required
    - `armCapLifetime` number, required
    - `armAdjustEveryYears` integer, required
    - `refinanceEnabled` boolean, required
    - `refinanceYear` integer, required
    - `refinanceRate` number, required
    - `refinanceClosingCostPct` number, required
    - `monthlyRent` number, required
    - `rentInsuranceMonthly` number, required
    - `marginalTaxRate` number, required
    - `capGainsRate` number, required
    - `saltCap` number, required
    - `standardDeduction` number, required
    - `filingStatus` 'mfj' | 'single', required
    - `sellingCostPct` number, required
    - `analysisYears` integer, required
    - `inflationRate` number
    - `appreciationPath` number[], nullable
    - `investmentReturnPath` number[], nullable
    - `rentInflationPath` number[], nullable
    - `armRatePath` number[], nullable
    - `homeAppreciationRate` number
    - `investmentReturnRate` number
    - `rentInflationRate` number
  - `mcParams` MCParams, required
    - `apprMean` number, required
    - `apprStdev` number, required
    - `retMean` number, required
    - `retStdev` number, required
    - `rentMean` number, required
    - `rentStdev` number, required
    - `rateStdev` number
  - `numRuns` integer
  - `mode` string

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/terravue/apis/propertyiq-api.md) · [All operations](https://skmtc.dev/terravue/apis/propertyiq-api/llms.txt) · [OpenAPI document](https://skmtc.dev/terravue/apis/propertyiq-api/revisions/ea492f95ac2a?raw)