LeadGen Property V2:Request Parameters
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:
|
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
Default: no filter. To include a variety of types, use 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.
|
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
|
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:
|
Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 18-34 years old | ||||||||||||||||||||||||||||||||||||||||
gender |
Gender:
|
Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple genders, i.e. f-m mean female and male | ||||||||||||||||||||||||||||||||||||||||
hhinc |
Household income:
|
Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means $14,999 or less | ||||||||||||||||||||||||||||||||||||||||
marital |
Marital status
|
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
|
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):
|
Default: all. Otherwise specify the index; use ‘-‘ dash to specify multiple choices, i.e. 1-2 means 2 or less | ||||||||||||||||||||||||||||||||||||||||
adults |
Adults in household:
| |||||||||||||||||||||||||||||||||||||||||
kids |
Children in household:
|
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 |
|
Other Options
URL Parameter | Description | Values | ||||||
---|---|---|---|---|---|---|---|---|
one |
|
Default: true | ||||||
xml |
|
Default: false |