Search APIs
Add Your API
US Real Estate API thumbnail

US Real Estate

9.9 Popularity
100% Service Level
1672ms Latency
N/A Test

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

NameLocationTypeRequiredDescription
keyword_textquerystringyesnone
limitquerystringnonone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/property-detail

GET /api/v3/property-detail

Params

NameLocationTypeRequiredDescription
property_idquerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /property-by-mls-id

GET /property-by-mls-id

Get property detail by MLS ID

Params

NameLocationTypeRequiredDescription
mls_idquerystringyesMLS ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v3/property-detail

GET /v3/property-detail

Get property detail by property_id

Params

NameLocationTypeRequiredDescription
property_idquerystringyesProperty ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

Location

GET /location/suggest

GET /api/location/suggest

Sugget location address

Params

NameLocationTypeRequiredDescription
inputquerystringyesAddress

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

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

NameLocationTypeRequiredDescription
area_typequerystringyesOne of the following options: city
cityquerystringnoCity name
state_codequerystringnoState Code
neighborhoodquerystringnoNeighborhood name
postal_codequerystringnoPostal code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

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

NameLocationTypeRequiredDescription
postal_codequerystringyesPostal Code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

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

NameLocationTypeRequiredDescription
area_typequerystringyesOne of the following options: city
cityquerystringnoCity name
state_codequerystringnoState Code
neighborhoodquerystringnoNeighborhood name
postal_codequerystringnoPostal Code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

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

NameLocationTypeRequiredDescription
postal_codequerystringyesPostal Code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /location/schools

GET /api/location/schools

Get schools

Params

NameLocationTypeRequiredDescription
cityquerystringyesCity name
state_codequerystringyesState Code
neighborhoodquerystringnoNeighborhood name
postal_codequerystringnoPostal Code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /location/noise-score

GET /api/location/noise-score

Get noise score by latitude and longitude

Params

NameLocationTypeRequiredDescription
latitudequerystringyesnone
longitudequerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /location/commute-time

GET /api/location/commute-time

Get commute time between two addresses

Params

NameLocationTypeRequiredDescription
originsquerystringyesOrigin Address
destinationsquerystringyesDestination Address
modequerystringyesOne of the following options: driving

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /location/schools-by-postal-code

GET /api/location/schools-by-postal-code

Get schools by postal code

Params

NameLocationTypeRequiredDescription
postal_codequerystringyesPostal Code

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

For Sale

GET /for-sale

GET /api/for-sale

Params

NameLocationTypeRequiredDescription
cityquerystringyesnone
state_codequerystringyesnone
locationquerystringyesnone
limitquerystringyesnone
offsetquerystringyesnone
sortquerystringyesnone
price_minquerystringyesnone
price_maxquerystringyesnone
beds_minquerystringyesnone
beds_maxquerystringyesnone
baths_minquerystringyesnone
baths_maxquerystringyesnone
property_typequerystringyesnone
property_type_nyc_onlyquerystringyesnone
new_constructionquerystringyesnone
hide_pending_contingentquerystringyesnone
has_virtual_toursquerystringyesnone
has_3d_toursquerystringyesnone
hide_foreclosurequerystringyesnone
price_reducedquerystringyesnone
open_housequerystringyesnone
keywordsquerystringyesnone
no_hoa_feequerystringyesnone
hoa_maxquerystringyesnone
days_on_realtorquerystringyesnone
expand_search_radiusquerystringyesnone
include_nearby_areas_slug_idquerystringyesnone
home_size_minquerystringyesnone
home_size_maxquerystringyesnone
lot_size_minquerystringyesnone
lot_size_maxquerystringyesnone
home_age_maxquerystringyesnone
storiesquerystringyesnone
garagequerystringyesnone
heating_coolingquerystringyesnone
inside_roomsquerystringyesnone
outside_featuresquerystringyesnone
lot_viewsquerystringyesnone
community_ammenitiesquerystringyesnone
features_in_nyc_onlyquerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

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

NameLocationTypeRequiredDescription
property_idquerystringyesProperty ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /for-sale/similiar-homes

