List Crawlers

curl --request GET \
  --url https://api.lobstr.io/v1/crawlers \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lobstr.io/v1/crawlers"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lobstr.io/v1/crawlers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/crawlers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/crawlers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/crawlers")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/crawlers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "total_results": 123,
  "limit": 123,
  "page": 123,
  "total_pages": 123,
  "result_from": 123,
  "result_to": 123,
  "data": [
    {}
  ],
  "next": {},
  "previous": {},
  "data[].id": "<string>",
  "data[].name": "<string>",
  "data[].slug": "<string>",
  "data[].is_public": true,
  "data[].is_available": true,
  "data[].is_premium": true,
  "data[].has_issues": true,
  "data[].max_concurrency": 123,
  "data[].credits_per_row": 123,
  "data[].account": {},
  "data[].icon": "<string>"
}

GET

crawlers

List Crawlers

curl --request GET \
  --url https://api.lobstr.io/v1/crawlers \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lobstr.io/v1/crawlers"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lobstr.io/v1/crawlers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/crawlers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/crawlers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/crawlers")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/crawlers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "total_results": 123,
  "limit": 123,
  "page": 123,
  "total_pages": 123,
  "result_from": 123,
  "result_to": 123,
  "data": [
    {}
  ],
  "next": {},
  "previous": {},
  "data[].id": "<string>",
  "data[].name": "<string>",
  "data[].slug": "<string>",
  "data[].is_public": true,
  "data[].is_available": true,
  "data[].is_premium": true,
  "data[].has_issues": true,
  "data[].max_concurrency": 123,
  "data[].credits_per_row": 123,
  "data[].account": {},
  "data[].icon": "<string>"
}

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: 53

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: 53

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

number

Credits charged per result row. Example: 0.5

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.

Code Examples

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

import requests

url = "https://api.lobstr.io/v1/crawlers"
headers = {
    "Authorization": "Token YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
data = response.json()

print(f"Total crawlers: {data['total_results']}")
print(f"Showing {data['result_from']}-{data['result_to']}\n")

# Display available crawlers
for crawler in data['data']:
    status = "✓" if crawler['is_available'] else "✗"
    premium = " [PREMIUM]" if crawler['is_premium'] else ""
    print(f"{status} {crawler['name']}{premium}")
    print(f"   ID: {crawler['id']}")
    print(f"   Credits: {crawler['credits_per_row']} per row")
    print()

Response

200

{
  "total_results": 53,
  "limit": 50,
  "page": 1,
  "total_pages": 2,
  "result_from": 1,
  "result_to": 50,
  "data": [
    {
      "id": "6c5227261fbbd3430f926d409f4c44bf",
      "object": "crawler",
      "account": null,
      "name": "Twitter Profile Scraper",
      "slug": "twitter-profile-scraper",
      "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+",
      "is_public": true,
      "is_available": true,
      "is_premium": false,
      "has_issues": false,
      "max_concurrency": 20,
      "credits_per_row": 2
    },
    {
      "id": "c47dfc2beba9fdc2472d3b3321b06b66",
      "object": "crawler",
      "account": {
        "type": "facebook-sync",
        "baseurl": "https://www.facebook.com",
        "cookies": [
          {
            "name": "c_user",
            "required": true
          },
          {
            "name": "xs",
            "required": true
          }
        ],
        "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+"
      },
      "name": "Facebook Pages Search Export",
      "slug": "facebook-pages-search-export",
      "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+",
      "is_public": true,
      "is_available": true,
      "is_premium": false,
      "has_issues": false,
      "max_concurrency": 20,
      "credits_per_row": 20
    },
    {
      "id": "a1d243d3824a1ac773414416eb80362d",
      "object": "crawler",
      "account": {
        "type": "sales-nav-sync",
        "baseurl": "https://www.linkedin.com",
        "cookies": [
          {
            "name": "li_at",
            "required": true
          },
          {
            "name": "JSESSIONID",
            "required": true
          }
        ],
        "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+"
      },
      "name": "Sales Navigator Leads Scraper",
      "slug": "sales-navigator-leads-scraper",
      "icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1MCIgaGVpZ2h0PSI1MCI+PC9zdmc+",
      "is_public": true,
      "is_available": true,
      "is_premium": false,
      "has_issues": false,
      "max_concurrency": 10,
      "credits_per_row": 3
    }
  ],
  "next": null,
  "previous": null
}

Get Balance Get Crawler Details

Overview

Getting Started

Core Concepts

User

Crawler

Squid

Delivery

Account

Task

Run

Result

List Crawlers

Headers

Response Structure

Crawler Object Fields

Code Examples

Response

​Headers

​Response Structure

​Crawler Object Fields

​Code Examples

​Response

Headers

Response Structure

Crawler Object Fields

Code Examples

Response