API Reference

CRE data.
Finally programmable.

420+ REST endpoints. Webhooks. TypeScript and Python SDKs. A schema that maps to real CRE concepts — not generic tables. Build integrations your team will actually maintain.

import { HqO } from '@hqo/sdk';

const hqo = new HqO({
  apiKey: process.env.HQO_API_KEY,
  region: 'us-east-1',
});

// Fetch all active leases expiring in 12 months
const expiringLeases = await hqo.leases.list({
  status: 'active',
  expiresWithin: '12m',
  expand: ['tenant', 'building', 'health_score'],
});

// Subscribe to lease events
hqo.webhooks.on('lease.expiration_approaching', async (event) => {
  const { lease, daysUntilExpiry, tenant } = event.data;
  await triggerRenewalWorkflow(lease.uuid, tenant);
});

Endpoints

420+ endpoints by domain.

GET/v1/buildings
GET/v1/buildings/:uuid
POST/v1/buildings
PATCH/v1/buildings/:uuid
GET/v1/buildings/:uuid/floors
GET/v1/buildings/:uuid/spaces
GET/v1/buildings/:uuid/leases
GET/v1/buildings/:uuid/metrics

Authentication

All API requests require a Bearer token. Tokens are scoped to organizations and carry permission masks down to individual object types.

Authorization: Bearer hqo_live_sk_...
API key scoping (read / write / admin)
JWT short-lived tokens via SSO
SAML 2.0 + OIDC supported
IP allowlisting

Rate Limits

Rate limits are applied per API key, per minute. Enterprise keys get dedicated capacity. Limits are communicated via standard response headers.

Developer1,000 req/min
Professional5,000 req/min
Enterprise50,000 req/min
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4876
X-RateLimit-Reset: 1709834521

Webhooks

Subscribe to any object lifecycle event. Deliveries are HMAC-signed. Failed deliveries are retried with exponential backoff up to 24 hours.

lease.created
lease.amended
lease.expiration_approaching
tenant.health_score_changed
work_order.created
work_order.completed
invoice.overdue
payment.received
visitor.checked_in
building.occupancy_updated

SDKs

Strongly typed. Zero boilerplate.

TypeScript SDK

v2.4.1

npm install @hqo/sdk
TypeScript1.2k GitHub stars

Python SDK

v2.3.0

pip install hqo-sdk
Python840 GitHub stars

OpenAPI Spec

v420.0

curl https://api.hqo.ai/openapi.json
OpenAPI 3.1

Ready to build?

Get an API key in 60 seconds. Full documentation, sandbox environment, and TypeScript SDK included.