Skip to main content
POST
/
v1
/
listings
/
search
POST /v1/listings/search
curl --request POST \
  --url https://api.example.com/v1/listings/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "minPrice": 123,
  "maxPrice": 123,
  "minBeds": 123,
  "maxBeds": 123,
  "minBaths": 123,
  "maxBaths": 123,
  "minSqFt": 123,
  "maxSqFt": 123,
  "propertyType": "<string>",
  "hasPool": true,
  "isWaterfront": true,
  "hasGarage": true,
  "semanticQuery": "<string>",
  "mode": "<string>",
  "limit": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.aris247.com/llms.txt

Use this file to discover all available pages before exploring further.

Search MLS property listings. Routes automatically to IDX Broker or the brokerage’s custom database based on their integration type.

​
Request

curl -X POST \
  "https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/listings/search" \
  -H "Content-Type: application/json" \
  -H "X-ARIS-API-Key: aris_yourkey" \
  -d '{
    "city": "Austin",
    "state": "TX",
    "maxPrice": 500000,
    "minBeds": 3,
    "mode": "hybrid",
    "semanticQuery": "modern home with updated kitchen",
    "limit": 12
  }'

​
Body parameters

​
city
string
City name.
​
state
string
Two-letter state code.
​
zip
string
ZIP code.
​
minPrice
number
Minimum listing price.
​
maxPrice
number
Maximum listing price.
​
minBeds
integer
Minimum bedrooms.
​
maxBeds
integer
Maximum bedrooms.
​
minBaths
number
Minimum bathrooms.
​
maxBaths
number
Maximum bathrooms.
​
minSqFt
integer
Minimum square footage.
​
maxSqFt
integer
Maximum square footage.
​
propertyType
string
"Single Family", "Condo", "Townhouse", etc.
​
hasPool
boolean
Filter for homes with a pool.
​
isWaterfront
boolean
Filter for waterfront properties.
​
hasGarage
boolean
Filter for homes with a garage.
​
semanticQuery
string
Natural language query for ranking.
​
mode
string
default:"hybrid"
Search mode: structured_only, keyword, semantic, or hybrid.
​
limit
integer
default:"12"
Max results (max 24).

​
Search modes

ModeDescription
structured_onlyOnly hard filters, no ranking
keywordFull-text search boost on top of filters
semanticVector similarity ranking
hybridCombines keyword and semantic ranking (recommended)

​
Response

{
  "listings": [
    {
      "listingId": "a12345",
      "address": "123 Main St, Austin, TX 78701",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "price": "450000",
      "beds": 3,
      "baths": 2,
      "sqft": "1850",
      "photos": ["https://..."],
      "daysOnMarket": 14,
      "description": "Beautiful 3-bed home with updated kitchen...",
      "status": "Active",
      "detailsUrl": "https://...",
      "videoUrls": [{"url": "https://...", "title": "Virtual Tour"}]
    }
  ],
  "total": 47,
  "returned": 12,
  "searchCriteria": {"city": "Austin", "maxPrice": 500000, "minBeds": 3}
}