Listings
Build listing detail experiences from an EasyAgentIDX-owned, provider-independent schema. Listing endpoints require the listings:read scope.
Required headers
Authorization: Bearer eai_YOUR_KEY X-EAI-Site-ID: site_YOUR_SITE_ID
GET /api/v1/listings/:id
Return one listing from the active MLS feed bound to the API key. The response includes the listing and a similar array.
curl "https://app.easyagentidx.com/api/v1/listings/LISTING_ID" -H "Authorization: Bearer $EASYAGENTIDX_API_KEY" -H "X-EAI-Site-ID: $EASYAGENTIDX_SITE_ID"
Normalized listing fields
| Group | Fields |
|---|---|
| Identity | id, mls_number, mls_board_code, status |
| Address | address.street, city, state, zip, county, full |
| Price and facts | price, price_per_sqft, beds, baths, sqft, lot_size_sqft, year_built |
| Media | photos, hero_photo, virtual_tour_url |
| Attribution | agent, office, and the required compliance object |
| Location | latitude, longitude, subdivision, neighborhood_name, schools |
Warning
Render the completecompliance object and follow MLS compliance requirements. Do not infer attribution from provider-specific fields.GET /api/v1/listings/:id/nearby
Return nearby businesses and amenities from the configured nearby data integration. This endpoint does not return similar listings. The listing ID remains in the URL for page context, while coordinates are explicit query parameters.
| Parameter | Required | Description |
|---|---|---|
lat | Yes | Latitude from the listing response |
lng | Yes | Longitude from the listing response |
radius | No | Radius in meters from 100 to 40,000 |
categories | No | Comma-separated EasyAgentIDX nearby category IDs |
limit | No | Results per category. Default 5, maximum 10 |
curl "https://app.easyagentidx.com/api/v1/listings/LISTING_ID/nearby?lat=32.8328&lng=-117.2713&radius=1600&limit=5" -H "Authorization: Bearer $EASYAGENTIDX_API_KEY" -H "X-EAI-Site-ID: $EASYAGENTIDX_SITE_ID"
When the customer has not enabled the nearby integration, the endpoint returns an empty category list. Preserve the attribution object whenever results are displayed.