/compass/listings
curl --request POST \
--url https://api.anysite.io/api/compass/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/compass/listings"
payload = {
"listing": "<string>",
"timeout": 300
}
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({listing: '<string>', timeout: 300})
};
fetch('https://api.anysite.io/api/compass/listings', 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",
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([
'listing' => '<string>',
'timeout' => 300
]),
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"
payload := strings.NewReader("{\n \"listing\": \"<string>\",\n \"timeout\": 300\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")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/compass/listings")
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 \"listing\": \"<string>\",\n \"timeout\": 300\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CompassListing",
"compass_property_id": "<string>",
"feed_listing_id": "<string>",
"listing_type": "<string>",
"status": "<string>",
"status_code": 123,
"mls_status": "<string>",
"price": 123,
"listed_price": 123,
"closed_price": 123,
"price_per_sqft": 123,
"hoa_fee": 123,
"monthly_charges_with_taxes": 123,
"down_payment_percent": 123,
"bedrooms": 123,
"full_bathrooms": 123,
"half_bathrooms": 123,
"total_bathrooms": 123,
"square_feet": 123,
"lot_size": 123,
"total_rooms": 123,
"legal_room_count": 123,
"year_built": 123,
"building_age": "<string>",
"parking_spaces": 123,
"property_type": "<string>",
"amenities": [],
"pretty_address": "<string>",
"street_number": "<string>",
"street": "<string>",
"street_type": "<string>",
"unit_number": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"county": "<string>",
"latitude": 123,
"longitude": 123,
"geo_id": "<string>",
"days_on_market": 123,
"parcel_number": "<string>",
"building_name": "<string>",
"building_id": "<string>",
"building_floors": 123,
"building_units": 123,
"listed_at": 123,
"contract_at": 123,
"closed_at": 123,
"updated_at": 123,
"is_off_mls": true,
"is_consumer_searchable": true,
"image": "<string>",
"images": [],
"page_link": "<string>",
"property_page_link": "<string>",
"agents": [],
"charges": [],
"open_houses": [],
"location_entities": [],
"key_details": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/compass
/compass/listings
Get full Compass listing details by its detail URL: address, price (list/closed/last known), price per sqft, HOA and taxes, beds/baths, square feet, lot size, property type, amenities, description, MLS status, days on market, building info, latitude/longitude, photos, listing agents, open houses, location entities and key details.
Price: 20 credits
⚠️ Common errors: 412: Listing not found (well-formed URL but no listing data for it)
POST
/
api
/
compass
/
listings
/compass/listings
curl --request POST \
--url https://api.anysite.io/api/compass/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/compass/listings"
payload = {
"listing": "<string>",
"timeout": 300
}
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({listing: '<string>', timeout: 300})
};
fetch('https://api.anysite.io/api/compass/listings', 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",
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([
'listing' => '<string>',
'timeout' => 300
]),
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"
payload := strings.NewReader("{\n \"listing\": \"<string>\",\n \"timeout\": 300\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")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/compass/listings")
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 \"listing\": \"<string>\",\n \"timeout\": 300\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CompassListing",
"compass_property_id": "<string>",
"feed_listing_id": "<string>",
"listing_type": "<string>",
"status": "<string>",
"status_code": 123,
"mls_status": "<string>",
"price": 123,
"listed_price": 123,
"closed_price": 123,
"price_per_sqft": 123,
"hoa_fee": 123,
"monthly_charges_with_taxes": 123,
"down_payment_percent": 123,
"bedrooms": 123,
"full_bathrooms": 123,
"half_bathrooms": 123,
"total_bathrooms": 123,
"square_feet": 123,
"lot_size": 123,
"total_rooms": 123,
"legal_room_count": 123,
"year_built": 123,
"building_age": "<string>",
"parking_spaces": 123,
"property_type": "<string>",
"amenities": [],
"pretty_address": "<string>",
"street_number": "<string>",
"street": "<string>",
"street_type": "<string>",
"unit_number": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"county": "<string>",
"latitude": 123,
"longitude": 123,
"geo_id": "<string>",
"days_on_market": 123,
"parcel_number": "<string>",
"building_name": "<string>",
"building_id": "<string>",
"building_floors": 123,
"building_units": 123,
"listed_at": 123,
"contract_at": 123,
"closed_at": 123,
"updated_at": 123,
"is_off_mls": true,
"is_consumer_searchable": true,
"image": "<string>",
"images": [],
"page_link": "<string>",
"property_page_link": "<string>",
"agents": [],
"charges": [],
"open_houses": [],
"location_entities": [],
"key_details": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes