LeadGen Property V2:Request Parameters

From Melissa Data Wiki
Revision as of 22:46, 30 September 2019 by Admin (talk | contribs)
Jump to navigation Jump to search

← LeadGen Cloud API

LeadGen Property V2 Navigation
Introduction
Request Parameters
Response
Property Result Codes



Standard Components

Parameter Definition
Domain
Version V2
Web Service Property
Protocol REST
Action "Get Count" or "Buy List"
Geographic type ZIP, City, County, or Radius. See Geographic Types for more info.
Customer ID The requester’s Customer ID, License Key, or Email Address.
Options


Actions

The following actions are supported by the web service:

Action Service Description
Get Get the count of customers who fit the geographic and property criteria.
Buy Buy a list of customers' info that fit the geographic and property criteria.


An example of this action in the URL: 

https://list.melissadata.net/v2/Property/buy_zip?id=123456&zip=92688&propertype=10-11-22&bedrooms=2-4&occu=3


Authentication

Each Customer ID, License Key, or Email Address is passed in as id in the URL. This is checked against the list of registered customers.


Geographic Types

An example of this parameter in the URL 

https://list.melissadata.net/v2/Property/count_zip?id=123456&zip=92688&propertype=10-11-22&bedrooms=2-4&occu=3

Each request must specify one of the following geographic types:

Type Sub Types Description
zip ZIP(s)

5-digit ZIPs Multiple ZIP can be requested, comma separated with no space or period.

ZIP in Radius

5-digit ZIP Miles of radius from any given ZIP (mile in decimal).

ZIP(s) in City

5-digit ZIP, City, and 2-digit State.

address

Address, City and State or ZIP. Miles of radius from a given address. (mile in decimal)

street Street name and ZIP or city and state, with street number range being optional
city

Format: 2-digit state;city name, i.e. TX;Dallas Multiple cities be requested, comma separated with no space, or period

town

Multiple town or place be requested, comma separated with no space, or period Format: 2-digit state;town name, i.e. CA:Adelanto Town name and State

county by FIPS

Format: 2-digit state;county name, or FIPS

by County, State

Multiple counties be requested, comma separated with no space or period, i.e. CA:Lake, 06029

state

2-digit state name

circle

Miles of radius from a point defined as “latitude;longitude” with a semi colon delimiter, i.e.“-117.597760116333;33.63565170564778” 0.25 miles radius min., 25 miles radius max.

polygon A set of points (latitude /longitude)within 0.25 miles square and 25 miles square. Each point is defined as “latitude;longitude” with a semi colon delimiter, use comma delimiter between each set of latitude;longitude. For example, 33.649656850987895;-117.59544268774414, 33.636509228993326;-117.6109780423584, 33.63222152688031;-117.59518519567871”
rectangle

Southwest and northeast points (latitude /longitude). Each point is defined as “latitude;longitude” with a semi colon delimiter, use comma delimiter between each set of latitude;longitude. For example, “33.63565170564778;-117.597760116333, 33.649513952846554;-117.58685961889648” 0.25 miles square min., 25 miles square max.


Options

Each request takes a set of geographic input. Property and other input are optional with default values, as well as purchase options. See Columns in File for the format of all columns appended to file.

Geographic Options

An example of this parameter in the URL: 

https://list.melissadata.net/v2/Property/buy_city?id=123456&ctyst=CA;Tustin,CA;Irvine
URL Parameter Geographic Type Description
zip

Required: zip Optional: address, street, circle, rectangle

Each five-digit ZIP is validated.
addr Require: Address No validation.
ctyst Required: city Format: state;city
city Optional: address, street, ZIP If ZIP is given, city is not necessary.
town Required: town Not validated.
cntyst Required: county The value could be .a variety of state;county and/or FIPS.
state

Required: state Optional: address, county, street, zip

For state type, 2-digit state is required. For other types, if ZIP or FIPS is given, state is not necessary.

mile

Required: address, street, circle Option: zip

Radius of miles from a given street, address or ZIP.
street Required: street Exact street name is required. No validation.
num1 Optional: street Start and end of the range of street numbers. Either end can be left unspecified.
num2
pt Required: circle, rectangle. polygon

Each point is defined as “latitude;longitude” with a semi colon delimiter. For multiple points, use comma delimiter between each set of latitude;longitude. For example, “33.63565170564778;-117.597760116333, 33.649513952846554;-117.58685961889648” Rectangle takes 2 points: 1) southwest, 2) northeast. Polygon takes at least 3 points, counter clockwise.


Property Options

URL Parameter Description Values
propertype

Property codes & types:

