POST Request Parameters

Parameter Description Usage
objectId Uniquely identifies addresses. If provided, the associated objectId with each address is returned in the response for reference. It should be a valid positive integer. If not provided, then the objectId is generated starting '1' and auto incremented. Optional
attributes Acceptable comma-separated values are:
  • all
    Note: If customer provides input parameter for attributes as "all", customer will be charged for all the attributes (1 credit per property attribute).
  • pbKey
  • propApn
  • propType
  • propSqFt
  • propLinkId
  • buildgSqFt
  • buildgSqFtSource
  • landUse
  • construction
  • subdivision
  • geometry
  • geoId
  • builtYear
  • bedrooms
  • baths
  • pool
  • fireplace
  • mobileHome
  • heatingType
  • coolingType
  • assessedValue
  • marketValue
  • taxAmount
  • taxExemptions
  • caExemptions
  • appraisedValue
  • salesDate
  • priorSaleDate
  • priorSalesPrice
  • stories
  • buildgFeaturesSqFt
  • livingSqFt
  • roofFrameType
  • foundation
  • buildgUnitNo
  • buildgCount
  • buildgCondition
  • roofCoverType
  • taxAddress
  • vacancy
  • owners
  • appraisedValueImp
  • assessedValueImp
  • buildgType
  • basementType
  • effectiveBuiltYear
  • exteriorWalls
  • garageType
  • lastUpdated
  • marketValueImp
  • absenteeOwner
  • parkingSqFt
  • replacementCost
  • roofShapeType
  • buildgStyle
  • basementSqFt
  • ownerType
  • OwnerVestType
  • elevator
  • formattedTaxAddress
  • situsAddress
  • propApnSequence
  • fipsCode
  • propZoning
  • locCode
  • legalMapRef
  • legalAssessorDesc
  • legalFullDesc
  • legalLotCode
  • legalLotNumber
  • legalLandLot
  • legalTractNumber
  • legalBlock
  • legalSection
  • legalDistrict
  • legalUnitNumber
  • legalPhaseNumber
  • legalSubName
  • legalTownMuniName
  • legalSectionTownshipRange
  • propAcres
  • propFrontFootage
  • propDepthFootage
  • buildgView
  • propSiteInfluene
  • buildgName
  • buildgQuality
  • buildgImproveType
  • grossSqft
  • adjGrossSqft
  • buildgClass
  • interiorWall
  • floorType
  • rooms
  • otherRooms
  • partialBaths
  • bathFixtures
  • plumbingFixtures
  • fireplaceType
  • parkingCapacity
  • poolType
  • energyType
  • fuelType
  • sewerType
  • waterType
  • amenities
  • extraFeatureSqft
  • buildgImproveArea
  • taxAccountNumber
  • taxTapeCutDate
  • taxDocType
  • taxSalesPrice
  • taxSalesPriceCode
  • recBookNumber
  • recPageNumber
  • recDocNumber
  • priorSaleDocType
  • priorSaleCode
  • priorSaleFolioNumber
  • priorSalePageNumber
  • priorSaleDocNumber
  • taxYear
  • taxDelYear
  • assessedYear
  • assessedLandValue
  • marketValueYear
  • marketValueLand
  • appraisedValueLand
  • taxRateCode
Required
addresses List of addresses Required
These parameters are part of "addresses" parameter:
mainAddressLine Input address. Required
addressLastLine Last line of the address. Optional
placeName Building name, place name, Point of Interest (POI), company or firm name associated with the input address.
areaName1 Specifies the largest geographic area, typically a state or province.
areaName2 Specifies the secondary geographic area, typically a county or district.
areaName3 Specifies a city or town name.
areaName4 Specifies a city subdivision or locality.
postCode The postal code in the appropriate format for the country.
postCodeExt Postal code extension.
country ISO 3166-1 alpha-3 country code.

Supported country: USA

addressNumber House or building number.
streetName Street name of the input address.
unitType Specifies the type of unit, such as Apt., Ste. and Bldg.
unitValue Specifies the unit value/number, such as "3B".