--- title: Lobstr API Integration on Truto slug: lobstr category: Default canonical: "https://truto.one/integrations/detail/lobstr/" --- # Lobstr API Integration on Truto **Category:** Default **Status:** Generally available ## MCP-ready AI tools Truto exposes 42 tools for Lobstr that AI agents can call directly. - **list_all_lobstr_plants** — List all plants in lobstr that the user has access to. Returns: id. - **create_a_lobstr_plant** — Create a new plant in the lobstr store. Returns: id. - **delete_a_lobstr_plant_by_id** — Delete a single plant in lobstr by id. Returns an empty 204 response on success. Required: id. - **get_single_lobstr_user_by_id** — Get the authenticated lobstr user's complete profile in a single call. Returns: personal_details, account_status, subscription. Useful as a first call after authentication to verify credentials and inspect account state. - **get_single_lobstr_balance_by_id** — Get the current lobstr account balance and credit information. Returns: name, available, consumed, bonus_credit, rollover_credit, interval, used_slots, total_available_slots, has_unpaid_bill, reset_time. - **list_all_lobstr_crawlers** — List all available crawlers on the lobstr platform. Returns: id, name, is_available, is_premium, credits_per_row for each crawler. Use this to discover which crawlers are available before creating squids or adding tasks. - **get_single_lobstr_crawler_by_id** — Get a single lobstr crawler by id. Returns: id, name, is_available, is_premium, credits_per_row. Required: id. - **get_single_lobstr_crawler_param_by_id** — Get the configurable input parameters for a specific lobstr crawler. Returns the full parameter configuration organized into two sections: task and squid. Required: crawler_hash. - **list_all_lobstr_squids** — List all lobstr squids belonging to the authenticated user. Returns squid objects including id and name. Optionally filter results by name using a case-insensitive partial match. - **create_a_lobstr_squid** — Create a new squid in lobstr. Returns the created squid object including id and name. - **get_single_lobstr_squid_by_id** — Get a single lobstr squid by id. Returns: id, name. Required: id. - **update_a_lobstr_squid_by_id** — Update an existing lobstr squid by id. Returns the updated squid object including id and name. Required: id. - **delete_a_lobstr_squid_by_id** — Delete a lobstr squid by id. Returns an empty 204 response on success. Required: id. - **list_all_lobstr_tasks** — List lobstr tasks. Returns: id, status, and params for each task record in the collection. - **create_a_lobstr_task** — Create lobstr tasks by adding URLs or search queries to a squid for scraping. Returns tasks (array with id, status, params) and duplicated_count indicating how many duplicate tasks were skipped. Required: squid, tasks. - **get_single_lobstr_task_by_id** — Get a single lobstr task by id. Returns: id, status, and params containing the scraping parameters for the task. Required: id. - **delete_a_lobstr_task_by_id** — Delete a lobstr task by id. Returns an empty 204 response on success. Required: id. - **list_all_lobstr_runs** — List lobstr runs for a specific squid to view run history and past executions. Returns: id, status, is_done, total_results, credit_used, done_reason. Required: squid. - **create_a_lobstr_run** — Create a new run in lobstr. Returns: id, status, is_done, total_results, credit_used, done_reason. - **get_single_lobstr_run_by_id** — Get a single lobstr run by id. Returns: id, status, is_done, total_results, credit_used, done_reason. - **get_single_lobstr_run_stat_by_id** — Get detailed real-time statistics for a specific lobstr run. Returns: percent_done, total_tasks_done, total_tasks, results_done, results_total, duration, eta, and is_done. Useful for polling run progress until the run completes. Required: run_hash. - **get_single_lobstr_run_credit_by_id** — Get credit usage details for a lobstr run by its hash identifier. Returns: run_id, total_credits, total_results, breakdown (per-function credit and attempt counts), rates, base_function_label, and filter_breakdown. Required: run_hash. - **get_single_lobstr_run_download_by_id** — Get a temporary download URL for a lobstr run's exported results file. Returns: s3 (a pre-signed temporary URL pointing directly to the data file). Required: run_hash. - **list_all_lobstr_run_tasks** — List run tasks in lobstr. Returns the collection of task execution records. Returns: id, status, where status reflects the task lifecycle (pending, running, uploading, paused, done, aborted, error). - **list_all_lobstr_results** — List scraped data results from lobstr runs, queryable per squid. Returns an array of scraped data rows; the fields within each row are scraping-configuration-specific and vary by squid setup. To export results as a file, use the Download Run endpoint instead. - **list_all_lobstr_accounts** — List all connected platform accounts in lobstr. Returns a paginated array of account objects, each including: id, username, type, status, status_code_info, and baseurl. - **get_single_lobstr_account_by_id** — Get a single lobstr connected platform account by id. Returns: id, username, type, status, status_code_info, and baseurl. Required: id. - **delete_a_lobstr_account_by_id** — Delete a lobstr connected platform account by id. Returns an empty 204 response on success. Required: id. - **create_a_lobstr_account** — Create a new connected platform account in lobstr. Returns: id, username, type, status, status_code_info, and baseurl. - **create_a_lobstr_account_cooky** — Create a lobstr platform account by submitting authentication cookies for a specific account type. Returns the created account object including id, username, type, status, status_code_info, and cookies. Required: type, cookies. - **list_all_lobstr_account_types** — List all available platform account types in lobstr and their authentication requirements. Returns: id, name, domain, baseurl, cookies (required credential names), and params (optional rate-limit and batch configuration). No required parameters. - **get_single_lobstr_synchronize_by_id** — Check the synchronization status of a cookie update task in lobstr by its ID. Returns: id, object, status_code, status_text, account_hash. Required: id. - **get_single_lobstr_crawler_attribute_by_id** — Get the output attributes defined for a specific lobstr crawler. Returns the list of result fields the crawler can produce, including each attribute's name, type, description, function group, is_main flag, and example value. Required: crawler_hash. - **get_single_lobstr_squid_chain_by_id** — Get the chain configuration for a lobstr squid. Returns the downstream chain settings including target_module_id, field_map, autostart, cluster_name, and cluster_concurrency. Required: squid_hash. - **create_a_lobstr_squid_chain** — Configure a chain on a lobstr squid so its results automatically feed into a target squid. Returns the chain configuration including target_module_id, field_map, autostart, cluster_name, and cluster_concurrency. Required: squid_hash, target_module_id. A squid can only have one outgoing chain at a time; chains are limited to a maximum depth of 3 squids. - **delete_a_lobstr_squid_chain_by_id** — Delete the chain configuration on a lobstr squid, removing the downstream link to the target squid. Returns an empty 204 response on success. Required: squid_hash. - **create_a_lobstr_squid_empty** — Empty a lobstr squid by removing all its tasks and results while preserving its configuration. Returns: id, object, emptied, deleted_count. Required: squid_hash. - **create_a_lobstr_task_upload** — Upload tasks to lobstr to queue them for scraping. Returns: tasks (array of task objects each with id, status, and params) and duplicated_count indicating how many submitted tasks were duplicates. - **get_single_lobstr_task_upload_by_id** — Get a single lobstr task upload by id. Returns: id, status, and params containing the target URL. Required: id. - **create_a_lobstr_run_abort** — Abort an active lobstr run before completion using its hash ID. The run stops collecting data immediately and begins exporting any results already gathered. Returns: id, status, is_done, done_reason, total_results, duration, credit_used. Required: run_hash. - **create_a_lobstr_delivery** — Create and configure a delivery integration for a lobstr squid (scraping job). Supports delivery methods including email, Google Sheets, webhook, S3, and SFTP. The source documentation for this endpoint does not enumerate specific parameter names or response fields. - **create_a_lobstr_delivery_test** — Test a lobstr delivery configuration for a specified delivery method. Returns an empty 204 response on success. Required: route (one of 'email', 'googlesheet', 'webhook', 's3', or 'sftp'). ## How it works 1. **Link your customer's Lobstr account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Lobstr.** The Proxy API is a 1-to-1 mapping of the Lobstr API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed authenticated web scraping into your SaaS** — Offer your customers built-in data extraction from gated platforms like LinkedIn, Sales Navigator, and Google Maps without them ever leaving your product. Truto handles the Lobstr connection so your users only see your UI. - **Power AI prospecting and lead enrichment workflows** — Sales and RevOps platforms can let users define an ICP, then run Lobstr Squids on Sales Navigator or LinkedIn in the background to feed structured lead data into downstream enrichment and outreach pipelines. - **Automate competitor and review monitoring for vertical SaaS** — Local SEO, reputation, and franchise platforms can schedule recurring Google Maps and review scrapes per customer location, surfacing fresh competitor and sentiment data inside their dashboards. - **Run market intelligence pipelines for real estate and classifieds** — Prop-tech and classifieds analytics tools can trigger overnight Runs across hundreds of search URLs, pull bulk JSON from Lobstr, and update pricing or inventory models without operating scraper infrastructure. - **Offer no-code data pipelines to non-technical end users** — Abstract Lobstr's Crawlers, Squids, and Tasks behind your own campaign builder so end users configure scraping jobs in your product's language while you orchestrate everything via Truto. ## What you can build - **In-app Squid configuration builder** — Let users pick a Crawler, create a Squid, and update its parameters from inside your product using create_a_lobstr_squid and update_a_lobstr_squid_by_id. - **Bring-your-own-cookie account linking** — Capture an end user's session cookies via your own onboarding flow and inject them into Lobstr through create_a_lobstr_account and create_a_lobstr_account_cooky to scrape authenticated sites. - **Bulk task upload and campaign launcher** — Accept CSVs or URL lists from users, push them with create_a_lobstr_task or create_a_lobstr_task_upload, then kick off extraction via create_a_lobstr_run. - **Multi-step scraping with Squid Chains** — Wire outputs of one Squid into another (e.g. Google Maps Search → Google Maps Reviews) using create_a_lobstr_squid_chain to ship end-to-end pipelines as a single user-facing workflow. - **Real-time run monitoring and credit dashboards** — Show users live run progress, credit consumption, and history using get_single_lobstr_run_by_id, get_single_lobstr_run_stat_by_id, get_single_lobstr_run_credit_by_id, and get_single_lobstr_balance_by_id. - **Webhook-based result ingestion** — Register deliveries with create_a_lobstr_delivery to receive completed run data asynchronously, or pull row-level results via list_all_lobstr_results and bulk files via get_single_lobstr_run_download_by_id. ## FAQs ### How do end users authenticate their Lobstr account? Users connect their Lobstr workspace through Truto's managed auth flow. For scraping sites behind login walls, your product can additionally capture browser session cookies from the end user and pass them to Lobstr via the create_a_lobstr_account_cooky endpoint, so passwords are never shared. ### Can I trigger scraping jobs programmatically from my backend? Yes. You can fully orchestrate Lobstr headlessly: create a Squid, add Tasks (single URLs or bulk uploads), start execution with create_a_lobstr_run, and abort with create_a_lobstr_run_abort — all without your users touching Lobstr's UI. ### What's the best way to get results back into my application? Two patterns are supported. For real-time ingestion, configure a webhook with create_a_lobstr_delivery so Lobstr pushes results when a run completes. For pull-based flows, poll get_single_lobstr_run_stat_by_id, then fetch row-level data via list_all_lobstr_results or the bulk S3 file via get_single_lobstr_run_download_by_id. ### Does Lobstr support multi-step scraping workflows? Yes. Using create_a_lobstr_squid_chain you can pipe the output of one Squid into another (up to a depth of 3), which is ideal for patterns like search → detail page or listing → reviews without building intermediate glue code. ### How do I track usage and credit consumption per customer? Lobstr exposes balance and per-run credit endpoints. You can call get_single_lobstr_balance_by_id for the account-level balance and get_single_lobstr_run_credit_by_id to attribute consumption to a specific run, which is useful for metering or reselling capacity to your customers. ### Which Crawlers and target sites can my users access? Lobstr maintains 50+ pre-built Crawlers covering platforms like LinkedIn, Sales Navigator, Google Maps, Twitter, YouTube, and real estate aggregators. You can list them dynamically with list_all_lobstr_crawlers and inspect configurable parameters via get_single_lobstr_crawler_param_by_id to render them inside your product. ## Related reading - [Connect Lobstr to Claude: Manage Crawlers and Automated Results](https://truto.one/blog/connect-lobstr-to-claude-manage-crawlers-and-automated-results/) — Learn how to connect Lobstr to Claude using a managed MCP server to orchestrate web scraping squids, tasks, and data exports directly from your AI agent. - [Connect Lobstr to ChatGPT: Automate Scraper Squids and Data Runs](https://truto.one/blog/connect-lobstr-to-chatgpt-automate-scraper-squids-and-data-runs/) — Learn how to connect Lobstr to ChatGPT using a managed MCP server. Automate data extraction, orchestrate scraper squids, and track runs with AI. - [Connect Lobstr to AI Agents: Orchestrate Tasks and Scraped Exports](https://truto.one/blog/connect-lobstr-to-ai-agents-orchestrate-tasks-and-scraped-exports/) — Learn how to connect Lobstr to AI agents using Truto's /tools endpoint. Build autonomous workflows to orchestrate web crawlers, execute runs, and extract data.