v2

latestOpenAPI 3.1.22026-08-07853184.9 KB
Lookup Property

Lookup information on a property

The LookupProperty endpoint returns general information regarding a property.

The service requires at least one of the following input combinations:

Set A - addresskey

Set B - fips, apn

Set C - fips, account

Set D - mak

Set E - ff

Set F - a1, postal

Set G - a1, city, state

get/LookupProperty

Query parameters

colsstring

Columns - The column names or groups to be output.

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Delimit multiple columns with a ,.

For example: ColumnName,ColumnName.

Columns:

GrpAll - Recommended. Indicates to the Cloud API that all fields should be returned.

<details> <summary> <code>GrpParcel</code> - Parcel info </summary>
  • AccountNumber
  • AlternateAPN
  • APNYearChange (Deprecated)
  • County
  • FIPSCode
  • FormattedAPN
  • MapBook
  • MapPage
  • MinorCivilDivisionName
  • PreviousAPN
  • UnformattedAPN
  • YearAdded (Deprecated)
</details> <details> <summary> <code>GrpLegal</code> - Legal description info </summary>
  • Block1
  • Block2 (Deprecated)
  • LegalDescription
  • LotNumber1
  • LotNumber2
  • LotNumber3
  • Phase
  • Quarter
  • QuarterQuarter
  • Range
  • Section
  • Subdivision
  • Township
  • TractNumber
  • Unit
</details> <details> <summary> <code>GrpPropertyAddress</code> - Address of the property </summary>
  • Address
  • AddressKey
  • BaseMAK
  • CarrierRoute
  • City
  • Latitude
  • Longitude
  • MAK
  • PrivacyInfo
  • State
  • Zip
</details> <details> <summary> <code>GrpParsedPropertyAddress</code> - Parsed elements of the property address </summary>
  • PostDirectional
  • PreDirectional
  • Range
  • StreetName
  • Suffix
  • SuiteName
  • SuiteRange
</details> <details> <summary> <code>GrpPrimaryOwner</code> - Primary owner info </summary>
  • CompanyFlag
  • MelissaIdentityKey1
  • MelissaIdentityKey2
  • Name1First
  • Name1Full
  • Name1Last
  • Name1Middle
  • Name1Suffix
  • Name2First
  • Name2Full
  • Name2Last
  • Name2Middle
  • Name2Suffix
  • TrustFlag
  • Type (Deprecated)
  • VestingType
</details> <details> <summary> <code>GrpSecondaryOwner</code> <i>(Deprecated)</i> - Secondary owner info </summary>
  • Name3First (Deprecated)
  • Name3Full (Deprecated)
  • Name3Last (Deprecated)
  • Name3Middle (Deprecated)
  • Name3Suffix (Deprecated)
  • Name4First (Deprecated)
  • Name4Full (Deprecated)
  • Name4Last (Deprecated)
  • Name4Middle (Deprecated)
  • Name4Suffix (Deprecated)
  • Type (Deprecated)
</details> <details> <summary> <code>GrpOwnerAddress</code> - Owner's address info </summary>
  • Address
  • BaseMAK
  • CarrierRoute
  • City
  • FormatInfo
  • MAK
  • PrivacyInfo
  • State
  • Zip
</details> <details> <summary> <code>GrpLastDeedOwnerInfo</code> - Owner info listed on latest deed for the property </summary>
  • Name1First
  • Name1Full
  • Name1Last
  • Name1Middle
  • Name1Suffix
  • Name2First
  • Name2Full
  • Name2Last
  • Name2Middle
  • Name2Suffix
  • Name3First (Deprecated)
  • Name3Full (Deprecated)
  • Name3Last (Deprecated)
  • Name3Middle (Deprecated)
  • Name3Suffix (Deprecated)
  • Name4First (Deprecated)
  • Name4Full (Deprecated)
  • Name4Last (Deprecated)
  • Name4Middle (Deprecated)
  • Name4Suffix (Deprecated)
</details> <details> <summary> <code>GrpCurrentDeed</code> - Other deed info listed on the latest deed for the property </summary>
  • LenderCode (Deprecated)
  • LenderName
  • MortgageAmount
  • MortgageDate
  • MortgageDueDate
  • MortgageLoanTypeCode
  • MortgageTerm
  • MortgageTermCode
  • SecondMortgageAmount
  • SecondMortgageLoanTypeCode
