Skip to main content
POST
geo.property.lookup

Authorizations

​
Authorization
string
header
required

API key: sk_live_…

Headers

​
Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
​
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
​
countryCode
string
default:US

ISO two- or three-letter country code.

Required string length: 1 - 3
Pattern: ^[A-Z]{2,3}$
​
address
string

Full US address; send this, components or ref.

Required string length: 1 - 512
​
components
object

US address components.

​
ref
string

The ref returned by an address row from geo.address.suggest or an address lookup.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
​
selections
enum<string>[]

Facts to return; financial explicitly includes personal ownership data.

Required array length: 1 - 3 elements

Location and building facts, or explicitly requested ownership, mailing address, lender, tax and deed facts.

Available options:
location,
structural,
financial
​
include
enum<string>[]

Only these facts within the selected groups.

Required array length: 1 - 356 elements
Available options:
assessedImprovementPercent,
assessedImprovementValue,
assessedLandValue,
assessedValue,
assessorLastUpdate,
assessorTaxrollUpdate,
codeTitleCompany,
companyFlag,
contactCity,
contactCrrt,
contactFullAddress,
contactHouseNumber,
contactMailInfoFormat,
contactMailingCounty,
contactMailingFips,
contactPostDirection,
contactPreDirection,
contactState,
contactStreetName,
contactSuffix,
contactUnitDesignator,
contactValue,
contactZip,
contactZip4,
deedDocumentPage,
deedDocumentBook,
deedDocumentNumber,
deedOwnerFirstName,
deedOwnerFirstName2,
deedOwnerFirstName3,
deedOwnerFirstName4,
deedOwnerFullName,
deedOwnerFullName2,
deedOwnerFullName3,
deedOwnerFullName4,
deedOwnerLastName,
deedOwnerLastName2,
deedOwnerLastName3,
deedOwnerLastName4,
deedOwnerMiddleName,
deedOwnerMiddleName2,
deedOwnerMiddleName3,
deedOwnerMiddleName4,
deedOwnerSuffix,
deedOwnerSuffix2,
deedOwnerSuffix3,
deedOwnerSuffix4,
deedSaleDate,
deedSalePrice,
deedTransactionId,
disabledTaxExemption,
firstName,
firstName2,
firstName3,
firstName4,
homeownerTaxExemption,
instrumentDate,
interestRate,
interestRateType2,
lastName,
lastName2,
lastName3,
lastName4,
lenderAddress,
lenderAddress2,
lenderCity,
lenderCity2,
lenderCode2,
lenderFirstName,
lenderFirstName2,
lenderLastName,
lenderLastName2,
lenderName,
lenderName2,
lenderSellerCarryBack,
lenderSellerCarryBack2,
lenderState,
lenderState2,
lenderZip,
lenderZip2,
lenderZipExtended,
lenderZipExtended2,
loanAmount,
marketImprovementPercent,
marketImprovementValue,
marketLandValue,
marketValueYear,
middleName,
middleName2,
middleName3,
middleName4,
mortgageAmount2,
mortgageDueDate,
mortgageDueDate2,
mortgageInterestType,
mortgageLenderCode,
mortgageStartDate,
mortgageStartDate2,
mortgageTerm,
mortgageTerm2,
mortgageTermType,
mortgageTermType2,
mortgageType,
mortgageType2,
mortgateRate2,
multiParcelFlag,
nameTitleCompany,
otherTaxExemption,
ownerFullName,
ownerFullName2,
ownerFullName3,
ownerFullName4,
ownerOccupancyStatus,
ownershipTransferDate,
ownershipTransferDocNumber,
ownershipTransferTransactionId,
ownershipType,
ownershipType2,
ownershipVestingRelationCode,
previousAssessedValue,
priorSaleAmount,
priorSaleDate,
saleAmount,
saleDate,
salePrice,
seniorTaxExemption,
suffix,
suffix2,
suffix3,
suffix4,
taxAssessYear,
taxBilledAmount,
taxDelinquentYear,
taxFiscalYear,
taxRateArea,
totalMarketValue,
trustDescription,
veteranTaxExemption,
widowTaxExemption,
block1,
block2,
carrierRouteCode,
cbsaCode,
cbsaName,
censusBlock,
censusBlockGroup,
censusFipsPlaceCode,
censusTract,
city,
combinedStatisticalArea,
congressionalDistrict,
elevationFeet,
fipsCode,
geoQuality,
houseNumber,
landUseCode,
landUseGroup,
landUseStandard,
latitude,
legalDescription,
legalUnit,
longitude,
lot1,
lot2,
lot3,
metroDivision,
minorCivilDivisionCode,
minorCivilDivisionName,
msaCode,
msaName,
neighborhoodCode,
parcelAccountNumber,
parcelMapBook,
parcelMapPage,
parcelNumberAlternate,
parcelNumberFormatted,
parcelNumberPrevious,
parcelNumberYearAdded,
parcelNumberYearChange,
parcelRawNumber,
phaseName,
postDirection,
preDirection,
propertyAddressFull,
quarter,
quarterQuarter,
range,
section,
situsCounty,
situsState,
state,
streetName,
streetSuffix,
subdivision,
taxJurisdiction,
township,
tractNumber,
unitDesignator,
unitValue,
zip4,
zipcode,
zoning,
firstFloorSqft,
secondFloorSqft,
acres,
airConditioner,
arborPergola,
atticArea,
atticFlag,
balcony,
balconyArea,
basementSqft,
basementSqftFinished,
basementSqftUnfinished,
bathHouse,
bathHouseSqft,
bathroomsPartial,
bathroomsTotal,
bedrooms,
boatAccess,
boatHouse,
boatHouseSqft,
boatLift,
bonusRoom,
breakfastNook,
breezeway,
buildingDefinitionCode,
buildingSqft,
cabin,
cabinSqft,
canopy,
canopySqft,
carport,
carportSqft,
cellar,
centralVacuum,
communityRec,
constructionType,
courtyard,
courtyardArea,
deck,
deckArea,
depthLinearFootage,
drivewaySqft,
drivewayType,
effectiveYearBuilt,
elevator,
equestrianArena,
escalator,
exerciseRoom,
exteriorWalls,
familyRoom,
fence,
fenceArea,
fireResistanceCode,
fireSprinklersFlag,
fireplace,
fireplaceNumber,
flooring,
foundation,
gameRoom,
garage,
garageSqft,
gazebo,
gazeboSqft,
golfCourse,
grainery,
grainerySqft,
greatRoom,
greenhouse,
greenhouseSqft,
grossSqft,
guesthouse,
guesthouseSqft,
handicapAccessibility,
heat,
heatFuelType,
hobbyRoom,
intercomSystem,
interiorStructure,
kennel,
kennelSqft,
laundry,
leanTo,
leanToSqft,
loadingPlatform,
loadingPlatformSqft,
lotSqft,
mediaRoom,
milkhouse,
milkhouseSqft,
mobileHomeHookup,
mudRoom,
numberOfBuildings,
office,
officeSqft,
overheadDoor,
parcelShellRecord,
parkingSpaces,
patioArea,
plumbingFixturesCount,
poleStruct,
poleStructSqft,
pond,
pool,
poolArea,
poolhouse,
poolhouseSqft,
porch,
porchArea,
poultryHouse,
poultryHouseSqft,
publicationDate,
quonset,
quonsetSqft,
roofCover,
roofFrame,
rooms,
rvParking,
safeRoom,
sauna,
securityAlarm,
sewerType,
shed,
shedSqft,
silo,
siloSqft,
sittingRoom,
soundSystem,
sportsCourt,
sprinklers,
stable,
stableSqft,
storageBuilding,
storageBuildingSqft,
storiesNumber,
stormShelter,
stormShutter,
structureStyle,
study,
sunroom,
tennisCourt,
topographyCode,
unitCount,
upperFloorsSqft,
utility,
utilityBuilding,
utilityBuildingSqft,
utilitySqft,
viewDescription,
waterFeature,
waterServiceType,
wetBar,
widthLinearFootage,
wineCellar,
yearBuilt
​
exclude
enum<string>[]