Value Definition
00 Miscellaneous
000 Not Available/None
10 Single Family Residence
11 Condominium(Residential)
20 Commercial
21 Duplex, Triplex, Quadplex
22 Apartment
23 Hotel, Motel
24 Condominium(Commercial)
25 Retail
26 Service(general public)
27 Office Building
28 Warehouse
29 Financial Institution
30 Hospital(medical complex, clinic)
31 Parking
32 Amusement-Recreation
50 Industrial
51 Industrial Light
52 Industrial Heavy
53 Transport
54 Utility
70 Agricultural
80 Vacant Lot (Land)
90 Exempt

Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, e.g. propertype =10-11 means Single Family Residence and Condominium(Residential)

bedrooms Number of bedrooms

Default: no filter. To specify a range, use min-max, e.g. 2-4. Use 0 if either end has no preference. For example, 2-0 means at least 2.

bathrooms Number of bathrooms
units Unit number
yearbuilt Year built. Format. YYYY.
pval Property value ($)
equity Equity ($)
lvratio Loan to value ratio (%).
sqft Square footage
bsqft Basement square footage
lot

Lot size. It can be a range. The unit can be:

  • a for acre, or
  • f for sq. ft.

Format: unit;size.

Default: no filter. Unit: default is sq. ft (f). Size: To specify a range, use min-max. 2-4 means 2-4 acres. Use 0 if either end has no preference. For instance, f;2000-0 means at least 2000 sq. ft.

samt Range of sale amounts in thousands ($)

Default: no filter. To specify a range, use min-max, i.e. 2-4. Use 0 if either end has no preference. For instance, 2-0 means at least $2,000.

sdt Range of sale dates

Default: no filter. To specify a period, use MYYYY-MYYYY. The start month starts on the 1st; the end month ends on the last day, i.e. sdt=32010-122014, this covers 3/1/2010 to 12/31/2014.

pool Has pool or not.

1 means using it as a filter while 0 means no preference. For example, pool=1. If not specified, it means no preference.

heat Has heater or not.
ac Has A/C or not.
fireplace Has fireplace or not.


Mortgage Options

URL Parameter Description Values
mtgAmt

(Range of) amount in thousands ($) Combined amount for 1st and 2nd mortgages

Default: no filter To specify a range of amounts, use min-max. Use 0 if either end has no preference. For instance, 2-0 means at least $2000, 5-10 means between$5000 and $10000. It’s an OR relationship when more than one of the three parameters have values.

mtgAmt1 1st Mortgage Amount
mtgAmt2 2nd Mortgage Amount
mtgRt

Rate (range) Rate for either 1st or 2nd mortgage

Default: no filter. To specify a range of rates, use min-max. Use 0 if either end has no preference. For instance, 2.5-0 means 2.5% at least, 3-5.5 means between 3% and 5.5%. It’s an OR relationship when more than one of the three parameters have values.

mtgRt1 1st Mortgage Rate
mtgRt2 2nd Mortgage Rate
mtgRtTp

Interest rate type for 1st or 2nd mortgage. Types are:

Value Definition
2 fixed rate
1 adjustable rate
0 unknown

Default: no filter. To include a variety of types, use -. For instance, 2-1 means to include fixed and adjustable rate. It’s an OR relationship when more than one of the three parameters have values.

mtgRtTp1
mtgRtTp2
mtgTm Term (years)

Default: no filter To specify a range of terms, use min-max. Use 0 if either end has no preference. For instance, 5-0 means at least 5-year term, 15-30 means between 15-year to 30-year term It’s an OR relationship when more than one of the three parameters have values.

mtgTm1 1st mortgage term
mtgTm2 2nd Mortgage Term
mtgLender

Mortgage lender(s). Exact names are needed. Use – as the delimiter for multiple lenders.

Default: no filter Example: America Bank-America Bank and Trust

mtgRecDt Recording date (range)

Default: no filter. To specify a period, use MYYYY-MYYYY. The start month starts on the 1st; the end month ends on the last day. For instance, 12015-112018 means between 1/1/2015 and 11/30/2018. It’s an OR relationship when more than one of the three parameters have values.

mtgRecDt1 1st Mortgage Recording Date
mtgRecDt2 2nd mortgage recording date
mtgTp

Mortgage type(s). Multiple mortgages are separated by comma.

Value Definition
0 Unknown
3 Building or Construction
5 Conventional
6 Line of Credit
8 FHA
10 Conventional
16 Veterans Administration Loan
101 USDA - US Department of Agriculture Loan
102 Regional Government Programs
103 Commercial
104 Regional Government Programs
105 Reverse Mortgage
120 Private Party Loan

Default: no filter For instance, 5-8 means conventional or FHA It’s an OR relationship when more than one of the three parameters have values.

mtgTp1 1st Mortgage type
mtgTp2 2nd mortgage type
mtgScb Seller Carry Back (Is the seller is also the lender?)

Default: no filter. Including or excluding – true or false. It’s an OR relationship when more than one of the three parameters have values.

mtgScb1 1st Mortgage Seller Carry back
mtgScb2 2nd mortgage seller carry back
occu

Occupant types

Value Definition
1 Owner occupied
2 Absentee owner (all types)
3 Absentee Owner - In County
4 Absentee Owner – In State
5 Absentee Owner – Out of County
6 Absentee Owner – Out of State

