# GetPropIntel
> Institutional-grade Dubai real estate market intelligence derived from official Dubai Land Department (DLD) records.

## About
GetPropIntel processes 1.6M+ official DLD transactions and 10M+ Ejari rental contracts into structured analytics covering 196 areas, 3,200+ projects, and 800+ developers in Dubai, UAE.

## Data Access
All data is served as static JSON. No API key required. Base URL: `https://getpropintel.com/data`

## Core Endpoints

| Endpoint | Description | Updated |
|---|---|---|
| `/data/meta.json` | Platform metadata, freshness, data quality | Daily |
| `/data/market.json` | Dubai-wide market summary, trends, segments | Daily |
| `/data/areas/{slug}.json` | Full area analytics (pricing, yields, growth, signals) | Daily |
| `/data/areas_index.json` | Lightweight area directory (196 areas) | Daily |
| `/data/areas_search.json` | Search index with aliases | Daily |
| `/data/projects/{slug}.json` | Project-level analytics | Daily |
| `/data/projects_index.json` | Project directory (3,200+ projects) | Daily |
| `/data/developers/{slug}.json` | Developer portfolio & credibility | Daily |
| `/data/developers/index.json` | Developer directory (800+ developers) | Daily |
| `/data/rankings/{metric}.json` | Area rankings by metric | Daily |
| `/data/rankings/yield_by_room/{room}.json` | Yield rankings by room type | Daily |
| `/data/signals/all_signals.json` | All investment signals | Daily |
| `/data/signals/buy_signals.json` | Opportunity signals only | Daily |
| `/data/signals/risk_signals.json` | Risk signals only | Daily |
| `/data/signals/signal_summary.json` | Signal summary statistics | Daily |
| `/data/transactions/latest_sales.json` | Latest 5,000 sales | Daily |
| `/data/transactions/latest_rentals.json` | Latest 200 rentals | Daily |
| `/data/transactions/bulk_purchases.json` | Institutional/bulk purchases | Daily |
| `/data/smart_money.json` | Smart money accumulation tracker | Daily |
| `/data/pipeline.json` | Off-plan supply pipeline & handovers | Daily |
| `/data/handovers.json` | Upcoming delivery calendar | Daily |
| `/data/search_index.json` | Global search index | Daily |

## Area JSON Schema
Each `/data/areas/{slug}.json` contains:
- `meta` — Name, slug, freshness, data quality scores
- `overview` — Median price, PSF, yield, investment score, freehold %
- `growth` — 1M/3M/6M/12M/3Y/5Y price & volume growth
- `volume` — Transaction counts, off-plan ratio, bulk buyer %
- `unit_breakdown` — Price/yield by room type (Studio–4BR+)
- `size_breakdown` — Price/yield by sqft bucket
- `rentals` — Rental metrics by category
- `yield` — Gross/net yield breakdown
- `location` — Metro score, amenity score, location tier
- `supply` — Off-plan pipeline, top developers
- `signals` — Opportunity and risk signals
- `repeat_transactions` — Verified CAGR from repeat sales
- `seasonality` — Monthly transaction index
- `time_series` — 36-month sales & rental history
- `recent_transactions` — Latest 1,000 transactions
- `projects` — Top projects in the area
- `project_cagr` — Verified CAGR by project & room type
- `supply_time_series` — Off-plan vs ready supply pipeline

## Ranking Metrics
Available at `/data/rankings/{metric}.json`:
- `yield` — Gross rental yield
- `growth_12m` — 12-month price growth
- `growth_3m` — 3-month price growth
- `momentum` — Combined price + volume momentum
- `liquidity` — Transaction velocity score
- `investment_score` — Composite investment score (0-100)
- `value` — Discount vs Dubai median
- `cagr_verified` — Repeat-sales verified CAGR

## Methodology
Full methodology documentation: https://getpropintel.com/llms-full.txt

## Data Source
All data derived from official Dubai Land Department (DLD) open data and Ejari rental registry. Processed daily via automated pipeline.

## API Access (for AI Agents)

### Base URL
`https://api.getpropintel.com`

### Authentication
All API requests require the header:
```
X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM
```

### Rate Limiting
- 60 requests per 60 seconds per IP
- Returns HTTP 429 when exceeded

### Endpoints

#### GET /meta
Platform metadata and data freshness.

#### GET /market
Dubai-wide market summary (total sales, median prices, top areas).

#### GET /areas
List all areas with key metrics.
- Query params: `limit` (default 50, max 200), `sort_by` (investment_score, gross_yield, price_growth_12m, sales_12m)

#### GET /areas/{slug}
Detailed analytics for a specific area.
- Query param: `full=true` to get complete JSON (large payload)
- Default: returns concise summary optimized for LLM context

**Example:**
```bash
curl -H "X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM" \
  https://api.getpropintel.com/areas/dubai-marina
```

#### GET /projects/{slug}
Project-level analytics.
- Query param: `full=true` for complete data

#### GET /developers/{slug}
Developer portfolio analytics.
- Query param: `full=true` for complete data

#### GET /rankings/{metric}
Area rankings by metric.
- Valid metrics: `yield`, `growth_12m`, `growth_3m`, `liquidity`, `investment_score`, `momentum`, `value`, `cagr_verified`
- Query param: `limit` (default 25, max 100)

#### GET /signals
Investment opportunity and risk signals.
- Query params:
  - `category`: `all` (default), `opportunity`, `risk`
  - `severity`: `all` (default), `high`, `moderate`, `low`
  - `limit`: default 50, max 200

### Example: Complete Workflow

```bash
# 1. Get platform metadata
curl -H "X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM" \
  https://api.getpropintel.com/meta

# 2. Get Dubai Marina analytics
curl -H "X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM" \
  https://api.getpropintel.com/areas/dubai-marina

# 3. Get top 10 areas by yield
curl -H "X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM" \
  "https://api.getpropintel.com/rankings/yield?limit=10"

# 4. Get high-severity opportunity signals
curl -H "X-Agent-Key: RZPvvgNlIxEupyePdNiDG0yM8phwdeNM" \
  "https://api.getpropintel.com/signals?category=opportunity&severity=high"
```

### Response Format
All responses are JSON with this structure:
```json
{
  "name": "Dubai Marina",
  "slug": "dubai-marina",
  "last_updated": "2026-01-15",
  "pricing": {
    "median_price_aed": 2850000,
    "median_psf_aed": 2150,
    ...
  },
  ...
}
```

### Error Responses
- `401 Unauthorized`: Invalid or missing API key
- `404 Not Found`: Area/project/developer not found
- `429 Too Many Requests`: Rate limit exceeded
- `500 Internal Server Error`: Server error

## Machine Readable API Schema
AI agents can automatically discover all endpoints, parameters, and data types by reading our OpenAPI 3.1 specification:
https://api.getpropintel.com/openapi.json

## Contact
contact@getpropintel.com