Public API Documentation

Overview

The Connector API is a pull-based batch-sync surface. Designed for downstream apps (e.g. Datahouse, internal ETLs) that mirror REK's property data into their own store. REK serves the data; the caller owns the schedule.

Each property is returned in the same full-detail shape as the Research API's POST /research response, so consumer code can ingest payloads from either surface interchangeably.

Authentication

Same X-API-Key system as the Research API. Generate a dedicated key (e.g. named datahouse-sync) on the API Keys page and store the raw value in your secrets manager — it's shown once at creation.

curl https://dashboard.rek-partners.com/api/connector/properties \
  -H "X-API-Key: rek_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Base URL

All endpoint paths below are relative to this base URL.

Quick start

Three common call patterns:

1. Full sync (first run)

GET /properties?limit=50
X-API-Key: rek_live_…

No since param → returns every dashboard-visible property, paginated. Follow next_cursor until null.

2. Delta sync (subsequent runs)

GET /properties?since=2026-06-05T03:00:00Z&limit=50
X-API-Key: rek_live_…

Returns only properties where updated_at > since. Save the response's sync_timestamp as the next call's since value.

3. Refetch one property

GET /properties/{listing_id}
X-API-Key: rek_live_…

Refreshes a single record by its stable listing_id — no need to run a full sync.

GET /properties

Paginated full-detail list. Each item has the same shape as a Research API POST /research response (see Response fields below for the complete key reference).

Query parameters

Response (200 OK)

{
  "results": [
    { /* same shape as POST /research — see Response fields below */ }
  ],
  "next_cursor": "eyJ1IjoiMjAyNi0wNi0wNlQwMTowMDowMFoiLCJpIjozMjF9",
  "sync_timestamp": "2026-06-06T01:24:00.123456+00:00",
  "count": 50
}

Behavior

• next_cursor is null on the last page.
• sync_timestamp is REK's server clock at request time — save it and pass as the next call's since.
• Rows excluded automatically: external-API research stubs and inactive rows.
• Stable ordering on (updated_at ASC, id ASC); cursor encodes that tuple so resuming a sync never skips or duplicates a row.

GET /properties/{listing_id}

Refetch one property by its stable listing_id (NOT the internal numeric id). Returns the same full-detail shape as one entry from /properties.

Response (404 Not Found)

{ "detail": "Property not found" }

Returned when the listing_id is unknown, the row is inactive, or the row is an external-API research stub (those are hidden from this endpoint).

Recommended sync loop

import httpx, os

REK_BASE = "https://dashboard.rek-partners.com/api/connector"
HEADERS = {"X-API-Key": os.environ["REK_API_KEY"]}

def sync_once(last_sync_timestamp: str | None) -> str:
    """Pull every property updated since last_sync_timestamp, upsert
    locally, return the new sync timestamp to persist."""
    params = {"limit": 50}
    if last_sync_timestamp:
        params["since"] = last_sync_timestamp

    new_timestamp = None
    with httpx.Client(timeout=60.0, headers=HEADERS) as c:
        while True:
            r = c.get(f"{REK_BASE}/properties", params=params)
            r.raise_for_status()
            body = r.json()

            # Capture server time from the FIRST page only — using it
            # as next `since` means rows updated mid-pagination get
            # picked up on the next run.
            if new_timestamp is None:
                new_timestamp = body["sync_timestamp"]

            for prop in body["results"]:
                upsert_property(prop)  # your local DB write

            if not body["next_cursor"]:
                break
            # Drop `since` once paginating — cursor encodes our position.
            params = {"limit": 50, "cursor": body["next_cursor"]}

    return new_timestamp

Status codes

Response field reference

The Connector wraps a list of full property payloads in a small envelope. The envelope tells you how to paginate; each property payload matches the Research API shape one-for-one.

Envelope (top-level keys)

Per-property payload — top-level keys

public_records_summary — promoted fields