# Property Search API Searchable API for list building, search counts, and advanced filtering on properties. You can also use this API to implement your own comparables API, or property analytics API. Questions? Contact our team to ask us for best practices with using this API.This API implements easy paging so your apps can easily manage filtered results in a results pane with paging. When your user clicks on a result, just use the id from this API to get the full property results using the Property Detail API. Questions on best practices for implementing paged property results in your app? Just contact our team. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "property-apis", "version": "1.0" }, "servers": [ { "url": "https://api.realestateapi.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "security": [ { "sec0": [] } ], "paths": { "/v2/PropertySearch": { "post": { "summary": "Property Search API", "description": "Searchable API for list building, search counts, and advanced filtering on properties. You can also use this API to implement your own comparables API, or property analytics API. Questions? Contact our team to ask us for best practices with using this API.This API implements easy paging so your apps can easily manage filtered results in a results pane with paging. When your user clicks on a result, just use the id from this API to get the full property results using the Property Detail API. Questions on best practices for implementing paged property results in your app? Just contact our team.", "operationId": "property-search-api", "parameters": [ { "name": "x-api-key", "in": "header", "description": "User's API key", "required": true, "schema": { "type": "string" } }, { "name": "x-user-id", "in": "header", "description": "Denote a unique user identifier to this api call by passing it in this header field", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "boolean", "description": "Set to true to only return the count for the total number of records that would be returned for the search and not the records themselves." }, "ids": { "type": "array", "description": "Provide a list of property IDs from past or saved Property Searches to pull back all of the enriched fields", "items": { "type": "integer", "format": "int32" } }, "ids_only": { "type": "boolean", "description": "Returns up to 10,000 property IDs matching your search criteria. When provided, the \"size\" and \"resultIndex\" will be ignored.", "default": false }, "obfuscate": { "type": "boolean", "description": "Will remove the address and name fields on the properties returned", "default": false }, "sort": { "type": "object", "description": "Sorts result set based on user defined sorting definitions across the Property Search fields", "properties": {} }, "summary": { "type": "boolean", "description": "Returns an aggregation of all lead types in a summary object. The summary object will return totals for each lead type within the context of the given search.", "default": false }, "resultIndex": { "type": "integer", "description": "Used with size to accomplish paging. The server will skip the number of records specified by resultIndex, and return the records starting after the resultIndex. The total number of records returned will not be greater than the size specified, or a max of 250 set by the server.", "format": "int32" }, "size": { "type": "integer", "description": "Set to the maximum number of records that the server can return for the search. Used in conjunction with resultIndex for paging results.", "default": 50, "format": "int32" }, "address": { "type": "string", "description": "Fully formatted address for a property search. This should include house, street, city, state and zip" }, "house": { "type": "string", "description": "Used to search for specific house numbers. Must be accompanied with state or zip to limit results." }, "street": { "type": "string", "description": "Used to search searching street names only. Must be accompanied with state or zip to limit results." }, "city": { "type": "string", "description": "Used to search within a city only. Must be accompanied with state or zip to limit results." }, "state": { "type": "string", "description": "Used to search within a state. Must be accompanied by city, house, or street to limit results." }, "county": { "type": "string", "description": "Used to search within a county. Must be accompanied by state, or zip." }, "zip": { "type": "string", "description": "Used to search within a US zip code. An array of zips (of type:string) can also be provided to this field." }, "latitude": { "type": "number", "description": "If latitude & longitude are provided, the search radius will be calculated with that set of coordinates as center", "format": "float" }, "longitude": { "type": "number", "description": "If latitude & longitude are provided, the search radius will be calculated with that set of coordinates as center", "format": "float" }, "radius": { "type": "number", "description": "Provide a search radius between 0.1-10 miles for narrowing your search", "format": "float" }, "polygon": { "type": "array", "description": "Provide an array of latitude/longitude pairs for the Geo portion of your query", "items": { "properties": { "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" } }, "type": "object" } }, "multi_polygon": { "type": "array", "description": "Minimum of 1 polygon", "items": { "properties": { "boundaries": { "type": "array", "items": { "properties": { "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" } }, "type": "object" } } }, "type": "object" } }, "property_type": { "type": "string", "description": "Provide the type of residences/properties you are looking for", "enum": [ "SFR", "MFR", "LAND", "CONDO", "MOBILE", "OTHER" ] }, "property_use_code": { "type": "integer", "description": "Also accepts an Array of Integers, where each integer is one of our accepted Property Use Codes. See all codes here: https://developer.realestateapi.com/reference/property-use-codes-reference", "format": "int32" }, "mls_active": { "type": "boolean", "description": "Find active MLS listings" }, "mls_pending": { "type": "boolean", "description": "Find pending MLS sales that are expected to close" }, "mls_cancelled": { "type": "boolean", "description": "Find terminated MLS listings" }, "mls_sold": { "type": "boolean", "description": "Find sold MLS listings" }, "mls_days_on_market_min": { "type": "integer", "description": "Find properties that have been on the market for a certain amount of days. Use with \"mls_active\": true, \"mls_pending\": true or \"mls_cancelled\": true", "format": "int32" }, "mls_days_on_market_max": { "type": "integer", "format": "int32" }, "mls_listing_price_min": { "type": "integer", "description": "Lower bound used with mls_listing_max to only find properties with MLS listing prices within a defined range", "format": "int32" }, "mls_listing_price_max": { "type": "integer", "description": "Minimum value of 1", "format": "int32" }, "mls_listing_price": { "type": "integer", "description": "The official MLS listing price for the property", "format": "int32" }, "mls_listing_price_operator": { "type": "string", "description": "mls_operator is to be used with mls_listing_price to indicate a range less than or greater than starting with that listing price. For example, { mls_listing_price: 100000, mls_operator: 'gte' } would retrieve all properties with an MLS listing price of $100,000 or more", "enum": [ "lt", "lte", "gt", "gte" ] }, "id": { "type": "string", "description": "AutoComplete Field. Can be a string or an integer. Represents the unique property id in the case of full address autocomplete searches." }, "apn": { "type": "string", "description": "AutoComplete Field. The Property's unique tax assessor identifier, returned as part of the AutoComplete API response." }, "stateId": { "type": "string", "description": "AutoComplete Field." }, "countyId": { "type": "string", "description": "AutoComplete Field." }, "neighborhood_id": { "type": "integer", "description": "Autocomplete field.", "format": "int32" }, "neighborhood_name": { "type": "string", "description": "Autocomplete field." }, "searchType": { "type": "string", "description": "AutoComplete Field. A = full address ; C = city ; N = county; S = street ; Z = zip; G = neighborhood; T = state", "enum": [ "A", "C", "N", "S", "Z", "G", "T" ] }, "fips": { "type": "string", "description": "AutoComplete Field." }, "title": { "type": "string", "description": "AutoComplete Field." }, "usps_mail_state": { "type": "string", "description": "Filter for properties with a specific USPS mailing state" }, "absentee_owner": { "type": "boolean", "description": "Used for searching for properties where the owner is not currently a resident. Generally signifies a tenant or non-owner occupied property." }, "adjustable_rate": { "type": "boolean", "description": "Indicates if the current mortgage on the property has an adjustable rate." }, "assumable": { "type": "boolean", "description": "Indicates if the mortgage on a given property is assumable." }, "attic": { "type": "boolean" }, "auction": { "type": "boolean", "description": "Used to find properties with an auction date. Used with search_range or a default max of 1 year." }, "basement": { "type": "boolean", "description": "Used to find properties with a basement." }, "breezeway": { "type": "boolean" }, "carport": { "type": "boolean", "description": "Indicates properties with a carport structure." }, "cash_buyer": { "type": "boolean", "description": "Indicates if the property ownership is subsequent to an all cash transaction" }, "corporate_owned": { "type": "boolean", "description": "Used to find properties where one of the owners is company." }, "death": { "type": "boolean", "description": "Used to find properties where the property owner on the deed is recently deceased. Can be used for probate lists." }, "deck": { "type": "boolean", "description": "Used to find properties that have a deck" }, "feature_balcony": { "type": "boolean", "description": "Used to find properties with a balcony." }, "fire_sprinklers": { "type": "boolean", "description": "Used to find properties with registered fire sprinkler fixtures." }, "flood_zone": { "type": "boolean", "description": "Indicates if the property is in a flood zone area. This flag can be used in conjunction with \"flood_zone_type\" to get more specific result sets." }, "foreclosure": { "type": "boolean", "description": "Used to find properties in foreclosure. Used with search_range or a default max of 1 year." }, "free_clear": { "type": "boolean", "description": "Used to find properties without an open mortgage." }, "garage": { "type": "boolean", "description": "Used to find properties with a physical structure marked for garage use." }, "high_equity": { "type": "boolean", "description": "Indicates properties with high equity (>39%)" }, "hoa": { "type": "boolean", "description": "Filter for properties that have an HOA" }, "individual_owned": { "type": "boolean", "description": "Filter for properties only owned by an Individual (not LLC or Trust)" }, "inherited": { "type": "boolean", "description": "Set to true to search inherited properties" }, "in_state_owner": { "type": "boolean", "description": "Used to find properties with an owner whose mailing address is in the same state as the property address." }, "investor_buyer": { "type": "boolean", "description": "Signals that the property was cash purchased by an absentee owner/investor, rather than individual like with the cash_buyer flag" }, "judgment": { "type": "boolean", "description": "Used to find properties where a lawsuit has been filed against a property owner or a party involved in a real estate transaction, and the court rules in favor of one of the parties, and issued a judgment." }, "last_sale_arms_length": { "type": "boolean", "description": "Setting this to \"true\" will filter out transfers and other non-arms length transaction types. Use in conjunction with last_sale_date_min/max" }, "mfh_2to4": { "type": "boolean", "description": "Multi-family homes with 2 to 4 units" }, "mfh_5plus": { "type": "boolean", "description": "Multi-family homes with 5 or more units" }, "out_of_state_owner": { "type": "boolean", "description": "Used to find properties with an owner whose mailing address is in a different state as the property address." }, "patio": { "type": "boolean", "description": "Used to find properties with a patio" }, "pool": { "type": "boolean", "description": "Used to find properties with a pool" }, "pre_foreclosure": { "type": "boolean", "description": "Used to find poperties that have received any notice of preforeclosure. Used with search_range or a default max of 1 year." }, "prior_owner_individual": { "type": "boolean", "description": "Helps determine what properties are the result of a Flip. Use with \"prior_owner_months_owned_min\"/\"prior_owner_months_owned_max\"" }, "private_lender": { "type": "boolean", "description": "Returns all properties that are currently financed by a private lender" }, "quit_claim": { "type": "boolean", "description": "Indicates if the property ownership was subsequent to a quit claim" }, "reo": { "type": "boolean", "description": "Used to find properties owned by a bank, trust, services entity, or tax entity. Used with search_range or a default max of 1 year." }, "rv_parking": { "type": "boolean", "description": "The property is designated as having RV Parking" }, "tax_lien": { "type": "boolean", "description": "Find properties where there is a tax lien against the property" }, "trust_owned": { "type": "boolean", "description": "The property is owned by a Trust" }, "vacant": { "type": "boolean", "description": "Used to find properties that are vacant" }, "census_block": { "type": "string", "description": "Values 1000-5000" }, "census_block_group": { "type": "string", "description": "Values 0-10" }, "census_tract": { "type": "string", "description": "Official tract number from the U.S. Census Bureau" }, "construction": { "type": "string", "description": "Full list of construction types: https://developer.realestateapi.com/reference/construction-types" }, "document_type_code": { "type": "string", "description": "Used to find a specific document type for more granular searches other than the booleans provided. This field can also be assigned an array of document type codes. Used in conjunction with search_range, or a maximum default value of 1 year." }, "flood_zone_type": { "type": "string", "description": "B, C, X (for moderate to low risk areas); A, AE, A1-30, AH, AO, AR, A99, V, VE, V1 - V30 (High Risk - Coastal Areas); D (Undetermined Risk Zone)" }, "loan_type_code_first": { "type": "string", "description": "Refer to the Loan Codes that are searchable://developer.realestateapi.com/reference/loan-type-codes" }, "loan_type_code_second": { "type": "string" }, "loan_type_code_third": { "type": "string" }, "notice_type": { "type": "string", "description": "Search by the Recording Date of the .foreclosureInfo data for the specified notice type", "enum": [ "FOR", "NOD", "NOL", "NTS", "REO" ] }, "parcel_account_number": { "type": "string", "description": "e.g. 05-00925.01" }, "roof_construction_code": { "type": "integer", "description": "Accepts an array or single integer code value. See all possible values here: https://developer.realestateapi.com/reference/roof-construction-codes", "format": "int32" }, "roof_material_code": { "type": "integer", "description": "Accepts an array or single integer code value. See all possible values here: https://developer.realestateapi.com/reference/roof-materials-codes", "format": "int32" }, "search_range": { "type": "string", "description": "Used in conjunction for reo, auction, foreclosure, and preforeclosure searches to limit the search to only return records where the event happened within the provided range. All ranges work from NOW back to the provided range.", "enum": [ "1_MONTH", "2_MONTH", "3_MONTH", "6_MONTH", "1_YEAR" ] }, "sewage": { "type": "string", "description": "Options: Municipal, Yes, Septic, None, Storm" }, "water_source": { "type": "string", "description": "Full list of water source types you can filter by: https://developer.realestateapi.com/reference/water-source-searches" }, "estimated_equity": { "type": "integer", "description": "Used in conjunction with the equity_percent_operator to find properties where the estimated equity amount is greater than or less than the value provided. Equity dollar amount is computed as the difference of the estimated value less any known open mortgages.", "format": "int32" }, "equity_operator": { "type": "string", "description": "Comparison operator for searches using estimated_equity. Returns properties based on a greater than, or less than operation coupled with the value provided for estimated_equity which is based on total dollars of equity estimated from the estimated value and any known open mortgages.", "enum": [ "lt", "lte", "gt", "gte" ] }, "equity_percent": { "type": "integer", "description": "Used in conjunction with the equity_percent_operator to find properties where the equity percentage is greater than or less than the value provided. Equity percentage is a based on the difference of the computed LTV.", "format": "int32" }, "equity_percent_operator": { "type": "string", "description": "Comparison operator for searches using equity_percent. Returns properties based on a greater than, or less than operation coupled with the value provided for equity_percent which is based on the difference of the calculated LTV.", "enum": [ "lt", "lte", "gt", "gte" ] }, "last_sale_date": { "type": "string", "description": "Find properties based on the date of the last sale history transaction", "format": "date" }, "last_sale_date_operator": { "type": "string", "description": "Used in conjunction with \"last_sale_date\" to find properties that satisfy the range for when they were last sold in a transaction.", "enum": [ "lt", "lte", "gt", "gte" ] }, "median_income": { "type": "integer", "description": "Find properties based on the median income of the Areas that contain the properties", "format": "int32" }, "median_income_operator": { "type": "string", "description": "Used in conjunction with the \"median_income\" field in order to specify the range lower or higher you want to look at from the given median_income.", "enum": [ "lt", "lte", "gt", "gte" ] }, "years_owned": { "type": "integer", "description": "Number value of the years owned you are searching for. To be used with years_owned_operator", "format": "int32" }, "years_owned_operator": { "type": "string", "description": "Operator for less than and greater than searches on years_owned field", "enum": [ "lt", "lte", "gt", "gte" ] }, "assessed_improvement_value_min": { "type": "integer", "description": "Value range search against the county assessed improvement value", "format": "int32" }, "assessed_improvement_value_max": { "type": "integer", "format": "int32" }, "assessed_land_value_min": { "type": "integer", "description": "Value range search against the county assessed land value", "format": "int32" }, "assessed_land_value_max": { "type": "integer", "format": "int32" }, "assessed_value_min": { "type": "integer", "description": "Value range search against the county assessed value", "format": "int32" }, "assessed_value_max": { "type": "integer", "format": "int32" }, "auction_date_min": { "type": "string", "description": "filter on dates of upcoming foreclosure auctions (e.g. Current Date \"2024-05-01\" & set a future date range of \"2024-05-15\" to \"2024-05-30\"). Use with \"auction\": true", "format": "date" }, "auction_date_max": { "type": "string", "format": "date" }, "baths_min": { "type": "integer", "description": "Used for searching a range of properties with bathrooms between a min and max. Minimum numbers of bathrooms for the given property search", "format": "int32" }, "baths_max": { "type": "integer", "description": "Used for searching a range of properties with bathrooms between a min and max. Maximum numbers of bathrooms for the given property search", "format": "int32" }, "beds_min": { "type": "integer", "description": "Used for searching a range of properties with bedrooms between a min and max. Minimum numbers of bedrooms for the given property search", "format": "int32" }, "beds_max": { "type": "integer", "description": "Used for searching a range of properties with bedrooms between a min and max. Maximum numbers of bedrooms for the given property search", "format": "int32" }, "building_size_min": { "type": "integer", "description": "Used for searching a range of properties with an interior, living square footage between a min and max. Minimum square footage of the interior living space for the given property search", "format": "int32" }, "building_size_max": { "type": "integer", "description": "Used for searching a range of properties with an interior, living square footage between a min and max. Maximum square footage of the interior living space for the given property search", "format": "int32" }, "deck_area_min": { "type": "integer", "description": "In sq. ft.", "format": "int32" }, "deck_area_max": { "type": "string", "description": "In sq. ft." }, "estimated_equity_min": { "type": "integer", "description": "Filter for properties based on the nominal value of equity owners have in their homes. Works well with \"value_min\"/\"value_max\".", "format": "int32" }, "estimated_equity_max": { "type": "integer", "format": "int32" }, "foreclosure_date_min": { "type": "string", "description": "Filter for properties based on a date range for when a specific Foreclosure document was recorded - use with \"foreclosure\": true & \"notice_type\"", "format": "date" }, "foreclosure_date_max": { "type": "string", "format": "date" }, "last_sale_date_min": { "type": "string", "description": "Minimum Date for the last sale transaction date", "format": "date" }, "last_sale_date_max": { "type": "string", "description": "Maximum Date for the last sale transaction date", "format": "date" }, "last_sale_price_min": { "type": "integer", "description": "Filter for properties based on a Last Sale Price range.", "format": "int32" }, "last_sale_price_max": { "type": "integer", "format": "int32" }, "lot_size_min": { "type": "integer", "description": "Used for searching a range of properties with lot sizes between a min and max. Minimum square footage of the exterior lot built for the given property search", "format": "int32" }, "lot_size_max": { "type": "integer", "description": "Used for searching a range of properties with lot sizes between a min and max. Maximum square footage of the exterior lot built for the given property search", "format": "int32" }, "ltv_min": { "type": "integer", "description": "Min. of 0", "format": "int32" }, "ltv_max": { "type": "string", "description": "Max of 100" }, "median_income_min": { "type": "integer", "description": "Filter for properties that are within a certain range of median income (Zipcode-level)", "format": "int32" }, "median_income_max": { "type": "integer", "format": "int32" }, "mortgage_min": { "type": "integer", "description": "Used for searching a range of properties with an estimated total of open mortgages between a min and max. Minimum estimated amount for all open mortgages for the given property search.", "format": "int32" }, "mortgage_max": { "type": "integer", "description": "Used for searching a range of properties with an estimated total of open mortgages between a min and max. Maximum estimated amount for all open mortgages for the given property search.", "format": "int32" }, "rooms_min": { "type": "integer", "description": "Used for setting the minimum on the number of total rooms you want your properties to have.", "format": "int32" }, "rooms_max": { "type": "integer", "description": "Used for setting the maximum on the number of total rooms you want your properties to have.", "format": "int32" }, "pool_area_min": { "type": "integer", "description": "In sq. ft.", "format": "int32" }, "pool_area_max": { "type": "integer", "description": "In sq. ft.", "format": "int32" }, "portfolio_equity_min": { "type": "integer", "description": "Used to find properties where the minimum ownership interest or the stake that an investor has in the portfolio is as specified. Portfolio equity is the difference between the total value of the portfolio and any outstanding debts or liabilities related to the portfolio.", "format": "int32" }, "portfolio_equity_max": { "type": "integer", "description": "Used to find properties where the maximum ownership interest or the stake that an investor has in the portfolio is as specified. Portfolio equity is the difference between the total value of the portfolio and any outstanding debts or liabilities related to the portfolio.", "format": "int32" }, "portfolio_mortgage_balance_min": { "type": "integer", "description": "Filter for properties based on the remaining open mortgage balance of the Portfolio for Owners with > 1 property", "format": "int32" }, "portfolio_mortgage_balance_max": { "type": "integer", "format": "int32" }, "portfolio_purchased_last12_min": { "type": "integer", "format": "int32" }, "portfolio_purchased_last12_max": { "type": "integer", "format": "int32" }, "portfolio_purchased_last6_min": { "type": "integer", "format": "int32" }, "portfolio_purchased_last6_max": { "type": "integer", "format": "int32" }, "portfolio_value_min": { "type": "integer", "description": "Filter for properties based on the Total Value of the Portfolio for Owners with > 1 property", "format": "int32" }, "portfolio_value_max": { "type": "integer", "format": "int32" }, "pre_foreclosure_date_min": { "type": "string", "description": "Filter by the Recording Date of Pre-Foreclosure Related Documents. Use with \"pre_foreclosure\": true", "format": "date" }, "pre_foreclosure_date_max": { "type": "string", "format": "date" }, "prior_owner_months_owned_min": { "type": "integer", "description": "Define the time range for what constitutes a \"Flip\" period between the last 2 transactions", "format": "int32" }, "prior_owner_months_owned_max": { "type": "integer", "format": "int32" }, "properties_owned_min": { "type": "integer", "description": "The minimum amount of total properties that any property owner's portfolio will have for each property returned.", "format": "int32" }, "properties_owned_max": { "type": "integer", "description": "The maximum amount of total properties that any property owner's portfolio will have for each property returned.", "format": "int32" }, "stories_min": { "type": "integer", "description": "The minimum amount of floors/stories you want properties in your response to have", "format": "int32" }, "stories_max": { "type": "integer", "description": "The maximum amount of floors/stories you want properties in your response to have", "format": "int32" }, "tax_delinquent_year_min": { "type": "integer", "description": "2019 - 2022 range yields most results. Matching Min & Max will give a single year range.", "format": "int32" }, "tax_delinquent_year_max": { "type": "integer", "description": "2019 - 2022 range yields most results. Matching Min & Max will give a single year range.", "format": "int32" }, "units_min": { "type": "integer", "description": "The minimum amount of individual units that the property contains", "format": "int32" }, "units_max": { "type": "integer", "description": "The maximum amount of individual units that the property contains", "format": "int32" }, "value_min": { "type": "integer", "description": "Used for searching a range of properties with an estimated value between a min and max. Minimum estimated value for the given property search", "format": "int32" }, "value_max": { "type": "integer", "description": "Used for searching a range of properties with an estimated value between a min and max. Maximum estimated value for the given property search.", "format": "int32" }, "year_min": { "type": "integer", "description": "**Deprecation Notice** (replace with year_built_min). Used for searching a range of properties built between a min and max. Minimum year built for the given property search", "format": "int32" }, "year_max": { "type": "integer", "description": "**Deprecation Notice** (replace with year_built_min). Used for searching a range of properties built between a min and max. Maximum year built for the given property search", "format": "int32" }, "year_built_min": { "type": "integer", "description": "Used for searching a range of properties built between a min and max. Minimum year built for the given property search", "format": "int32" }, "year_built_max": { "type": "integer", "description": "Used for searching a range of properties built between a min and max. Minimum year built for the given property search", "format": "int32" }, "years_owned_min": { "type": "integer", "description": "Number value for lower bound of a range search for years_owned. Used in conjunction with years_owned_max", "format": "int32" }, "years_owned_max": { "type": "integer", "description": "Number value for lower bound of a range search for years_owned. Used in conjunction with years_owned_min.", "format": "int32" }, "last_update_date_min": { "type": "string", "description": "fetch property IDs of properties that have been updated in a given time range.", "format": "date" }, "last_update_date_max": { "type": "string", "format": "date" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Build a List of Properties": { "value": "{\n \"live\": true,\n \"input\": {\n \"count\": false,\n \"mls_active\":true,\n \"city\": \"Herndon\",\n \"state\": \"VA\"\n },\n \"data\": [\n {\n \"absenteeOwner\": false,\n \"address\": {\n \"address\": \"13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"13723 Neil Armstrong Ave Unit 308\",\n \"zip\": \"20171\"\n },\n \"adjustableRate\": false,\n \"airConditioningAvailable\": false,\n \"assessedImprovementValue\": 326590,\n \"assessedLandValue\": 82000,\n \"assessedValue\": 408590,\n \"auction\": false,\n \"basement\": false,\n \"bathrooms\": 2,\n \"bedrooms\": 2,\n \"cashBuyer\": false,\n \"corporateOwned\": false,\n \"death\": false,\n \"distressed\": false,\n \"documentType\": \"Grant Deed\",\n \"documentTypeCode\": \"DTGD\",\n \"equity\": false,\n \"equityPercent\": 38,\n \"estimatedEquity\": 189084,\n \"estimatedValue\": 490308,\n \"floodZone\": true,\n \"floodZoneDescription\": \"AREA OF MINIMAL FLOOD HAZARD\",\n \"floodZoneType\": \"X\",\n \"foreclosure\": false,\n \"forSale\": false,\n \"freeClear\": false,\n \"garage\": false,\n \"highEquity\": false,\n \"id\": \"253175355\",\n \"inherited\": false,\n \"inStateAbsenteeOwner\": false,\n \"investorBuyer\": false,\n \"landUse\": \"Residential\",\n \"lastMortgage1Amount\": null,\n \"lastSaleAmount\": \"418000\",\n \"lastSaleDate\": \"2020-07-23\",\n \"latitude\": 38.920743,\n \"lenderName\": \"One American Mtg\",\n \"listingAmount\": null,\n \"longitude\": -77.421772,\n \"lotSquareFeet\": 0,\n \"mailAddress\": {\n \"address\": \"13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"13723 Neil Armstrong Ave Unit 308\",\n \"zip\": \"20171\"\n },\n \"medianIncome\": \"150066\",\n \"MFH2to4\": false,\n \"MFH5plus\": false,\n \"mlsActive\": true,\n \"mlsCancelled\": false,\n \"mlsDaysOnMarket\": 101,\n \"mlsFailed\": false,\n \"mlsHasPhotos\": false,\n \"mlsLastSaleDate\": \"2020-07-23\",\n \"mlsLastStatusDate\": \"2023-04-15\",\n \"mlsListingDate\": \"2023-04-15\",\n \"mlsListingPrice\": 2500,\n \"mlsPending\": false,\n \"mlsSold\": false,\n \"mlsStatus\": \"Active\",\n \"mlsType\": \"ForSale\",\n \"negativeEquity\": false,\n \"neighborhood\": {\n \"center\": \"POINT(-77.421701188095 38.919564722822)\",\n \"id\": \"63205\",\n \"name\": \"Discovery Square\",\n \"type\": \"subdivision\"\n },\n \"openMortgageBalance\": 313500,\n \"outOfStateAbsenteeOwner\": false,\n \"owner1FirstName\": \"Attili\",\n \"owner1LastName\": \"Srinivas\",\n \"owner2FirstName\": \"Attili\",\n \"owner2LastName\": \"Manjusha\",\n \"ownerOccupied\": true,\n \"preForeclosure\": false,\n \"privateLender\": false,\n \"propertyId\": \"253175355\",\n \"propertyType\": \"CONDO\",\n \"propertyUse\": \"Condominium\",\n \"propertyUseCode\": 366,\n \"rentAmount\": null,\n \"reo\": false,\n \"roomsCount\": 5,\n \"squareFeet\": 1323,\n \"suggestedRent\": \"2070\",\n \"unitsCount\": 0,\n \"vacant\": false,\n \"yearBuilt\": 2015,\n \"yearsOwned\": 3\n }\n ],\n \"resultCount\": 156,\n \"resultIndex\": 50,\n \"recordCount\": 50,\n \"statusCode\": 200,\n \"statusMessage\": \"success\",\n \"requestExecutionTimeMS\": \"126ms\"\n}" } }, "schema": { "oneOf": [ { "title": "Build a List of Properties", "type": "object", "properties": { "live": { "type": "boolean", "example": true, "default": true }, "input": { "type": "object", "properties": { "count": { "type": "boolean", "example": false, "default": true }, "mls_active": { "type": "boolean", "example": true, "default": true }, "city": { "type": "string", "example": "Herndon" }, "state": { "type": "string", "example": "VA" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "absenteeOwner": { "type": "boolean", "example": false, "default": true }, "address": { "type": "object", "properties": { "address": { "type": "string", "example": "13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171" }, "city": { "type": "string", "example": "Herndon" }, "county": { "type": "string", "example": "Fairfax" }, "state": { "type": "string", "example": "VA" }, "street": { "type": "string", "example": "13723 Neil Armstrong Ave Unit 308" }, "zip": { "type": "string", "example": "20171" } } }, "adjustableRate": { "type": "boolean", "example": false, "default": true }, "airConditioningAvailable": { "type": "boolean", "example": false, "default": true }, "assessedImprovementValue": { "type": "integer", "example": 326590, "default": 0 }, "assessedLandValue": { "type": "integer", "example": 82000, "default": 0 }, "assessedValue": { "type": "integer", "example": 408590, "default": 0 }, "auction": { "type": "boolean", "example": false, "default": true }, "basement": { "type": "boolean", "example": false, "default": true }, "bathrooms": { "type": "integer", "example": 2, "default": 0 }, "bedrooms": { "type": "integer", "example": 2, "default": 0 }, "cashBuyer": { "type": "boolean", "example": false, "default": true }, "corporateOwned": { "type": "boolean", "example": false, "default": true }, "death": { "type": "boolean", "example": false, "default": true }, "distressed": { "type": "boolean", "example": false, "default": true }, "documentType": { "type": "string", "example": "Grant Deed" }, "documentTypeCode": { "type": "string", "example": "DTGD" }, "equity": { "type": "boolean", "example": false, "default": true }, "equityPercent": { "type": "integer", "example": 38, "default": 0 }, "estimatedEquity": { "type": "integer", "example": 189084, "default": 0 }, "estimatedValue": { "type": "integer", "example": 490308, "default": 0 }, "floodZone": { "type": "boolean", "example": true, "default": true }, "floodZoneDescription": { "type": "string", "example": "AREA OF MINIMAL FLOOD HAZARD" }, "floodZoneType": { "type": "string", "example": "X" }, "foreclosure": { "type": "boolean", "example": false, "default": true }, "forSale": { "type": "boolean", "example": false, "default": true }, "freeClear": { "type": "boolean", "example": false, "default": true }, "garage": { "type": "boolean", "example": false, "default": true }, "highEquity": { "type": "boolean", "example": false, "default": true }, "id": { "type": "string", "example": "253175355" }, "inherited": { "type": "boolean", "example": false, "default": true }, "inStateAbsenteeOwner": { "type": "boolean", "example": false, "default": true }, "investorBuyer": { "type": "boolean", "example": false, "default": true }, "landUse": { "type": "string", "example": "Residential" }, "lastMortgage1Amount": {}, "lastSaleAmount": { "type": "string", "example": "418000" }, "lastSaleDate": { "type": "string", "example": "2020-07-23" }, "latitude": { "type": "number", "example": 38.920743, "default": 0 }, "lenderName": { "type": "string", "example": "One American Mtg" }, "listingAmount": {}, "longitude": { "type": "number", "example": -77.421772, "default": 0 }, "lotSquareFeet": { "type": "integer", "example": 0, "default": 0 }, "mailAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "13723 Neil Armstrong Ave Unit 308, Herndon, Va 20171" }, "city": { "type": "string", "example": "Herndon" }, "county": { "type": "string", "example": "Fairfax" }, "state": { "type": "string", "example": "VA" }, "street": { "type": "string", "example": "13723 Neil Armstrong Ave Unit 308" }, "zip": { "type": "string", "example": "20171" } } }, "medianIncome": { "type": "string", "example": "150066" }, "MFH2to4": { "type": "boolean", "example": false, "default": true }, "MFH5plus": { "type": "boolean", "example": false, "default": true }, "mlsActive": { "type": "boolean", "example": true, "default": true }, "mlsCancelled": { "type": "boolean", "example": false, "default": true }, "mlsDaysOnMarket": { "type": "integer", "example": 101, "default": 0 }, "mlsFailed": { "type": "boolean", "example": false, "default": true }, "mlsHasPhotos": { "type": "boolean", "example": false, "default": true }, "mlsLastSaleDate": { "type": "string", "example": "2020-07-23" }, "mlsLastStatusDate": { "type": "string", "example": "2023-04-15" }, "mlsListingDate": { "type": "string", "example": "2023-04-15" }, "mlsListingPrice": { "type": "integer", "example": 2500, "default": 0 }, "mlsPending": { "type": "boolean", "example": false, "default": true }, "mlsSold": { "type": "boolean", "example": false, "default": true }, "mlsStatus": { "type": "string", "example": "Active" }, "mlsType": { "type": "string", "example": "ForSale" }, "negativeEquity": { "type": "boolean", "example": false, "default": true }, "neighborhood": { "type": "object", "properties": { "center": { "type": "string", "example": "POINT(-77.421701188095 38.919564722822)" }, "id": { "type": "string", "example": "63205" }, "name": { "type": "string", "example": "Discovery Square" }, "type": { "type": "string", "example": "subdivision" } } }, "openMortgageBalance": { "type": "integer", "example": 313500, "default": 0 }, "outOfStateAbsenteeOwner": { "type": "boolean", "example": false, "default": true }, "owner1FirstName": { "type": "string", "example": "Attili" }, "owner1LastName": { "type": "string", "example": "Srinivas" }, "owner2FirstName": { "type": "string", "example": "Attili" }, "owner2LastName": { "type": "string", "example": "Manjusha" }, "ownerOccupied": { "type": "boolean", "example": true, "default": true }, "preForeclosure": { "type": "boolean", "example": false, "default": true }, "privateLender": { "type": "boolean", "example": false, "default": true }, "propertyId": { "type": "string", "example": "253175355" }, "propertyType": { "type": "string", "example": "CONDO" }, "propertyUse": { "type": "string", "example": "Condominium" }, "propertyUseCode": { "type": "integer", "example": 366, "default": 0 }, "rentAmount": {}, "reo": { "type": "boolean", "example": false, "default": true }, "roomsCount": { "type": "integer", "example": 5, "default": 0 }, "squareFeet": { "type": "integer", "example": 1323, "default": 0 }, "suggestedRent": { "type": "string", "example": "2070" }, "unitsCount": { "type": "integer", "example": 0, "default": 0 }, "vacant": { "type": "boolean", "example": false, "default": true }, "yearBuilt": { "type": "integer", "example": 2015, "default": 0 }, "yearsOwned": { "type": "integer", "example": 3, "default": 0 } } } }, "resultCount": { "type": "integer", "example": 156, "default": 0 }, "resultIndex": { "type": "integer", "example": 50, "default": 0 }, "recordCount": { "type": "integer", "example": 50, "default": 0 }, "statusCode": { "type": "integer", "example": 200, "default": 0 }, "statusMessage": { "type": "string", "example": "success" }, "requestExecutionTimeMS": { "type": "string", "example": "126ms" } } }, { "title": "Property Count Example", "type": "object", "properties": { "input": { "type": "object", "properties": { "count": { "type": "boolean", "example": true, "default": true }, "zip": { "type": "string", "example": "08046" }, "beds_min": { "type": "integer", "example": 2, "default": 0 }, "beds_max": { "type": "integer", "example": 4, "default": 0 }, "baths_min": { "type": "integer", "example": 2, "default": 0 }, "baths_max": { "type": "integer", "example": 5, "default": 0 }, "equity": { "type": "integer", "example": 250000, "default": 0 }, "equity_comparison": { "type": "string", "example": "lt" } } }, "data": { "type": "array", "items": { "type": "object", "properties": {} } } } }, { "title": "Obfuscate Properties Example", "type": "object", "properties": { "input": { "type": "object", "properties": { "count": { "type": "boolean", "example": false, "default": true }, "obfuscate": { "type": "boolean", "example": true, "default": true }, "state": { "type": "string", "example": "VA" }, "city": { "type": "string", "example": "Arlington" } } }, "data": { "type": "array", "items": { "type": "object", "properties": {} } } } }, { "title": "Property Summary", "type": "object", "properties": { "input": { "type": "object", "properties": { "summary": { "type": "boolean", "example": true, "default": true }, "zip": { "type": "string", "example": "08046" }, "beds_min": { "type": "integer", "example": 2, "default": 0 }, "beds_max": { "type": "integer", "example": 4, "default": 0 }, "baths_min": { "type": "integer", "example": 2, "default": 0 }, "baths_max": { "type": "integer", "example": 5, "default": 0 }, "equity": { "type": "integer", "example": 250000, "default": 0 }, "equity_comparison": { "type": "string", "example": "lt" } } }, "data": { "type": "array" } } } ] } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "x-user-id", "value": "UniqueUserIdentifier" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```