Skip to main content
GET
List Crawlers
This endpoint returns a paginated list of all available crawlers on the lobstr.io platform. Each crawler is designed to extract specific types of data from different sources. Use this endpoint to discover which crawlers are available for your data collection needs before creating squids or adding tasks.

Headers

string
required
Your API authentication token. Value: Token YOUR_API_KEY
string
default:"application/json"
Content type of the request. Value: application/json

Response Structure

integer
Total number of crawlers available. Example: 71
integer
Number of results per page. Example: 50
integer
Current page number. Example: 1
integer
Total number of pages available. Example: 1
integer
Starting index of results in current page. Example: 1
integer
Ending index of results in current page. Example: 71
array
Array of crawler objects with comprehensive details
string | null
Full URL to the next page (null if on last page). Example: null
string | null
Full URL to the previous page (null if on first page). Example: null

Crawler Object Fields

string
Unique identifier (hash) for the crawler. Example: "4734d096159ef05210e0e1677e8be823"
string
Human-readable name of the crawler. Example: "Google Maps Search Export"
string
URL-friendly identifier. Example: "google-maps-search-export"
boolean
Whether the crawler is publicly available. Example: true
boolean
Whether the crawler is currently available for use (false if paused). Example: true
boolean
Requires premium subscription or extra credits. Example: false
boolean
Currently experiencing issues (runs paused until fixed). Example: false
integer
Maximum number of concurrent tasks allowed for this crawler. Example: 20
object
Credits charged per result row, keyed by plan type: current is the rate on today’s plans, legacy the rate kept by grandfathered subscriptions. Example: {"legacy": 1, "current": 1}
object
Credits charged per email found, keyed the same way as credits_per_row. Only meaningful for crawlers with an email enrichment function. Example: {"legacy": 100, "current": 2}
boolean
Whether this crawler can verify the email addresses it finds. Example: true
string
What the crawler collects, as shown in the store. Example: "Export every follower of a public Instagram account"
string | null
Link to the crawler’s help article, or null when it has none. Example: null
integer | null
Position in the public store listing. null for crawlers that are not ranked. Example: 1
object | null
Throughput profile of the crawler’s default worker — success_ratio, min_rate_per_worker, and max_rate_per_worker. null when no profile is published.
object | null
Same throughput profile for the email enrichment worker. null when the crawler has no email function.
array
Crawlers this one can chain into. Empty when the crawler supports no chaining — see Get Crawler Details for the shape of each entry.
object | null
Required account sync details (null if no authentication needed). Example: null
string
Base64-encoded SVG icon for UI display. Example: "data:image/svg+xml;base64,PHN2ZyB4bWxucz..."
Cache the list of crawlers locally as it doesn’t change frequently. This reduces unnecessary API calls and improves your application’s performance.
Each crawler has a unique hash identifier that you’ll use when creating squids or configuring data collection tasks.
Check the crawler parameters endpoint to see what configuration options are available for each crawler before starting your scraping operations.

Available Crawlers

Quick reference of all public crawlers and their IDs. Use the Crawler ID as the squid_hash when creating a squid or as the crawler_id when querying by crawler.

Code Examples

Response

200