Quickstart Guide| LeadGen - Property

Introduction

LeadGen Property can be used to:

Get count, purchase property, and owner contact info.
Available to mailers for private use, in-house use, or as a portal for your customers to use to make their list selections.
You can custom-design a website to meet your own needs, as well as those of your customers.

Basic Order of Operations

Real Time

Set up the request:

License key, options, etc.

Send the count request:

Get count of the properties that fit the geographic and other criteria.

Send the buy request:

Buy a list of the property info that fits the geographic and other criteria.

Download/Retrieve list:

Download the list from HTTPS link in the buy call response.

Input Request

Simply replace [your Melissa license key] with your license key to test these requests. It will also work in any browser.

REST - Count

Use a REST request to get the count.

curl -X GET "https://list.melissadata.net/v2/Property/count_zip?id=[your Melissa license key]&zip=92688&propertype=10-11-22&bedrooms=2-4&occu=3"

REST - Purchase

Use the REST request to purchase the list.

curl -X GET "https://list.melissadata.net/v2/Property/buy_zip?id=[your Melissa license key]&zip=92688&propertype=10-11-22&bedrooms=2-4&occu=3"

HTTPS - Download

Use the HTTPS link to download the purchased list.

curl -u user:password "https://list.melissadata.com/ListOrderFiles/1234567.csv"

