API Documentation

Access your property intelligence data programmatically. The RealiQ REST API is available on the Enterprise plan.

Authentication

All API requests require an API key passed via the Authorization header. API keys can be created and managed from Settings > API Keys in your dashboard.

curl -H "Authorization: Bearer nc_live_abc123..." \
  https://www.realiq.uk
/api/v1/properties

API keys start with nc_ and are hashed with SHA-256 before storage. Keep your keys secret.

Rate Limiting

Each API key is limited to 1,000 requests per day. When exceeded, the API returns a 429 Too Many Requests response. Rate limit counters reset at midnight UTC.

Response Format

All responses use a standard JSON envelope.

Success (list)

{
  "data": [ ... ],
  "meta": {
    "count": 50,
    "has_more": true,
    "cursor": "eyJpZCI6IjUwIn0"
  }
}

Success (single)

{
  "data": { ... }
}

Error

{
  "error": {
    "message": "Invalid API key",
    "code": "UNAUTHORIZED"
  }
}

Pagination

List endpoints support cursor-based pagination. Pass cursor and optional limit (default 50, max 100).

GET /api/v1/properties?limit=25&cursor=eyJpZCI6IjI1In0

Endpoints

GET/api/v1/properties

List properties with optional filters.

Query Parameters

Parameter	Type	Description
sector	string	Filter by sector (e.g. Office, Industrial, Retail)
city	string	Filter by city name
postcode	string	Filter by postcode prefix
min_price	number	Minimum asking price
max_price	number	Maximum asking price

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/properties?sector=Industrial&limit=10"

Example Response

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "name": "Apex Business Park",
      "address": "Unit 5, Apex Park, Leeds LS11 5QA",
      "sector": "Industrial",
      "asking_price": 4250000,
      "niy": 6.85,
      "total_rent": 291125,
      "number_of_tenants": 3,
      "wault": 5.2,
      "created_at": "2026-02-10T14:30:00Z"
    }
  ],
  "meta": { "count": 1, "has_more": false, "cursor": null }
}

GET/api/v1/properties/:id

Get a single property with its tenancy schedule.

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/properties/a1b2c3d4-..."

GET/api/v1/matches

List investor-property matches with scores and AI commentary.

Query Parameters

Parameter	Type	Description
status	string	Filter by status: new, reviewed, contacted, passed
min_score	number	Minimum match score (0-100)
investor_id	uuid	Filter matches for a specific investor

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/matches?min_score=90&status=new"

GET/api/v1/comparables

List comparable transactions from your evidence database.

Query Parameters

Parameter	Type	Description
sector	string	Filter by sector
city	string	Filter by city
start_date	date	Transaction date from (YYYY-MM-DD)
end_date	date	Transaction date to (YYYY-MM-DD)

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/comparables?sector=Office&city=Manchester"

GET/api/v1/investors

List investors with their acquisition profiles.

Query Parameters

Parameter	Type	Description
name	string	Search by investor name
type	string	Filter by investor type

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/investors?type=fund"

GET/api/v1/investors/:id

Get a single investor with all their acquisition requirements.

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/investors/e5f6g7h8-..."

GET/api/v1/tenancies

List tenancies across all properties.

Query Parameters

Parameter	Type	Description
property_id	uuid	Filter tenancies for a specific property
tenant_name	string	Search by tenant name

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/tenancies?tenant_name=Amazon"

GET/api/v1/stats

Get portfolio overview statistics.

curl -H "Authorization: Bearer nc_live_abc123..." \
  "https://www.realiq.uk
/api/v1/stats"

Example Response

{
  "data": {
    "properties_count": 188,
    "total_value": 1510000000,
    "total_rent": 104100000,
    "investors_count": 109,
    "matches_count": 12120,
    "comparables_count": 923,
    "sector_breakdown": {
      "Industrial": 72,
      "Office": 48,
      "Retail": 35,
      "Mixed Use": 18,
      "Other": 15
    }
  }
}

POST/api/v1/extract

Upload a document for AI extraction. Requires a key with write scope. Accepts PDF, DOCX, and XLSX files via multipart/form-data.

curl -X POST \
  -H "Authorization: Bearer nc_live_abc123..." \
  -F "file=@brochure.pdf" \
  https://www.realiq.uk
/api/v1/extract

Example Response

{
  "data": {
    "extraction_id": "f1a2b3c4-...",
    "property": {
      "name": "Phoenix House",
      "address": "45 High Street, Birmingham B2 4LP",
      "sector": "Office",
      "asking_price": 3750000,
      "niy": 7.2
    },
    "tenancies_count": 4,
    "comparables_count": 2,
    "validation": {
      "score": 87,
      "status": "passed"
    }
  }
}