Property V4:REST JSON: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 274: Line 274:
             "YearAdded":"string",
             "YearAdded":"string",
             "MapBook":"string",
             "MapBook":"string",
             "MapPage":"string"
             "MapPage":"string",
            "TaxJurisdiction":"string",
            "CBSAName":"string",
            "CBSACode":"string",
            "MSAName":"string",
            "MSACode":"string",
            "MetropolitanDivision":"string",
            "MinorCivilDivisionCode":"string",
            "NeighborhoodCode":"string",
            "CensusTract":"string",
            "CensusBlockGrp":"string",
            "CensusBlock":"string"
         },
         },
         "Legal": {
         "Legal": {

Revision as of 22:12, 18 May 2018

← Property

Property Navigation
Introduction
Licensing
Input/Output
LookupDeeds
  ↳  Request
  ↳  Response
  ↳  Service Codes
LookupHomesByOwner
  ↳  Request
  ↳  Response
LookupProperty
  ↳  Request
  ↳  Response
  ↳  Service Codes
  ↳  Frequencies
Examples
REST JSON
POST JSON
POST XML
Result Codes
Result Code Use
Property Result Codes
Sample Code



LookupDeeds

REST Request

https://property.melissadata.net/v4/WEB/LookupDeeds
?id={License Key}
&t={Transmission Reference}
&cols={Columns}
&mak={Melissa Address Key}
&fips={FIPS}
&apn={APN}
&txid={Transaction ID}
&format={Format}
&ff={FreeForm}

JSON Response

{
    "Version":"string",
    "TransmissionReference":"string",
    "Results":"string",
    "TotalRecords":"string",
    "Records": [
        {
        "DocInfo": {
            "TypeCode":"string",
                "NumberFormatted":"string",
                "NumberLegacy":"string",
                "InstrumentNumber":"string",
                "Book":"string",
                "Page":"string",
                "InstrumentDate":"string",
                "RecordingDate":"string"
            },
            "TxDefInfo": {
                "TransactionType":"string",
                "TransferInfoPurchaseTypeCode":"string",
                "ForeclosureAuctionSale":"string",
                "TransferInfoDistressCircumstanceCode":"string",
                "QuitclaimFlag":"string",
                "TransferInfoMultiParcelFlag":"string",
                "ArmsLengthFlag":"string",
                "PartialInterest":"string"
            },
            "TxAmtInfo": {
                "TransferAmount":"string",
                "TransferAmountInfoAccuracy":"string",
                "TransferTaxTotal":"string",
                "TransferTaxCounty":"string"
            },
            "PrimaryGrantor": {
                "Name1Full":"string",
                "Name1First":"string",
                "Name1Middle":"string",
                "Name1Last":"string",
                "Name1Suffix":"string",
                "Name1ClassType":"string",
                "Name1LegalType":"string",
                "Name2Full":"string",
                "Name2First":"string",
                "Name2Middle":"string",
                "Name2Last":"string",
                "Name2Suffix":"string",
                "Name2ClassType":"string",
                "Name2LegalType":"string"
            },
            "SecondaryGrantor": {
                "Name3Full":"string",
                "Name3First":"string",
                "Name3Middle":"string",
                "Name3Last":"string",
                "Name3Suffix":"string",
                "Name3ClassType":"string",
                "Name4Full":"string",
                "Name4First":"string",
                "Name4Middle":"string",
                "Name4Last":"string",
                "Name4Suffix":"string",
                "Name4ClassType":"string"
            },
            "PrimaryGrantee": {
                "Name1Full":"string",
                "Name1First":"string",
                "Name1Middle":"string",
                "Name1Last":"string",
                "Name1Suffix":"string",
                "Name1ClassType":"string",
                "Name1LegalType":"string",
                "Name2Full":"string",
                "Name2First":"string",
                "Name2Middle":"string",
                "Name2Last":"string",
                "Name2Suffix":"string",
                "Name2ClassType":"string"
            },
            "SecondaryGrantee": {
                "Name3Full":"string",
                "Name3First":"string",
                "Name3Middle":"string",
                "Name3Last":"string",
                "Name3Suffix":"string",
                "Name3ClassType":"string",
                "Name4Full":"string",
                "Name4First":"string",
                "Name4Middle":"string",
                "Name4Last":"string",
                "Name4Suffix":"string",
                "Name4ClassType":"string"
            },
            "TitleCompInfo": {
                "StandardizedCode":"string",
                "StandardizedName":"string",
                "TitleCompanyRaw":"string"
            },
            "Mortgage1": {
                "DocNumberFormatted":"string",
                "DocNumberLegacy":"string",
                "InstrumentNumber":"string",
                "Book":"string",
                "Page":"string",
                "RecordingDate":"string",
                "Type":"string",
                "Amount":"string",
                "LenderCode":"string",
                "LenderFullName":"string",
                "LenderFirstName":"string",
                "LenderLastName":"string",
                "LenderAddress":"string",
                "LenderCity":"string",
                "LenderState":"string",
                "LenderZip":"string",
                "LenderZip4":"string",
                "LenderType":"string",
                "IsLenderSeller":"string",
                "Term":"string",
                "TermType":"string",
                "TermDate":"string",
                "PrepaymentPenaltyFlag":"string",
                "PrepaymentTerm":"string",
                "InterestRateType":"string",
                "InterestRate":"string",
                "InterestTypeInitial":"string",
                "FixedStepConvRate":"string",
                "InterestMargin":"string",
                "InterestIndex":"string",
                "InterestRateMax":"string",
                "AdjustableRateIndex":"string",
                "InterestOnlyFlag":"string",
                "InterestOnlyPeriod":"string"
            },
            "Mortgage2": {
                "DocNumberFormatted":"string",
                "DocNumberLegacy":"string",
                "InstrumentNumber":"string",
                "Book":"string",
                "Page":"string",
                "RecordingDate":"string",
                "Type":"string",
                "Amount":"string",
                "LenderCode":"string",
                "LenderFullName":"string",
                "LenderFirstName":"string",
                "LenderLastName":"string",
                "LenderAddress":"string",
                "LenderCity":"string",
                "LenderState":"string",
                "LenderZip":"string",
                "LenderZip4":"string",
                "LenderType":"string",
                "IsLenderSeller":"string",
                "Term":"string",
                "TermType":"string",
                "TermDate":"string",
                "PrepaymentPenaltyFlag":"string",
                "PrepaymentTerm":"string",
                "InterestRateType":"string",
                "InterestRate":"string",
                "InterestTypeInitial":"string",
                "FixedStepConvRate":"string",
                "InterestMargin":"string",
                "InterestIndex":"string",
                "InterestRateMax":"string",
                "AdjustableRateIndex":"string",
                "InterestOnlyFlag":"string",
                "InterestOnlyPeriod":"string"
            },
            "Valuation": {
                "EstDownPayment":"string",
                "EstLTV":"string"
            }
        }
    ]
}


LookupHomesByOwner

REST Request

https://property.melissadata.net/v4/WEB/LookupHomesByOwner
?id={License Key}
&t={Transmission Reference}
&mak={Melissa Address Key}
&ff={FreeForm}
&format={Format}

JSON Response

{
    "Version":"string",
    "TransmissionReference":"string",
    "Results":"string",
    "TotalRecords":"string",
    "Records": [
        {
            "MAK":"string",
            "BaseMAK":"string",
            "FIPS":"string",
            "APN":"string",
            "PropertyAddress":"string",
            "PropertyCity":"string",
            "PropertyState":"string",
            "PropertyZip":"string",
            "PropertyPlus4":"string"
        }
    ]
}


LookupProperty

REST Request

https://property.melissadata.net/v4/WEB/LookupProperty
?id={License Key}
&t={Transmission Reference}
&cols={Columns}
&addresskey={Address Key}
&fips={FIPS}
&apn={APN}
&account={Account}
&mak={Melissa Address Key}
&ff={FreeForm}

JSON Response

{
    "Version":"string",
    "TransmissionReference":"string",
    "TransmissionResults":"string",
    "TotalRecords":"string",
    "Records": [
        {
        "RecordID":"string",
        "Results":"string",
        "Parcel": {
            "FIPSCode":"string",
            "County":"string",
            "UnformattedAPN":"string",
            "FormattedAPN":"string",
            "AlternateAPN":"string",
            "APNYearChange":"string",
            "PreviousAPN":"string",
            "AccountNumber":"string",
            "YearAdded":"string",
            "MapBook":"string",
            "MapPage":"string",
            "TaxJurisdiction":"string",
            "CBSAName":"string",
            "CBSACode":"string",
            "MSAName":"string",
            "MSACode":"string",
            "MetropolitanDivision":"string",
            "MinorCivilDivisionCode":"string",
            "NeighborhoodCode":"string",
            "CensusTract":"string",
            "CensusBlockGrp":"string",
            "CensusBlock":"string"
        },
        "Legal": {
            "LegalDescription":"string",
            "Range":"string",
            "Township":"string",
            "Section":"string",
            "Quarter":"string",
            "QuarterQuarter":"string",
            "Subdivision":"string",
            "Phase":"string",
            "TractNumber":"string",
            "Block1":"string",
            "Block2":"string",
            "LotNumber1":"string",
            "LotNumber2":"string",
            "LotNumber3":"string",
            "Unit":"string"
        },
        "PropertyAddress": {
            "Address":"string",
            "City":"string",
            "State":"string",
            "Zip":"string",
            "AddressKey":"string",
            "MAK":"string",
            "BaseMAK":"string",
            "Latitude":"string",
            "Longitude":"string"
        },
        "ParsedPropertyAddress": {
            "Range":"string",
            "PreDirectional":"string",
            "StreetName":"string",
            "Suffix":"string",
            "PostDirectional":"string",
            "SuiteName":"string",
            "SuiteRange":"string"
        },
        "PrimaryOwner": {
            "Name1Full":"string",
            "Name1First":"string",
            "Name1Middle":"string",
            "Name1Last":"string",
            "Name1Suffix":"string",
            "TrustFlag":"string",
            "CompanyFlag":"string",
            "Name2Full":"string",
            "Name2First":"string",
            "Name2Middle":"string",
            "Name2Last":"string",
            "Name2Suffix":"string",
            "Type":"string",
            "VestingType":"string"
        },
        "SecondaryOwner": {
            "Name3Full":"string",
            "Name3First":"string",
            "Name3Middle":"string",
            "Name3Last":"string",
            "Name3Suffix":"string",
            "Name4Full":"string",
            "Name4First":"string",
            "Name4Middle":"string",
            "Name4Last":"string",
            "Name4Suffix":"string",
            "Type":"string"
        },
        "OwnerAddress": {
            "Address":"string",
            "City":"string",
            "State":"string",
            "Zip":"string",
            "CarrierRoute":"string",
            "MAK":"string",
            "BaseMAK":"string"
        },
        "LastDeedOwnerInfo": {
            "Name1Full":"string",
            "Name1First":"string",
            "Name1Middle":"string",
            "Name1Last":"string",
            "Name1Suffix":"string",
            "Name2Full":"string",
            "Name2First":"string",
            "Name2Middle":"string",
            "Name2Last":"string",
            "Name2Suffix":"string",
            "Name3Full":"string",
            "Name3First":"string",
            "Name3Middle":"string",
            "Name3Last":"string",
            "Name3Suffix":"string",
            "Name4Full":"string",
            "Name4First":"string",
            "Name4Middle":"string",
            "Name4Last":"string",
            "Name4Suffix":"string"
        },
        "CurrentDeed": {
            "MortgageAmount":"string",
            "MortgageDate":"string",
            "MortgageLoanTypeCode":"string",
            "MortgageTermCode":"string",
            "MortgageTerm":"string",
            "MortgageDueDate":"string",
            "LenderCode":"string",
            "LenderName":"string",
            "SecondMortgageAmount":"string",
            "SecondMortgageLoanTypeCode":"string"
        },
        "Tax": {
            "YearAssessed":"string",
            "AssessedValueTotal":"string",
            "AssessedValueImprovements":"string",
            "AssessedValueLand":"string",
            "AssessedImprovementsPerc":"string",
            "PreviousAssessedValue":"string",
            "MarketValueYear":"string",
            "MarketValueTotal":"string",
            "MarketValueImprovements":"string",
            "MarketValueLand":"string",
            "MarketImprovementsPerc":"string",
            "TaxFiscalYear":"string",
            "TaxRateArea":"string",
            "TaxBilledAmount":"string",
            "TaxDelinquentYear":"string",
            "LastTaxRollUpdate":"string",
            "AssrLastUpdated":"string",
            "TaxExemptionHomeowner":"string",
            "TaxExemptionDisabled":"string",
            "TaxExemptionSenior":"string",
            "TaxExemptionVeteran":"string",
            "TaxExemptionWidow":"string",
            "TaxExemptionAdditional":"string"
        },
        "PropertyUseInfo": {
            "YearBuilt":"string",
            "YearBuiltEffective":"string",
            "ZonedCodeLocal":"string",
            "PropertyUseMuni":"string",
            "PropertyUseGroup":"string",
            "PropertyUseStandardized":"string"
        },
        "SaleInfo": {
            "AssessorLastSaleDate":"string",
            "AssessorLastSaleAmount":"string",
            "AssessorPriorSaleDate":"string",
            "AssessorPriorSaleAmount":"string",
            "LastOwnershipTransferDate":"string",
            "LastOwnershipTransferDocumentNumber":"string",
            "LastOwnershipTransferTxID":"string",
            "DeedLastSaleDocumentBook":"string",
            "DeedLastSaleDocumentPage":"string",
            "DeedLastDocumentNumber":"string",
            "DeedLastSaleDate":"string",
            "DeedLastSalePrice":"string",
            "DeedLastSaleTxID":"string"
        },
        "PropertySize": {
            "AreaBuilding":"string",
            "AreaBuildingDefinitionCode":"string",
            "AreaGross":"string",
            "Area1stFloor":"string",
            "Area2ndFloor":"string",
            "AreaUpperFloors":"string",
            "AreaLotAcres":"string",
            "AreaLotSF":"string",
            "LotDepth":"string",
            "LotWidth":"string",
            "AtticArea":"string",
            "AtticFlag":"string",
            "BasementArea":"string",
            "BasementAreaFinished":"string",
            "BasementAreaUnfinished":"string",
            "ParkingGarage":"string",
            "ParkingGarageArea":"string",
            "ParkingCarport":"string",
            "ParkingCarportArea":"string"
        },
        "Pool": {
            "Pool":"string",
            "PoolArea":"string",
            "SaunaFlag":"string"
        },
        "IntStructInfo": {
            "Foundation":"string",
            "Construction":"string",
            "InteriorStructure":"string",
            "PlumbingFixturesCount":"string",
            "ConstructionFireResistanceClass":"string",
            "SafetyFireSprinklersFlag":"string",
            "FlooringMaterialPrimary":"string"
        },
        "IntRoomInfo": {
            "BathCount":"string",
            "BathPartialCount":"string",
            "BedroomsCount":"string",
            "RoomsCount":"string",
            "StoriesCount":"string",
            "UnitsCount":"string",
            "RoomsBonusRoomFlag":"string",
            "RoomsBreakfastNookFlag":"string",
            "RoomsCellarFlag":"string",
            "RoomsCellarWineFlag":"string",
            "RoomsExcerciseFlag":"string",
            "RoomsFamilyCode":"string",
            "RoomsGameFlag":"string",
            "RoomsGreatFlag":"string",
            "RoomsHobbyFlag":"string",
            "RoomsLaundryFlag":"string",
            "RoomsMediaFlag":"string",
            "RoomsMudFlag":"string",
            "RoomsOfficeArea":"string",
            "RoomsOfficeFlag":"string",
            "RoomsSafeRoomFlag":"string",
            "RoomsSittingFlag":"string",
            "RoomsStormShelter":"string",
            "RoomsStudyFlag":"string",
            "RoomsSunroomFlag":"string",
            "RoomsUtilityArea":"string",
            "RoomsUtilityCode":"string"
        },
        "IntAmenities": {
            "Fireplace":"string",
            "FireplaceCount":"string",
            "AccessabilityElevatorFlag":"string",
            "AccessabilityHandicapFlag":"string",
            "EscalatorFlag":"string",
            "CentralVacuumFlag":"string",
            "IntercomFlag":"string",
            "SoundSystemFlag":"string",
            "WetBarFlag":"string",
            "SecurityAlarmFlag":"string"
        },
        "ExtStructInfo": {
            "StructureStyle":"string",
            "Exterior1Code":"string",
            "RoofMaterial":"string",
            "RoofConstruction":"string",
            "StormShutterFlag":"string",
            "OverheadDoorFlag":"string"
        },
        "ExtAmenities": {
            "ViewDescription":"string",
            "PorchCode":"string",
            "PorchArea":"string",
            "PatioArea":"string",
            "DeckFlag":"string",
            "DeckArea":"string",
            "FeatureBalconyFlag":"string",
            "BalconyArea":"string",
            "BreezewayFlag":"string"
        },
        "ExtBuildings": {
            "BuildingsCount":"string",
            "BathHouseArea":"string",
            "BathHouseFlag":"string",
            "BoatAccessFlag":"string",
            "BoatHouseArea":"string",
            "BoatHouseFlag":"string",
            "CabinArea":"string",
            "CabinFlag":"string",
            "CanopyArea":"string",
            "CanopyFlag":"string",
            "GazeboArea":"string",
            "GazeboFlag":"string",
            "GranaryArea":"string",
            "GranaryFlag":"string",
            "GreenHouseArea":"string",
            "GreenHouseFlag":"string",
            "GuestHouseArea":"string",
            "GuestHouseFlag":"string",
            "KennelArea":"string",
            "KennelFlag":"string",
            "LeanToArea":"string",
            "LeanToFlag":"string",
            "LoadingPlatformArea":"string",
            "LoadingPlatformFlag":"string",
            "MilkHouseArea":"string",
            "MilkHouseFlag":"string",
            "OutdoorKitchenFireplaceFlag":"string",
            "PoolHouseArea":"string",
            "PoolHouseFlag":"string",
            "PoultryHouseArea":"string",
            "PoultryHouseFlag":"string",
            "QuonsetArea":"string",
            "QuonsetFlag":"string",
            "ShedArea":"string",
            "ShedCode":"string",
            "SiloArea":"string",
            "SiloFlag":"string",
            "StableArea":"string",
            "StableFlag":"string",
            "StorageBuildingArea":"string",
            "StorageBuildingFlag":"string",
            "UtilityBuildingArea":"string",
            "UtilityBuildingFlag":"string",
            "PoleStructureArea":"string",
            "PoleStructureFlag":"string"
        },
        "Utilities": {
            "HVACCoolingDetail":"string",
            "HVACHeatingDetail":"string",
            "HVACHeatingFuel":"string",
            "SewageUsage":"string",
            "WaterSource":"string",
            "MobileHomeHookupFlag":"string"
        },
        "Parking": {
            "RVParkingFlag":"string",
            "ParkingSpaceCount":"string",
            "DrivewayArea":"string",
            "DrivewayMaterial":"string"
        },
        "YardGardenInfo": {
            "TopographyCode":"string",
            "FenceCode":"string",
            "FenceArea":"string",
            "CourtyardFlag":"string",
            "CourtyardArea":"string",
            "ArborPergolaFlag":"string",
            "SprinklersFlag":"string",
            "GolfCourseGreenFlag":"string",
            "TennisCourtFlag":"string",
            "SportsCourtFlag":"string",
            "ArenaFlag":"string",
            "WaterFeatureFlag":"string",
            "PondFlag":"string",
            "BoatLiftFlag":"string"
        },
        "Shape": {
            "WellKnownText":"string"
        },
        "AssociatedParcels": []
        }
    ]
}