Rental property analysis for your integration.

Base URL and availability

The API is served under /api/v1. Set a base URL for the environment you have been authorized to use, then append the operation path shown below.

For an authorized staging integration, set the base URL to the preview host provided for your deployment. Do not include /api/v1 in the variable; the examples append that path.

export RENTMAX_AI_API_BASE_URL="https://your-authorized-preview-host"
export RENTMAX_AI_API_KEY="rmai_..."

The preview host may require Vercel deployment authentication in addition to the RentMax AI API key. In Windows PowerShell, use $env:RENTMAX_AI_API_BASE_URL, $env:RENTMAX_AI_API_KEY, and curl.exe.

Quick start

Create a key, add API credits, send a request from your server, and inspect the response.

1. Sign in to RentMax AI and open API Configuration. Create a key with a recognizable name. The full key is shown once; save it before leaving the page. You can keep up to five active keys, and rotating one revokes the old key immediately.
2. Choose a prepaid API credit pack. The price is shown before checkout. Website subscriptions do not include API credits, and there is no free API trial.
3. Store the key in your server’s secret manager or environment as RENTMAX_AI_API_KEY. Never put it in browser code, a mobile app, a public repository, or client-visible logs.
4. Set RENTMAX_AI_API_BASE_URL to the authorized API host for your environment, as described above.
5. Send an Idempotency-Key for each new operation. It is optional, but strongly recommended so you can safely retry after a timeout. Reuse it only for the same operation and exact same request body.

curl "$RENTMAX_AI_API_BASE_URL/api/v1/analyze" \
  -H "Authorization: Bearer $RENTMAX_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: property-123-run-001" \
  -d '{"address":"123 Main St, Austin, TX 78701","values":{"purchasePrice":350000,"targetRent":2400},"sections":["dealSummary","keyMetrics","risks"]}'

The address is illustrative. Use a real U.S. street address for a live property lookup. The supplied rent and purchase price act as underwriting overrides.

Common use cases

Choose the smallest workflow that answers your question. Each endpoint call is a separate operation.

Choose an operation

Every operation is an HTTPS POST with an application/json object body of at most 5,000 bytes. Only the top-level fields shown in the table are accepted; extra fields are rejected. address must be a complete, supported U.S. street address between 10 and 240 characters.

underwrite and report require positive values.targetRent and values.purchasePrice. analyze always requires an address. It can fill either financial value from the property lookup, and positive values you provide override the lookup; the completed analysis still needs both values. sections is accepted only by analyze and report.

Underwriting without a property lookup

For /underwrite or /report, put the assumptions inside a values object. The example below calculates metrics from supplied numbers without a street address.

curl "$RENTMAX_AI_API_BASE_URL/api/v1/underwrite" \
  -H "Authorization: Bearer $RENTMAX_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: scenario-austin-001" \
  -d '{"values":{"targetRent":2400,"purchasePrice":350000,"propertyTaxAnnual":4200,"insurance":160,"vacancyRatePct":5,"downPct":20,"ratePct":6.5,"termYears":30,"useLoan":true}}'

Property lookup and report examples

curl "$RENTMAX_AI_API_BASE_URL/api/v1/rent-estimate" \
  -H "Authorization: Bearer $RENTMAX_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: rent-austin-001" \
  -d '{"address":"123 Main St, Austin, TX 78701"}'

curl "$RENTMAX_AI_API_BASE_URL/api/v1/report" \
  -H "Authorization: Bearer $RENTMAX_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: report-austin-001" \
  -d '{"values":{"targetRent":2400,"purchasePrice":350000},"sections":["dealSummary","keyMetrics","risks"]}'

Underwriting inputs

Send values as an object. Money values are JSON numbers in U.S. dollars; percentages use percentage points, so send 6.5 for 6.5%. Each numeric field has an inclusive range below. Unknown fields, strings in place of numbers, non-finite values, and text instructions are rejected. useLoan must be a JSON boolean.

For underwrite and report, targetRent and purchasePrice are required in values. For analyze, property estimates supply them when available; include positive overrides for any missing or changed value. If useLoan is true and the loan inputs are usable, mortgagePI is ignored. All defaults are assumptions, not verified property facts. Enter realistic taxes, insurance, HOA, maintenance, vacancy, and financing details.

Choose report sections

For analyze and report, omit sections to request all supported report sections. To request a smaller report, send a non-empty array of unique supported names. Arbitrary prompts and unsupported names are rejected.

{"values":{"targetRent":2400,"purchasePrice":350000},"sections":["dealSummary","keyMetrics","risks"]}

Supported sections: dealSummary, keyMetrics, strengths, risks, areaInsights, nextSteps, and assumptions.

Response reference

Successful operations return HTTP 200 and JSON. Every success includes ok: true, requestId, creditCost: 1, and creditsRemaining. The request ID is also returned in the X-Request-Id header. A successful replay additionally includes replayed: true.

Example: rent-estimate response

{
  "ok": true,
  "requestId": "server-generated-request-id",
  "property": {
    "matchedAddress": "123 Main St, Austin, TX 78701",
    "beds": 3,
    "baths": 2,
    "sqft": 1500,
    "price": 350000
  },
  "rentEstimate": {
    "monthly": 2400,
    "low": 2200,
    "high": 2600,
    "confidence": "medium",
    "comparableSignals": 4
  },
  "sources": {
    "propertyData": "Property data source",
    "rentEstimate": "Rent estimate source"
  },
  "warnings": [],
  "generatedAt": "2026-10-06T18:00:00.000Z",
  "creditCost": 1,
  "creditsRemaining": 24
}

Numeric property details and estimate bounds can be null when a source does not provide them; matchedAddress is a string. Each warning is an object with a code and readable message. The API returns normalized fields, not raw provider records or comparable listings.

Underwriting metrics

underwrite, report, and analyze include a metrics object calculated from the normalized inputs. All money amounts are USD.

Metrics that cannot be calculated because their denominator is zero are null. In the normalized inputs response, useLoan is represented as "1" or "0".

AI report sections

analysis contains only the requested supported keys. dealSummary and assumptions are strings; keyMetrics is an array of { "label": string, "value": string } objects; strengths, risks, areaInsights, and nextSteps are arrays of strings.

Retries, errors, and limits

Errors returned by the RentMax AI API are JSON with ok: false, a readable error, stable machine-readable code, and requestId. Some validation errors also include detail.fields. A deployment-protection response can come from Vercel before the API runs and may use a different response body.

{"ok":false,"error":"A valid RentMax AI API key is required.","code":"INVALID_API_KEY","requestId":"server-generated-request-id"}

Make retries safe

Send a unique Idempotency-Key with 8–128 letters, numbers, dots, colons, underscores, or hyphens. The header is optional, but if you omit it the server generates a random key that you may not know after a network timeout. For requests that reach credit reservation, the Idempotency-Key response header echoes the supplied or generated key. Retry an uncertain request with the same operation, exact same body, and same key. A completed retry returns the saved result with replayed: true and does not charge again. Reusing a key with a different request returns 409 IDEMPOTENCY_CONFLICT. If the first request is still running, the API returns 409 IDEMPOTENCY_IN_PROGRESS and Retry-After: 5; wait, then retry with the same key. A previously failed request returns 409 IDEMPOTENCY_FAILED; after checking its request ID and credit status, start a new attempt with a new key.

HTTP status guide

Reports are informational, not financial, legal, or tax advice. Verify property records and market assumptions independently.