An all purpose data dictionary for using Property Search to find properties & enrich them using the Property Detail API
| Property Search Filter Name(s) | Property Detail Property Name | Notes |
|---|---|---|
| Geo Fields | ||
| address | propertyInfo.address.address | |
| house | propertyInfo.address.house | |
| street | propertyInfo.address.street | |
| city | propertyInfo.address.city | |
| state | propertyInfo.address.state | Must be a valid 2 digit state code |
| county | propertyInfo.address.county | |
| zip | propertyInfo.address.zip | Must be exactly 5 digits |
| latitude | propertyInfo.latitude | Must have at least 6 digits of precision |
| longitude | propertyInfo.longitude | Must have at least 6 digits of precision |
| usps_mail_state | N/A | Check ownerInfo.mailAddress |
| census_block | lotInfo.censusBlock | Values 1000-5000 |
| census_block_group | lotInfo.censusBlockGroup | Values 0-10 |
| census_tract | lotInfo.censusTract | Official tract number from the U.S. Census Bureau |
| radius | ||
| MLS Fields | ||
| mls_active | mlsActive | |
| mls_pending | mlsPending | |
| mls_cancelled | mlsCancelled | |
| mls_sold | mlsSold | |
| mls_days_on_market_min / mls_days_on_market_max | mlsDaysOnMarket | |
| mls_listing_price | mlsListingPrice | Searches using mls_listing_price_operator, mls_listing_price_min, mls_listing_price_max can be validated against mlsListingPrice in the response |
| AutoComplete Params | ||
| id | id | |
| apn | lotInfo.apn or lotInfo.apnUnformatted | |
| stateId | N/A | |
| count | count | |
| countyId | N/A | |
| neighborhood_id | neighborhood.id | |
| neighborhood_name | neighborhood.name | |
| searchType | N/A | |
| fips | propertyInfo.address.fips | |
| title | N/A | |
| ids_only | ||
| resultIndex | ||
| summary | ||
| Boolean Filters | ||
| absentee_owner | absenteeOwner | |
| air_conditioning_available | airConditioningAvailable | |
| adjustable_rate | adjustableRate | |
| assumable | assumable | |
| attic | N/A | needs to be added to PD response |
| auction | auction | |
| basement | propertyInfo.basementSquareFeet | basementSquareFeet should be > 0 |
| breezeway | N/A | needs to be added to PD response |
| carport | propertyInfo.carport | |
| cash_buyer | cashBuyer | |
| corporate_owned | corporateOwned | |
| death | death | |
| deck | propertyInfo.deck | |
| equity | equity | check for estimatedEquity > 0 |
| feature_balcony | N/A | needs to be added to PD response |
| fire_sprinklers | propertyInfo.safetyFireSprinklers | |
| flood_zone | floodZone | |
| foreclosure | N/A | if set to true, check for existence of .foreclosureInfo and it's array length > 0 in PD responses |
| free_clear | freeClear | if set to true, results will have no .currentMortgages |
| garage | propertyInfo.garageSquareFeet | garageSquareFeet should be > 0 |
| high_equity | highEquity | |
| hoa | propertyInfo.hoa | |
| individual_owned | N/A | Check the .owner1LastName and/or .owner2LastName |
| inherited | inherited | |
| in_state_owner | inStateAbsenteeOwner | |
| investor_buyer | investorBuyer | |
| judgment | judgment | |
| last_sale_arms_length | lastSaleArmsLength | Use in conjunction with last_sale_date_min/max |
| mfh_2to4 | MFH2to4 | |
| mfh_5plus | MFH5plus | |
| negative_equity | N/A | equityPercent < 0 |
| out_of_state_owner | outOfStateAbsenteeOwner | |
| patio | propertyInfo.patio | |
| pool | propertyInfo.pool | |
| pre_foreclosure | preForeclosure | |
| price_reduced | priceReduced | |
| prior_owner_individual | lastSale.priorOwnerIndividual | |
| private_lender | N/A | |
| quit_claim | quitClaim | |
| reo | N/A | |
| rv_parking | propertyInfo.rvParking | |
| tax_lien | taxLien | |
| trust_owned | N/A | Check the .owner1LastName and/or .owner2LastName |
| vacant | vacant | |
| Enumeration Fields | ||
| construction | propertyInfo.construction | Different types of construction can be found at: Coming Soon |
| document_type_code | lastSale.documentTypeCode | Codes can be found at: <https://developer.realestateapi.com/reference/document-type-codes> |
| flood_zone_type | floodZoneType | To be used in conjunction with the flood_zone boolean |
| loan_type_code_first | loanTypeCodeFirst | To learn more about loan type searches go to: <https://developer.realestateapi.com/reference/loan-type-codes> |
| loan_type_code_second | loanTypeCodeSecond | |
| loan_type_code_third | loanTypeCodeThird | |
| notice_type | foreclosureInfo[x].documentType | Options: NOL, NOD, NOR, FOR; use reo boolean for REO notice type |
| property_type | propertyType | Options: SFR, MFR, CONDO, MOBILE, LAND, OTHER |
| property_use_code | propertyInfo.propertyUseCode | To learn more about property use codes go to: <https://developer.realestateapi.com/reference/property-use-codes-reference> |
| roof_construction_code | propertyInfo.roofConstruction | <https://developer.realestateapi.com/reference/roof-construction-codes> |
| roof_material_code | propertyInfo.roofMaterial | <https://developer.realestateapi.com/reference/roof-materials-codes> |
| search_range | N/A | Options: 1_MONTH, 2_MONTH, 3_MONTH, 6_MONTH, 1_YEAR |
| last_trustee_full_name | ||
| multi_polygon | Minimum of 1 polygon | |
| obfuscate | ||
| parcel_account_number | parcelAccountNumber | |
| polygon | ||
| sewage | ||
| tax_exemption_code | ||
| water_source | ||
| building_condition | ||
| Operator Search Fields | ||
| estimated_equity / equity_operator | estimatedEquity | |
| equity_percent / equity_percent_operator | equityPercent | |
| last_sale_date / last_sale_date_operator | lastSaleDate | |
| median_income / median_income_operator | demographics.medianIncome | |
| years_owned / years_owned_operator | ownerInfo.ownershipLength | |
| mls_listing_price_operator | ||
| Range Search Fields | ||
| assessed_improvement_value_min / assessed_improvement_value_max | taxInfo.assessedImprovementValue: | |
| assessed_land_value_min / assessed_land_value_max | taxInfo.assessedLandValue: | |
| assessed_value_min / assessed_value_max | taxInfo.assessedValue: | |
| auction_date_min / auction_date_max | ||
| baths_min / baths_max | propertyInfo.bathrooms | |
| beds_min / beds_max | propertyInfo.bedrooms | |
| building_size_min / building_size_max | propertyInfo.livingSquareFeet | This field is named with the "building_" prefix because we default to using buildingSquareFeet in the case where any properties have an unknown livingSquareFeet |
| deck_area_min / deck_area_max | propertyInfo.deckArea | |
| estimated_equity_min / estimated_equity_max | estimatedEquity | |
| estimated_mortgage_payment_min / estimated_mortgage_payment_max | estimatedMortgagePayment | |
| first_mortgage_percent_min / first_mortgage_percent_max | firstMortgagePercent | |
| first_mortgage_recording_date_min / first_mortgage_recording_date_max | ||
| foreclosure_date_min / foreclosure_date_max | ||
| improvement_value_percent_min / improvement_value_percent_max | improvementValuePercent | |
| last_sale_date_min / last_sale_date_max | lastSaleDate | |
| last_sale_price_min / last_sale_price_max | lastSalePrice | |
| last_judgment_amount_min / last_judgment_amount_max | ||
| last_opening_bid_amount_min / last_opening_bid_amount_max | ||
| last_update_date_min / last_update_date_max | lastUpdateDate | |
| listing_price_to_value_percent_min / listing_price_to_value_percent_max | ||
| ltv_min / ltv_max | ||
| lot_size_min / lot_size_max | lotInfo.lotSquareFeet | |
| median_income_min / median_income_max | demographics.medianIncome | |
| mls_listing_price_min / mls_listing_price_max | ||
| mortgage_min / mortgage_max | openMortgageBalance | |
| open_mortgage_percent_min / open_mortgage_percent_max | openMortgagePercent | |
| open_mortgages_min / open_mortgages_max | openMortgageBalance | |
| rooms_min / rooms_max | propertyInfo.roomsCount | |
| pool_area_min / pool_area_max | propertyInfo.poolArea | |
| portfolio_equity_min / portfolio_equity_max | linkedProperties.totalEquity | |
| portfolio_mortgage_balance_min / portfolio_mortgage_balance_max | linkedProperties.totalMortgageBalance | |
| portfolio_purchased_last12_min / portfolio_purchased_last12_max | portfolioPurchasedLast12Months | |
| portfolio_purchased_last6_min / portfolio_purchased_last6_max | portfolioPurchasedLast6Months | |
| portfolio_value_min / portfolio_value_max | linkedProperties.totalValue | |
| pre_foreclosure_date_min / pre_foreclosure_date_max | ||
| prior_owner_months_owned_min / prior_owner_months_owned_max | lastSale.priorOwnerMonthsOwned | |
| properties_owned_min / properties_owned_max | linkedProperties.totalOwned | |
| second_mortgage_percent_min / second_mortgage_percent_max | secondMortgagePercent | |
| second_mortgage_recording_date_min / second_mortgage_recording_date_max | ||
| stories_min / stories_max | propertyInfo.stories | |
| tax_delinquent_year_min / tax_delinquent_year_max | taxInfo.taxDelinquentYear | |
| third_mortgage_percent_min / third_mortgage_percent_max | thirdMortgagePercent | |
| third_mortgage_recording_date_min / third_mortgage_recording_date_max | ||
| units_min / units_max | propertyInfo.unitsCount | |
| value_min / value_max | estimatedValue | |
| year_min / year_max | ||
| year_built_min / year_built_max | propertyInfo.yearBuilt | |
| years_owned_min / years_owned_max | ownerInfo.ownershipLength |