/hotpads/listings
curl --request POST \
--url https://api.anysite.io/api/hotpads/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/hotpads/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/hotpads/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/hotpads/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/hotpads/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/hotpads/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/hotpads/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>",
"url": "<string>",
"@type": "HotpadsListing",
"unit": "<string>",
"name": "<string>",
"property_type": "<string>",
"listing_type": "<string>",
"alias": "<string>",
"address": {
"@type": "HotpadsAddress",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
},
"neighborhood": "<string>",
"latitude": 123,
"longitude": 123,
"price_min": 123,
"price_max": 123,
"bed_min": 123,
"bed_max": 123,
"bath_min": 123,
"bath_max": 123,
"sqft_min": 123,
"sqft_max": 123,
"unit_count": 123,
"is_furnished": true,
"lease_terms": "<string>",
"amenities": [],
"amenity_highlights": [],
"pet_policies": [],
"image": "<string>",
"images": [],
"photo_count": 123,
"videos": [],
"tour_urls": [],
"costs_fees_note": "<string>",
"special_offers": [],
"property_manager": "<string>",
"property_manager_contact": "<string>",
"property_manager_phone": "<string>",
"property_manager_website": "<string>",
"models": [],
"schools": [],
"listed_at": 123,
"created_at": 123,
"updated_at": 123
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/hotpads
/hotpads/listings
Get full HotPads rental pad (single unit) details by short id and unit (or pad URL): address, coordinates, neighborhood, price and beds/baths/sqft, property type, description, amenities, pet policies, photos, videos, 3D tours, costs and lease terms, special offers, property manager, floor plans, nearby schools (GreatSchools rating and grades) and listing dates.
Price: 1 credit
⚠️ Common errors: 412: Listing not found (well-formed but nonexistent pad short id/unit)
POST
/
api
/
hotpads
/
listings
/hotpads/listings
curl --request POST \
--url https://api.anysite.io/api/hotpads/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/hotpads/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/hotpads/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/hotpads/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/hotpads/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/hotpads/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/hotpads/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>",
"url": "<string>",
"@type": "HotpadsListing",
"unit": "<string>",
"name": "<string>",
"property_type": "<string>",
"listing_type": "<string>",
"alias": "<string>",
"address": {
"@type": "HotpadsAddress",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
},
"neighborhood": "<string>",
"latitude": 123,
"longitude": 123,
"price_min": 123,
"price_max": 123,
"bed_min": 123,
"bed_max": 123,
"bath_min": 123,
"bath_max": 123,
"sqft_min": 123,
"sqft_max": 123,
"unit_count": 123,
"is_furnished": true,
"lease_terms": "<string>",
"amenities": [],
"amenity_highlights": [],
"pet_policies": [],
"image": "<string>",
"images": [],
"photo_count": 123,
"videos": [],
"tour_urls": [],
"costs_fees_note": "<string>",
"special_offers": [],
"property_manager": "<string>",
"property_manager_contact": "<string>",
"property_manager_phone": "<string>",
"property_manager_website": "<string>",
"models": [],
"schools": [],
"listed_at": 123,
"created_at": 123,
"updated_at": 123
}
]{
"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