GET /api/for-sale/similiar-homes

Get similar properties

Params

NameLocationTypeRequiredDescription
property_idquerystringyesProperty ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /for-sale/home-estimate-value

GET /api/for-sale/home-estimate-value

Get property value estimation

Params

NameLocationTypeRequiredDescription
property_idquerystringyesProperty ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/for-sale

GET /api/v2/for-sale

Search properties for sale

Params

NameLocationTypeRequiredDescription
cityquerystringnoCity name
state_codequerystringnoState Code
locationquerystringnoAdditional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: relevant
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: multi_family
property_type_nyc_onlyquerystringnoComma separated values. One or more from following options: condo
new_constructionquerystringnotrue for new construction only. Leave blank for any
hide_pending_contingentquerystringnotrue for hide pending/contingent. Leave blank for any
has_virtual_toursquerystringnotrue for properties with virtual tour only. Leave blank for any
has_3d_toursquerystringnotrue for properties with 3D tour only. Leave blank for any
hide_foreclosurequerystringnotrue for hide foreclosure. Leave blank for any
price_reducedquerystringnotrue for properties with price reduced only. Leave blank for any
open_housequerystringnotrue for properties with open house only. Leave blank for any
keywordsquerystringnoComma-separated values. Get popular keywords from /keywords-search-suggest response
no_hoa_feequerystringnotrue for properties without HOA fee only. Leave blank for any
hoa_maxquerystringnoMaximum HOA fee in USD
days_on_realtorquerystringnoOne of the following options: today
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
lot_size_minquerystringnoOne of the following options: 2000
lot_size_maxquerystringnoOne of the following options: 2000
home_age_maxquerystringnoMaximum home age
storiesquerystringnoOne of the following options: single
garagequerystringnoOne of the following options: 1+
heating_coolingquerystringnoComma-separated values. One or more from following options: central_air
inside_roomsquerystringnonone
outside_featuresquerystringnoComma-separated values. One or more from following options: swimming_pool
lot_viewsquerystringnoComma-separated values. One or more from following options: waterfront
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
features_in_nyc_onlyquerystringnoComma-separated values. One or more from following options: furniture

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/for-sale-by-zipcode

GET /api/v2/for-sale-by-zipcode

Search properties for sale by Zipcode

Params

NameLocationTypeRequiredDescription
zipcodequerystringyesZip code/ Postal Code
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: relevant
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: multi_family
property_type_nyc_onlyquerystringnoComma separated values. One or more from following options: condo
new_constructionquerystringnotrue for new construction only. Leave blank for any
hide_pending_contingentquerystringnotrue for hide pending/contingent. Leave blank for any
has_virtual_toursquerystringnotrue for properties with virtual tour only. Leave blank for any
has_3d_toursquerystringnotrue for properties with 3D tour only. Leave blank for any
hide_foreclosurequerystringnotrue for hide foreclosure. Leave blank for any
price_reducedquerystringnotrue for properties with price reduced only. Leave blank for any
open_housequerystringnotrue for properties with open house only. Leave blank for any
keywordsquerystringnoComma-separated values. Get popular keywords from /keywords-search-suggest response
no_hoa_feequerystringnotrue for properties without HOA fee only. Leave blank for any
hoa_maxquerystringnoMaximum HOA fee in USD
days_on_realtorquerystringnoOne of the following options: today
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
lot_size_minquerystringnoOne of the following options: 2000
lot_size_maxquerystringnoOne of the following options: 2000
home_age_maxquerystringnoMaximum home age
storiesquerystringnoOne of the following options: single
garagequerystringnoOne of the following options: 1+
heating_coolingquerystringnoComma-separated values. One or more from following options: central_air
inside_roomsquerystringnoComma-separated values. One or more comma separated from following options: basement
outside_featuresquerystringnoComma-separated values. One or more from following options: swimming_pool
lot_viewsquerystringnoComma-separated values. One or more from following options: waterfront
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
features_in_nyc_onlyquerystringnoComma-separated values. One or more from following options: furniture

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v3/for-sale

