Skip to content
Overview

lobstr.io API Documentation

The most powerful and easy-to-use data collection API. 70+ ready-made crawlers, simple REST endpoints, structured JSON output.

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.

Core Concepts

The lobstr.io API is built around three primitives:

  • Squid — a configured scraper instance tied to a crawler and your settings
  • Task — a URL or keyword the squid will scrape
  • Run — a single execution of a squid against its tasks

A typical workflow:

  1. Authenticate

    Include Authorization: Token YOUR_API_KEY in every request. Get your key from the dashboard.

  2. Create a squid

    Pick a crawler (e.g. google-maps-leads-scraper) and create a squid with your settings.

  3. Add tasks

    Add URLs or keywords as tasks to the squid.

  4. Start a run

    Trigger a run and poll for completion.

  5. Get results

    Fetch structured JSON results from GET /v1/results.

Developer Tools