curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties"
payload = { "account_id": "{account_id}" }
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}'})
};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties', 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/stakeholder_entities/{stakeholder_entity_id}/properties",
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}'
]),
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/stakeholder_entities/{stakeholder_entity_id}/properties"
payload := strings.NewReader("{\n \"account_id\": \"{account_id}\"\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/stakeholder_entities/{stakeholder_entity_id}/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{account_id}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties")
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}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": 123,
"name": "Marina View",
"address": "1 Ocean Ave, Marina Del Rey, CA",
"property_class": "A",
"market_name": "Los Angeles",
"submarket_name": "Marina Del Rey",
"unit_count": 250,
"year_built": 1998,
"image_url": "https://cdn.example.com/properties/marina-view.jpg",
"asking_rent_avg": 2450,
"asking_rent_market_avg": 2400,
"asking_rent_change": 0.021,
"asking_rent_psf_avg": 3.25,
"asking_rent_psf_market_avg": 3.15,
"asking_rent_psf_change": 0.01,
"ner_avg": 2350,
"ner_market_avg": 2300,
"ner_change": 0.02,
"ner_psf_avg": 3.1,
"ner_psf_market_avg": 3,
"ner_psf_change": 0.015,
"days_on_market_avg": 21,
"days_on_market_market_avg": 23,
"days_on_market_change": -0.05,
"exposure_percent_avg": 0.08,
"exposure_percent_market_avg": 0.09,
"exposure_percent_change": -0.01,
"occupancy_percent_avg": 0.94,
"occupancy_percent_market_avg": 0.93,
"occupancy_percent_change": 0.005,
"leased_percent_avg": 0.96,
"leased_percent_market_avg": 0.95,
"leased_percent_change": 0.006,
"concession_value_avg": 500,
"concession_value_market_avg": 450,
"concession_value_change": 0.1,
"concession_percent_avg": 0.03,
"concession_percent_market_avg": 0.025,
"concession_percent_change": 0.004,
"leased_unit_count": 12,
"google_reviews_rating": 4.3,
"stakeholder_entities": [
{
"id": 78012,
"name": "Greystar Real Estate Partners",
"entity_type": "Property Manager",
"image_url": "https://cdn.example.com/organizations/greystar.png"
}
],
"lat": "33.98",
"lng": "-118.45",
"unified_status": "Stabilized"
}
],
"pagination": {
"current_page": 1,
"total_pages": 3,
"total_count": 45,
"per_page": 20
}
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Stakeholder entity not found"
}You have exceeded the rate limit for this API.
List Organization Properties
List a stakeholder organization’s properties with market-relative performance metrics.
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties"
payload = { "account_id": "{account_id}" }
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}'})
};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties', 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/stakeholder_entities/{stakeholder_entity_id}/properties",
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}'
]),
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/stakeholder_entities/{stakeholder_entity_id}/properties"
payload := strings.NewReader("{\n \"account_id\": \"{account_id}\"\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/stakeholder_entities/{stakeholder_entity_id}/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{account_id}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/{stakeholder_entity_id}/properties")
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}"
response = http.request(request)
puts response.read_body{
"properties": [
{
"id": 123,
"name": "Marina View",
"address": "1 Ocean Ave, Marina Del Rey, CA",
"property_class": "A",
"market_name": "Los Angeles",
"submarket_name": "Marina Del Rey",
"unit_count": 250,
"year_built": 1998,
"image_url": "https://cdn.example.com/properties/marina-view.jpg",
"asking_rent_avg": 2450,
"asking_rent_market_avg": 2400,
"asking_rent_change": 0.021,
"asking_rent_psf_avg": 3.25,
"asking_rent_psf_market_avg": 3.15,
"asking_rent_psf_change": 0.01,
"ner_avg": 2350,
"ner_market_avg": 2300,
"ner_change": 0.02,
"ner_psf_avg": 3.1,
"ner_psf_market_avg": 3,
"ner_psf_change": 0.015,
"days_on_market_avg": 21,
"days_on_market_market_avg": 23,
"days_on_market_change": -0.05,
"exposure_percent_avg": 0.08,
"exposure_percent_market_avg": 0.09,
"exposure_percent_change": -0.01,
"occupancy_percent_avg": 0.94,
"occupancy_percent_market_avg": 0.93,
"occupancy_percent_change": 0.005,
"leased_percent_avg": 0.96,
"leased_percent_market_avg": 0.95,
"leased_percent_change": 0.006,
"concession_value_avg": 500,
"concession_value_market_avg": 450,
"concession_value_change": 0.1,
"concession_percent_avg": 0.03,
"concession_percent_market_avg": 0.025,
"concession_percent_change": 0.004,
"leased_unit_count": 12,
"google_reviews_rating": 4.3,
"stakeholder_entities": [
{
"id": 78012,
"name": "Greystar Real Estate Partners",
"entity_type": "Property Manager",
"image_url": "https://cdn.example.com/organizations/greystar.png"
}
],
"lat": "33.98",
"lng": "-118.45",
"unified_status": "Stabilized"
}
],
"pagination": {
"current_page": 1,
"total_pages": 3,
"total_count": 45,
"per_page": 20
}
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "<string>",
"message": "<string>",
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Stakeholder entity not found"
}You have exceeded the rate limit for this API.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ApartmentIQ stakeholder entity ID.
Body
Request contract for listing a stakeholder organization's properties.
ApartmentIQ account ID used to set the request account context.
Optional property filters and metric aggregation date range. When stakeholder_entity_ids is provided, results are limited to properties associated with both the path stakeholder entity and the provided stakeholder entities.
Show child attributes
Show child attributes
One-based page number. Values less than 1 are treated as 1.
x >= 1Rows per page. Values above 100 are capped at 100.
1 <= x <= 100Metric or property field used to sort results. Invalid values are treated as asking_rent_avg.
unit_count, year_built, asking_rent_avg, ner_avg, asking_rent_psf_avg, ner_psf_avg, days_on_market_avg, exposure_percent_avg, occupancy_percent_avg, leased_percent_avg, concession_value_avg, concession_percent_avg Sort direction. Invalid values are treated as desc.
asc, desc Response
Stakeholder organization properties and pagination metadata.