Default: no preference. For multiple absentee owner types, use – as the delimiter. It’s an OR relationship between the selected types. For instance, 3-6 means in county or out of state.

owntrs Trustee owner

Default: no preference. Including or excluding – true or false.

owncorp Corporate owner


Demographic Options

hhage Household age: 1. 18 - 24 Years Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 18-34 years old Melissa Data LeadGen Property API V2 Quick Start Guide Page 8 of 12 2. 25 - 34 Years 3. 35 - 44 Years 4. 45 - 54 Years 5. 55 - 64 Years 6. 65 - 74 Years 7. 75+ Years gender gender f female m male u unisex Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple genders, i.e. f-m mean female and male hhinc Household income: 1 Under $10,000 2 $10,000 - $14,999 3 $15,000 - $19,999 4 $20,000 - $24,999 5 $25,000 - $29,999 6 $30,000 - $34,999 7 $35,000 - $39,999 8 $40,000 - $44,999 9 $45,000 - $49,999 A $50,000 - $54,999 B $55,000 - $59,999 C $60,000 - $64,999 D $65,000 - $69,999 E $70,000 - $99,999 F $100,000 - $149,999 G $150,000 - $174,999 H $175,000 - $199,999 I $200,000 - $249,999 J $250,000+ Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means $14,999 or less marital Marital status a inferred married b inferred single m married s single Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. b-s means inferred single or single lores Length of residence 0 Less than 1 year 1 1 Year 2 2 Years 3 3 Years 4 4 Years 5 5 Years 6 6 Years 7 7 Years 8 8 Years 9 9 Years 10 10 Years 11 11 Years 12 12 Years 13 13 Years 14 14 Years 15 Over 14 Years Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 0-1-2 means 2 years or under people Persons in household (number of people in household) 1. 1 Person 2. 2 Persons 3. 3 Persons 4. 4 Persons 5. 5 Persons Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 2 or less Melissa Data LeadGen Property API V2 Quick Start Guide Page 9 of 12 6. 6 Persons 7. 7 Persons 8. 8 Persons 9. 9+ Persons adults adults in household 1. 1 Adult 2. 2 Adults 3. 3 Adults 4. 4 Adults 5. 5 Adults 6. 6+ Adults kids children in household 1. 1 Child 2. 2 Children 3. 3 Children 4. 4 Children 5. 5 Children 6. 6 Children 7. 7 Children 8. 8+ Children 2.5.6. Number of records in file Each purchase allows 100,000 records at most. URL Parameter Meaning Values qty Number of records to buy Default: no preference. 2.5.7. Append fields in file Owner names, mailing address and property’s site address are included in the list by default. Additional fields can be added by setting each of the following URL parameters’ value to “true.” PROPERTY MORTGAGE ABSENTEE/OWNER TYPE DEMOGRAPHIC URL Param File Column URL Param File Column URL Param File Column URL Param File Column fpropertype PropertyType fmtgAmt Mortgage1Amount Mortgage2Amount foccu PrimaryAbsenteeOwner fhhage HouseholdAge fbedrooms BedroomsCount fmtgRt Mortgage1InterestRate Mortgage2InterestRate fowntrs TrusteeOwner fhhinc IncomeEstimatedHousehold fbathrooms BathCount fmtgRtTp Mortgage1InterestRateType Mortgage2InterestRateType fowncorp CorporateOwner fmarital MaritalStatus fsqft AreaSqft fmtgTm Mortgage1Term Mortgage2Term Mortgage1TermType Mortgage2TermType flores HomeLengthOfResidence flot LotSqft fmtgLender Mortgage1LenderName Mortgage2LenderName fpeople HouseholdSize LotAcre fmtgRecDt Mortgage1RecordingDate Mortgage2RecordingDate fadults NumberOfAdults funits Units fmtgTp Mortgage1Type Mortgage2Type fkids NumberOfChildren fyearbuilt YearBuilt fmtgScb Mortgage1SellerCarryBack Mortgage2SellerCarryBack fpval EstimatedPropertyValue fequity EquityAmount flvratio LoanToValueRatio Melissa Data LeadGen Property API V2 Quick Start Guide Page 10 of 12 fsdt LastSaleDate fsamt LastSaleAmount fbsqft BasementAreaSqft fpool Pool fheat Heater fac AC ffireplace Fireplace 2.5.8. File format URL Parameter Value file 1 = Zipped .dbf 3 = Zipped .csv 5 = Zipped .xls 6 = .dbf 8 = .csv (default) 10 = .xls 2.5.9. Other options URL Parameter Meaning Default Value one false = all properties owned by owner true = One property per owner true xml true = response in xml false = response in json false [[Category:LeadGen Property] V2]

Retrieved from "http://wiki.melissadata.com/index.php?title=LeadGen_Property_V2:Request_Parameters&oldid=16749"