Introduction

Zynplex — Developer Reference

A read-only REST API over Canadian MLS® listings sourced from CREA DDF®. These docs are the single source of truth for everything a client needs to build against the API: endpoints, params, response shapes, errors, and integration constraints.

If you’re building a frontend with Claude, paste this page (or the full /v1/openapi.json spec) into your project context. Every shape here matches the live spec.

Base URL

https://api.zynplex.ca

All endpoints are JSON. No path-level version is currently exposed — breaking changes will appear under /v2/… if/when they happen. The OpenAPI document is at /v1/openapi.json.

What’s in these docs

  • Quickstart — your first authenticated request in 60 seconds.
  • Concepts — authentication, mandatory attribution, pagination & sorting, error responses, rate limits.
  • Endpoints — full reference for every public route: listings, single listing detail, history, media, aggregates, location autocomplete, members, offices, and open houses.
  • Client examples — copy-pasteable TypeScript / curl / Python snippets for the patterns you’ll actually use.
  • Filtering recipes — “show me listings within 5 km of the user”, “all listings by a team of agents”, “polygon-bound map search”, etc.

Need help?

  • Email hello@zynplex.ca — < 24h business-day reply.
  • Subscription / billing questions: open the customer portal.
  • Production status, planned maintenance, or recent incidents: subscribe to status updates via the portal Dashboard.
Quickstart