</details> <details> <summary> <code>GrpTax</code> - Property tax info </summary>
  • AssessedImprovementsPerc
  • AssessedValueImprovements
  • AssessedValueLand
  • AssessedValueTotal
  • AssrLastUpdated
  • LastTaxRollUpdate
  • MarketImprovementsPerc
  • MarketValueImprovements
  • MarketValueLand
  • MarketValueTotal
  • MarketValueYear
  • PreviousAssessedValue (Deprecated)
  • PropertyUseGroup
  • PropertyUseMuni
  • PropertyUseStandardized
  • TaxBilledAmount
  • TaxDelinquentYear
  • TaxExemptionAdditional
  • TaxExemptionDisabled
  • TaxExemptionHomeowner
  • TaxExemptionSenior
  • TaxExemptionVeteran
  • TaxExemptionWidow
  • TaxFiscalYear
  • TaxRateArea
  • YearAssessed
  • YearBuilt
  • YearBuiltEffective
  • ZonedCodeLocal
</details> <details> <summary> <code>GrpPropertyUseInfo</code> - Property usage info </summary>
  • PropertyUseGroup
  • PropertyUseMuni
  • PropertyUseStandardized
  • YearBuilt
  • YearBuiltEffective
  • ZonedCodeLocal
</details> <details> <summary> <code>GrpSaleInfo</code> - Property sale info </summary>
  • AssessorLastSaleAmount
  • AssessorLastSaleDate
  • AssessorPriorSaleAmount
  • AssessorPriorSaleDate
  • DeedLastDocumentNumber
  • DeedLastSaleDate
  • DeedLastSaleDocumentBook
  • DeedLastSaleDocumentPage
  • DeedLastSalePrice
  • DeedLastSaleTxID (Deprecated)
  • LastOwnershipTransferDate
  • LastOwnershipTransferDocumentNumber
  • LastOwnershipTransferTxID (Deprecated)
</details> <details> <summary> <code>GrpPropertySize</code> - Property size info </summary>
  • Area1stFloor
  • Area2ndFloor
  • AreaBuilding
  • AreaBuildingDefinitionCode
  • AreaGross
  • AreaLotAcres
  • AreaLotSF
  • AreaUpperFloors
  • AtticArea
  • AtticFlag
  • BasementArea
  • BasementAreaFinished
  • BasementAreaUnfinished
  • LotDepth
  • LotWidth
  • ParkingCarport
  • ParkingCarportArea
  • ParkingGarage
  • ParkingGarageArea
</details> <details> <summary> <code>GrpPool</code> - Pool info </summary>
  • Pool
  • PoolArea
  • SaunaFlag
</details> <details> <summary> <code>GrpIntStructInfo</code> - Interior structural info </summary>
  • Construction
  • ConstructionFireResistanceClass
  • FlooringMaterialPrimary
  • Foundation
  • InteriorStructure
  • PlumbingFixturesCount
  • SafetyFireSprinklersFlag
</details> <details> <summary> <code>GrpIntRoomInfo</code> - Interior rooms info </summary>
  • BathCount
  • BathPartialCount
  • BedroomsCount
  • BonusRoomFlag
  • BreakfastNookFlag
  • CellarFlag
  • CellarWineFlag (Deprecated)
  • ExcerciseFlag
  • FamilyCode
  • GameFlag
  • GreatFlag
  • HobbyFlag
  • LaundryFlag
  • MediaFlag
  • MudFlag
  • OfficeArea
  • OfficeFlag
  • RoomsCount
  • SafeRoomFlag
  • SittingFlag
  • StoriesCount
  • StormFlag
  • StudyFlag
  • SunroomFlag
  • UnitsCount
  • UtilityArea
  • UtilityCode
</details> <details> <summary> <code>GrpIntAmenities</code> - Interior amenities info </summary>
  • AccessabilityElevatorFlag
  • AccessabilityHandicapFlag
  • CentralVacuumFlag
  • EscalatorFlag
  • Fireplace
  • FireplaceCount
  • IntercomFlag
  • SecurityAlarmFlag
  • SoundSystemFlag
  • WetBarFlag
</details> <details> <summary> <code>GrpExtStructInfo</code> - Exterior structural info </summary>
  • Exterior1Code
  • OverheadDoorFlag
  • RoofConstruction
  • RoofMaterial
  • StormShutterFlag
  • StructureStyle
