POST /v1/listings/search

POST

listings

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
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/v1/listings/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/listings/search"

payload = {
    "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
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

string

City name.

string

Two-letter state code.

string

ZIP code.

number

Minimum listing price.

number

Maximum listing price.

integer

Minimum bedrooms.

integer

Maximum bedrooms.

number

Minimum bathrooms.

number

Maximum bathrooms.

integer

Minimum square footage.

integer

Maximum square footage.

string

"Single Family", "Condo", "Townhouse", etc.

boolean

Filter for homes with a pool.

boolean

Filter for waterfront properties.

boolean

Filter for homes with a garage.

string

Natural language query for ranking.

string

default:"hybrid"

Search mode: structured_only, keyword, semantic, or hybrid.

integer

default:"12"

Max results (max 24).

Search modes

Mode	Description
`structured_only`	Only hard filters, no ranking
`keyword`	Full-text search boost on top of filters
`semantic`	Vector similarity ranking
`hybrid`	Combines 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}
}

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
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/v1/listings/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/listings/search"

payload = {
    "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
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Overview

Endpoints

POST /v1/listings/search

Request

Body parameters

Search modes

Response

​Request

​Body parameters

​Search modes

​Response

Request

Body parameters

Search modes

Response