API Reference

REST endpoints for the PropertyGenome platform. Authenticate with a key from your developer keys, then call the base URL below. See the developer platform for your plan's limits.

Base URL & auth

Base URL: https://app.propertygenome.ai

Every request must include an Authorization: Bearer <API key> header. The environment is selected by your key prefix: pg_test_ keys hit the sandbox (safe, never touches production data or billing), pg_live_ keys hit production. Sandbox is available on the Professional & Enterprise plans.

Rate limits & SLA

Plan	Rate limit	Daily quota	Uptime SLA	Support	Sandbox
Standard	60/min	5,000/day	99.5%	48h	—
Professional	300/min	25,000/day	99.9%	24h	✓
Enterprise	1,200/min	250,000/day	99.99%	4h	✓

A 429 Too Many Requests is returned when the per-minute limit is exceeded; the Retry-After header gives the wait in seconds. Daily quota resets at 00:00 UTC.

POST /api/v2/property-aura POST /api/realtime-score POST /api/cashflow GET /api/enterprise/forecast

POST/api/v2/property-aura

PropertyAura Intelligence

Return the portable PropertyAura model for web, mobile, or server clients: score-driven energy-field color, 27 signal channels, seven families, coverage, planning ring, and rendering parameters.

Available on: enterprise

Parameters

Name	In	Type	Required	Description
Authorization	header	string	required	Bearer <Enterprise API key>
address	body	string	required	Full US property address.
property_type	body	string	optional	Property type or category.
year_built	body	number	optional	Property construction year.
planning	body	object	optional	Optional planning-intelligence context for the orbital ring.

Example request

curl -X POST "https://app.propertygenome.ai/api/v2/property-aura" \
  -H "Authorization: Bearer $PG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"123 Main St, Dallas, TX 75201"}'

Example response

{
  "api_version": "v2",
  "intelligence_area": "property_aura",
  "enterprise_feature": true,
  "supported_clients": ["web", "mobile", "server"],
  "address": "123 Main St, Dallas, TX 75201",
  "genome_score": 90,
  "energy_field": { "band": "high", "color": "green", "css_color": "hsl(120 72% 48%)" },
  "coverage": "hybrid",
  "property_aura": {
    "score": 90,
    "families": [],
    "channels": [],
    "core": { "radius": 1.24, "hue": 0.9, "brightness": 0.95 }
  }
}

POST/api/realtime-score

Genome Score

Return the 27-signal PropertyGenome score and signal breakdown for an address. White-label safe.

Available on: enterprise, lender, pro, brokerage

Parameters

Name	In	Type	Required	Description
Authorization	header	string	required	Bearer <API key>
address	body	string	required	Full street address.

Example request

curl -X POST "https://app.propertygenome.ai/api/realtime-score" \
  -H "Authorization: Bearer $PG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"123 Main St, Dallas, TX 75201"}'

Example response

{
  "address": "123 Main St, Dallas, TX 75201",
  "genomeScore": 78,
  "confidence": "high",
  "signals": { "flood_risk": 12, "market_momentum": 71, "condition_score": 80 }
}

POST/api/cashflow

Cash-Flow Projection

30-year DCF / IRR / NPV projection with a sensitivity grid for an investment scenario.

Available on: enterprise, pro

Parameters

Name	In	Type	Required	Description
Authorization	header	string	required	Bearer <API key>
purchasePrice	body	number	required	Purchase price in USD.
monthlyRent	body	number	required	Expected monthly rent in USD.
holdYears	body	number	optional	Hold period in years (default 10).

Example request

curl -X POST "https://app.propertygenome.ai/api/cashflow" \
  -H "Authorization: Bearer $PG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"123 Main St, Dallas, TX 75201"}'

Example response

{
  "projection": { "summary": { "irr": 0.1432, "npv": 84210, "cashOnCash": 0.071 } }
}

GET/api/enterprise/forecast

36-Month Forecast

Forward 36-month value + rent curve for an address, with an optional bear/base/bull scenario set. Enterprise tier.

Available on: enterprise

Parameters

Name	In	Type	Required	Description
Authorization	header	string	required	Bearer <API key>
address	query	string	required	Full street address.
sqft	query	number	optional	Living area in sq ft (default 1500).
scenarios	query	boolean	optional	Include bear/base/bull scenarios (default false).

Example request

curl "https://app.propertygenome.ai/api/enterprise/forecast?address=123+Main+St" \
  -H "Authorization: Bearer $PG_API_KEY"

Example response

{
  "forecast": {
    "address": "123 Main St, Dallas, TX 75201",
    "currentValue": 512000,
    "currentRent": 3200,
    "months": [ { "month": 1, "value": 513600, "rent": 3208, "valueChange": 0.31, "rentChange": 0.22 } ]
  }
}