Housing Data API

The Housing Data API provides read-only access to Range Lab’s curated housing dataset. Use it to display rental and affordable-housing inventory inside your own product or workflow.

• Authenticated per-request with an API key issued by Range Lab.
• Results are scoped to the regions granted to your key.
• Rate limited per minute; see your key’s configured limit.

https://basecamp.rangelab.io

Send the API key on every request in the x-api-key header.

Each endpoint requires one of the partner scopes:

• properties:read — rental property endpoints (/api/v1/properties*, /api/v1/metadata/*, and the rentals partner exports).
• sales:read — for-sale endpoints (/api/v1/sales* and the sales partner exports).
• housing-resources:read — community housing resources (/api/v1/housing-resources* and the matching partner exports). Read-only projection of the shared resources table.

Scopes are independent — a key can hold any combination, and an admin can grant additional scopes to an existing key without forcing a reissue. Contact partners@rangelab.io to add a scope to a key you already have.

curl -H "x-api-key: rl_live_..." \
  https://basecamp.rangelab.io/api/v1/auth/whoami

Keys are shown exactly once at issuance. Store them in a secret manager; never commit them to source control.

curl -G "https://basecamp.rangelab.io/api/v1/properties" \
  -H "x-api-key: rl_live_..." \
  --data-urlencode "city=Medford" \
  --data-urlencode "state=OR" \
  --data-urlencode "limit=20"

const res = await fetch(
  "https://basecamp.rangelab.io/api/v1/properties?city=Medford&state=OR&limit=20",
  { headers: { "x-api-key": process.env.RANGE_LAB_API_KEY } }
);
const { data, meta } = await res.json();

{
  "data": [
    {
      "id": "uuid",
      "property_name": "Example Apartments",
      "city": "Medford",
      "state": "OR",
      "price": 1450,
      "beds": 2,
      "baths": 1,
      "availability": "available",
      "images": [],
      "detail_url": ""
    }
  ],
  "meta": {
    "total": 120,
    "limit": 20,
    "offset": 0
  }
}

Each key has a per-minute quota (default 60). When exceeded, the response is 429 with a Retry-After header indicating seconds to wait.

Append ?format=csv to any list endpoint to receive a streaming CSV download instead of JSON. CSV requests may use a higher limit (up to 50,000) and return a Content-Disposition: attachment header so browsers prompt a save.

• Supported on the rentals JSON endpoints (/properties, /properties/changes, /properties/search, /properties/nearby, /properties/:id/similar, /metadata/cities), the sales endpoints (/sales, /sales/changes), and the housing-resources endpoints (/housing-resources, /housing-resources/changes).
• Same x-api-key auth, same rate limit, same region scoping as JSON.
• Optional fields=full swaps in an extended column set (description, images, structured fields). Default is a leaner core column set suited for ETL pipelines.
• For full-dataset sync, prefer the /changes variant of each endpoint with updated_since over repeating a full snapshot.
• CSV exports route through the streaming paged iterator, so the per-request row cap is 50,000 rather than the PostgREST default of 1,000.

curl -G "https://basecamp.rangelab.io/api/v1/properties?format=csv&limit=10000" \
  -H "x-api-key: rl_live_..." \
  -o rangelab-properties.csv

The Housing Data API is currently in limited partner preview. To request a key, email partners@rangelab.io with your organization name, intended use, and the regions you need to cover.