--- title: "List lead scrapers" method: GET path: "/api/v1/lead-scrapers" tags: ["Lead Scrapers"] --- # List lead scrapers `GET /api/v1/lead-scrapers` ## Request - Base URL: `https://api.aerosend.io` - URL: `https://api.aerosend.io/api/v1/lead-scrapers` - Auth: API key in header `X-API-Key` Returns the lead scraper catalog for the authenticated client. ## Behavior - Returns the same 16 scrapers for every account - Each scraper includes `id`, `name`, and `inputs` - Send `id` as `scraper_id` and each input `key` inside `params` - Does not include prices - Does not charge and does not start a scrape ## Input object - **key**: snake_case name to send in `params` - **label**: the name shown to the customer - **type**: `text`, `url`, `number`, `boolean`, `string_list`, `select`, or `multi_select` - **required**: the field must be present on submit - **options**: allowed values when type is `select` or `multi_select`. Each option has `value` and `label`. Send `value` - **minimum**, **maximum**, and **step**: limits when the form enforces them `string_list` and `multi_select` are JSON arrays of strings. `file_name` keeps letters, numbers, spaces, underscores, and hyphens. A result count is required before payment even when that field is optional on submit. ## Scrapers and params **clutch** (Clutch) - **clutch_url** (text, required) - **number_of_companies** (number, optional). When present, rounds up to the next 1,000 - **file_name** (text, required) **google-maps** (Google Maps) - **categories** (string_list, required) - **exact_match** (boolean, optional) - **locations** (string_list, required) - **max_results** (number, required). Integer >= 1000 and a multiple of 1000 - **enrichments** (multi_select, optional): `companyInsight`, `similarWeb`, `contactsLeadEnrichment`, `emailContacts`, `phoneEnricher`, `chainInfo`, `builtWith` - **file_name** (text, required) **ad-libraries** (Ad Libraries) - **company_names** (string_list, required) - **platforms** (multi_select, optional): `meta`, `tiktok`, `google`, `linkedin` - **file_name** (text, required) **sales-navigator** (Professional Navigator) - **sales_navigator_url** (url, required) - **sales_navigator_number_of_results** (number, optional). 1000, 2000, or 2500 - **file_name** (text, required) **yelp** (Yelp) - **yelp_search_term** (text, required) - **yelp_location** (text, optional) - **yelp_number_of_results** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **yellow-pages** (Yellow Pages) - **search_term** (text, required) - **location** (text, optional) - **yellow_pages_number_of_results** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **indeed** (Indeed) - **job_title** (text, required) - **indeed_location** (text, optional) - **indeed_country** (select, optional): `us`, `uk`, `ca`, `au`, `de`, `fr`, `in`, `nl`, `ie`, `sg`, `ae`, `jp`, `br`, `mx`, `es`, `it`, `pl`, `be`, `ch`, `at`, `nz`, `za`, `ph`, `id`, `my`, `kr`, `tw`, `hk`, `pt`, `se`, `no`, `dk`, `fi` - **number_of_results** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **linkedin-jobs** (Professional Jobs) - **titles** (string_list, required) - **locations** (string_list, optional) - **date_posted** (select, optional): `r86400` past 24 hours, `r604800` past week, `r2592000` past month. Omit for any time - **contract_type** (multi_select, optional): `F` full-time, `P` part-time, `C` contract, `T` temporary, `I` internship, `V` volunteer - **experience_level** (multi_select, optional): `1` internship, `2` entry level, `3` associate, `4` mid-senior, `5` director, `6` executive - **remote_type** (multi_select, optional): `2` remote, `1` hybrid, `3` on-site - **results_limit** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **post-search** (Professional Post Search) - **search_keywords** (string_list, required) - **post_date_posted** (select, optional): `any`, `past1h`, `past24h`, `pastWeek`, `pastMonth`, `past3months`, `past6months`, `pastYear` - **post_sort_by** (select, optional): `relevant`, `recent` - **number_of_posts** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **profile-search** (Professional Profile Search) - **profile_search_query** (text, required). At most 300 characters - **profile_locations** (string_list, optional) - **current_job_titles** (string_list, optional) - **seniority_level** (multi_select, optional): `in_training`, `entry_level`, `senior`, `strategic`, `entry_manager`, `experienced_manager`, `director`, `vp`, `cxo`, `owner` - **profile_detail_level** (select, optional): `short`, `full`, `fullEmail` - **profile_number_of_results** (number, optional). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **email-verification** (Email Verification) - **file_id** (text, required). Returned by `POST /api/v1/lead-scrapers/email-verification/file` - **number_of_contacts_to_verify** (number, required). Integer >= 1 - **file_name** (text, required) **apollo** (Apollo) - **apollo_search_url** (url, required) - **apollo_number_of_leads** (number, required). Integer >= 1000 and a multiple of 1000 - **apollo_verify_emails** (select, optional): `dont-verify`, `verify` - **file_name** (text, required) **crunchbase** (Crunchbase) - **crunchbase_search_url** (url, required) - **crunchbase_number_of_companies** (number, required). Integer >= 1000 and a multiple of 1000 - **file_name** (text, required) **profile-enrichment** (Profile Enrichment) - **profile_enrichment_urls** (string_list, required). Each item is a URL - **file_name** (text, required) **post-comments** (Post Commenters) - **post_urls** (string_list, required) - **max_comments_per_post** (number, optional). Integer >= 1 - **posted_limit** (select, optional): `past24h`, `pastWeek`, `pastMonth` - **scrape_replies** (boolean, optional) - **profile_scraper_mode** (select, optional): `short`, `full` - **file_name** (text, required) **google-ads** (Google Ads) - **advertiser_name** (text). At least one of **advertiser_name** or **transparency_center_url** is required - **transparency_center_url** (text) - **ad_format** (select, optional): `text`, `image`, `video`. Omit for all formats - **max_results** (number, optional). Integer from 1 to 50000. Required before payment ## Response `200` Catalog retrieved - LeadScraperListApiResponse - `success` boolean: Success flag - `data` LeadScraper[]: Response data - `id` string: Scraper id to send as scraper_id - `name` string: Display name - `inputs` LeadScraperInput[]: Inputs this scraper accepts - `key` string: snake_case key to send in params - `label` string: Label from the form - `type` string: text, url, number, boolean, string_list, select, or multi_select - `required` boolean: True when the field must be present - `options` LeadScraperOption[]: Allowed values when type is select or multi_select - `value` string: Value to send in params - `label` string: Label shown on the form - `minimum` integer: Minimum when the form enforces one - `maximum` integer: Maximum when the form enforces one - `step` integer: Step when the form enforces one - `timestamp` string: Response timestamp ## Other responses - `401`: Unauthorized - Invalid or expired API key - `429`: Rate limit exceeded --- [API](https://skmtc.dev/aerosend/apis/aerosend-developer-api.md) · [All operations](https://skmtc.dev/aerosend/apis/aerosend-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aerosend/apis/aerosend-developer-api/revisions/9828eeb89b1f?raw)