
US Real Estate
Spotlights
API Overview
US Real Estate & commercial property for sale & for rent, housing, apartments, home estimate value, agents search, noise score, nearby schools, commute time, mortgage rate & calculator, recently sold homes, mls, realtor, zillow, opendoor, realty, redfin, etc.
US Real Estate & commercial property for sale & rentals
US Real Estate
Base URLs: https://us-real-estate.p.rapidapi.com
General
GET /keywords-search-suggest
GET /keywords-search-suggest
Search defined keywords by keyword text
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
keyword_text | query | string | yes | none |
limit | query | string | no | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/property-detail
GET /api/v3/property-detail
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /property-by-mls-id
GET /property-by-mls-id
Get property detail by MLS ID
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
mls_id | query | string | yes | MLS ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v3/property-detail
GET /v3/property-detail
Get property detail by property_id
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | Property ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
Location
GET /location/suggest
GET /api/location/suggest
Sugget location address
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
input | query | string | yes | Address |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/for-sale-nearby-areas
GET /api/location/for-sale-nearby-areas
Get nearby area for searching for sale properties. Search by city+state_code or city+state_code+neighborhood or postal_code
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
area_type | query | string | yes | One of the following options: city |
city | query | string | no | City name |
state_code | query | string | no | State Code |
neighborhood | query | string | no | Neighborhood name |
postal_code | query | string | no | Postal code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/for-sale-nearby-areas-by-postal-code
GET /api/location/for-sale-nearby-areas-by-postal-code
Get nearby area for searching for sale properties by postal code
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
postal_code | query | string | yes | Postal Code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/for-rent-nearby-areas
GET /api/location/for-rent-nearby-areas
Get nearby area for searching for rent properties. Search by city+state_code or city+state_code+neighborhood or postal_code
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
area_type | query | string | yes | One of the following options: city |
city | query | string | no | City name |
state_code | query | string | no | State Code |
neighborhood | query | string | no | Neighborhood name |
postal_code | query | string | no | Postal Code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/for-rent-nearby-areas-by-postal-code
GET /api/location/for-rent-nearby-areas-by-postal-code
Get nearby area for searching for rent properties by postal code
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
postal_code | query | string | yes | Postal Code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/schools
GET /api/location/schools
Get schools
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | City name |
state_code | query | string | yes | State Code |
neighborhood | query | string | no | Neighborhood name |
postal_code | query | string | no | Postal Code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/noise-score
GET /api/location/noise-score
Get noise score by latitude and longitude
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
latitude | query | string | yes | none |
longitude | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/commute-time
GET /api/location/commute-time
Get commute time between two addresses
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
origins | query | string | yes | Origin Address |
destinations | query | string | yes | Destination Address |
mode | query | string | yes | One of the following options: driving |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /location/schools-by-postal-code
GET /api/location/schools-by-postal-code
Get schools by postal code
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
postal_code | query | string | yes | Postal Code |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
For Sale
GET /for-sale
GET /api/for-sale
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | none |
state_code | query | string | yes | none |
location | query | string | yes | none |
limit | query | string | yes | none |
offset | query | string | yes | none |
sort | query | string | yes | none |
price_min | query | string | yes | none |
price_max | query | string | yes | none |
beds_min | query | string | yes | none |
beds_max | query | string | yes | none |
baths_min | query | string | yes | none |
baths_max | query | string | yes | none |
property_type | query | string | yes | none |
property_type_nyc_only | query | string | yes | none |
new_construction | query | string | yes | none |
hide_pending_contingent | query | string | yes | none |
has_virtual_tours | query | string | yes | none |
has_3d_tours | query | string | yes | none |
hide_foreclosure | query | string | yes | none |
price_reduced | query | string | yes | none |
open_house | query | string | yes | none |
keywords | query | string | yes | none |
no_hoa_fee | query | string | yes | none |
hoa_max | query | string | yes | none |
days_on_realtor | query | string | yes | none |
expand_search_radius | query | string | yes | none |
include_nearby_areas_slug_id | query | string | yes | none |
home_size_min | query | string | yes | none |
home_size_max | query | string | yes | none |
lot_size_min | query | string | yes | none |
lot_size_max | query | string | yes | none |
home_age_max | query | string | yes | none |
stories | query | string | yes | none |
garage | query | string | yes | none |
heating_cooling | query | string | yes | none |
inside_rooms | query | string | yes | none |
outside_features | query | string | yes | none |
lot_views | query | string | yes | none |
community_ammenities | query | string | yes | none |
features_in_nyc_only | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /for-sale/other-homes-in-building
GET /api/for-sale/other-homes-in-building
Get properties in the same building
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | Property ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /for-sale/similiar-homes
GET /api/for-sale/similiar-homes
Get similar properties
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | Property ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /for-sale/home-estimate-value
GET /api/for-sale/home-estimate-value
Get property value estimation
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | Property ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/for-sale
GET /api/v2/for-sale
Search properties for sale
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | no | City name |
state_code | query | string | no | State Code |
location | query | string | no | Additional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: relevant |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: multi_family |
property_type_nyc_only | query | string | no | Comma separated values. One or more from following options: condo |
new_construction | query | string | no | true for new construction only. Leave blank for any |
hide_pending_contingent | query | string | no | true for hide pending/contingent. Leave blank for any |
has_virtual_tours | query | string | no | true for properties with virtual tour only. Leave blank for any |
has_3d_tours | query | string | no | true for properties with 3D tour only. Leave blank for any |
hide_foreclosure | query | string | no | true for hide foreclosure. Leave blank for any |
price_reduced | query | string | no | true for properties with price reduced only. Leave blank for any |
open_house | query | string | no | true for properties with open house only. Leave blank for any |
keywords | query | string | no | Comma-separated values. Get popular keywords from /keywords-search-suggest response |
no_hoa_fee | query | string | no | true for properties without HOA fee only. Leave blank for any |
hoa_max | query | string | no | Maximum HOA fee in USD |
days_on_realtor | query | string | no | One of the following options: today |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
lot_size_min | query | string | no | One of the following options: 2000 |
lot_size_max | query | string | no | One of the following options: 2000 |
home_age_max | query | string | no | Maximum home age |
stories | query | string | no | One of the following options: single |
garage | query | string | no | One of the following options: 1+ |
heating_cooling | query | string | no | Comma-separated values. One or more from following options: central_air |
inside_rooms | query | string | no | none |
outside_features | query | string | no | Comma-separated values. One or more from following options: swimming_pool |
lot_views | query | string | no | Comma-separated values. One or more from following options: waterfront |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
features_in_nyc_only | query | string | no | Comma-separated values. One or more from following options: furniture |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/for-sale-by-zipcode
GET /api/v2/for-sale-by-zipcode
Search properties for sale by Zipcode
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
zipcode | query | string | yes | Zip code/ Postal Code |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: relevant |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: multi_family |
property_type_nyc_only | query | string | no | Comma separated values. One or more from following options: condo |
new_construction | query | string | no | true for new construction only. Leave blank for any |
hide_pending_contingent | query | string | no | true for hide pending/contingent. Leave blank for any |
has_virtual_tours | query | string | no | true for properties with virtual tour only. Leave blank for any |
has_3d_tours | query | string | no | true for properties with 3D tour only. Leave blank for any |
hide_foreclosure | query | string | no | true for hide foreclosure. Leave blank for any |
price_reduced | query | string | no | true for properties with price reduced only. Leave blank for any |
open_house | query | string | no | true for properties with open house only. Leave blank for any |
keywords | query | string | no | Comma-separated values. Get popular keywords from /keywords-search-suggest response |
no_hoa_fee | query | string | no | true for properties without HOA fee only. Leave blank for any |
hoa_max | query | string | no | Maximum HOA fee in USD |
days_on_realtor | query | string | no | One of the following options: today |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
lot_size_min | query | string | no | One of the following options: 2000 |
lot_size_max | query | string | no | One of the following options: 2000 |
home_age_max | query | string | no | Maximum home age |
stories | query | string | no | One of the following options: single |
garage | query | string | no | One of the following options: 1+ |
heating_cooling | query | string | no | Comma-separated values. One or more from following options: central_air |
inside_rooms | query | string | no | Comma-separated values. One or more comma separated from following options: basement |
outside_features | query | string | no | Comma-separated values. One or more from following options: swimming_pool |
lot_views | query | string | no | Comma-separated values. One or more from following options: waterfront |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
features_in_nyc_only | query | string | no | Comma-separated values. One or more from following options: furniture |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v3/for-sale
GET /api/v3/for-sale
Search properties for sale
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | no | City name |
state_code | query | string | no | State Code |
location | query | string | no | Additional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: relevant |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: multi_family |
property_type_nyc_only | query | string | no | Comma separated values. One or more from following options: condo |
new_construction | query | string | no | true for new construction only. Leave blank for any |
hide_pending_contingent | query | string | no | true for hide pending/contingent. Leave blank for any |
has_virtual_tours | query | string | no | true for properties with virtual tour only. Leave blank for any |
has_3d_tours | query | string | no | true for properties with 3D tour only. Leave blank for any |
hide_foreclosure | query | string | no | true for hide foreclosure. Leave blank for any |
price_reduced | query | string | no | true for properties with price reduced only. Leave blank for any |
open_house | query | string | no | true for properties with open house only. Leave blank for any |
keywords | query | string | no | Comma-separated values. Get popular keywords from /keywords-search-suggest response |
no_hoa_fee | query | string | no | true for properties without HOA fee only. Leave blank for any |
hoa_max | query | string | no | Maximum HOA fee in USD |
days_on_realtor | query | string | no | One of the following options: today |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
lot_size_min | query | string | no | One of the following options: 2000 |
lot_size_max | query | string | no | One of the following options: 2000 |
home_age_max | query | string | no | none |
stories | query | string | no | One of the following options: single |
garage | query | string | no | One of the following options: 1+ |
heating_cooling | query | string | no | Comma-separated values. One or more from following options: central_air |
inside_rooms | query | string | no | Comma-separated values. One or more comma separated from following options: basement |
outside_features | query | string | no | Comma-separated values. One or more from following options: swimming_pool |
lot_views | query | string | no | Comma-separated values. One or more from following options: waterfront |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
features_in_nyc_only | query | string | no | Comma-separated values. One or more from following options: furniture |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
Sold Home
GET /sold-homes
GET /api/sold-homes
Get recently sold properties
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | City name |
state_code | query | string | yes | State Code |
location | query | string | no | Additional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
sort | query | string | no | One of the following options: sold_date |
expand_search_radius | query | string | no | One of the following options: 1 |
max_sold_days | query | string | no | Maximum sold days form now |
new_construction | query | string | no | true for new construction only. Leave blank for any |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/sold-homes-by-zipcode
GET /api/v2/sold-homes-by-zipcode
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
zipcode | query | string | yes | Zipcode |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
expand_search_radius | query | string | no | One of the following options: 1 |
max_sold_days | query | string | no | Maximum sold days form now |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
For Rent
GET /v2/for-rent
GET /api/v2/for-rent
Get for rent properties
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | City name |
state_code | query | string | yes | State Code |
location | query | string | no | Additional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: frehsnest |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: townhome |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
in_unit_features | query | string | no | Comma-separated values. One or more from following options: central_air |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
cats_ok | query | string | no | true for Cats allowed only |
dogs_ok | query | string | no | true for Dogs allowed only |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/for-rent-result-count
GET /api/v2/for-rent-result-count
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | City name |
state_code | query | string | yes | State Code |
location | query | string | no | Additional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: frehsnest |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: multi_family |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
in_unit_features | query | string | no | Comma-separated values. One or more from following options: central_air |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
cats_ok | query | string | no | true for Cats allowed only |
dogs_ok | query | string | no | true for Dogs allowed only |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/for-rent-by-zipcode
GET /api/v2/for-rent-by-zipcode
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
zipcode | query | string | yes | Zipcode |
limit | query | string | no | Number of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42. |
offset | query | string | no | Number of skipped results |
sort | query | string | no | One of the following options: frehsnest |
price_min | query | string | no | Minimmum price |
price_max | query | string | no | Maximum price |
beds_min | query | string | no | Minimum beds |
beds_max | query | string | no | Maximum beds |
baths_min | query | string | no | Minimum Bathrooms |
baths_max | query | string | no | Maximum Bathrooms |
property_type | query | string | no | Comma-separated values. Available options: multi_family |
expand_search_radius | query | string | no | One of the following options: 1 |
include_nearby_areas_slug_id | query | string | no | Comma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas |
home_size_min | query | string | no | One of the following options: 750 |
home_size_max | query | string | no | One of the following options: 1000 |
in_unit_features | query | string | no | Comma-separated values. One or more from following options: central_air |
community_ammenities | query | string | no | Comma-separated values. One or more from following options: community_swimming_pool |
cats_ok | query | string | no | true for Cats allowed only |
dogs_ok | query | string | no | true for Dogs allowed only |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /v2/for-rent/similiar-homes
GET /api/v2/for-rent/similiar-homes
Get for rent similar properties
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | Property ID |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /for-rent
GET /api/for-rent
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
city | query | string | yes | none |
state_code | query | string | yes | none |
location | query | string | yes | none |
limit | query | string | yes | none |
offset | query | string | yes | none |
sort | query | string | yes | none |
price_min | query | string | yes | none |
price_max | query | string | yes | none |
beds_min | query | string | yes | none |
beds_max | query | string | yes | none |
baths_min | query | string | yes | none |
baths_max | query | string | yes | none |
property_type | query | string | yes | none |
expand_search_radius | query | string | yes | none |
include_nearby_areas_slug_id | query | string | yes | none |
home_size_min | query | string | yes | none |
home_size_max | query | string | yes | none |
in_unit_features | query | string | yes | none |
community_ammenities | query | string | yes | none |
cats_ok | query | string | yes | none |
dogs_ok | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /for-rent/similiar-homes
GET /api/for-rent/similiar-homes
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
property_id | query | string | yes | none |
postal_code | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
Agents
GET /agents/agents-search
GET /api/agents/agents-search
Search agents by State Code and City
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
state_code | query | string | yes | State Code |
city | query | string | yes | City name |
agent_name | query | string | no | Agent name |
limit | query | string | no | Number of results. Maximum is 100. |
offset | query | string | no | Number of skipped results |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /agents/agents-search-by-zipcode
GET /api/agents/agents-search-by-zipcode
Search agents by zipcode
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
zipcode | query | string | yes | Zipcode |
agent_name | query | string | no | Agent name |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /agents/agent-listings
GET /api/agents/agent-listings
Get agent listings
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
advertiser_id | query | string | yes | Advertiser ID. Get from agent-search result |
page | query | string | no | Listing page number |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /agents/agent-profile
GET /api/agents/agent-profile
Get agent's profile
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
advertiser_id | query | string | yes | Advertiser ID. Get from agent-search result |
nrds_id | query | string | no | NRDS ID. Get from agent-search result |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
Finance
GET /finance/mortgage-calculate
GET /api/finance/mortgage-calculate
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
price | query | string | yes | none |
down_payment | query | string | yes | none |
percent_rate | query | string | yes | none |
year_term | query | string | yes | none |
monthly_home_insurance | query | string | yes | none |
hoa_fees | query | string | yes | none |
percent_tax_rate | query | string | yes | none |
show_amortization | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /finance/average-rate
GET /api/finance/average-rate
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
postal_code | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |
Responses Data Schema
GET /finance/rate-trends
GET /api/finance/rate-trends
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
is_refinance | query | string | yes | none |
> Response Examples
> 200 Response
{}
Responses
HTTP Status Code | Meaning | Description | Data schema |
---|---|---|---|
200 | OK | Success | Inline |