Input Fields

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. Multiple counties be requested, comma separated with no space or period, i.e. CA:Lake, 06029.
`county`	by County, State
`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.

Property Options

URL Parameter Description Values

propertype

Property Codes & Types

Code	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
33	Mobile Home
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, i.e. propertype =10-11 means Single Family Residence and Condominium(Residential)

bedrooms Number of bedrooms 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.

bathrooms Number of bathrooms

unit 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, a;2.5-0 means at least 2.5 acres.

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, 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 Amount Parameters

Parameter Definition 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: 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.

Code	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 Parameters

Parameter Definition Values

occu

Occupant types

Code	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 Parameters

Parameter Definition Values

hhage

Household age:

Code	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

Code	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:

Code	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

Code	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

Code	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)

Code	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

Code	Definition
1	1 Adult
2	2 Adults
3	3 Adults
4	4 Adults
5	5 Adults
6	6+ Adults

kids

children in household

Code	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

Foreclosure Parameters

Parameter	Definition	Values
`fctype`	Foreclose record types Notice of Default LisPendens Notice of Trustee Sale Notice of foreclosure sale	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.
`fcdate`	Foreclosure recording date	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.
`defamt`	Default amount	Default: no filter
`judamt`	Judgement amount	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.

Geography Append Fields

Parameter	Field Name
`fpropertype`	PropertyType
`fbedrooms`	BedroomsCount
`fbathrooms`	BathCount
`fsqft`	AreaSqft
`flot`	LotSqft
`flot`	LotAcre
`funit`	Unit
`fyearbuilt`	YearBuilt
`fpval`	EstimatedPropertyValue
`fequity`	EquityAmount
`flvratio`	LoanToValueRatio
`fsdt`	LastSaleDate
`fsamt`	LastSaleAmount
`fbsqft`	BasementAreaSqft
`fpool`	Pool
`fheat`	Heater
`fac`	AC
`ffireplace`	Fireplace
`fufapn`	UnformattedAPN
`ffapn`	FormattedAPN
`faapn`	AlternateAPN
`fapny`	APNYearChange
`fan`	AccountNumber

Mortgage Append Fields

Parameter	Field Name
`fmtgAmt`	Mortgage1Amount
`fmtgAmt`	Mortgage2Amount
`fmtgRt`	Mortgage1InterestRate
`fmtgRt`	Mortgage2InterestRate
`fmtgRtTp`	Mortgage1InterestRateType
`fmtgRtTp`	Mortgage2InterestRateType
`fmtgTm`	Mortgage1Term
`fmtgTm`	Mortgage2Term
`fmtgLender`	Mortgage1LenderName
`fmtgLender`	Mortgage2LenderName
`fmtgRecDt`	Mortgage1RecordingDate
`fmtgRecDt`	Mortgage2RecordingDate
`fmtgTp`	Mortgage1Type
`fmtgTp`	Mortgage2Type
`fmtgScb`	Mortgage1SellerCarryBack
`fmtgScb`	Mortgage2SellerCarryBack

Occupant/Owner Append Fields

Parameter	Field Name
`foccu`	PrimaryAbsenteeOwner
`fowntrs`	TrusteeOwner
`fowncorp`	CorporateOwner

Demographic Append Fields

Parameter	Field Name
`fhhage`	HouseholdAge
`fgender`	Gender
`fhhinc`	IncomeEstimatedHousehold
`fmartial`	MaritalStatus
`flores`	HomeLengthofResidence
`fpeople`	HouseholdSize
`fadults`	NumberOfAdults
`fkids`	NumberOfChildren

Foreclosure Append Fields

Parameter	Field Name
`ffctype`	ForeclosureType
`ffcdate`	ForeclosureRecordingDate
`ffcdefamt`	ForeclosureDefaultAmount

Other Append Fields

Parameter	Field Name
`fphone`	Phone
`fphone`	CellPhone

Input Best Practices

While text encoding is a rare issue with LeadGen Property Web Service, note that the API will not support any wrongly-encoded special characters or non-Latin characters. In general, text encoding is an important part of any data enterprise.

This service can deal with multiple languages and scripts. It expects UTF-8 encoding. Be on the lookout for question marks (?), squares (▖) or other unwanted characters like �. They may be an indication of encoding issues and may result in data loss. Bad encoding or character loss is not something our service can correct for you.

Output Response

JSON Response

Here is a sample response.

{
  "options": {
    "propertyOptions": ["Property Type: Single Family Residence;Condominium(Residential);Apartment;", "Bedrooms: at least 1"],
    "mortgageOptions": ["All Mortgages Term (Years): between 10 and 30"],
    "occupantOptions": ["Absentee/Owner Occupied: AbsenteeOwner"],
    "demographicOptions": ["Household Income: $65,000 - $69,999;$70,000 - $99,999;$100,000 - $149,999;$150,000 - $174,999;$175,000 - $199,999;"],
    "listOptions": ["One property per owner."]
  },
  "areas": [{
    "geo": "22382 Avenida Empresa, Rancho Santa Margarita, CA 92688",
    "count": 14,
    "message": ""
  }],
  "summary": {
    "geoType": "Address",
    "totalCount": 14,
    "orderId": 1234567,
    "fileUrl": "https://list.melissadata.com/ListOrderFiles/1234567.csv",
    "status": [{
      "statusCode": 1,
      "statusDetail": "Approved."
    }]
  }
}

XML Response

Here is a sample response.

<Response_Property >
  <areas>
    <CountByArea>
      <Geo>
        22382 Avenida Empresa, Rancho Santa Margarita, CA 92688
      </Geo>
      <Count>14</Count>
      <Message/>
    </CountByArea>
  </areas>
  <summary>
    <GeoType>Address</GeoType>
    <TotalCount>14</TotalCount>
    <OrderId>1234567</OrderId>
    <FileUrl>
      https://list.melissadata.com/ListOrderFiles/1234567.csv
    </FileUrl>
    <Status>
      <Status>
        <StatusCode>1</StatusCode>
        <StatusDetail>Approved.</StatusDetail>
      </Status>
    </Status>
  </summary>
  <Options>
    <ListOptions>
      <string>One property per owner.</string>
    </ListOptions>
    <PropertyOptions>
      <string>
        Property Type: Single Family Residence;Condominium(Residential);Apartment;
      </string>
      <string>Bedrooms: at least 1</string>
    </PropertyOptions>
    <MortgageOptions>
      <string>All Mortgages Term (Years): between 10 and 30</string>
    </MortgageOptions>
    <OccupantOptions>
      <string>Absentee/Owner Occupied: AbsenteeOwner</string>
    </OccupantOptions>
    <DemographicOptions>
      <string>
        Household Income: $65,000 - $69,999;$70,000 - $99,999;$100,000 - $149,999;$150,000 - $174,999;$175,000 - $199,999;
      </string>
    </DemographicOptions>
  </Options>
</Response_Property>

Output Fields

Download File

Output Name	Max Length	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
BedroomsCount	10
BathCount	10
AreaSqft	10
LotSqft	10
LotAcre	15
Unit	5
YearBuilt	4
EstimatedPropertyValue	15
EquityAmount	15
LoanToValueRatio	15
LastSaleDate	10
LastSaleAmount	15
BasementAreaSqft	10
Pool	3
Heater	3
AC	3
Fireplace	3
UnformattedAPN	60
FormattedAPN	60
AlternateAPN	60
APNYearChange	4
AccountNumber	35
Mortgage1Amount	15
Mortgage2Amount	15
Mortgage1InterestRate	10
Mortgage2InterestRate	10
Mortgage1InterestRateType	15
Mortgage2InterestRateType	15
Mortgage1Term	10
Mortgage2Term	10
Mortgage1LenderName	250
Mortgage2LenderName	250
Mortgage1RecordingDate	10
Mortgage2RecordingDate	10
Mortgage1Type	250
Mortgage2Type	250
Mortgage1SellerCarryBack	3
Mortgage2SellerCarryBack	3
PrimaryAbsenteeOwner	13
TrusteeOwner	3
CorporateOwner	3
HouseholdAge	11
Gender	6
IncomeEstimatedHousehold	250
MaritalStatus	250
HomeLengthofResidence	250
HouseholdSize	250
NumberOfAdults	250
NumberOfChildren	250
ForeclosureType	30
ForeclosureRecordingDate	10
ForeclosureDefaultAmount	15
Phone	10
CellPhone	10

Interpreting Results

All Melissa products use result codes. LeadGen - Property Result codes are numeric codes, e.g. 101. Result codes are returned as a comma-delimited string with no whitespace, e.g. 100,101.

The following table shows the most common result codes seen while using LeadGen - Property.

Code	Description
1	Approved.
100	Unrecognized ZIP Code.
101	Unrecognized city or state.
102	Unrecognized county or state.
103	Unrecognized address.
106	Invalid user information.
107	Invalid number of records requested.
108	Order failed, please try later.
109	Insufficient geographic input.
111	Request exceeds 100,000 record maximum.
112	Unrecognized state.
113	Error.
116	Sorry, you have no permission to this service.
117	ZIP Code is not a valid input for the requested geography type.
123	Invalid option.
124	Excel and comma limited files cannot have more than 65,535 records.
134	Invalid geographic input.
135	Conflict between ZIPs in city and ZIP in radius.
136	ZIP in radius cannot have multiple ZIPs.
137	Unrecognized town.
138	Miles must be between 0.25 and 10.
139	Invalid latitude/longitude.
140	Miles must be between 0.25 and 10.
141	Area must be between 0.25 and 10 sq. miles.
142	Invalid file type.