LeadGen Property:Request Parameters

← LeadGen Cloud API

Standard Components

Parameter	Definition
Domain
Version	Web Service version.
Web Service	Property
Protocol	REST. The protocol used by the Web Service.
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 or email address.
Options	Geographic Options Property Options General Options Other Purchase 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.

Authentication

Each customer’s ID or email address is passed in as “id” in the URL. This is checked against the list of registered customers. If the required customer ID has not been activated for LeadGen Property, the service will return <Status Code> with the value “Declined”.

Required

URL Parameter	Description
id	Required. User ID or Email Address. You must be subscribed to the Property Web Service.

Geographic Types

Each request must specify one of the following geographic types:

Don't forget! The call URL format: Property Call Format.

URL Parameter	Geographic Type	Description
zip?	Zip	Format: 5-digit ZIP or 9-digit ZIP+4 Multiple ZIP or ZIP+4 can be requested, comma separated with no space. Ex. zp=92688,85023,129265917
city?	City	Format: 2-digit state;city name Multiple cities be requested, comma separated with no space. Ex. city=TX;Dallas,TX;Houston,TX;Austin
county?	County	Format: 2-digit state;county name Multiple counties be requested, comma separated with no space. Ex. county=CA;Lake,AZ;Mohave,AZ;Maricopa
radius?	Radius	Miles of radius from a given address, or the closest records to a given address.

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

URL Parameter	Geographic Type	Description
zip	Required: zip Optional: radius	Each five-digit ZIP is validated. Plus4 is a filter in the data section.
city	Required: city Optional: radius	Each city and state combinations is validated.
county	Required: county	Each county and state combination is validated. FIPS is retrieved if valid.
addr	Required: radius	Exact street number and street name are used in the data section. No validation. Latitude and longitude are retrieved if the address exists.
mile	Optional: radius (One of the two should be given, not required together.)	Mile is used to find out the latitudes/longitudes of a parameter so many miles from the given address.
records		Number of records that are the closest to the given address.

Property Options

URL Parameter	Description	Default Value	Optional Output Parameter
abs	Does not append the absentee indicator to file.	abs=0	Append the indicator to file: abs=1
abs-d	Appends absentee owners only.	abs-d=1	Append all owner types: abs-d=0

Purchase Options

The following options are for buy requestes only.

URL Parameter	Description	Default Value	Optional Output Parameter
multi	Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5.	multi=1	multi=(1 through 5)
file	Buy Requests Only. Defines the desired file format of a purchased list.	file= 8	Value File Format 1 Zipped .dbf 2 Zipped .txt 3 Zipped .csv 4 Zipped .xls (Excel) 6 .dbf 7 .txt 8 (Default) .csv 10 .xls (Excel)
po	Buy Requests Only. Defines the customer’s purchase order number.	N/A	To specify: po=xxxx

General Options

URL Parameter	Description	Default Value	Optional Output Parameter
dbug	Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected.	dbug=0	To check: dbug=1