/compass/listings/search
curl --request POST \
--url https://api.anysite.io/api/compass/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"listing_type": 2,
"sale_statuses": [
9
],
"property_types": [],
"min_price": 1,
"max_price": 1,
"min_beds": 1,
"max_beds": 1,
"min_baths": 1,
"min_sqft": 1,
"max_sqft": 1,
"min_year_built": 1,
"max_year_built": 1,
"max_hoa": 1,
"min_lot_size_acres": 1,
"max_lot_size_acres": 1
}
'import requests
url = "https://api.anysite.io/api/compass/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"listing_type": 2,
"sale_statuses": [9],
"property_types": [],
"min_price": 1,
"max_price": 1,
"min_beds": 1,
"max_beds": 1,
"min_baths": 1,
"min_sqft": 1,
"max_sqft": 1,
"min_year_built": 1,
"max_year_built": 1,
"max_hoa": 1,
"min_lot_size_acres": 1,
"max_lot_size_acres": 1
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
location: '<string>',
count: 2,
timeout: 300,
listing_type: 2,
sale_statuses: [9],
property_types: [],
min_price: 1,
max_price: 1,
min_beds: 1,
max_beds: 1,
min_baths: 1,
min_sqft: 1,
max_sqft: 1,
min_year_built: 1,
max_year_built: 1,
max_hoa: 1,
min_lot_size_acres: 1,
max_lot_size_acres: 1
})
};
fetch('https://api.anysite.io/api/compass/listings/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/compass/listings/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location' => '<string>',
'count' => 2,
'timeout' => 300,
'listing_type' => 2,
'sale_statuses' => [
9
],
'property_types' => [
],
'min_price' => 1,
'max_price' => 1,
'min_beds' => 1,
'max_beds' => 1,
'min_baths' => 1,
'min_sqft' => 1,
'max_sqft' => 1,
'min_year_built' => 1,
'max_year_built' => 1,
'max_hoa' => 1,
'min_lot_size_acres' => 1,
'max_lot_size_acres' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/compass/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/compass/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/compass/listings/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CompassListingCard",
"price": 123,
"price_label": "<string>",
"address": "<string>",
"region": "<string>",
"beds": 123,
"baths": 123,
"sqft": 123,
"lot_acres": 123,
"status_code": 123,
"badges": [],
"latitude": 123,
"longitude": 123,
"image": "<string>",
"images": [],
"page_link": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/compass
/compass/listings/search
Search Compass listings for sale or rent in a location. Returns listing cards with price, address, beds, baths, sqft, status, latitude/longitude, photos and the page_link for full details. Filter by property type, price, beds, baths, square feet, lot size, year built and HOA.
Price: 20 credits per 50 results
POST
/
api
/
compass
/
listings
/
search
/compass/listings/search
curl --request POST \
--url https://api.anysite.io/api/compass/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"listing_type": 2,
"sale_statuses": [
9
],
"property_types": [],
"min_price": 1,
"max_price": 1,
"min_beds": 1,
"max_beds": 1,
"min_baths": 1,
"min_sqft": 1,
"max_sqft": 1,
"min_year_built": 1,
"max_year_built": 1,
"max_hoa": 1,
"min_lot_size_acres": 1,
"max_lot_size_acres": 1
}
'import requests
url = "https://api.anysite.io/api/compass/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"listing_type": 2,
"sale_statuses": [9],
"property_types": [],
"min_price": 1,
"max_price": 1,
"min_beds": 1,
"max_beds": 1,
"min_baths": 1,
"min_sqft": 1,
"max_sqft": 1,
"min_year_built": 1,
"max_year_built": 1,
"max_hoa": 1,
"min_lot_size_acres": 1,
"max_lot_size_acres": 1
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
location: '<string>',
count: 2,
timeout: 300,
listing_type: 2,
sale_statuses: [9],
property_types: [],
min_price: 1,
max_price: 1,
min_beds: 1,
max_beds: 1,
min_baths: 1,
min_sqft: 1,
max_sqft: 1,
min_year_built: 1,
max_year_built: 1,
max_hoa: 1,
min_lot_size_acres: 1,
max_lot_size_acres: 1
})
};
fetch('https://api.anysite.io/api/compass/listings/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/compass/listings/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location' => '<string>',
'count' => 2,
'timeout' => 300,
'listing_type' => 2,
'sale_statuses' => [
9
],
'property_types' => [
],
'min_price' => 1,
'max_price' => 1,
'min_beds' => 1,
'max_beds' => 1,
'min_baths' => 1,
'min_sqft' => 1,
'max_sqft' => 1,
'min_year_built' => 1,
'max_year_built' => 1,
'max_hoa' => 1,
'min_lot_size_acres' => 1,
'max_lot_size_acres' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/compass/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/compass/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/compass/listings/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"listing_type\": 2,\n \"sale_statuses\": [\n 9\n ],\n \"property_types\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"min_beds\": 1,\n \"max_beds\": 1,\n \"min_baths\": 1,\n \"min_sqft\": 1,\n \"max_sqft\": 1,\n \"min_year_built\": 1,\n \"max_year_built\": 1,\n \"max_hoa\": 1,\n \"min_lot_size_acres\": 1,\n \"max_lot_size_acres\": 1\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CompassListingCard",
"price": 123,
"price_label": "<string>",
"address": "<string>",
"region": "<string>",
"beds": 123,
"baths": 123,
"sqft": 123,
"lot_acres": 123,
"status_code": 123,
"badges": [],
"latitude": 123,
"longitude": 123,
"image": "<string>",
"images": [],
"page_link": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
Minimum string length:
1Required range:
x >= 1Required range:
20 <= x <= 1500Available options:
2, 1 Available options:
9, 12, 7 Available options:
single_family, condo, co_op, townhouse, multi_family, land, mobile_manufactured Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Response
Successful Response
⌘I