Developer API

Read your portfolio data programmatically

A REST API over the same data your dashboard uses — properties, units, leases, invoices, and more — authenticated with a scoped, read-only API key.

Getting started

Sign in to your dashboard

API access is scoped to your company account. Sign in, or enroll your company if you're new.

Generate a read-only API key

From Dashboard → Integrations → API Keys, create a key. Keys authenticate with an "Authorization: Api-Key <key>" header — a separate scheme from the JWT session your dashboard uses, and deliberately read-only.

Explore the interactive docs

The full OpenAPI schema and Swagger UI live at /api/docs, generated directly from the live API — kept behind authentication since it enumerates every endpoint and field on the platform.

API principles

Read-only by design

API keys can retrieve data, not mutate it — creating, updating, or deleting a record still requires an authenticated session in the app itself.

Rate limited where it matters

Sensitive and third-party-backed endpoints (payment initiation, subscription activation, public token-based flows like lease e-signing) carry explicit hourly rate limits, not just a blanket default.

One schema, always current

Documentation is generated from the live Django REST Framework views via drf-spectacular — it can't drift out of sync with what the API actually does.

Example request

curl https://app.aperyx.io/api/v1/properties/list/ \
  -H "Authorization: Api-Key YOUR_API_KEY"

Full interactive documentation, with every endpoint and field, is available at /api/docs once you're signed in.