Skip to content
Examples

Update Settings

Configure LinkedIn Search Scraper settings

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.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

Configure your LinkedIn Search Scraper squid settings.

This scraper requires a synced LinkedIn account. Link one to your squid before running.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Must be application/json. Value: application/json

Squid Parameters

Parameter Type Default Description
keywords string — Free-text search keywords. Overrides the keywords of the pasted URL when set. Works on people, company and post searches.
first_name string — People search only. Keeps only profiles whose first name matches.
last_name string — People search only. Keeps only profiles whose last name matches.
title string — People search only. Free-text job title filter. LinkedIn matches it against the current title.
company string — People search only. Free-text company filter. For an exact company page use current_company_url instead — if both are filled, current_company_url wins.
current_company_url string — People search only. LinkedIn company page URL or slug. Resolved to LinkedIn's company id; keeps only people currently working there. Costs one extra request per task.
school string — People search only. Free-text school filter.
network string — People search only. Connection degrees to keep, from 1st, 2nd, 3rd+. Comma separated for several (e.g. 1st,2nd).
profile_language string — People search only. Two-letter profile language codes, comma separated (e.g. fr or en,fr).
location string — A place name (e.g. France, Paris, or Paris Texas to pick one city among namesakes). LinkedIn's numeric geo id still works (e.g. 103644278 for the United States). Comma separated for several. Applies to people (member location) and companies (headquarters location).
industry string — Company search only. An industry name as LinkedIn lists it (e.g. Software Development, Hospitals and Health Care). LinkedIn's numeric industry id still works. Comma separated for several.
max_results integer 1000 Maximum number of rows to collect per search URL. LinkedIn never returns more than about 1,000 results for one search, whatever this is set to.
max_unique_results_per_run integer — Maximum number of unique results retrieved across all tasks in the entire run. Leave empty for unlimited.
profile_details boolean false People search only. Opens each profile once to add the About text, current position, full experience, education, skills, open-to-work and creator flags and the cover photo. Costs 1 extra credit per profile.
company_details boolean false Company search only. Opens each company page once to add the website, description, tagline, founding year, employee and follower counts, size, type, headquarters and offices, specialties, cover image, similar/showcase/affiliated pages, products and phone. Costs 1 extra credit per company.
post_engagement boolean false Post search only. Opens each post once to add its like, comment and repost counts. Costs 1 extra credit per post.

Code Examples

curl -X POST https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "CEO",
    "location": "United States",
    "network": "1st,2nd",
    "max_results": 500,
    "profile_details": true
  }'

Response

201
{"params": {"title": "CEO", "location": "United States", "network": "1st,2nd", "max_results": 500, "profile_details": true}}