Skip to article

Search

Search listings from your approved feed with a full set of filters. Results are paginated and ordered by list date descending by default.

Endpoint

GET /api/v1/search

Query parameters

ParameterTypeRequiredDescription
locationstringNoCity name, ZIP code, neighborhood, or address keyword
max_pricenumberNoMaximum list price in USD
min_pricenumberNoMinimum list price in USD
min_bedsnumberNoMinimum number of bedrooms
max_bedsnumberNoMaximum number of bedrooms
min_bathsnumberNoMinimum number of bathrooms
statusstringNoactive, pending, sold, expired or withdrawn. Default: active. Display availability follows the approved feed.
property_typestringNoA feed-supported property type, such as single, condo, multi or land
sortstringNonewest, oldest, price_asc, price_desc, sqft_asc, sqft_desc, beds_asc, beds_desc, baths_asc, baths_desc, year_asc, year_desc, dom_asc or dom_desc
pageintegerNoPage number from 1 to 10,000. Default: 1
per_pageintegerNoResults per page. Range: 1-50. Default: 20

Example request

Search listings
curl -H "Authorization: Bearer eai_YOUR_KEY" \
  -H "X-EAI-Site-ID: site_YOUR_SITE_ID" \
  "https://app.easyagentidx.com/api/v1/search" \
  -G \
  -d "location=La Jolla CA" \
  -d "max_price=3000000" \
  -d "status=active"
→ 200 OK { "data": [...listings], "meta": { "total": 94, "page": 1, "per_page": 20 } }

Response

Returns a paginated array of listing objects. See the Listings page for the full field reference.