Skip to main content
POST
/
v1
/
listings
/
search
Search MLS property listings
curl --request POST \
  --url https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router/v1/listings/search \
  --header 'Content-Type: application/json' \
  --header 'X-ARIS-API-Key: <api-key>' \
  --data '
{
  "brokerageId": "550e8400-e29b-41d4-a716-446655440000",
  "city": "Austin",
  "state": "TX",
  "maxPrice": 500000,
  "minBeds": 3,
  "mode": "hybrid",
  "semanticQuery": "modern home with updated kitchen",
  "limit": 12
}
'
{
  "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": [
        "<string>"
      ],
      "daysOnMarket": 14,
      "description": "<string>",
      "status": "Active",
      "detailsUrl": "<string>",
      "videoUrls": [
        {
          "url": "<string>",
          "title": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "returned": 123,
  "searchCriteria": {},
  "message": "<string>"
}

Authorizations

​
X-ARIS-API-Key
string
header
required

Body

application/json
​
brokerageId
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
city
string
Example:

"Austin"

​
state
string
Example:

"TX"

​
zip
string
Example:

"78701"

​
minPrice
number
Example:

200000

​
maxPrice
number
Example:

500000

​
minBeds
integer
Example:

3

​
maxBeds
integer
Example:

5

​
minBaths
number
Example:

2

​
maxBaths
number
​
minSqFt
integer
Example:

1500

​
maxSqFt
integer
​
propertyType
string
Example:

"Single Family"

​
statuses
string[]
Example:
["Active", "Coming Soon"]
​
hasPool
boolean
​
isWaterfront
boolean
​
hasGarage
boolean
​
minYearBuilt
integer
Example:

2000

​
maxDaysOnMarket
integer
Example:

30

​
semanticQuery
string

Natural language query for semantic/hybrid ranking.

Example:

"modern open floor plan with updated kitchen"

​
keywords_must
string[]

Terms that must appear in the listing description.

Example:
["pool", "granite"]
​
keywords_not
string[]

Terms to exclude from results.

Example:
["fixer upper"]
​
mode
enum<string>
default:hybrid
Available options:
structured_only,
keyword,
semantic,
hybrid
​
limit
integer
default:12
Required range: x <= 24
Example:

12

Response

Listing search results.

​
listings
object[]
​
total
integer

Total number of listings matching the criteria.

​
returned
integer

Number of listings in this response (may be less than total due to limit).

​
searchCriteria
object

Echo of the search parameters that were applied.

​
message
string | null

Optional message explaining empty results or fallback behavior.