# Rentiful Open Data v2

Public dataset of global build-to-rent operators, buildings, units, and listings.
Currently weighted to UK and UAE; expanding.

This URL is the agent-facing entry point.

## Start here

- **Agent manual** → /llms.txt (public — auth, workflows, copy-paste examples)
- **OpenAPI spec** → /doc (public, JSON) | /swagger (public, interactive UI)
- **Full dataset (bulk)** → /v2/bundle, /rentiful.md (Bearer token required)

## Common queries (public, no auth)

| Goal | Endpoint |
|---|---|
| All UK operators | `GET /v2/operators?country=gb` |
| Top UK BTR operators | `GET /v2/operators?country=gb&tier=P0&sector=BTR` |
| Co-living anywhere | `GET /v2/operators?sector=CoLiving` |
| Search anything | `GET /v2/lookup?q=greystar` |
| One operator | `GET /v2/operators/{id}` |
| One building | `GET /v2/buildings/{id}` |
| Listing history | `GET /v2/units/{unitId}/listings/history` |

## Authentication

Per-entity reads are public. Bulk dataset endpoints and all writes require:

```
Authorization: Bearer <ROD_ADMIN_TOKEN>
```

## Health

`curl https://v2.rod.rentiful.ai/health`