For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LoginGet a Demo
DocumentationAPI Reference
DocumentationAPI Reference
  • Property Report
    • GETList
    • GETSearch
    • GETSearch Tags
    • GETReports By Tag
    • PATCHUpdate Metadata
  • Property
    • GETSearch
    • GETGet Property
    • POSTComparables
    • POSTPost Property
    • POSTMarket Rents
    • POSTExpense Benchmarks
  • Market
    • POSTMarket Search
    • GETShape Search
  • Dataset
    • POSTDataset Export Async
LogoLogo
LoginGet a Demo
Property

Market Rents

POST
https://api.hellodata.ai/property/market_rents
POST
/property/market_rents
$curl -X POST https://api.hellodata.ai/property/market_rents \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "subject": {
>    "id": "52907745-7672-470e-a803-a2f8feb52944",
>    "building_name": "OneEleven",
>    "street_address": "111 West Wacker Drive",
>    "city": "Chicago",
>    "state": "IL",
>    "zip_code": "60601",
>    "year_built": 2014,
>    "number_units": 505,
>    "number_stories": 60,
>    "lat": 41.88651,
>    "lon": -87.63141,
>    "created_on": "2024-02-13",
>    "building_availability": [
>      {
>        "id": "123e4567-e89b-12d3-a456-426614174000",
>        "is_floorplan": true,
>        "bed": 2,
>        "bath": 2,
>        "partial_bath": 1,
>        "sqft": 850,
>        "floorplan_name": "2B2B",
>        "unit_name": "203",
>        "enter_market": "2023-12-01",
>        "exit_market": "2024-01-15",
>        "tags": [
>          "ada_unit"
>        ],
>        "history": [
>          {
>            "from_date": "2024-01-01",
>            "to_date": "2024-03-31",
>            "price": 1500,
>            "effective_price": 1450,
>            "period_id": 0,
>            "min_price": 1200,
>            "max_price": 1800,
>            "min_effective_price": 1150,
>            "max_effective_price": 1750
>          }
>        ],
>        "availability_periods": [
>          {
>            "period_id": 0,
>            "enter_market": "2023-12-01",
>            "exit_market": "2024-01-15",
>            "days_on_market": 45,
>            "availability": "2024-01-01"
>          }
>        ],
>        "floor": 5,
>        "availability": "2024-01-01",
>        "min_price": 1200,
>        "price": 1500,
>        "max_price": 1800,
>        "min_effective_price": 1150,
>        "effective_price": 1450,
>        "max_effective_price": 1750,
>        "days_on_market": 45,
>        "min_sqft": 800,
>        "max_sqft": 900,
>        "created_on": "2023-11-01",
>        "price_plans": [
>          {
>            "duration_in_months": 12,
>            "specials": "Special incentives available at OneEleven! Enjoy up to a half month free on select apartments."
>          }
>        ],
>        "amenities": [
>          "string"
>        ]
>      }
>    ],
>    "building_quality": {
>      "property_overall_quality": 0.85,
>      "avg_quality_score_bedroom": 0.82,
>      "avg_quality_score_kitchen": 0.87,
>      "avg_quality_score_bathroom": 0.81,
>      "avg_quality_score_dining_room": 0.8,
>      "avg_quality_score_common_areas": 0.83,
>      "avg_quality_score_fitness_center": 0.78,
>      "avg_quality_score_laundry_room": 0.75,
>      "avg_quality_score_living_room": 0.84,
>      "avg_quality_score_main_entrance": 0.86,
>      "avg_quality_score_stairs_hallway": 0.79,
>      "avg_quality_score_swimming_pool": 0.88,
>      "avg_quality_score_walk_in_closet": 0.8
>    },
>    "street_address_alias": [
>      "111 West Wacker",
>      "111 West Wacker Drive"
>    ],
>    "msa": "Chicago-Naperville-Elgin, IL-IN-WI",
>    "market_embedding": [
>      1.1
>    ],
>    "building_name_alias": [
>      "string"
>    ],
>    "building_phone_number": "7087250291",
>    "building_website": "https://www.oneelevenchicago.com/",
>    "is_single_family": false,
>    "is_condo": false,
>    "is_apartment": true,
>    "year_built_prediction": "2020+",
>    "number_stories_prediction": "11+",
>    "management_company": "The Bozzuto Group",
>    "pricing_strategy": {
>      "is_using_rev_management": true,
>      "avg_duration": 30,
>      "avg_price_change": 100,
>      "avg_time_on_market": 30,
>      "day_of_week_distribution": [
>        1.1
>      ],
>      "count_prices": 1.1
>    },
>    "cats_monthly_rent": 50,
>    "cats_one_time_fee": 50,
>    "cats_deposit": 50,
>    "dogs_monthly_rent": 50,
>    "dogs_one_time_fee": 50,
>    "dogs_deposit": 50,
>    "admin_fee": 600,
>    "amenity_fee": 0,
>    "application_fee": 65,
>    "storage_fee": 50,
>    "parking_covered": 300,
>    "parking_garage": 319,
>    "parking_surface_lot": 100,
>    "min_deposit": 2248,
>    "max_deposit": 2248,
>    "building_amenities": [
>      "24_hour_maintenance"
>    ],
>    "unit_amenities": [
>      "air_conditioning"
>    ]
>  }
>}'
200Successful
1[
2  {
3    "unit": {
4      "building_name": "OneEleven",
5      "unit_name": "203",
6      "floorplan_name": "2B2B",
7      "bed": 2,
8      "bath": 2,
9      "partial_bath": 1,
10      "sqft": 850,
11      "price": 1500,
12      "effective_price": 1350,
13      "enter_market": "2023-12-01",
14      "exit_market": "2024-01-15",
15      "tags": [
16        "ada_unit"
17      ],
18      "floor": 2,
19      "availability": "2023-12-04"
20    },
21    "predicted_price": 2500,
22    "predicted_price_sqft": 2.08,
23    "predicted_effective_price": 2250,
24    "predicted_effective_price_sqft": 1.87,
25    "supporting_units": [
26      {
27        "similarity": 0.9,
28        "unit": {
29          "building_name": "OneEleven",
30          "unit_name": "203",
31          "floorplan_name": "2B2B",
32          "bed": 2,
33          "bath": 2,
34          "partial_bath": 1,
35          "sqft": 850,
36          "price": 1500,
37          "effective_price": 1350,
38          "enter_market": "2023-12-01",
39          "exit_market": "2024-01-15",
40          "tags": [
41            "ada_unit"
42          ],
43          "floor": 2,
44          "availability": "2023-12-04"
45        },
46        "predicted_diff": -0.13
47      }
48    ]
49  }
50]

Get market rents for active units among a subject property given its details. We use all property and unit details (characteristics, amenities, location, etc.) to find similar units in the market that have been rented recently. We then use the rent prices of these units to estimate the unit pricing.

This is an alias for the pricing endpoint with a more descriptive name.

Was this page helpful?
Previous

Expense Benchmarks

Next
Built with

Authentication

x-api-keystring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
subjectobjectRequired
The content of the property for which to compute the recommended pricing.
settingsobjectOptional
The settings for computing the recommended pricing. For example to exclude the subject property from the comps analysis, to limit the search radius for comparable properties, or to filter the data to include only units occurring within a specific date range.

Response

The unit pricing.
unitobject
The PricingUnit object represents rudimentary information about a unit and its pricing. It is returned when querying a property's recommended pricing instead of the full unit details.
predicted_pricedouble or null
The recommended rent for the unit, based on an analysis of comparable units.
predicted_price_sqftdouble or null
The recommended rent per square foot of the unit, based on an analysis of comparable units.
predicted_effective_pricedouble or null
The recommended effective rent for the unit, based on an analysis of comparable units.
predicted_effective_price_sqftdouble or null
The recommended effective rent per square foot of the unit, based on an analysis of comparable units.
supporting_unitslist of objects