Skip to main content
GET
/
v1
/
crawlers
/
{crawler_hash}
Get Crawler Details
curl --request GET \
  --url https://api.lobstr.io/v1/crawlers/{crawler_hash} \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "is_public": true,
  "is_available": true,
  "is_premium": true,
  "has_issues": true,
  "account": {},
  "input": [
    {}
  ],
  "result": [
    {}
  ],
  "input[].level": "<string>",
  "input[].is_params": "<string>",
  "input[].is_details": "<string>",
  "input[].function": "<string>",
  "input[].credits_per_function": "<string>",
  "input[].name": "<string>",
  "input[].type": "<string>",
  "input[].required": "<string>",
  "input[].default": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves detailed information about a specific crawler using its hash ID. It helps you understand each crawler’s availability, cost, parameters, and potential issues before using it.

​
Headers

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

​
Query Parameters

​
crawler_hash
string
required
The unique identifier (hash/id) of the crawler. Example: 4734d096159ef05210e0e1677e8be823

​
Response Field Explanations

​
id
string
Unique identifier for the crawler. Example: "c106a44a98044ef18acc59986ae10967"
​
name
string
Human-readable name (e.g., “Google Maps Search Export”). Example: "Google Maps (1)"
​
slug
string
URL-friendly identifier. Example: ""
​
is_public
boolean
Whether the crawler is publicly accessible. Example: true
​
is_available
boolean
Whether the crawler is available for runs (false if paused). Example: true
​
is_premium
boolean
Requires premium subscription or extra credits. Example: false
​
has_issues
boolean
Currently experiencing issues (runs paused until fixed). Example: false
​
account
object | null
Required account sync details (null if no authentication needed). Example: null
​
input
array
Array of configurable parameters (task-level and squid-level). Example: []
​
result
array
Array of output field names this crawler collects. Example: []

​
Understanding Input Parameters

​
input[].level
string
Parameter level: “task” (per URL/task) or “squid” (overall run behavior). Example: ""
​
input[].is_params
string
For task-level: true indicates this parameter is used per task submission. Example: ""
​
input[].is_details
string
For squid-level: true indicates this controls overall behavior or features. Example: ""
​
input[].function
string
If true, this is an optional add-on feature with extra credit costs. Example: ""
​
input[].credits_per_function
string
Extra credits charged per row when this optional function is enabled. Example: ""
​
input[].name
string
Parameter name to use when configuring the crawler. Example: "Google Maps (1)"
​
input[].type
string
Data type of the parameter (string, int, boolean, etc.). Example: ""
​
input[].required
string
Whether this parameter is mandatory. Example: ""
​
input[].default
string
Default value if parameter is not provided. Example: ""
Check the ‘has_issues’ flag before creating tasks. If true, the crawler is experiencing problems and runs are paused.
Parameters with ‘function: true’ are optional add-ons that cost extra credits per row (specified in ‘credits_per_function’).
Some crawlers require account synchronization (see ‘account’ field). You’ll need to sync cookies before running these crawlers.
Use the ‘result’ array to know exactly what fields will be returned in your data. This helps you plan your data processing pipeline.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/crawlers/4734d096159ef05210e0e1677e8be823" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "id": "4734d096159ef05210e0e1677e8be823",
  "object": "crawler",
  "account": null,
  "name": "Google Maps Search Export",
  "slug": "google-maps-search-export",
  "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+",
  "is_public": true,
  "is_available": true,
  "is_premium": false,
  "has_issues": false,
  "input": [
    {
      "name": "url",
      "type": "string",
      "level": "task",
      "regex": "http(.*)google(.*)/maps/(search|place)(.*)",
      "default": null,
      "example": "https://www.google.com/maps/search/restaurant/@43.2928346,5.3662584,14z",
      "required": false,
      "is_details": false,
      "description": "A string representing the Google Maps Search URL, containing all establishments the crawler will collect."
    },
    {
      "name": "activity",
      "type": "string",
      "level": "task",
      "value": "restaurant",
      "example": "restaurant",
      "required": false,
      "is_params": true,
      "description": "The activity of the search location."
    },
    {
      "max": 200,
      "name": "max_results",
      "type": "int",
      "level": "squid",
      "default": 200,
      "example": 200,
      "required": false,
      "is_details": true,
      "description": "Google Maps restricts search results to a maximum of 200. To access a larger dataset, consider utilizing our URL generator."
    },
    {
      "name": "extract_emails_from_website",
      "type": "boolean",
      "level": "squid",
      "default": true,
      "display": "Extract Emails From Website",
      "function": true,
      "priority": 3,
      "required": false,
      "is_details": true,
      "description": "Extract email addresses from the business's website.",
      "credits_per_function": 10
    },
    {
      "name": "collect_business_details",
      "type": "boolean",
      "level": "squid",
      "default": false,
      "display": "Collect Business Details",
      "function": true,
      "priority": 1,
      "required": false,
      "is_details": true,
      "description": "Extract attributes like plus_code, poi, health, and last_opening_hours_updated_at.",
      "credits_per_function": 10
    }
  ],
  "result": [
    "zero_x",
    "cid",
    "url",
    "name",
    "address",
    "country_name",
    "country_code",
    "zip_code",
    "city",
    "lat",
    "lng",
    "ratings",
    "score",
    "category",
    "main_image_url",
    "phone",
    "website",
    "menu",
    "plus_code",
    "is_temporarily_closed",
    "is_permanently_closed",
    "has_owner",
    "opening_hours",
    "email",
    "facebook",
    "instagram"
  ],
  "max_concurrency": 20,
  "credits_per_row": 2
}