Send the count request: This call returns an XML document showing the record counts for a specific request, allowing you to see how many records are available for the selected parameters.
Send the buy request: This call initiates the purchase of the list detailed by the request. This call is similar to the Get call, but has additional information returned. This information is the order ID, number of usage, and download URL. If the purchase of the list was successful, you will receive a link to the list file in the format you selected in the options.
Download/ retrieve list: download the list from ftp link in the buy call response.
Required: zip Optional: radius by miles, radius by records, city, county
Each five-digit ZIP is validated For radius by miles and radius by records types, either ZIP or the city and state combination needs to be entered. For city and county types, request can be narrowed down by specifying ZIP(s) within the city/county.
Optional: zip, city, radius by miles
Format validation: carrierRoute-ZIP (dash between carrier route and zip) The ZIP part must be consistent with the zip parameter above. Carrier route is used as filter in selection. If no occupant is within the requested carrier route(s), nothing will be returned. Multiple carrierRoute-ZIP’s can be entered as comma separated with no space. For radius by miles type, request can be narrowed down by specifying carrier route(s) within the mileage of the given address.
Required: city Optional: radius by miles, radius by records
Each city and state combination is validated. For radius by miles and radius by records types, either ZIP or the city and state combination needs to be entered.
Each county and state combination is validated. FIPS is retrieved if valid.
Required: county, city Optional: radius
Two-digit state code is validated in combination with city or county depends on the geo type. For radius by miles and radius by records types, either ZIP or the city and state combination needs to be entered.
Required: radius by miles, radius by records
Exact street number and street name are used in data selection No validation. Latitude and longitude are retrieved if the address exists.
Required: radius by miles
Mile is used to find out the latitude and longitude of a parameter so many miles away from the given address.
Required: radius by records
Number of records that are the closest to the given address (within 10 mile radius).
Occupant Request Parameters
To include city deliveries – residential addresses
While text encoding is a rare issue with LeadGen Occupant 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.