GET /api/v3/for-sale

Search properties for sale

Params

NameLocationTypeRequiredDescription
cityquerystringnoCity name
state_codequerystringnoState Code
locationquerystringnoAdditional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: relevant
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: multi_family
property_type_nyc_onlyquerystringnoComma separated values. One or more from following options: condo
new_constructionquerystringnotrue for new construction only. Leave blank for any
hide_pending_contingentquerystringnotrue for hide pending/contingent. Leave blank for any
has_virtual_toursquerystringnotrue for properties with virtual tour only. Leave blank for any
has_3d_toursquerystringnotrue for properties with 3D tour only. Leave blank for any
hide_foreclosurequerystringnotrue for hide foreclosure. Leave blank for any
price_reducedquerystringnotrue for properties with price reduced only. Leave blank for any
open_housequerystringnotrue for properties with open house only. Leave blank for any
keywordsquerystringnoComma-separated values. Get popular keywords from /keywords-search-suggest response
no_hoa_feequerystringnotrue for properties without HOA fee only. Leave blank for any
hoa_maxquerystringnoMaximum HOA fee in USD
days_on_realtorquerystringnoOne of the following options: today
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
lot_size_minquerystringnoOne of the following options: 2000
lot_size_maxquerystringnoOne of the following options: 2000
home_age_maxquerystringnonone
storiesquerystringnoOne of the following options: single
garagequerystringnoOne of the following options: 1+
heating_coolingquerystringnoComma-separated values. One or more from following options: central_air
inside_roomsquerystringnoComma-separated values. One or more comma separated from following options: basement
outside_featuresquerystringnoComma-separated values. One or more from following options: swimming_pool
lot_viewsquerystringnoComma-separated values. One or more from following options: waterfront
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
features_in_nyc_onlyquerystringnoComma-separated values. One or more from following options: furniture

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

Sold Home

GET /sold-homes

GET /api/sold-homes

Get recently sold properties

Params

NameLocationTypeRequiredDescription
cityquerystringyesCity name
state_codequerystringyesState Code
locationquerystringnoAdditional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
sortquerystringnoOne of the following options: sold_date
expand_search_radiusquerystringnoOne of the following options: 1
max_sold_daysquerystringnoMaximum sold days form now
new_constructionquerystringnotrue for new construction only. Leave blank for any

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/sold-homes-by-zipcode

GET /api/v2/sold-homes-by-zipcode

Params

NameLocationTypeRequiredDescription
zipcodequerystringyesZipcode
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
expand_search_radiusquerystringnoOne of the following options: 1
max_sold_daysquerystringnoMaximum sold days form now

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

For Rent

GET /v2/for-rent

GET /api/v2/for-rent

Get for rent properties

Params

NameLocationTypeRequiredDescription
cityquerystringyesCity name
state_codequerystringyesState Code
locationquerystringnoAdditional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: frehsnest
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: townhome
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
in_unit_featuresquerystringnoComma-separated values. One or more from following options: central_air
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
cats_okquerystringnotrue for Cats allowed only
dogs_okquerystringnotrue for Dogs allowed only

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/for-rent-result-count

GET /api/v2/for-rent-result-count

Params

NameLocationTypeRequiredDescription
cityquerystringyesCity name
state_codequerystringyesState Code
locationquerystringnoAdditional Location detail, could be neighborhood or postal_code or leave it blank. Get from /location/suggest response. Default is blank
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: frehsnest
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: multi_family
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
in_unit_featuresquerystringnoComma-separated values. One or more from following options: central_air
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
cats_okquerystringnotrue for Cats allowed only
dogs_okquerystringnotrue for Dogs allowed only

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/for-rent-by-zipcode

GET /api/v2/for-rent-by-zipcode

Params

