Developer Platform API
Build a custom real estate website or application with approved MLS data. Use your own interface and user accounts, add EasyAgentIDX platform resources as needed, or combine API calls with ready-made widgets on the same approved website.
Warning
API keys are server-side secrets. Never place a key in browser JavaScript, a mobile application bundle, a public repository, or an AI prompt. Use a server component, route handler, or backend service.Availability
Developer Platform access begins on Pro after the website is verified and its MLS approval is active. The response from /platform/capabilities is the runtime source of truth for the account, website, scopes, plan features, and active add-ons.
Base URL
https://app.easyagentidx.com/api/v1
First request
Every request requires the API key and the public site identifier shown once the key is created. Keys are bound to one verified website and one active MLS feed.
curl https://app.easyagentidx.com/api/v1/platform/capabilities \ -H "Authorization: Bearer $EASYAGENTIDX_API_KEY" \ -H "X-EAI-Site-ID: $EASYAGENTIDX_SITE_ID"
What you can build
| Resource group | Platform access |
|---|---|
| Platform | Capabilities, approved site, widgets, visitors, saved searches, saved listings, analytics, team, agency clients, and HomeThread collections |
| IDX | Property search, listing detail, nearby places, and location typeahead |
| Leads | Create, list, read, update, and delete leads |
| Home Valuations | Address search, property data, AVM estimates, valuation history, and credit usage when the add-on is active |
| Events | Signed webhooks for lead, valuation, visitor, saved search, and API widget activity |
Plan-aware capabilities
- Pro: one approved website, full IDX API, leads, widgets, analytics and webhooks. HomeThread resources follow at its separate app launch.
- Brokerage: multi-site access plus team and agent resources with higher per-site limits.
- Agency Partner: client workspace visibility and client-specific credentials in addition to Brokerage capabilities.
- Enterprise: standard organization and team resources with the highest published limit and custom arrangements when required. Agency resale operations are not inherited.
- Home Valuations: valuation endpoints are available only when the selected website has an active add-on and remaining credits.
Stable contract
Public fields use an EasyAgentIDX-owned, snake case schema. Provider credentials, internal identifiers, billing records, employee administration, and raw upstream payloads are never returned. Breaking changes require a new URL version.
Response and traffic headers
Responses use a data envelope with an optional meta object. Authenticated responses include RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset. A 429 response also includes Retry-After.
Machine-readable contract
Download the current OpenAPI 3.1 document for client generation, API exploration, and AI-assisted development. Example values never contain a real customer key.