§ DOC / API REFERENCE

the api.

Programmatic access to property valuations, scenario modeling, and usage tracking. Three endpoints, JSON over HTTPS, bearer-token auth. Included with the Investor plan.

01 / QUICKSTART

Generate a key from your dashboard, then run a valuation against the live endpoint. Base URL is https://plaincomp.com/api.

curl -X POST https://plaincomp.com/api/valuation \
  -H "Authorization: Bearer plaincomp_live_..." \
  -H "Content-Type: application/json" \
  -d '{"address":"123 Main St, Phoenix, AZ 85001"}'

02 / ENDPOINTS

All endpoints accept and return JSON. Tap any row to jump to its reference.

POST /api/valuation →

Run a comparable-market-analysis valuation for a residential property.

METHOD
POST

POST /api/scenario →

Apply a natural-language scenario to an existing valuation and return a revised estimate.

METHOD
POST

GET /api/usage →

Check current usage and remaining quota for the active billing period.

METHOD
GET

03 / VALUATION

Run a comparable-market-analysis valuation for a residential property. Address is required; optional fields tighten the comp set.

REQUEST BODY

{
  "address": "123 Main St, Phoenix, AZ 85001",
  "beds": 3,
  "baths": 2,
  "sqft": 1800,
  "property_type": "Single Family"
}

RESPONSE

{
  "valuation": 425000,
  "low": 410000,
  "high": 440000,
  "confidence_grade": "A",
  "comp_count": 8,
  "narrative": "...",
  "comps": [ ... ]
}

04 / SCENARIO

Apply a natural-language scenario to an existing valuation and return a revised estimate with the adjustment broken out.

REQUEST BODY

{
  "question": "What if I added a pool?",
  "valuation": 425000,
  "address": "123 Main St, Phoenix, AZ 85001",
  "beds": 3,
  "baths": 2,
  "sqft": 1800
}

RESPONSE

{
  "revised_valuation": 445000,
  "adjustment": 20000,
  "adjustment_percent": 4.7,
  "explanation": "..."
}

05 / USAGE

Check current usage and remaining quota for the active billing period. No request body required.

RESPONSE

{
  "count": 12,
  "limit": "unlimited",
  "tier": "investor",
  "remaining": "unlimited",
  "authenticated": true
}

06 / AUTH + LIMITS

All requests require a bearer key. Limits apply per key, scoped to the active billing period.

A — AUTHENTICATION

Bearer-token, per-key

Pass your key in the Authorization header on every request. Generate and revoke keys at any time from the dashboard. API access is included with the Investor plan.

Authorization: Bearer YOUR_API_KEY

B — RATE LIMITS

Generous, per-key

Rate limits are applied per API key. The Investor plan includes generous request limits suitable for most production workloads. For higher-volume needs, contact api@plaincomp.com.

07 / ERRORS

Standard HTTP status codes. Error responses include a JSON body with a human-readable message.

400

Invalid request body or missing required fields

401

Missing or invalid API key

429

Rate limit or usage quota exceeded

500

Internal server error

502

Upstream data provider error

08 / GET STARTED

API access is included with the Investor plan. Generate and revoke keys at any time from your dashboard.

→ GENERATE API KEY SEE PRICING METHOD