Examples
Update Settings
Configure Yellow Pages Companies Search Export settings
The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POST
https://api.lobstr.io/v1/squids/{squid_hash}Configure your Yellow Pages Companies Search Export squid settings.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderrequiredMust be application/json. Value: application/json
Squid Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | string | — | Yellow Pages search URL (use this OR keyword + location) |
| keyword | string | — | What you are looking for on Yellow Pages |
| location | string | — | US city and state to search in, e.g. 'Austin, TX' |
| max_unique_results_per_run | integer | — | Max unique results across all tasks in a run |
| max_results | integer | 3000 | Maximum results per task (Yellow Pages max ~3000) |
| sort | string | Default | How Yellow Pages orders results: Default, Distance, Best Match, Highest Rated, Most Reviewed |
| min_rating | string | — | Only collect businesses with at least this rating |
| min_reviews | integer | — | Only collect businesses with at least this many reviews |
| category_match | boolean | false | Only collect businesses whose categories contain your search term |
| results_details | boolean | false | Visit each business page to collect lat/lng, email, description, social links |
Setting results_details: true enables additional detail fields in results, including latitude, longitude, email, description, and social media links.
Code Examples
curl -X POST "https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH" \ -H "Authorization: Token YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"keyword": "plumber", "location": "Austin, TX", "max_results": 100, "sort": "Highest Rated"}}'
Response
201
{"params": {"keyword": "plumber", "location": "Austin, TX", "max_results": 100, "sort": "Highest Rated"}}