Difference between revisions of "LeadGen Property V2:Request Parameters"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 35: Line 35:
*[[#Property Options|Property Options]]
*[[#Property Options|Property Options]]
*[[#Mortgage Options|Mortgage Options]]
*[[#Mortgage Options|Mortgage Options]]
*[[#Absentee/Owner Type Options|Absentee/Owner Type Options]]
*[[#Occupant/Owner Options|Occupant/Owner Options]]
*[[#Demographic Options|Demographic Options]]
*[[#Demographic Options|Demographic Options]]
*[[#General Options|General Options]]
*[[#Number of Records in File|Number of Records in File]]
*[[#Columns in File|Columns in File]]
*[[#File Format|File Format]]
*[[#Other Options|Other Options]]
|}
|}


Line 84: Line 87:
|
|
5-digit ZIPs
5-digit ZIPs
Multiple ZIP can be requested, comma separated with no space or period.
Multiple ZIP can be requested, comma separated with no space or period.
|-
|-
Line 89: Line 93:
|
|
5-digit ZIP
5-digit ZIP
Miles of radius from any given ZIP (mile in decimal).
Miles of radius from any given ZIP (mile in decimal).
|-
|-
Line 99: Line 104:
|
|
Address, City and State or ZIP.
Address, City and State or ZIP.
Miles of radius from a given address. (mile in decimal)
Miles of radius from a given address. (mile in decimal)
|-
|-
Line 109: Line 115:
|
|
Format: 2-digit state;city name, i.e. TX;Dallas
Format: 2-digit state;city name, i.e. TX;Dallas
Multiple cities be requested, comma separated with no space, or period
Multiple cities be requested, comma separated with no space, or period
|-
|-
Line 115: Line 122:
|
|
Multiple town or place be requested, comma separated with no space, or period
Multiple town or place be requested, comma separated with no space, or period
Format: 2-digit state;town name, i.e. CA:Adelanto
Format: 2-digit state;town name, i.e. CA:Adelanto
Town name and State
Town name and State
|-
|-
Line 136: Line 145:
|
|
Miles of radius from a point defined as “latitude;longitude” with a semi colon delimiter, i.e.“-117.597760116333;33.63565170564778”
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.
0.25 miles radius min., 25 miles radius max.
|-
|-
Line 146: Line 156:
|
|
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”
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.
0.25 miles square min., 25 miles square max.
|}
|}
Line 151: Line 162:


==Options==
==Options==
Each request takes a set of geographic input. Property and other input are optional with default values, as well as purchase options. See [[LeadGen:Property:List/File#Columns in File|Columns in File]] for the format of all columns appended to file.
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|Columns in File]] for the format of all columns appended to file.


===Geographic Options===
<h3 class="h3grey">Geographic Options</h3>
An example of this parameter in the URL:
:An example of this parameter in the URL:
<pre>
<pre class="indent">
https://list.melissadata.net/v2/Property/buy_city?id=123456&ctyst=CA;Tustin,CA;Irvine
https://list.melissadata.net/v2/Property/buy_city?id=123456&ctyst=CA;Tustin,CA;Irvine
</pre>
</pre>


{|class="alternate01" cellspacing="0"
:{|class="alternate01" cellspacing="0"
!URL Parameter
!URL Parameter
!Geographic Type
!Geographic Type
Line 167: Line 178:
|
|
Required: zip
Required: zip
Optional: address, street, circle, rectangle
Optional: address, street, circle, rectangle
|Each five-digit ZIP is validated.
|Each five-digit ZIP is validated.
Line 193: Line 205:
|
|
Required: state
Required: state
Optional: address, county, street, zip
Optional: address, county, street, zip
|
|
For state type, 2-digit state is required.
For state type, 2-digit state is required.
For other types, if ZIP or FIPS is given, state is not necessary.
For other types, if ZIP or FIPS is given, state is not necessary.
|-
|-
Line 201: Line 215:
|
|
Required: address, street, circle
Required: address, street, circle
Option: zip
Option: zip
|Radius of miles from a given street, address or ZIP.
|Radius of miles from a given street, address or ZIP.
Line 218: Line 233:
|
|
Each point is defined as “latitude;longitude” with a semi colon delimiter.
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”
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.
Rectangle takes 2 points: 1) southwest, 2) northeast.
Polygon takes at least 3 points, counter clockwise.
Polygon takes at least 3 points, counter clockwise.
|}
|}




===Property Options===
<h3 class="h3grey">Property Options</h3>
{|class="alternate01" cellspacing="0"
 
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!URL Parameter
!Description
!Description
Line 288: Line 307:
|32
|32
|Amusement-Recreation
|Amusement-Recreation
|-
|33
|Mobile Home
|-
|-
|50
|50
Line 315: Line 337:
|
|
Default: all.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, e.g. propertype =10-11 means Single Family Residence and Condominium(Residential)
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, e.g. propertype =10-11 means Single Family Residence and Condominium(Residential)
|-
|-
Line 321: Line 344:
|rowspan="9"|
|rowspan="9"|
Default: no filter.
Default: no filter.
To specify a range, use min-max, e.g. 2-4. Use <code>0</code> if either end has no preference. For example, <code>2-0</code> means at least 2.
To specify a range, use min-max, e.g. 2-4. Use <code>0</code> if either end has no preference. For example, <code>2-0</code> means at least 2.
|-
|-
Line 355: Line 379:
|
|
Default: no filter.
Default: no filter.
Unit: default is sq. ft (f).
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.
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.
|-
|-
Line 362: Line 388:
|
|
Default: no filter.
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.
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.
|-
|-
Line 368: Line 395:
|
|
Default: no filter.
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.
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.
|-
|-
Line 387: Line 415:




===Mortgage Options===
<h3 class="h3grey">Mortgage Options</h3>
{|class="alternate01" cellspacing="0"
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!URL Parameter
!Description
!Description
Line 399: Line 427:
|rowspan="3"|
|rowspan="3"|
Default: no filter
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.
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.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 414: Line 444:
|rowspan="3"|
|rowspan="3"|
Default: no filter.
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%.
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.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 442: Line 474:
|rowspan="3"|
|rowspan="3"|
Default: no filter.
Default: no filter.
To include a variety of types, use <code>-</code>. For instance, 2-1 means to include fixed and adjustable rate.
To include a variety of types, use <code>-</code>. 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.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 455: Line 489:
|rowspan="3"|
|rowspan="3"|
Default: no filter
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
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.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 467: Line 503:
|
|
Mortgage lender(s). Exact names are needed.
Mortgage lender(s). Exact names are needed.
Use – as the delimiter for multiple lenders.
Use – as the delimiter for multiple lenders.
|
|
Default: no filter
Default: no filter
Example: America Bank-America Bank and Trust
Example: America Bank-America Bank and Trust
|-
|-
Line 476: Line 514:
|rowspan="3"|
|rowspan="3"|
Default: no filter.
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.
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.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 534: Line 574:
|rowspan="3"|
|rowspan="3"|
Default: no filter
Default: no filter
For instance, 5-8 means conventional or FHA
For instance, 5-8 means conventional or FHA
It’s an OR relationship when more than one of the three parameters have values.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 547: Line 589:
|rowspan="3"|
|rowspan="3"|
Default: no filter.
Default: no filter.
Including or excluding – true or false.
Including or excluding – true or false.
It’s an OR relationship when more than one of the three parameters have values.
It’s an OR relationship when more than one of the three parameters have values.
|-
|-
Line 555: Line 599:
|mtgScb2
|mtgScb2
|2nd mortgage seller carry back
|2nd mortgage seller carry back
|}
<h3 class="h3grey">Occupant/Owner Options</h3>
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!Description
!style="border-right:0px;"|Values
|-
|-
|occu
|occu
Line 563: Line 615:
!Value
!Value
!Definition
!Definition
|-
|-
|-
|1
|1
Line 585: Line 636:
|
|
Default: no preference.
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.
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
|owntrs
|Trustee owner
|Trustee owner
|rowspan="2"|
|rowspan="3"|
Default: no preference.
Default: no preference.
Including or excluding – true or false.
Including or excluding – true or false.
Line 595: Line 647:
|owncorp
|owncorp
|Corporate owner
|Corporate owner
|-
|vacant
|Vacant property
|}
|}




===Demographic Options===
<h3 class="h3grey">Demographic Options</h3>
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!Description
!style="border-right:0px;"|Values
|-
|hhage
|
Household age:


hhage
{|class="alternate01" cellspacing="0"
Household age:
!Value
1. 18 - 24 Years
!Definition
|-
|1
|18 - 24 Years
|-
|2
|25 - 34 Years
|-
|3
|35 - 44 Years
|-
|4
|45 - 54 Years
|-
|5
|55 - 64 Years
|-
|6
|65 - 74 Years
|-
|7
|75+ Years
|}
|
Default: all.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 18-34 years old
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
|gender
2. 25 - 34 Years
|
3. 35 - 44 Years
Gender:
4. 45 - 54 Years
 
5. 55 - 64 Years
{|class="alternate01" cellspacing="0"
6. 65 - 74 Years
!Value
7. 75+ Years
!Definition
gender
|-
gender
|f
f female
|female
m male
|-
u unisex
|m
|male
|-
|u
|unisex
|}
|
Default: all.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple genders, i.e. f-m mean female and male
Otherwise specify the index; use ‘-‘ dash to specify multiple genders, i.e. f-m mean female and male
hhinc
|-
|hhinc
|
Household income:
Household income:
1 Under $10,000
 
2 $10,000 - $14,999
{|class="alternate01" cellspacing="0"
3 $15,000 - $19,999
!Value
4 $20,000 - $24,999
!Definition
5 $25,000 - $29,999
|-
6 $30,000 - $34,999
|1
7 $35,000 - $39,999
|Under $10,000
8 $40,000 - $44,999
|-
9 $45,000 - $49,999
|2
A $50,000 - $54,999
|$10,000 - $14,999
B $55,000 - $59,999
|-
C $60,000 - $64,999
|3
D $65,000 - $69,999
|$15,000 - $19,999
E $70,000 - $99,999
|-
F $100,000 - $149,999
|4
G $150,000 - $174,999
|$20,000 - $24,999
H $175,000 - $199,999
|-
I $200,000 - $249,999
|5
J $250,000+
|$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.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means $14,999 or less
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means $14,999 or less
marital
|-
|marital
|
Marital status
Marital status
a inferred married
 
b inferred single
{|class="alternate01" cellspacing="0"
m married
!Value
s single
!Definition
|-
|a
|inferred married
|-
|b
|inferred single
|-
|m
|married
|-
|s
|single
|}
|
Default: all.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. b-s means inferred single or single
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. b-s means inferred single or single
lores
|-
|lores
|
Length of residence
Length of residence
0 Less than 1 year
 
1 1 Year
{|class="alternate01" cellspacing="0"
2 2 Years
!Value
3 3 Years
!Definition
4 4 Years
|-
5 5 Years
|0
6 6 Years
|Less than 1 year
7 7 Years
|-
8 8 Years
|1
9 9 Years
|1 Year
10 10 Years
|-
11 11 Years
|2
12 12 Years
|2 Years
13 13 Years
|-
14 14 Years
|3
15 Over 14 Years
|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.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 0-1-2 means 2 years or under
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)
|people
1. 1 Person
|
2. 2 Persons
Persons in household (number of people in household):
3. 3 Persons
 
4. 4 Persons
{|class="alternate01" cellspacing="0"
5. 5 Persons
!Value
!Definition
|-
|1
|1 Person
|-
|2
|2 Persons
|-
|3
|3 Persons
|-
|4
|4 Persons
|-
|5
|5 Persons
|-
|6
|6 Persons
|-
|7
|7 Persons
|-
|8
|8 Persons
|-
|9
|9+ Persons
|}
|rowspan="3"|
Default: all.
Default: all.
Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 2 or less
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
|adults
6. 6 Persons
|
7. 7 Persons
Adults in household:
8. 8 Persons
 
9. 9+ Persons
{|class="alternate01" cellspacing="0"
adults
!Value
adults in household
!Definition
1. 1 Adult
|-
2. 2 Adults
|1
3. 3 Adults
|1 Adult
4. 4 Adults
|-
5. 5 Adults
|2
6. 6+ Adults
|2 Adults
kids
|-
children in household
|3
1. 1 Child
|3 Adults
2. 2 Children
|-
3. 3 Children
|4
4. 4 Children
|4 Adults
5. 5 Children
|-
6. 6 Children
|5
7. 7 Children
|5 Adults
8. 8+ Children
|-
2.5.6. Number of records in file
|6
Each purchase allows 100,000 records at most. URL Parameter Meaning Values
|6+ Adults
qty
|}
Number of records to buy
|-
Default: no preference.
|kids
2.5.7. Append fields in file
|
Owner names, mailing address and property’s site address are included in the list by default.
Children in household:
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
{|class="alternate01" cellspacing="0"
PropertyType
!Value
fmtgAmt
!Definition
Mortgage1Amount
|-
Mortgage2Amount
|1
foccu
|1 Child
PrimaryAbsenteeOwner
|-
fhhage
|2
HouseholdAge
|2 Children
fbedrooms
|-
BedroomsCount
|3
fmtgRt
|3 Children
Mortgage1InterestRate
|-
Mortgage2InterestRate
|4
fowntrs
|4 Children
TrusteeOwner
|-
fhhinc
|5
IncomeEstimatedHousehold
|5 Children
fbathrooms
|-
BathCount
|6
fmtgRtTp
|6 Children
Mortgage1InterestRateType
|-
Mortgage2InterestRateType
|7
fowncorp
|7 Children
CorporateOwner
|-
fmarital
|8
MaritalStatus
|8+ Children
fsqft
|}
AreaSqft
|}
fmtgTm
 
Mortgage1Term
 
Mortgage2Term
<h3 class="h3grey">Number of Records in File</h3>
Mortgage1TermType
:Each purchase allows 100,000 records at most.
Mortgage2TermType
 
flores
{|class="alternate01 indent" cellspacing="0"
HomeLengthOfResidence
!URL Parameter
flot
!Description
LotSqft
!style="border-right:0px;"|Values
fmtgLender
|-
Mortgage1LenderName
|qty
Mortgage2LenderName
|Number of records to buy
fpeople
|Default: no preference.
HouseholdSize
|}
LotAcre
 
fmtgRecDt
 
Mortgage1RecordingDate
 
Mortgage2RecordingDate
<h3 class="h3grey">Columns in File</h3>
fadults
:Owner names, mailing address and property address are included in the list by default.
NumberOfAdults
:Additional fields can be added by setting each of the URL parameters’ value to “true.”
funits
 
Units
{|class="alternate01 indent" cellspacing="0"
fmtgTp
!Column Name!!Max Length!!URL Value to Append!!Description
Mortgage1Type
|-
Mortgage2Type
|-
fkids
|ID|| || ||
NumberOfChildren
|-
fyearbuilt
|ContactMak|| || ||
YearBuilt
|-
fmtgScb
|FullName1||150|| ||party owner 1 full name
Mortgage1SellerCarryBack
|-
Mortgage2SellerCarryBack
|FirstName1||50|| ||party owner 1 first name
fpval
|-
EstimatedPropertyValue
|MiddleName1||20|| ||party owner 1 middle name
fequity
|-
EquityAmount
|LastName1||50|| ||party owner 1 last name
flvratio
|-
LoanToValueRatio
|Suffix1||20|| ||party owner 1 name suffix
Melissa Data LeadGen Property API V2
|-
Quick Start Guide Page 10 of 12
|FullName2||150|| ||party owner 2 full name
fsdt
|-
LastSaleDate
|FirstName2||50|| ||party owner 2 first name
fsamt
|-
LastSaleAmount
|MiddleName2||20|| ||party owner 2 middle name
fbsqft
|-
BasementAreaSqft
|LastName2||50|| ||party owner 2 last name
fpool
|-
Pool
|Suffix2||20|| ||party owner 2 name suffix
fheat
|-
Heater
|MailAddr||100|| ||mailing address
fac
|-
AC
|MailCity||100|| ||mailing city
ffireplace
|-
Fireplace
|MailState||15|| ||mailing state
2.5.8. File format URL Parameter Value
|-
file
|MailZip||10|| ||mailing ZIP
1 = Zipped .dbf
|-
3 = Zipped .csv
|MailPlus4||4|| ||mailing ZIP 4
5 = Zipped .xls
|-
6 = .dbf
|MailCRRT||4|| ||mailing carrier route
8 = .csv (default)
|-
10 = .xls
|MailDPB||2|| ||mailing delivery point
2.5.9. Other options URL Parameter Meaning Default Value
|-
one
|MailFIPS||5|| ||mailing FIPS
false = all properties owned by owner
|-
true = One property per owner
|SiteAddr||50|| ||property address
true
|-
xml
|SiteCity||35|| ||property city
true = response in xml
|-
false = response in json
|SiteState||15|| ||property state
false
|-
|SiteZip||10|| ||property ZIP
|-
|SitePlus4||4|| ||property ZIP 4
|-
|SiteCRRT||4|| ||property carrier route
|-
|SiteDPB||2|| ||property delivery point
|-
|SiteFIPS||5|| ||property FIPS
|-
|SiteMak|| || ||
|-
|PropertyType||250||fpropertype||
|-
|BedroomsCount||10||fbedrooms||
|-
|BathCount||10||fbathrooms||
|-
|AreaSqft||10||fsqft||
|-
|LotSqft||10||flot||
|-
|LotAcre||15|| ||
|-
|Units||5||funits||
|-
|YearBuilt||4||fyearbuilt||
|-
|EstimatedPropertyValue||15||fpval||
|-
|EquityAmount||15||fequity||
|-
|LoanToValueRatio||15||flvratio||
|-
|LastSaleDate||10||fsdt||
|-
|LastSaleAmount||15||fsamt||
|-
|BasementAreaSqft||10||fbsqft||
|-
|Pool||3||fpool||
|-
|Heater||3||fheat||
|-
|AC||3||fac||
|-
|Fireplace||3||ffireplace||
|-
|Mortgage1Amount||15||fmtgAmt||
|-
|Mortgage2Amount||15|| ||
|-
|Mortgage1InterestRate||10||fmtgRt||
|-
|Mortgage2InterestRate||10|| ||
|-
|Mortgage1InterestRateType||15||fmtgRtTp||
|-
|Mortgage2InterestRateType||15|| ||
|-
|Mortgage1Term||10||fmtgTm||
|-
|Mortgage2Term||10|| ||
|-
|Mortgage1LenderName||250||fmtgLender||
|-
|Mortgage2LenderName||250|| ||
|-
|Mortgage1RecordingDate||10||fmtgRecDt||
|-
|Mortgage2RecordingDate||10|| ||
|-
|Mortgage1Type||250||fmtgTp||
|-
|Mortgage2Type||250|| ||
|-
|Mortgage1SellerCarryBack||3||fmtgScb||
|-
|Mortgage2SellerCarryBack||3|| ||
|-
|PrimaryAbsenteeOwner||13||foccu||
|-
|TrusteeOwner||3||fowntrs||
|-
|CorporateOwner||3||fowncorp||
|-
|HouseholdAge||11||fhhage||
|-
|IncomeEstimatedHousehold||250||fgender||
|-
|MaritalStatus||250||fhhinc||
|-
|HomeLengthofResidence||250||fmartial||
|-
|HouseholdSize||250||flores||
|-
|NumberOfAdults||250||fpeople||
|-
|NumberOfChildren||250||fadults||
|}
 
 
<h3 class="h3grey">File Format</h3>
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!Values
|-
|file
|
{|class="alternate01" cellspacing="0"
!Value
!Definition
|-
|1
|Zipped .dbf
|-
|3
|Zipped .csv
|-
|5
|Zipped .xls
|-
|6
|.dbf
|-
|8
|.csv (default)
|-
|10
|.xls
|}
|}
 
 
<h3 class="h3grey">Other Options</h3>
{|class="alternate01 indent" cellspacing="0"
!URL Parameter
!Description
!style="border-right:0px;"|Values
|-
|one
|
{|class="alternate01" cellspacing="0"
!Value
!Definition
|-
|false
|all properties owned by owner
|-
|true
|One property per owner
|}
|Default: true
|-
|xml
|
{|class="alternate01" cellspacing="0"
!Value
!Definition
|-
|true
|response in xml
|-
|false
|response in json
|}
|Default: false
|}




[[Category:LeadGen]]
[[Category:LeadGen]]
[[Category:LeadGen Property V2]]
[[Category:LeadGen Property V2]]

Latest revision as of 01:31, 4 March 2023

← 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
33 Mobile Home
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


Occupant/Owner Options

URL Parameter Description Values
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
vacant Vacant property


Demographic Options

URL Parameter Description Values
hhage

Household age:

Value Definition
1 18 - 24 Years
2 25 - 34 Years
3 35 - 44 Years
4 45 - 54 Years
5 55 - 64 Years
6 65 - 74 Years
7 75+ Years

Default: all.

Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 18-34 years old

gender

Gender:

Value Definition
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:

Value Definition
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

Value Definition
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

Value Definition
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):

Value Definition
1 1 Person
2 2 Persons
3 3 Persons
4 4 Persons
5 5 Persons
6 6 Persons
7 7 Persons
8 8 Persons
9 9+ Persons

Default: all.

Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 2 or less

adults

Adults in household:

Value Definition
1 1 Adult
2 2 Adults
3 3 Adults
4 4 Adults
5 5 Adults
6 6+ Adults
kids

Children in household:

Value Definition
1 1 Child
2 2 Children
3 3 Children
4 4 Children
5 5 Children
6 6 Children
7 7 Children
8 8+ Children


Number of Records in File

Each purchase allows 100,000 records at most.
URL Parameter Description Values
qty Number of records to buy Default: no preference.


Columns in File

Owner names, mailing address and property address are included in the list by default.
Additional fields can be added by setting each of the URL parameters’ value to “true.”
Column Name Max Length URL Value to Append Description
ID
ContactMak
FullName1 150 party owner 1 full name
FirstName1 50 party owner 1 first name
MiddleName1 20 party owner 1 middle name
LastName1 50 party owner 1 last name
Suffix1 20 party owner 1 name suffix
FullName2 150 party owner 2 full name
FirstName2 50 party owner 2 first name
MiddleName2 20 party owner 2 middle name
LastName2 50 party owner 2 last name
Suffix2 20 party owner 2 name suffix
MailAddr 100 mailing address
MailCity 100 mailing city
MailState 15 mailing state
MailZip 10 mailing ZIP
MailPlus4 4 mailing ZIP 4
MailCRRT 4 mailing carrier route
MailDPB 2 mailing delivery point
MailFIPS 5 mailing FIPS
SiteAddr 50 property address
SiteCity 35 property city
SiteState 15 property state
SiteZip 10 property ZIP
SitePlus4 4 property ZIP 4
SiteCRRT 4 property carrier route
SiteDPB 2 property delivery point
SiteFIPS 5 property FIPS
SiteMak
PropertyType 250 fpropertype
BedroomsCount 10 fbedrooms
BathCount 10 fbathrooms
AreaSqft 10 fsqft
LotSqft 10 flot
LotAcre 15
Units 5 funits
YearBuilt 4 fyearbuilt
EstimatedPropertyValue 15 fpval
EquityAmount 15 fequity
LoanToValueRatio 15 flvratio
LastSaleDate 10 fsdt
LastSaleAmount 15 fsamt
BasementAreaSqft 10 fbsqft
Pool 3 fpool
Heater 3 fheat
AC 3 fac
Fireplace 3 ffireplace
Mortgage1Amount 15 fmtgAmt
Mortgage2Amount 15
Mortgage1InterestRate 10 fmtgRt
Mortgage2InterestRate 10
Mortgage1InterestRateType 15 fmtgRtTp
Mortgage2InterestRateType 15
Mortgage1Term 10 fmtgTm
Mortgage2Term 10
Mortgage1LenderName 250 fmtgLender
Mortgage2LenderName 250
Mortgage1RecordingDate 10 fmtgRecDt
Mortgage2RecordingDate 10
Mortgage1Type 250 fmtgTp
Mortgage2Type 250
Mortgage1SellerCarryBack 3 fmtgScb
Mortgage2SellerCarryBack 3
PrimaryAbsenteeOwner 13 foccu
TrusteeOwner 3 fowntrs
CorporateOwner 3 fowncorp
HouseholdAge 11 fhhage
IncomeEstimatedHousehold 250 fgender
MaritalStatus 250 fhhinc
HomeLengthofResidence 250 fmartial
HouseholdSize 250 flores
NumberOfAdults 250 fpeople
NumberOfChildren 250 fadults


File Format

URL Parameter Values
file
Value Definition
1 Zipped .dbf
3 Zipped .csv
5 Zipped .xls
6 .dbf
8 .csv (default)
10 .xls


Other Options

URL Parameter Description Values
one
Value Definition
false all properties owned by owner
true One property per owner
Default: true
xml
Value Definition
true response in xml
false response in json
Default: false
Retrieved from "http://wiki.melissadata.com/index.php?title=LeadGen_Property_V2:Request_Parameters&oldid=19428"