Send a request
A request for a web resource requires your account name, pipeline and its password, and follows this syntax:
Additional parameters can be added by chaining them to the username portion of the request, for example:
Your account name and pipeline credentials will be provided by your account manager when your account is opened.
Request Parameters
All requests inherit their default parameters from their target pipeline. Requests made with username and password authentication may modify these parameters by transmitting alternate values via the username portion of the request. Request parameters include:
Parameter | Purpose | Required | Description |
---|---|---|---|
account | Authentication | Yes | Your account name |
pipeline | Authentication | Yes | Your target pipeline name |
pipeline password | Authentication | Yes | Your target pipeline password |
country | Geotargeting | Optional | Two-letter country code, e.g. US, DE, BR (ISO 3166). Use "All" to randomly select a country on the request. |
state | Geotargeting | Optional | For targeting US states (does not include regions or territories in other countries). Two-letter state code, e.g. NY, IL, AZ |
city | Geotargeting | Optional | For targeting large cities and metro areas around the globe. When targeting major US cities, you must include state as well. See our Admin API for a method to retrieve supported cities. |
session | IP Rotation | Optional | Random string to ID your session, allowing you to keep the same IP for multiple requests. IP will change when new ID is used or in case session expires after 10 minutes of idle time. String should only use alphanumeric characters (0-9, A-z). |
Request parameters such as country, state or city can be set with default values in a pipeline without the need to include them in each request.