</details> <details> <summary> <code>GrpExtAmenities</code> - Exterior amenities info </summary>
  • BalconyArea
  • BreezewayFlag
  • DeckArea
  • DeckFlag
  • FeatureBalconyFlag
  • PatioArea
  • PorchArea
  • PorchCode
  • ViewDescription
</details> <details> <summary> <code>GrpExtBuildings</code> - Exterior building info </summary>
  • BathHouseArea
  • BathHouseFlag
  • BoatAccessFlag (Deprecated)
  • BoatHouseArea
  • BoatHouseFlag
  • BuildingsCount
  • CabinArea
  • CabinFlag
  • CanopyArea
  • CanopyFlag
  • GazeboArea
  • GazeboFlag
  • GranaryArea
  • GranaryFlag
  • GreenHouseArea
  • GreenHouseFlag
  • GuestHouseArea
  • GuestHouseFlag
  • KennelArea
  • KennelFlag
  • LeanToArea
  • LeanToFlag
  • LoadingPlatformArea
  • LoadingPlatformFlag
  • MilkHouseArea
  • MilkHouseFlag
  • OutdoorKitchenFireplaceFlag
  • PoleStructureArea
  • PoleStructureFlag
  • PoolHouseArea
  • PoolHouseFlag
  • PoultryHouseArea
  • PoultryHouseFlag
  • QuonsetArea
  • QuonsetFlag
  • ShedArea
  • ShedCode
  • SiloArea
  • SiloFlag
  • StableArea
  • StableFlag
  • StorageBuildingArea
  • StorageBuildingFlag
  • UtilityBuildingArea
  • UtilityBuildingFlag
</details> <details> <summary> <code>GrpUtilities</code> - Utility info </summary>
  • HVACCoolingDetail
  • HVACHeatingDetail
  • HVACHeatingFuel
  • MobileHomeHookupFlag
  • SewageUsage
  • WaterSource
</details> <details> <summary> <code>GrpParking</code> - Parking info </summary>
  • DrivewayArea
  • DrivewayMaterial
  • ParkingSpaceCount
  • RVParkingFlag
</details> <details> <summary> <code>GrpYardGardenInfo</code> - Yard & garden info </summary>
  • ArborPergolaFlag
  • ArenaFlag
  • BoatLiftFlag
  • CourtyardArea
  • CourtyardFlag
  • FenceArea
  • FenceCode
  • GolfCourseGreenFlag
  • PondFlag
  • SportsCourtFlag
  • SprinklersFlag
  • TennisCourtFlag
  • TopographyCode
  • WaterFeatureFlag
</details> <details> <summary> <code>GrpEstimatedValue</code> - Calculated estimated value of the property </summary>
  • ConfidenceScore
  • EstimatedMaxValue
  • EstimatedMinValue
  • EstimatedValue
  • ValuationDate
</details> <details> <summary> <code>GrpShape</code> - Parcel geometry shape in well known text format </summary>
  • WellKnownText
</details>
{"stackTrail":"components:parameters:LicenseKeyParam:schema","oasType":"schema","type":"unknown"}

Required. The License Key issued by Melissa.

format'json' | 'xml'

Desired format of the response.

optstring

Options - Specify which options to use. List options in <OptionName>:<Parameter> format. Multiple options are delimited with a ,.

For example: OptionName:Parameter,OptionName:Parameter.

  • Desc:< off | on > - Default set to off. This options allows Property to return back human readable descriptions and meanings instead of codes.
  • LatestMortgage:< Off | On > - Default set to Off. This options allows Property to have the CurrentDeed structure represent the latest mortgage, if available.
tstring

Transmission Reference - This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

a1string required

Input field for address line 1. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.

a2string

Input field for address line 2. This can be a continuation of AddressLine1 (ex: suite) or another address.

addresskeystring

An 11-digit key of the property. Based on the Zip5, Plus4 and two digit delivery code.

apnstring

Assessor's Parcel Number (APN) for the property.

citystring required

The city for the property.

ctrystring

The country for the property. Currently only properties in the US can be looked up.

ffstring

Free form address for the property.

fipsstring

Federal Information Processing Standard (FIPS) code for the property.

makstring

A proprietary unique key identifier for an address derived from Address Checking.

postalstring

The postal code for the property.

statestring required

The US state for the property.

Headers

Accept'application/json' | 'application/xml' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Response

Successful response

Versionstring

The current service version number.

TransmissionReferencestring

Serves as a unique request identifier.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Property Result Codes.

TotalRecordsinteger

Total number of records.