Usage examples

All examples use the placeholder variables REMATES_API_URL and REMATES_API_KEY. Substitute your deployment URL and a real key from the customer portal before running.

Full reference: Swagger UI · ReDoc · raw schema.

cURL

curl -sS \
  -H "X-API-Key: ${REMATES_API_KEY}" \
  "${REMATES_API_URL}/api/v1/properties/"

Python

import os
import requests

response = requests.get(
    f"{os.environ['REMATES_API_URL']}/api/v1/properties/",
    headers={"X-API-Key": os.environ["REMATES_API_KEY"]},
    timeout=10,
)
response.raise_for_status()
print(response.json())

JavaScript (browser or Deno)

const url = `${process.env.REMATES_API_URL}/api/v1/properties/`;
const response = await fetch(url, {
  headers: { "X-API-Key": process.env.REMATES_API_KEY },
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}`);
}
console.log(await response.json());

Quota handling

Calendar-month quotas return HTTP 429 when exhausted. Inspect Retry-After and back off until the monthly window resets. The portal exposes per-client usage so customers can plan ahead.

← Back to overview