Omit these facts.

Required array length: 1 - 356 elements
Available options:
assessedImprovementPercent,
assessedImprovementValue,
assessedLandValue,
assessedValue,
assessorLastUpdate,
assessorTaxrollUpdate,
codeTitleCompany,
companyFlag,
contactCity,
contactCrrt,
contactFullAddress,
contactHouseNumber,
contactMailInfoFormat,
contactMailingCounty,
contactMailingFips,
contactPostDirection,
contactPreDirection,
contactState,
contactStreetName,
contactSuffix,
contactUnitDesignator,
contactValue,
contactZip,
contactZip4,
deedDocumentPage,
deedDocumentBook,
deedDocumentNumber,
deedOwnerFirstName,
deedOwnerFirstName2,
deedOwnerFirstName3,
deedOwnerFirstName4,
deedOwnerFullName,
deedOwnerFullName2,
deedOwnerFullName3,
deedOwnerFullName4,
deedOwnerLastName,
deedOwnerLastName2,
deedOwnerLastName3,
deedOwnerLastName4,
deedOwnerMiddleName,
deedOwnerMiddleName2,
deedOwnerMiddleName3,
deedOwnerMiddleName4,
deedOwnerSuffix,
deedOwnerSuffix2,
deedOwnerSuffix3,
deedOwnerSuffix4,
deedSaleDate,
deedSalePrice,
deedTransactionId,
disabledTaxExemption,
firstName,
firstName2,
firstName3,
firstName4,
homeownerTaxExemption,
instrumentDate,
interestRate,
interestRateType2,
lastName,
lastName2,
lastName3,
lastName4,
lenderAddress,
lenderAddress2,
lenderCity,
lenderCity2,
lenderCode2,
lenderFirstName,
lenderFirstName2,
lenderLastName,
lenderLastName2,
lenderName,
lenderName2,
lenderSellerCarryBack,
lenderSellerCarryBack2,
lenderState,
lenderState2,
lenderZip,
lenderZip2,
lenderZipExtended,
lenderZipExtended2,
loanAmount,
marketImprovementPercent,
marketImprovementValue,
marketLandValue,
marketValueYear,
middleName,
middleName2,
middleName3,
middleName4,
mortgageAmount2,
mortgageDueDate,
mortgageDueDate2,
mortgageInterestType,
mortgageLenderCode,
mortgageStartDate,
mortgageStartDate2,
mortgageTerm,
mortgageTerm2,
mortgageTermType,
mortgageTermType2,
mortgageType,
mortgageType2,
mortgateRate2,
multiParcelFlag,
nameTitleCompany,
otherTaxExemption,
ownerFullName,
ownerFullName2,
ownerFullName3,
ownerFullName4,
ownerOccupancyStatus,
ownershipTransferDate,
ownershipTransferDocNumber,
ownershipTransferTransactionId,
ownershipType,
ownershipType2,
ownershipVestingRelationCode,
previousAssessedValue,
priorSaleAmount,
priorSaleDate,
saleAmount,
saleDate,
salePrice,
seniorTaxExemption,
suffix,
suffix2,
suffix3,
suffix4,
taxAssessYear,
taxBilledAmount,
taxDelinquentYear,
taxFiscalYear,
taxRateArea,
totalMarketValue,
trustDescription,
veteranTaxExemption,
widowTaxExemption,
block1,
block2,
carrierRouteCode,
cbsaCode,
cbsaName,
censusBlock,
censusBlockGroup,
censusFipsPlaceCode,
censusTract,
city,
combinedStatisticalArea,
congressionalDistrict,
elevationFeet,
fipsCode,
geoQuality,
houseNumber,
landUseCode,
landUseGroup,
landUseStandard,
latitude,
legalDescription,
legalUnit,
longitude,
lot1,
lot2,
lot3,
metroDivision,
minorCivilDivisionCode,
minorCivilDivisionName,
msaCode,
msaName,
neighborhoodCode,
parcelAccountNumber,
parcelMapBook,
parcelMapPage,
parcelNumberAlternate,
parcelNumberFormatted,
parcelNumberPrevious,
parcelNumberYearAdded,
parcelNumberYearChange,
parcelRawNumber,
phaseName,
postDirection,
preDirection,
propertyAddressFull,
quarter,
quarterQuarter,
range,
section,
situsCounty,
situsState,
state,
streetName,
streetSuffix,
subdivision,
taxJurisdiction,
township,
tractNumber,
unitDesignator,
unitValue,
zip4,
zipcode,
zoning,
firstFloorSqft,
secondFloorSqft,
acres,
airConditioner,
arborPergola,
atticArea,
atticFlag,
balcony,
balconyArea,
basementSqft,
basementSqftFinished,
basementSqftUnfinished,
bathHouse,
bathHouseSqft,
bathroomsPartial,
bathroomsTotal,
bedrooms,
boatAccess,
boatHouse,
boatHouseSqft,
boatLift,
bonusRoom,
breakfastNook,
breezeway,
buildingDefinitionCode,
buildingSqft,
cabin,
cabinSqft,
canopy,
canopySqft,
carport,
carportSqft,
cellar,
centralVacuum,
communityRec,
constructionType,
courtyard,
courtyardArea,
deck,
deckArea,
depthLinearFootage,
drivewaySqft,
drivewayType,
effectiveYearBuilt,
elevator,
equestrianArena,
escalator,
exerciseRoom,
exteriorWalls,
familyRoom,
fence,
fenceArea,
fireResistanceCode,
fireSprinklersFlag,
fireplace,
fireplaceNumber,
flooring,
foundation,
gameRoom,
garage,
garageSqft,
gazebo,
gazeboSqft,
golfCourse,
grainery,
grainerySqft,
greatRoom,
greenhouse,
greenhouseSqft,
grossSqft,
guesthouse,
guesthouseSqft,
handicapAccessibility,
heat,
heatFuelType,
hobbyRoom,
intercomSystem,
interiorStructure,
kennel,
kennelSqft,
laundry,
leanTo,
leanToSqft,
loadingPlatform,
loadingPlatformSqft,
lotSqft,
mediaRoom,
milkhouse,
milkhouseSqft,
mobileHomeHookup,
mudRoom,
numberOfBuildings,
office,
officeSqft,
overheadDoor,
parcelShellRecord,
parkingSpaces,
patioArea,
plumbingFixturesCount,
poleStruct,
poleStructSqft,
pond,
pool,
poolArea,
poolhouse,
poolhouseSqft,
porch,
porchArea,
poultryHouse,
poultryHouseSqft,
publicationDate,
quonset,
quonsetSqft,
roofCover,
roofFrame,
rooms,
rvParking,
safeRoom,
sauna,
securityAlarm,
sewerType,
shed,
shedSqft,
silo,
siloSqft,
sittingRoom,
soundSystem,
sportsCourt,
sprinklers,
stable,
stableSqft,
storageBuilding,
storageBuildingSqft,
storiesNumber,
stormShelter,
stormShutter,
structureStyle,
study,
sunroom,
tennisCourt,
topographyCode,
unitCount,
upperFloorsSqft,
utility,
utilityBuilding,
utilityBuildingSqft,
utilitySqft,
viewDescription,
waterFeature,
waterServiceType,
wetBar,
widthLinearFootage,
wineCellar,
yearBuilt
​
includeFinancialHistory
boolean
default:false

Explicitly request historical owner, lender and transaction facts; costs up to 1.40 USD.

Response

The result

​
modified
boolean
required

False for an unchanged conditional record.

​
record
object
required

Matched address and a short-lived handle for a later lookup.

​
property
object
​
financialHistory
object[]

Historical ownership and lender facts; at most five transactions.

Maximum array length: 5