API Reference

The Rentametrix API gives you programmatic access to your properties, market data, leasing metrics, and more. Use it to build custom integrations, automate reporting, or feed Rentametrix data into your own analytics pipelines.

Authentication

All API requests require authentication via a Bearer token in the Authorization header.

Obtaining an API Key

Go to Settings > API Keys in your Rentametrix workspace.
Click Generate New Key and give it a descriptive name.
Copy the key immediately — it will not be shown again.

Using the Key

Include the key as a Bearer token in every request:

curl -H "Authorization: Bearer rtmx_sk_your_api_key_here" \
  https://api.rentametrix.com/api/v1/properties

Base URL and Versioning

All endpoints are served from:

https://api.rentametrix.com/api/v1/

The API is versioned via the URL path. The current version is v1. When breaking changes are introduced, a new version will be released and the previous version will remain available for a deprecation period.

Rate Limits

Plan	Requests per Minute	Requests per Day
Starter	60	10,000
Professional	300	100,000
Enterprise	1,000	Unlimited

Rate limit headers are included in every response:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 297
X-RateLimit-Reset: 1700000000

If you exceed the limit, the API returns a 429 Too Many Requests response.

Quick Example

Request

curl -X GET "https://api.rentametrix.com/api/v1/properties?market=austin&limit=5" \
  -H "Authorization: Bearer rtmx_sk_your_api_key_here" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "prop_8xKz2mN",
      "name": "The Grand on Riverside",
      "market": "Austin, TX",
      "unitCount": 312,
      "avgEffectiveRent": 1485.00,
      "occupancy": 0.96,
      "leaseSeason": "2025-2026"
    },
    {
      "id": "prop_3vLq9wP",
      "name": "University Commons",
      "market": "Austin, TX",
      "unitCount": 248,
      "avgEffectiveRent": 1320.00,
      "occupancy": 0.93,
      "leaseSeason": "2025-2026"
    }
  ],
  "pagination": {
    "total": 47,
    "limit": 5,
    "offset": 0,
    "hasMore": true
  }
}

Error Responses

The API uses standard HTTP status codes. Errors include a JSON body with details:

{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "The 'market' parameter must be a valid market identifier.",
    "details": {
      "parameter": "market",
      "provided": "xyz_invalid"
    }
  }
}

Status Code	Meaning
200	Success
400	Bad request / invalid params
401	Missing or invalid auth token
403	Insufficient permissions
404	Resource not found
429	Rate limit exceeded
500	Internal server error

Endpoint Reference

Detailed documentation for each endpoint group is coming soon:

Properties — CRUD operations on properties, unit mixes, and amenities
Markets — Market definitions, comps, and competitive sets
Leases — Lease-level data, pacing, and occupancy metrics
Analytics — Pre-built analytics queries and custom report generation
Sync — Trigger and monitor data syncs with connected PMS integrations