Search Properties
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/properties/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}",
"query": "Marina"
}
'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/properties/search"
payload = {
"account_id": "{account_id}",
"query": "Marina"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({account_id: '{account_id}', query: 'Marina'})
};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/properties/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://data.apartmentiq.io/apartmentiq/api/v2/properties/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([
'account_id' => '{account_id}',
'query' => 'Marina'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://data.apartmentiq.io/apartmentiq/api/v2/properties/search"
payload := strings.NewReader("{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://data.apartmentiq.io/apartmentiq/api/v2/properties/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": 781245,
"property_name": "Marina Landing",
"city": "Austin",
"state": "TX",
"zip_code": "78701",
"unit_count": 284,
"year_built": 2019,
"year_renovated": null,
"property_class": "A",
"address": "401 Riverfront Dr",
"image_url": "https://cdn.example.com/properties/marina-landing.jpg",
"latitude": 30.2647,
"longitude": -97.7478
},
{
"id": 781266,
"property_name": "Marina Heights",
"city": "Austin",
"state": "TX",
"zip_code": "78703",
"unit_count": 196,
"year_built": 2012,
"year_renovated": 2021,
"property_class": "B",
"address": "88 Lakeview Ave",
"image_url": null,
"latitude": 30.2799,
"longitude": -97.7696
}
],
"pagination": {
"current_page": 1,
"total_pages": 2,
"total_count": 76,
"per_page": 50
}
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}"You have exceeded the rate limit for this API.\n"Properties
Search Properties
Search properties by text query, optionally scoped by stakeholder entities.
Requires Explore Pro access.
POST
/
properties
/
search
Search Properties
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/properties/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}",
"query": "Marina"
}
'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/properties/search"
payload = {
"account_id": "{account_id}",
"query": "Marina"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({account_id: '{account_id}', query: 'Marina'})
};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/properties/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://data.apartmentiq.io/apartmentiq/api/v2/properties/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([
'account_id' => '{account_id}',
'query' => 'Marina'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://data.apartmentiq.io/apartmentiq/api/v2/properties/search"
payload := strings.NewReader("{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://data.apartmentiq.io/apartmentiq/api/v2/properties/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"{account_id}\",\n \"query\": \"Marina\"\n}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": 781245,
"property_name": "Marina Landing",
"city": "Austin",
"state": "TX",
"zip_code": "78701",
"unit_count": 284,
"year_built": 2019,
"year_renovated": null,
"property_class": "A",
"address": "401 Riverfront Dr",
"image_url": "https://cdn.example.com/properties/marina-landing.jpg",
"latitude": 30.2647,
"longitude": -97.7478
},
{
"id": 781266,
"property_name": "Marina Heights",
"city": "Austin",
"state": "TX",
"zip_code": "78703",
"unit_count": 196,
"year_built": 2012,
"year_renovated": 2021,
"property_class": "B",
"address": "88 Lakeview Ave",
"image_url": null,
"latitude": 30.2799,
"longitude": -97.7696
}
],
"pagination": {
"current_page": 1,
"total_pages": 2,
"total_count": 76,
"per_page": 50
}
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}"You have exceeded the rate limit for this API.\n"Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
ApartmentIQ account ID used to set the request account context.
Search term.
One-based page number. Values less than 1 are treated as 1.
Required range:
x >= 1Rows per page. Values above 100 are capped at 100.
Required range:
1 <= x <= 100Optional stakeholder entity IDs. Rails accepts arrays or comma-delimited strings.
⌘I