NameLocationTypeRequiredDescription
zipcodequerystringyesZipcode
limitquerystringnoNumber of result limitation. Maximum is 200 for Paid Plan, 42 for Free Plan. Defaults to 42.
offsetquerystringnoNumber of skipped results
sortquerystringnoOne of the following options: frehsnest
price_minquerystringnoMinimmum price
price_maxquerystringnoMaximum price
beds_minquerystringnoMinimum beds
beds_maxquerystringnoMaximum beds
baths_minquerystringnoMinimum Bathrooms
baths_maxquerystringnoMaximum Bathrooms
property_typequerystringnoComma-separated values. Available options: multi_family
expand_search_radiusquerystringnoOne of the following options: 1
include_nearby_areas_slug_idquerystringnoComma-separated values. Expand search by including nearby areas. Get slug_id from /location/for-sale-nearby-areas
home_size_minquerystringnoOne of the following options: 750
home_size_maxquerystringnoOne of the following options: 1000
in_unit_featuresquerystringnoComma-separated values. One or more from following options: central_air
community_ammenitiesquerystringnoComma-separated values. One or more from following options: community_swimming_pool
cats_okquerystringnotrue for Cats allowed only
dogs_okquerystringnotrue for Dogs allowed only

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /v2/for-rent/similiar-homes

GET /api/v2/for-rent/similiar-homes

Get for rent similar properties

Params

NameLocationTypeRequiredDescription
property_idquerystringyesProperty ID

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /for-rent

GET /api/for-rent

Params

NameLocationTypeRequiredDescription
cityquerystringyesnone
state_codequerystringyesnone
locationquerystringyesnone
limitquerystringyesnone
offsetquerystringyesnone
sortquerystringyesnone
price_minquerystringyesnone
price_maxquerystringyesnone
beds_minquerystringyesnone
beds_maxquerystringyesnone
baths_minquerystringyesnone
baths_maxquerystringyesnone
property_typequerystringyesnone
expand_search_radiusquerystringyesnone
include_nearby_areas_slug_idquerystringyesnone
home_size_minquerystringyesnone
home_size_maxquerystringyesnone
in_unit_featuresquerystringyesnone
community_ammenitiesquerystringyesnone
cats_okquerystringyesnone
dogs_okquerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /for-rent/similiar-homes

GET /api/for-rent/similiar-homes

Params

NameLocationTypeRequiredDescription
property_idquerystringyesnone
postal_codequerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

Agents

GET /agents/agents-search

GET /api/agents/agents-search

Search agents by State Code and City

Params

NameLocationTypeRequiredDescription
state_codequerystringyesState Code
cityquerystringyesCity name
agent_namequerystringnoAgent name
limitquerystringnoNumber of results. Maximum is 100.
offsetquerystringnoNumber of skipped results

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /agents/agents-search-by-zipcode

GET /api/agents/agents-search-by-zipcode

Search agents by zipcode

Params

NameLocationTypeRequiredDescription
zipcodequerystringyesZipcode
agent_namequerystringnoAgent name

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /agents/agent-listings

GET /api/agents/agent-listings

Get agent listings

Params

NameLocationTypeRequiredDescription
advertiser_idquerystringyesAdvertiser ID. Get from agent-search result
pagequerystringnoListing page number

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /agents/agent-profile

GET /api/agents/agent-profile

Get agent's profile

Params

NameLocationTypeRequiredDescription
advertiser_idquerystringyesAdvertiser ID. Get from agent-search result
nrds_idquerystringnoNRDS ID. Get from agent-search result

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

Finance

GET /finance/mortgage-calculate

GET /api/finance/mortgage-calculate

Params

NameLocationTypeRequiredDescription
pricequerystringyesnone
down_paymentquerystringyesnone
percent_ratequerystringyesnone
year_termquerystringyesnone
monthly_home_insurancequerystringyesnone
hoa_feesquerystringyesnone
percent_tax_ratequerystringyesnone
show_amortizationquerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /finance/average-rate

GET /api/finance/average-rate

Params

NameLocationTypeRequiredDescription
postal_codequerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

GET /finance/rate-trends

GET /api/finance/rate-trends

Params

NameLocationTypeRequiredDescription
is_refinancequerystringyesnone

> Response Examples

> 200 Response

{}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKSuccessInline

Responses Data Schema

Data Schema