/apartmentlist/listings/search
curl --request POST \
--url https://api.anysite.io/api/apartmentlist/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"beds": [],
"min_price": 1,
"max_price": 1,
"amenities": [],
"move_in_date": "<string>"
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"beds": [],
"min_price": 1,
"max_price": 1,
"amenities": [],
"move_in_date": "<string>"
}
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,
beds: [],
min_price: 1,
max_price: 1,
amenities: [],
move_in_date: '<string>'
})
};
fetch('https://api.anysite.io/api/apartmentlist/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/apartmentlist/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,
'beds' => [
],
'min_price' => 1,
'max_price' => 1,
'amenities' => [
],
'move_in_date' => '<string>'
]),
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/apartmentlist/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\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/apartmentlist/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/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 \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "ApartmentlistSearchListing",
"url": "<string>",
"alias": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"show_price": true,
"rank": 123
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/apartmentlist
/apartmentlist/listings/search
Search Apartment List rental listings by location (/): for each result returns name, geo, per-bedroom starting price and photo. Supports filters by bedrooms, bathrooms, price range, amenities, housing type, curated collection and move-in date.
Price: 20 credits
POST
/
api
/
apartmentlist
/
listings
/
search
/apartmentlist/listings/search
curl --request POST \
--url https://api.anysite.io/api/apartmentlist/listings/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location": "<string>",
"count": 2,
"timeout": 300,
"beds": [],
"min_price": 1,
"max_price": 1,
"amenities": [],
"move_in_date": "<string>"
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/listings/search"
payload = {
"location": "<string>",
"count": 2,
"timeout": 300,
"beds": [],
"min_price": 1,
"max_price": 1,
"amenities": [],
"move_in_date": "<string>"
}
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,
beds: [],
min_price: 1,
max_price: 1,
amenities: [],
move_in_date: '<string>'
})
};
fetch('https://api.anysite.io/api/apartmentlist/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/apartmentlist/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,
'beds' => [
],
'min_price' => 1,
'max_price' => 1,
'amenities' => [
],
'move_in_date' => '<string>'
]),
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/apartmentlist/listings/search"
payload := strings.NewReader("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\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/apartmentlist/listings/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/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 \"beds\": [],\n \"min_price\": 1,\n \"max_price\": 1,\n \"amenities\": [],\n \"move_in_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "ApartmentlistSearchListing",
"url": "<string>",
"alias": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"show_price": true,
"rank": 123
}
]{
"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:
studio, 1, 2, 3 Available options:
1, 2, 3 Required range:
x >= 0Required range:
x >= 0Available options:
accessible, air_conditioning, bbq, balcony, bathtub, business_center, carpet, cat_friendly, ceiling_fan, dishwasher, dog_friendly, pet_friendly, pickleball, doorman, elevator, fireplace, furnished, garage, garbage_disposal, granite_counter, gym, hardwood_floors, heat, hot_tub, ice_maker, in_unit_laundry, on_site_laundry, parking, pool, stainless_steel, walk_in_closet, laundry_connections Available options:
student, senior Available options:
most_popular, best_rent_specials, luxury, best_in_budget Response
Successful Response