v1
latestOpenAPI 3.1.22026-08-062433.0 KBPerform action for a single business
Uses HTTP GET to accept one input record and returns the response in XML format.
Path parameters
There are two available actions:
- get - Get count of addresses that fit in the given criteria.
- buy - Buy a list of addresses' info that fit the given criteria.
The included Geographic Types are zip, city, county, state, radius, circle, and polygon.
Query parameters
Requester's customer ID or email address
Geographic Type
- Required: zip
- Optional: radius
Handling: Each five-digit ZIP is validated.
Geographic Type
- Required: zip
- Optional: radius
Handling: Plus4 is a filter in data selection.
Geographic Type
- Required: city
- Optional: radius
Handling: Each city and state combination is valid
Geographic Type
- Required: county
Handling: Each county and state combination is validated. FIPS is retrieved if valid.
Geographic Type
- Required: state
- Optional: radius
Handling: Two-digit state code is validated.
Geographic Type
- Required: radius
Handling: Exact street number and street name are used in data selection. No validation. Latitude and longitude are retrieved if the address exists.
Geographic Type
- Required: circle
- Optional: radius (Mile or record must be given.)
Handling: Mile is used to find out the latitude and longitude of a parameter for many miles away from the given address. For radius type, maximum is 50 miles. For circle type, the radius must be between .025 and 25 miles
Geographic Type
- Optional: radius (Mile or record must be given.)
Handling: Number of records that are closest to the given address
Geographic Type
- Optional: radius
Handling: A street name within the given zip. (The street name needs to be exact.)
Geographic Type
- Optional: radius
Handling: Zip for a specific street that is within the given radius (combination with a given address.)
Geographic Type
- Required: circle
Handling: A longitude;latitude point
Geographic Type
- Required: polygon
Handling: Each set of points for a polygon is validated and reoriented in the sequence of drawing.
Meanings: Append 6- digit SIC code to file if exists
Default: sic=0
To Append: sic=1
Meanings: Various SIC codes as selection/filter
Default: all inclusive
To Append: Otherwise specify the SIC's (2 to 6 digits), use '-'' dash to specify multiple SIC codes, i.e. sic-d=17-9999-729924
Meanings: Append number of employees to file
Default: staff=0
To Append: staff=1
Meanings: Various sizes of staff as selection/filter
- 1 - 4
- 5 - 9
- 10 - 19
- 20 - 49
- 50 - 99
- 100 - 249
- 250 - 499
- 500 - 999
- 1,000 - 4,999
- 5,000 - 9,999
- 10,000
Default: all inclusive
To Append: Otherwise specify the index; use '-' dash to specify multiple staff codes, i.e. staff-d=6-8-10
Meanings: Append annual sales volume to file
Default: sale=0 To Append: sale=1
Meanings: Various ranges of annual sales volumes as selection/filter
- $1,000-$499,999
- $500,000-$999,999
- $1,000,000-$2,499,999
- $2,500,000-$4,999,999
- $5,000,000-$9,999,999
- $10,000,000-$19,999,999
- $20,000,000-$49,999,999
- $50,000,000-$99,999,999
- $100,000,000-$499,999,999
- $500,000,000-$999,999,999
- Over $1 billion
Default: all inclusive
To Append: Otherwise specify the index; use '-' dash to specify multiple sales volume codes, i.e. sale-d=6-8-10
Meanings: Various ContactTitle as selection/filter
Default: all
To Append: use ‘,’ comma to specify multiple contacttitles
contacttitle-d=1,2,3
Meanings: Various Title as selection/filter
Default: all
To Append: use ‘,’ comma to specify multiple titles
title-d=DDS,DPT
One contact per business
Default Value: one=1
Optional Output Parameter: one=0 returns all contacts
Parameter check. If a parameter is spelt wrong or not suited for the given call, the request will be rejected.
Default Value: dbug=0
Optional Output Parameter: dbug=1 to check
Append contact name and gender to file if exists
Default Value: name=0
Optional Output Parameter: To append: name=1
Customer's purchase order number
Default Value: none
Optional Output Parameter: To specify: po=xxxx
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.
Default Value: multi=1
Optional Output Parameter: multi=(1 through 5)
Defines the desired file format of a purchased list.
Default Value: file=8
Optional Output Parameter:
- 2 - File Format: Zipped .txt
- 3 - File Format: Zipped .csv
- 5 - File Format: Zipped .xls (Excel)
- 7 - File Format: .txt
- 8 - (Default) File Format: .csv
- 10 - File Format: .xls (Excel)
Append fax number (if available)
Default Value: fax=0
Optional Output Parameter: fax=1
Append phone number (if available)
Default Value: phone=0
Optional Output Parameter: phone=1
Append 8-digit NAICS code to file if exists
Default Value: naics=0
Optional Output Parameter: naics=1
Appends the number of actual employees (as opposed to a range like staff)
Default Value: numemp=0
Optional Output Parameter: numemp=1
Appends the Key Executive to file
Default Value: keyexec=0
Optional Output Parameter: keyexec=1
Appends the estimated sales volume in thousands (as opposed to a range like sale)
Default Value: numsales=0
Optional Output Parameter: numsales=1
Headers
Format of the response.
Format of the request.
Response
Successful response