Developer Platform

The APEX API

A production-grade RESTful API with scoped API keys, 47 webhook events, and complete documentation. Build custom integrations, portfolio dashboards, and automation workflows directly on top of your APEX data.

Get API accessView all integrations
47
Webhook events
REST
API architecture
HMAC
Payload signing
99.9%
API uptime SLA
Key capabilities

Everything you need to build on your portfolio.

REST API

Available now

A fully documented RESTful API over HTTPS. Scoped API keys allow you to issue separate credentials for read-only access, write access, or specific resource types. Rate limiting is applied per key with configurable limits on Professional and Enterprise plans. All responses use consistent JSON envelopes with pagination, filtering, and sorting built in.

  • Scoped API keys per integration
  • Configurable rate limits
  • Cursor-based pagination
  • Field-level filtering
  • Idempotency keys on mutations

Webhooks

47 events

Subscribe to any combination of the 47 webhook events that cover the full APEX lifecycle. Payloads are signed with HMAC-SHA256 so you can verify authenticity at your endpoint. Failed deliveries are retried with exponential back-off over 24 hours. A webhook event log with full payload history is available in the APEX dashboard.

  • HMAC-SHA256 payload signing
  • Exponential back-off retries
  • 24-hour delivery window
  • Full event log with replay
  • Per-endpoint secret rotation

Bulk Import

CSV & JSON

Import assets, tenancy records, financial transactions, and compliance data in bulk via CSV or structured JSON. Ideal for migrating from spreadsheets or syncing data from legacy property management systems. Import jobs run asynchronously and report validation errors per row, so partial imports never silently fail.

  • CSV and JSON formats supported
  • Async import jobs
  • Per-row validation errors
  • Dry-run mode
  • Duplicate detection
{ }

SDKs

Coming soon

Official TypeScript and Python SDKs are currently in development and will be released later in 2026. Both SDKs will provide fully typed request and response models, automatic pagination helpers, and built-in retry logic. In the meantime, the API is straightforward to consume with any HTTP client — our documentation includes examples in TypeScript, Python, and cURL.

  • TypeScript SDK (Q3 2026)
  • Python SDK (Q3 2026)
  • Typed request/response models
  • Pagination helpers
  • Retry logic built in
Example response

Clear, consistent, predictable responses.

Every APEX API resource follows a consistent JSON structure. Monetary values are returned as integers in pence — never floating point — to prevent rounding errors in financial calculations. Percentage values use basis points for the same reason.

All timestamps are in ISO 8601 format with UTC timezone. Pagination uses cursor tokens rather than page numbers, so results remain stable even as your data is updated between requests.

Pence-integer arithmetic — no float rounding
Basis points for yields and LTV
ISO 8601 timestamps (UTC)
Cursor-based pagination
Consistent error envelopes
GET /v1/assets/:id
GET /v1/assets/ast_8xKp3mQz7nR2

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "ast_8xKp3mQz7nR2",
  "object": "asset",
  "name": "14 Cavendish Court",
  "class": "residential",
  "sub_class": "btl_single",
  "status": "active",
  "address": {
    "line1": "14 Cavendish Court",
    "city": "Leeds",
    "county": "West Yorkshire",
    "postcode": "LS1 3DQ",
    "country": "GB"
  },
  "financials": {
    "acquisition_cost_p": 28500000,
    "current_valuation_p": 34200000,
    "gross_annual_rent_p": 1980000,
    "gross_yield_bps": 579,
    "net_yield_bps": 431,
    "outstanding_mortgage_p": 18200000,
    "ltv_bps": 5322
  },
  "tenancy": {
    "status": "let",
    "rent_frequency": "monthly",
    "rent_p": 165000,
    "lease_start": "2024-03-01",
    "lease_end": "2026-02-28",
    "next_rent_review": "2025-03-01",
    "arrears_p": 0
  },
  "compliance": {
    "epc_rating": "C",
    "epc_expiry": "2031-08-14",
    "gas_safety_expiry": "2025-11-03",
    "eicr_expiry": "2029-04-22",
    "overall_status": "compliant"
  },
  "created_at": "2024-01-15T09:32:47Z",
  "updated_at": "2025-03-28T14:18:02Z"
}
Webhook events

Stay in sync with 47 real-time events.

Every material change in APEX fires a webhook. From new asset creation and tenancy updates through to compliance certificate renewals and financial transactions — your systems can react in real time, not in batches.

Configure multiple webhook endpoints, with separate subscriptions per endpoint so you only receive the events each system actually needs. Per-endpoint secret rotation means a compromised endpoint never puts your other integrations at risk.

Assets
asset.createdasset.updatedasset.archivedasset.valuation_updated
Tenancy
tenancy.createdtenancy.updatedtenancy.expiredtenancy.arrears_flagged
Financials
transaction.postedinvoice.raisedinvoice.paidinvoice.overdue
Compliance
compliance.cert_expiringcompliance.cert_expiredcompliance.status_changed
Lending
application.dip_receivedapplication.offer_issuedapplication.completed
+ 32 more events across documents, users, and exchange listings
Use cases

What teams are building with the APEX API.

1

Portfolio dashboards

Asset managers and family offices build custom reporting dashboards that pull live data from APEX and present it alongside data from other systems — bank accounts, HMRC submissions, share portfolios — in a single internal view. The API's comprehensive financial fields and asset-level detail make it straightforward to replicate the APEX dashboard experience in your own BI tooling.

Power BI integration
Looker Studio connectors
Custom board-level reporting
2

Accounting automation

Finance teams use webhooks to trigger automated journal entries in their ERP systems the moment a transaction is posted in APEX. Rent received, invoices raised, and maintenance costs approved in APEX flow directly into the appropriate nominal codes — eliminating double-entry and the reconciliation overhead that comes with it.

Auto-posting to Sage 200
HMRC MTD submissions
Month-end close automation
3

Custom integrations

Property management firms connect APEX to their own bespoke tooling — maintenance systems, tenant portals, and CRM platforms — via the API. Tenancy changes in APEX trigger provisioning in the tenant portal. Compliance certificate updates sync to the property manager's scheduling system. The API handles the data layer so each tool does what it does best.

Tenant portal sync
Maintenance system bridge
CRM contact enrichment
Getting started

From zero to first API call in minutes.

1

Create an account

Sign up for APEX Capitals and complete the onboarding flow. API access is available on Professional and Enterprise plans, with sandbox access on all plans.

2

Generate an API key

Navigate to Settings → Developer → API Keys. Issue a scoped key with the minimum permissions your integration requires. Store it securely — it's only shown once.

3

Make your first request

Send a GET request to /v1/assets with your Bearer token. The response includes your full asset list with financials, tenancy, and compliance data.

4

Subscribe to webhooks

Register a webhook endpoint from the Developer dashboard. Choose the event types you need, set up your HMAC verification, and start receiving real-time events.

Developer access

Get API access

API access is included in all Professional and Enterprise plans. Sandbox credentials with full read/write access are available on all plans for development and testing.

Get API accessView all integrations