# Property Detail API Comps, Mortgages, Mailing Addresses, Property Sales History & More! # 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/PropertyDetail": { "post": { "summary": "Property Detail API", "description": "Comps, Mortgages, Mailing Addresses, Property Sales History & More!", "operationId": "property-detail-api-1", "parameters": [ { "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": { "id": { "type": "string", "description": "The \"id\" property from the Property Search API result objects. If using this unique property ID for Property Detail, then no other fields are required." }, "comps": { "type": "boolean", "description": "Set to true if you would like to have houses nearby with conferable valuations returned as part of the response. ***Includes RealEstateAPI's special AVM for the property***", "default": false }, "exact_match": { "type": "boolean", "description": "only return matches that match your exact address or address parts, no fuzzy matching" }, "address": { "type": "string", "description": "A fully formatted address with the following format: 123 Main St, Arlington VA 22205. When this field is provided and is in the valid format, no other fields are required" }, "house": { "type": "string", "description": "House number field is to be used with the street, city, state, and zip fields (& unit if applicable)" }, "unit": { "type": "string", "description": "House unit number (for Apt. #'s, Suite #'s, etc.)" }, "street": { "type": "string", "description": "The street name of the property (e.g. Main St)" }, "city": { "type": "string", "description": "The city where the property is located" }, "state": { "type": "string", "description": "The 2 character state code for the property's state (e.g. VA = Virginia)" }, "county": { "type": "string", "description": "(*This field is not required for a fully formatted address*) The county where your search property is located." }, "zip": { "type": "string", "description": "Zipcodes need to be 5 digits" }, "apn": { "type": "string", "description": "The assessor's parcel number (APN) is a unique identifier for an address/parcel & is particularly helpful when looking up Land Parcels without House Numbers" }, "fips": { "type": "string", "description": "String of Length 5" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n input: {\n house: '17',\n street: 'Topeka Pass',\n city: 'Willingboro',\n state: 'NJ',\n zip: '08046'\n\t},\n data: {\n ownerInfo: [Object],\n deedInLieu: false,\n lotInfo: [Object],\n preForeclosure: false,\n absenteeOwner: false,\n warrantyDeed: false,\n lastSaleDate: '2021-12-16',\n id: 190787647,\n currentMortgages: [Array],\n taxLien: false,\n adjustableRate: false,\n vacant: false,\n mobileHome: false,\n sheriffsDeed: false,\n spousalDeath: false,\n equityPercent: 100,\n estimatedEquity: 349267,\n inStateAbsenteeOwner: false,\n reapi_loaded_at: '0',\n priorId: 1788050590,\n death: false,\n cashBuyer: true,\n mortgageHistory: [],\n ownerOccupied: true,\n outOfStateAbsenteeOwner: false,\n quitClaim: false,\n deathTransfer: false,\n bankOwned: false,\n propertyInfo: [Object],\n last_sale: [Object],\n estimatedValue: 349267,\n lien: false,\n propertyType: 'SFR',\n corporateOwned: false,\n openMortgageBalance: 0,\n privateLender: false,\n taxInfo: [Object],\n \"demographics\" : {\n\t\t\t\t\"medianIncome\" : \"130336\",\n \t\t\t\t\"suggestedRent\" : \"3010\",\n\t\t\t\t\"fmrYear\": \"2023\",\n\t\t\t\t\"fmrEfficiency\" : \"1750\",\n\t\t\t\t\"fmrOneBedroom\" : \"1780\",\n\t\t\t\t\"fmrTwoBedroom\" : \"2020\",\n\t\t\t\t\"fmrThreeBedroom\" : \"2530\",\n\t\t\t\t\"fmrFourBedroom\" : \"3010\",\n\t\t\t\t\"hudAreaName\" : \"Washington-Arlington-Alexandria, DC-VA-MD HUD Metro FMR Area\",\n \t\t\t\"hudAreaCode\" : \"METRO47900M47900\"\n\t\t\t},\n saleHistory: [Array],\n cashSale: false,\n foreclosureInfo: [],\n inherited: false,\n trusteeSale: false,\n lastSalePrice: '350000',\n equity: 274800,\n comps: [],\n reapiAvm: null\n },\n statusCode: 200,\n statusMessage: 'Success',\n credits: 0,\n live: true,\n requestExecutionTimeMS: '40ms',\n propertyLookupExecutionTimeMS: '40ms',\n compsLookupExecutionTimeMS: null\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n statusCode: 400,\n error: 'Bad Request',\n message: '\"value\" must be of type object',\n validation: { source: 'payload', keys: [ '' ] }\n}" } } } } }, "401": { "description": "401", "content": { "text/plain": { "examples": { "Result": { "value": "{\n statusCode: 401,\n error: 'Unauthorized Request',\n message: 'x-api-key must be valid',\n validation: {}\n}" } } } } }, "404": { "description": "404", "content": { "text/plain": { "examples": { "Result": { "value": "{\n statusCode: 404,\n error: 'Not Found',\n message: '',\n validation: { }\n}" } } } } }, "429": { "description": "429", "content": { "text/plain": { "examples": { "Result": { "value": "{\n statusCode: 429,\n error: 'Rate Limit Exceeded',\n message: '',\n validation: { }\n}" } } } } }, "500": { "description": "500", "content": { "text/plain": { "examples": { "Result": { "value": "{\n statusCode: 500,\n error: 'Server Error, Please Contact Support (dev@realestateapi.com)',\n message: '',\n validation: { }\n}" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "x-user-id", "value": "UniqueUserIdentifier" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```