# Anysite API — Full Reference for AI Agents
> This file contains complete API documentation optimized for LLMs and AI agents.
> Use it to understand every endpoint, its parameters, and expected responses.
## Quick Start
Base URL: https://api.anysite.io
Auth: `access-token` header (NOT Bearer)
Method: POST (JSON body) for all data endpoints, GET for token management
```bash
curl -X POST "https://api.anysite.io/api/linkedin/user" \
-H "access-token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"user": "linkedin.com/in/williamhgates"}'
```
## Common Tasks (copy-paste recipes)
### Find a person's LinkedIn profile
POST /api/linkedin/user {"user": "linkedin.com/in/username"}
### Get company info
POST /api/linkedin/company {"url": "linkedin.com/company/google"}
### Search LinkedIn users by keywords
POST /api/linkedin/search/users {"keywords": "CTO fintech", "count": 10}
### Find someone's email
POST /api/linkedin/email/user {"first_name": "Bill", "last_name": "Gates", "company_name": "Microsoft"}
### Get Instagram user profile
POST /api/instagram/user {"url": "instagram.com/natgeo"}
### Search Twitter/X posts
POST /api/twitter/search/posts {"query": "AI agents", "count": 20}
### Parse any webpage
POST /api/webparser/parse {"url": "https://example.com"}
### Search the web
POST /api/duckduckgo/search {"query": "best CRM tools 2025"}
---
## Complete Endpoint Reference
### Crunchbase (2 endpoints)
#### POST /api/crunchbase/company
Get Crunchbase Company info **Price:** 20 credits
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- company: string (required) — Company alias or full Crunchbase URL
**Response (array of objects):**
- id: string (required) — Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- logo_url: string | null (optional) — Logo Url
- short_description: string (required) — Short Description
- description: string (required) — Description
- legal_name: string | null (optional) — Legal Name
- website: string | null (optional) — Website
- founded_on: string | null (optional) — Founded On
- operating_status: string | null (optional) — Operating Status
- company_type: string | null (optional) — Company Type
- ipo_status: string | null (optional) — Ipo Status
- employee_count_range: string | null (optional) — Employee Count Range
- revenue_range: string | null (optional) — Revenue Range
- categories: array[string] (optional) — Categories [default: []]
- location: object | null (optional)
- contacts: object | null (optional)
- funding: object | null (optional)
- metrics: object | null (optional)
- ipo: object | null (optional)
- patents: object | null (optional)
- acquired_by: object | null (optional)
- related: object | null (optional)
- leadership_hires: array[object] (optional) — Leadership Hires [default: []]
- siftery_products: array[object] (optional) — Siftery Products [default: []]
- bombora_surges: array[object] (optional) — Bombora Surges [default: []]
- apptopia: object | null (optional)
- predictions: object | null (optional)
- technologies: array[object] (optional) — Technologies [default: []]
- employees: array[object] (optional) — Employees [default: []]
- investors: array[object] (optional) — Investors [default: []]
- products: array[object] (optional) — Products [default: []]
- acquisitions: array[object] (optional) — Acquisitions [default: []]
- funding_rounds: array[object] (optional) — Funding Rounds [default: []]
- investments: array[object] (optional) — Investments [default: []]
- layoffs: array[object] (optional) — Layoffs [default: []]
- awards: array[object] (optional) — Awards [default: []]
- offices: array[object] (optional) — Offices [default: []]
- news: array[object] (optional) — News [default: []]
---
#### POST /api/crunchbase/search
Search Crunchbase companies by filters **Price:** 20 credits per 50 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: array | string (optional) — Description keywords. Example: 'FinTech' or ['RegTech', 'FinTech'] [default: []]
- location: array | string (optional) — HQ locations. Example: 'Boston' or ['San Francisco', 'Boston'] [default: []]
- postal_code: array | string (optional) — HQ postal codes. Example: '94105' or ['94105', '10001'] [default: []]
- industry: array | string (optional) — Industries. Example: 'SaaS' or ['SaaS', 'Cloud Computing'] [default: []]
- employee_count_min: integer | null (optional) — Min employee count. Allowed: 1, 11, 51, 101, 251, 501, 1001, 5001, 10001
- employee_count_max: integer | null (optional) — Max employee count. Allowed: 10, 50, 100, 250, 500, 1000, 5000, 10000, 10001
- founded_after: string | null (optional) — Founded after date. Format: MM/DD/YYYY. Example: '01/01/2020'
- founded_before: string | null (optional) — Founded before date. Format: MM/DD/YYYY. Example: '12/31/2023'
- hiring: boolean | null (optional) — Only actively hiring companies
- event: array | string (optional) — Participated in events. Example: 'Dreamforce' or ['Dreamforce', 'CES'] [default: []]
- spotlight: array | string (optional) — Diversity spotlight labels. Example: 'Black Led' or ['Black Led', 'Latine Founded'] [default: []]
- count: integer (required) — Max result count [min: >0, max: <1000]
**Response (array of objects):**
- id: string (required) — Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- cb_rank: integer | null (optional) — Cb Rank
- logo_url: string | null (optional) — Logo Url
- short_description: string | null (optional) — Short Description
- description: string | null (optional) — Description
- founded_on: string | null (optional) — Founded On
- employee_count_range: string | null (optional) — Employee Count Range
- categories: array[string] (optional) — Categories [default: []]
- location: object | null (optional)
---
### Custom AI Parsers (53 endpoints)
Custom scraping endpoints for specialized data sources. See full documentation:
https://docs.anysite.io/api-reference
- POST /api/ai_based/amazon/search — Search Amazon products by keywords
- POST /api/ai_based/amazon/search_products — Search Amazon products with filters for price, location, and category
- POST /api/ai_based/applyboard/country_programs — Extract study programs from ApplyBoard country pages
- POST /api/ai_based/applyboard/school_programs — Search programs at a specific school on ApplyBoard with optional filters for level, intake, and category
- POST /api/ai_based/applyboard/search_programs — Search study programs on ApplyBoard by query and location
- POST /api/ai_based/bmc/docs-search — Get BMC Helix ITSM documentation pages list from XWiki REST API.
- POST /api/ai_based/bmc/helix-itsm-overview — Get BMC Helix ITSM product overview page metadata from XWiki REST API
- POST /api/ai_based/builtwith/popular_technologies — Extract popular technologies from BuiltWith homepage with website counts
- POST /api/ai_based/builtwith/search_domains — Search for domains on BuiltWith autocomplete API
- POST /api/ai_based/builtwith/technologies — Extract technology stack information for a domain from BuiltWith
- POST /api/ai_based/cbonds/stock_tradings — Get stock trading data (price history, volume, etc.) by stock ID and date range
- POST /api/ai_based/companies-house/search — Search UK companies by keyword from Companies House
- POST /api/ai_based/github/search_users — Search GitHub users by keyword
- POST /api/ai_based/gleif/lei_search — Search LEI records by company legal name using GLEIF API
- POST /api/ai_based/google_maps/search — Search for restaurants/places on the map using OpenStreetMap data. Use 'data' param with Overpass QL query. Default: restaurants in Berlin center. Example bbox query: [out:json];node[amenity=restaurant][name](52.49,13.35,52.54,13.45);out 20;
- POST /api/ai_based/googlenews/search — Search Google News for articles by keyword
- POST /api/ai_based/hackernews/search — Search Hacker News stories via Algolia API
- POST /api/ai_based/honeywell/categories — Get category IDs and names for CategoryIds parameter in /honeywell/partner_search. Returns hierarchical category tree with ID and Name fields.
- POST /api/ai_based/honeywell/countries — Get country IDs and names for CountryId parameter in /honeywell/partner_search. Returns list of countries with id, name, and code.
- POST /api/ai_based/honeywell/partner_search — Search Honeywell channel partners by country, category, and language
- POST /api/ai_based/honeywell/partner_types — Get partner type IDs and names for category filter in /honeywell/partners endpoint
- POST /api/ai_based/honeywell/partners — Search Honeywell warehouse automation partners using BullseyeLocations. Returns partner companies with contact information, location, and partner type filters.
- POST /api/ai_based/immo-clean/page_content — Extract page content from immo-clean.de WordPress pages including HTML structure with headings
- POST /api/ai_based/immo-clean/pages — List all pages from immo-clean.de to discover page IDs for content extraction
- POST /api/ai_based/justjoinit/jobs — Get posted job listings from justjoin.it job board
- POST /api/ai_based/kaspersky/countries — Get country ID mappings for Kaspersky Partner Search. Use country_id in filter_UF_COUNTRY parameter.
- POST /api/ai_based/kaspersky/partner_search — Search Kaspersky B2B partners by country. Use /kaspersky/countries to get country_id values for filter_UF_COUNTRY parameter. Supports pagination.
- POST /api/ai_based/krisha/advertisement — Extract full advertisement details from krisha.kz listing page by ad_id path parameter
- POST /api/ai_based/linkedin/job_search — Search LinkedIn jobs by keywords and location (public access)
- POST /api/ai_based/peatus/bus_routes — Search bus routes between two locations in Estonia with departure time and transport modes
- POST /api/ai_based/pinterest/posts — Payload example
- POST /api/ai_based/potomac/blog_articles — Extract all blog articles from Potomac blog page
- POST /api/ai_based/reddit/user — Get basic public profile information for a Reddit user
- POST /api/ai_based/reddit/user/comments — List most recent public comments made by a user
- POST /api/ai_based/rockwell/partner_details — Get full partner details from Rockwell Automation by partner ID
- POST /api/ai_based/rockwell/partners — Search Rockwell Automation partners with keyword search, filtering by partner type (SI/Distributor), and pagination support
- POST /api/ai_based/rockwellautomation/partner_details — Get full partner details by ID including address with country
- POST /api/ai_based/sgheg/doctors — Search doctors from SGH Egypt website
- POST /api/ai_based/sgheg/events — Get upcoming events from SGH Egypt website
- POST /api/ai_based/sgheg/media — Get media center items from SGH Egypt website
- POST /api/ai_based/sgheg/news — Get news articles from SGH Egypt website
- POST /api/ai_based/soundcloud/search — Search SoundCloud tracks by keyword
- POST /api/ai_based/theunfolder/category_articles — Extract article URLs from The Unfolder category pages for cross-posting
- POST /api/ai_based/tripadvisor/search_places — Search for places, locations, hotels, restaurants, and attractions on TripAdvisor
- POST /api/ai_based/trustmrr/search_company — Search for company details on TrustMRR by name
- POST /api/ai_based/trustmrr/search_startups — Search TrustMRR for startups, founders, and categories by name or keyword
- POST /api/ai_based/trustpilot/search_companies — Search companies on Trustpilot with filters (country, query, page, pageSize)
- POST /api/ai_based/twitter/user_tweets — Get user timeline tweets with media (images/videos) and engagement metrics
- POST /api/ai_based/universetoday/article_content — Get full content of a Universe Today article by URL path
- POST /api/ai_based/universetoday/articles — Get list of news articles from Universe Today homepage with pagination
- POST /api/ai_based/wasabi/channel_partners — Search Wasabi channel partners (243 partners across 27 pages). Use page parameter for pagination (0-26).
- POST /api/ai_based/wikileaks/search — Search WikiLeaks documents by keyword with pagination support
- POST /api/ai_based/x/user_by_screen_name — Get X/Twitter user profile information by screen name (username)
---
### DuckDuckGo Search (1 endpoints)
#### POST /api/duckduckgo/search
Simple DuckDuckGo search parser by query.
The first result is the most relevant. **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (required) — Search query. For example: 'python fastapi'
- count: integer (optional) — Maximum number of results (from 1 to 20) [min: >0, max: <21] [default: 10]
**Response (array of objects):**
- url: string (required) — Url
- title: string (optional) — Title [default: ]
- description: string (optional) — Description [default: ]
---
### Instagram Posts (3 endpoints)
#### POST /api/instagram/post
Instagram Get Post by ID **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- post: string (required) — Post ID
**Response (array of objects):**
- id: string (required) — Id
- code: string (required) — Code
- url: string (required) — Url
- image: string (required) — Image
- text: string | null (optional) — Text
- created_at: integer | null (optional) — Created At
- like_count: integer (optional) — Like Count [default: 0]
- comment_count: integer (optional) — Comment Count [default: 0]
- reshare_count: integer (optional) — Reshare Count [default: 0]
- view_count: integer | null (optional) — View Count
- user: object | null (optional)
- type: string | null (optional) — Type
- media: array[object] (optional) — Media [default: []]
- carousel_media_count: integer (optional) — Carousel Media Count [default: 0]
- is_paid_partnership: boolean (optional) — Is Paid Partnership [default: False]
---
#### POST /api/instagram/post/comments
Instagram Get Post Comments **Price:** 1 credit per 15 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- post: string (required) — Post ID
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- comment_index: integer (optional) — Comment Index [default: 0]
- created_at: integer | null (optional) — Created At
- text: string (required) — Text
- like_count: integer (optional) — Like Count [default: 0]
- reply_count: integer (optional) — Reply Count [default: 0]
- parent_id: string | null (optional) — Parent Id
- user: object | null (optional)
---
#### POST /api/instagram/post/likes
Instagram Get Post Likes **Price:** 1 credit per 100 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- post: string (required) — Post ID
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- image: string | null (optional) — Image
- is_verified: boolean (optional) — Is Verified [default: False]
- is_private: boolean (optional) — Is Private [default: False]
---
### Instagram Search (1 endpoints)
#### POST /api/instagram/search/posts
Instagram Search Posts **Price:** 1 credit per 30 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (required) — Search query
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- code: string (required) — Code
- url: string (required) — Url
- image: string (required) — Image
- text: string | null (optional) — Text
- created_at: integer | null (optional) — Created At
- like_count: integer (optional) — Like Count [default: 0]
- comment_count: integer (optional) — Comment Count [default: 0]
- reshare_count: integer (optional) — Reshare Count [default: 0]
- view_count: integer | null (optional) — View Count
- user: object | null (optional)
- type: string | null (optional) — Type
- media: array[object] (optional) — Media [default: []]
- carousel_media_count: integer (optional) — Carousel Media Count [default: 0]
- is_paid_partnership: boolean (optional) — Is Paid Partnership [default: False]
---
### Instagram Users (4 endpoints)
#### POST /api/instagram/user
Instagram Get User by URL, alias or ID **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User ID, alias or URL
- with_creation_date: boolean (optional) — Set this Parameter to true if you need to get account creation date. [default: False]
**Response (array of objects):**
- id: string (required) — Id
- alias: string (required) — Alias
- name: string (required) — Name
- url: string (required) — Url
- image: string | null (optional) — Image
- follower_count: integer (optional) — Follower Count [default: 0]
- following_count: integer (optional) — Following Count [default: 0]
- description: string | null (optional) — Description
- media_count: integer (optional) — Media Count [default: 0]
- is_private: boolean (optional) — Is Private [default: False]
- is_verified: boolean (optional) — Is Verified [default: False]
- is_business: boolean (optional) — Is Business [default: False]
- created_at: integer | null (optional) — Created At
- category: string | null (optional) — Category
- external_url: string | null (optional) — External Url
- email: string | null (optional) — Email
- whatsapp_number: string | null (optional) — Whatsapp Number
- phone: string | null (optional) — Phone
- location: object | null (optional)
- links: array[object] (optional) — Links [default: []]
- mentions: array[object] (optional) — Mentions [default: []]
- hashtags: array[object] (optional) — Hashtags [default: []]
- pinned_channels: array[object] (optional) — Pinned Channels [default: []]
---
#### POST /api/instagram/user/friendships
Instagram Get User Followers or Following **Price:** 1 credit per 25 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User ID, alias or URL
- count: integer (required) — Max result count [min: >0]
- type: enum[followers, following] (required) — Type of relationships to fetch
**Response (array of objects):**
- id: string (required) — Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- image: string | null (optional) — Image
- is_verified: boolean (optional) — Is Verified [default: False]
- is_private: boolean (optional) — Is Private [default: False]
---
#### POST /api/instagram/user/posts
Instagram Get User Posts **Price:** 1 credit per 12 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User ID, alias or URL
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- code: string (required) — Code
- url: string (required) — Url
- image: string (required) — Image
- text: string | null (optional) — Text
- created_at: integer | null (optional) — Created At
- like_count: integer (optional) — Like Count [default: 0]
- comment_count: integer (optional) — Comment Count [default: 0]
- reshare_count: integer (optional) — Reshare Count [default: 0]
- view_count: integer | null (optional) — View Count
- user: object | null (optional)
- type: string | null (optional) — Type
- media: array[object] (optional) — Media [default: []]
- carousel_media_count: integer (optional) — Carousel Media Count [default: 0]
- is_paid_partnership: boolean (optional) — Is Paid Partnership [default: False]
---
#### POST /api/instagram/user/reels
Instagram Get User Reels **Price:** 1 credit per 12 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User ID, alias or URL
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- code: string (required) — Code
- url: string (required) — Url
- image: string (required) — Image
- text: string | null (optional) — Text
- created_at: integer | null (optional) — Created At
- like_count: integer (optional) — Like Count [default: 0]
- comment_count: integer (optional) — Comment Count [default: 0]
- reshare_count: integer (optional) — Reshare Count [default: 0]
- view_count: integer | null (optional) — View Count
- user: object | null (optional)
- type: string | null (optional) — Type
- media: array[object] (optional) — Media [default: []]
- carousel_media_count: integer (optional) — Carousel Media Count [default: 0]
- is_paid_partnership: boolean (optional) — Is Paid Partnership [default: False]
---
### LinkedIn Companies (4 endpoints)
#### POST /api/linkedin/company
Linkedin Get Company **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- company: string | object (required) — Company Alias or URL or URN
**Response (array of objects):**
- urn: object (required) — LinkedinURN[Literal[, ]]
- url: string (required) — Url
- name: string (required) — Name
- alias: string (required) — Alias
- website: string | null (optional) — Website
- locations: array | null (optional) — Locations
- short_description: string | null (optional) — Short Description
- description: string | null (optional) — Description
- employee_count: integer | null (optional) — Employee Count
- founded_on: integer | null (optional) — Founded On
- phone: string | null (optional) — Phone
- logo_url: string | null (optional) — Logo Url
- organizational_urn: object | null (optional)
- page_verification_status: boolean | null (optional) — Page Verification Status
- last_modified_at: integer | null (optional) — Last Modified At
- headquarter_status: boolean | null (optional) — Headquarter Status
- headquarter_location: string | null (optional) — Headquarter Location
- industry: object | null (optional)
- industry_full: object | null (optional)
- specialities: array | null (optional) — Specialities
- is_active: boolean | null (optional) — Is Active
- employee_count_range: string | null (optional) — Employee Count Range
- similar_organizations: array | null (optional) — Similar Organizations
- hashtags: array | null (optional) — Hashtags
- crunchbase_link: string | null (optional) — Crunchbase Link
---
#### POST /api/linkedin/company/employee_stats
Linkedin Get Company Employee Stats **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
**Response (array of objects):**
- locations: array[object] (required) — Locations
- educations: array[object] (required) — Educations
- skills: array[object] (required) — Skills
- functions: array[object] (required) — Functions
- majors: array[object] (required) — Majors
---
#### POST /api/linkedin/company/employees
Linkedin Get Company Employees **Price:** 150 credits per 100 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- companies: array[object] (required) — Company URNs
- keywords: string | null (optional) — Any keyword for searching in the user page
- first_name: string | null (optional) — Search for exact first name
- last_name: string | null (optional) — Search for exact last name
- count: integer (required) — Max result count [min: >0, max: <1000]
**Response (array of objects):**
- internal_id: object (required) — LinkedinURN[Literal[]]
- urn: object (required) — LinkedinURN[Literal[]]
- name: string (required) — Name
- url: string (required) — Url
- image: string | null (optional) — Image
- headline: string | null (optional) — Headline
- location: string | null (optional) — Location
---
#### POST /api/linkedin/company/posts
Linkedin Get Company Posts **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
### LinkedIn DB (1 endpoints)
#### POST /api/linkedin/user/email
Get email addresses by LinkedIn internal_id, profile URL, or alias (supports batch up to 10 profiles) **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- profile: string | array (required) — LinkedIn internal_id, profile URL, alias, or set of them (max 10) [minLength: 1]
**Response (array of objects):**
- id: string (required) — User ID
- email: string (required) — Email address
- alias: string (required) — LinkedIn alias
- name: string (required) — User name
- internal_id: string (required) — Internal ID
- found: boolean (optional) — Whether user was found [default: True]
---
### LinkedIn Email Finder (1 endpoints)
#### POST /api/linkedin/email/user
Linkedin Get User By Email **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- email: string (required) — Email to get user by email
- count: integer (optional) — Max result count [min: >0] [default: 5]
**Response (array of objects):**
- internal_id: object (required) — LinkedinURN
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- emails: array[string] (required) — Emails
- phone_numbers: array[string] (required) — Phone Numbers
- birth_date: object | null (optional)
- websites: array | null (optional) — Websites
- headline: string | null (optional) — Headline
- follower_count: integer | null (optional) — Follower Count
- image: string | null (optional) — Image
- connection_count: integer | null (optional) — Connection Count
- description: string | null (optional) — Description
- top_skills: array | null (optional) — Top Skills
- frame: string | null (optional)
- location: string | null (optional) — Location
- pronouns: string | null (optional) — Pronouns
- custom_pronouns: string | null (optional) — Custom Pronouns
- verified: boolean (optional) — Verified [default: False]
---
### LinkedIn Groups (1 endpoints)
#### POST /api/linkedin/group
Linkedin Get Group **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- group: string (required) — Group URN or URL
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- url: string (required) — Url
- image: string | null (optional) — Image
- created_at: integer | null (optional) — Created At
- member_count: integer (required) — Member Count
- description: string | null (optional) — Description
- rules: string | null (optional) — Rules
- geo: object | null (optional)
- industries: array | null (optional) — Industries
- members: array | null (optional) — Members
---
### LinkedIn Posts (4 endpoints)
#### POST /api/linkedin/post
Linkedin Get Post Details **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: string | object (required) — Post URN or slug
- include_all_document_images: boolean (optional) — If enabled, all document images will be included. Otherwise, the document `images` list will be None. [default: False]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
#### POST /api/linkedin/post/comments
Linkedin Get Post Comments **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- sort: enum[relevance, recent] (optional) — LinkedinPostCommentsSort
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- text: string (required) — Text
- author: object (required) — LinkedinPostCommentUser
- created_at: integer (required) — Created At
- is_commenter_post_author: boolean (required) — Is Commenter Post Author
- comment_count: integer | null (optional) — Comment Count
- reactions: array | null (optional) — Reactions
- parent: object | null (optional)
---
#### POST /api/linkedin/post/reactions
Linkedin Get Post Reactions **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- type: enum[like, interest, empathy, praise, appreciation, entertainment, maybe] (required) — LinkedinReactionType
- user: object (required) — LinkedinPostReactionUser
---
#### POST /api/linkedin/post/reposts
Linkedin Get Post Reposts **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
### LinkedIn Search (7 endpoints)
#### POST /api/linkedin/search/companies
Linkedin Search Companies **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: string (optional) — Any keyword for searching in the company page. For exact search put desired keywords into brackets [default: ]
- location: array | string (optional) — Location URN, can be obtained in /linkedin/search/locations, only geo urn type is allowed. Or location name. [default: []]
- industry: array | string (optional) — Industry URN, can be obtained in /linkedin/search/industries, only industry urn type is allowed. Or industry name. [default: []]
- employee_count: array[string] (optional) — Employee count [default: []]
- count: integer (required) — Max result count [min: >0, max: 1000]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- url: string (required) — Url
- alias: string (required) — Alias
- image: string | null (optional) — Image
- industry: string | null (optional) — Industry
---
#### POST /api/linkedin/search/educations
Linkedin Search Educations **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- name: string (required) — Education name
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- headline: string | null (optional) — Headline
- image: string | null (optional) — Image
---
#### POST /api/linkedin/search/industries
Linkedin Search Industries **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- name: string (required) — Industry name
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
---
#### POST /api/linkedin/search/jobs
Linkedin Search Jobs **Price:** 1 credit per 25 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: string (optional) — Any keyword for searching in the job. For exact search put desired keywords into brackets [default: ]
- sort: string | null (optional) — Job sorting type
- experience_level: array | null (optional) — Job experience level
- job_types: array | null (optional) — Job types
- work_types: array | null (optional) — Work types
- industry: array | string (optional) — Industry URN, can be obtained in /linkedin/search/industries, only industry urn type is allowed
- company: array | null (optional) — Company URN, can be obtained in /linkedin/search/company, only company urn type is allowed
- location: string (optional) — Job location [default: worldwide]
- count: integer (required) — Max result count [min: >0, max: 1000]
**Response (array of objects):**
- urn: object (required) — LinkedinURN[Literal[]]
- name: string (required) — Name
- url: string (required) — Url
- company: object (required) — LinkedinSearchJobCompany
- location: string | null (optional) — Location
- work_type: string | null (optional)
- created_at: integer | null (optional) — Created At
- is_promoted: boolean (optional) — Is Promoted [default: False]
- is_east_apply: boolean (optional) — Is East Apply [default: False]
---
#### POST /api/linkedin/search/locations
Linkedin Search Locations **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- name: string (required) — Location name
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
---
#### POST /api/linkedin/search/posts
Linkedin Search Posts **Price:** 1 credit per 50 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: string (optional) — Any keyword for searching in the post. For exact search put desired keywords into brackets [default: ]
- sort: enum[relevance, recent] (optional) — LinkedinPostCommentsSort
- date_posted: enum[past-month, past-week, past-24h] (optional) — Date posted [default: past-month]
- content_type: string | null (optional) — Desired content type
- mentioned: array | null (optional) — Mentioned users URN in posts
- authors: array | null (optional) — Authors URN of posts
- author_industries: array | string | null (optional) — Industry URN, can be obtained in /linkedin/search/industries. Or industry name.
- author_title: string | null (optional) — Author job title.
- count: integer (required) — Max result count [min: >0, max: 1000]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
#### POST /api/linkedin/search/users
Linkedin Search Users **Price:** 1 credit per 10 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: string (optional) — Any keyword for searching in the user page.With the params result count will be small.Use other params to obtain a lot of results [default: ]
- first_name: string (optional) — Search for exact first name [default: ]
- last_name: string (optional) — Search for exact last name [default: ]
- title: string (optional) — Search for exact word in the title [default: ]
- company_keywords: string (optional) — Search for exact word in the company name [default: ]
- school_keywords: string (optional) — Search for exact word in the school name [default: ]
- current_company: array | string (optional) — Current company URN, only company urn type is allowed. Or company name.
- past_company: array | string (optional) — Past company URN, only company urn type is allowed or company name. Or company name.
- location: array | string (optional) — Location URN, can be obtained in /linkedin/search/locations, only geo urn type is allowed. Or location name.
- industry: array | string (optional) — Industry URN, can be obtained in /linkedin/search/industries, only industry urn type is allowed. Or industry name.
- education: array | string (optional) — Education URN, can be obtained in /linkedin/search/educations, only fsd_company urn type is allowed. Or education name.
- count: integer (required) — Max result count [min: >0, max: 1000]
**Response (array of objects):**
- internal_id: object (required) — LinkedinURN
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- image: string | null (optional) — Image
- headline: string | null (optional) — Headline
- location: string | null (optional) — Location
- open_to_work: boolean (optional) — Open To Work [default: False]
---
### LinkedIn Social Search (1 endpoints)
#### POST /api/linkedin/sn_search/users
Linkedin Sales Navigator Search Users **Price:** 150 credits per 100 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: string (optional) — Any keyword for searching in the user page.With the params result count will be small.Use other params to obtain a lot of results [default: ]
- first_names: array[string] (optional) — Search for exact first names
- last_names: array[string] (optional) — Search for exact last names
- current_titles: array[string] (optional) — Search for exact word in the current title
- location: array | string (optional) — Location URN, can be obtained in /linkedin/search/locations, only geo urn type is allowed. Or location name.
- education: array | string (optional) — Education URN, can be obtained in /linkedin/search/educations, only fsd_company urn type is allowed. Or education name.
- languages: array[string] (optional) — Profile Language
- past_titles: array[string] (optional) — Search for exact word in the past title
- functions: array[string] (optional) — Job functions
- levels: array[string] (optional) — Job level
- years_in_the_current_company: array[string] (optional) — Years in the current company
- years_in_the_current_position: array[string] (optional) — Years in the current position
- company_sizes: array[string] (optional) — Sizes of the current company
- company_types: array[string] (optional) — Types of the current company
- company_locations: array | string (optional) — Company Location URN, can be obtained in /linkedin/search/locations, only geo urn type is allowed. Or location name.
- current_companies: array | string (optional) — Current company URN, only company urn type is allowed. Or company name.
- past_companies: array | string (optional) — Past company URN, only company urn type is allowed or company name. Or company name.
- industry: array | string (optional) — Industry URN, can be obtained in /linkedin/search/industries, only industry urn type is allowed. Or industry name.
- is_posted_on_linkedin: boolean | null (optional) — Users who have recently published content on the platform
- count: integer (required) — Max result count [min: 1, max: 2500]
- company_keyword: string (optional) — Keyword for current company text filter in Sales Navigator. [default: ]
- past_company_keyword: string (optional) — Keyword for past company text filter in Sales Navigator. [default: ]
**Response (array of objects):**
- internal_id: object (required) — LinkedinURN
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- url: string (required) — Url
- image: string | null (optional) — Image
- headline: string | null (optional) — Headline
- location: string | null (optional) — Location
- is_premium: boolean (optional) — Is Premium [default: False]
- current_companies: array[object] (optional) — Current Companies [default: []]
---
### LinkedIn Users (12 endpoints)
#### POST /api/linkedin/user
Linkedin Get User **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string | object (required) — User Alias or URL or fsd_profile URN
- with_experience: boolean (optional) — Set this Parameter to true if you need to get experience info. With this parameter enabled the method will work longer [default: True]
- with_education: boolean (optional) — Set this Parameter to true if you need to get education info. With this parameter enabled the method will work longer [default: True]
- with_honors: boolean (optional) — Set this Parameter to true if you need to get honors info. With this parameter enabled the method will work longer [default: True]
- with_certificates: boolean (optional) — Set this Parameter to true if you need to get certificates info. With this parameter enabled the method will work longer [default: True]
- with_languages: boolean (optional) — Set this Parameter to true if you need to get languages info. With this parameter enabled the method will work longer [default: True]
- with_patents: boolean (optional) — Set this Parameter to true if you need to get patents info. With this parameter enabled the method will work longer [default: True]
- with_skills: boolean (optional) — Set this Parameter to true if you need to get skills info. With this parameter enabled the method will work longer [default: True]
- with_description_and_top_skills: boolean (optional) — Set this Parameter to true if you need to get description and top skills info. With this parameter enabled the method will work longer [default: True]
**Response (array of objects):**
- internal_id: object (required) — LinkedinURN
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- first_name: string | null (optional) — First Name
- last_name: string | null (optional) — Last Name
- alias: string (required) — Alias
- url: string (required) — Url
- email: string | null (optional) — Email
- birth_date: object | null (optional)
- websites: array | null (optional) — Websites
- headline: string | null (optional) — Headline
- follower_count: integer | null (optional) — Follower Count
- image: string | null (optional) — Image
- background_image: string | null (optional) — Background Image
- connection_count: integer | null (optional) — Connection Count
- description: string | null (optional) — Description
- top_skills: array | null (optional) — Top Skills
- frame: string | null (optional)
- location: string | null (optional) — Location
- country_code: string | null (optional) — Country Code
- country: string | null (optional) — Country
- city: string | null (optional) — City
- pronouns: string | null (optional) — Pronouns
- custom_pronouns: string | null (optional) — Custom Pronouns
- experience: array | null (optional) — Experience
- education: array | null (optional) — Education
- languages: array | null (optional) — Languages
- certificates: array | null (optional) — Certificates
- honors: array | null (optional) — Honors
- patents: array | null (optional) — Patents
- skills: array | null (optional) — Skills
- verified: boolean (optional) — Verified [default: False]
- is_premium: boolean (optional) — Is Premium [default: False]
- is_creator: boolean (optional) — Is Creator [default: False]
- is_influencer: boolean (optional) — Is Influencer [default: False]
- is_top_voice: boolean (optional) — Is Top Voice [default: False]
---
#### POST /api/linkedin/user/certificates
Linkedin Get User Certificates **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- name: string (required) — Name
- company: object | null (optional)
- created_at: string | null (optional) — Created At
- label: string | null (optional) — Label
- url: string | null (optional) — Url
---
#### POST /api/linkedin/user/comments
Linkedin Get User Comments **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
- commented_after: integer | null (optional) — Filter comments that created after the specified date. Accepts timestamp [min: >1114905600]
**Response (array of objects):**
- urn: object (required) — LinkedinURN[Literal[]]
- url: string (required) — Url
- text: string (required) — Text
- author: object (required) — LinkedinUserCommentUser
- created_at: integer (required) — Created At
- is_commenter_post_author: boolean (required) — Is Commenter Post Author
- comment_count: integer | null (optional) — Comment Count
- reactions: array | null (optional) — Reactions
- parent: object | null (optional)
- post: object (required) — LinkedinUserPost
---
#### POST /api/linkedin/user/education
Linkedin Get User Education **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- company: object (required) — LinkedinUserEducationCompany
- major: string | null (optional) — Major
- interval: string | null (optional) — Interval
- description: string | null (optional) — Description
---
#### POST /api/linkedin/user/endorsers
Linkedin Get User Endorsers **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- name: string (required) — Name
- photo: string | null (optional) — Photo
- alias: string (required) — Alias
- url: string (required) — Url
- headline: string | null (optional) — Headline
---
#### POST /api/linkedin/user/experience
Linkedin Get User Experience **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- company: object (required) — LinkedinUserExperienceCompany
- position: string | null (optional) — Position
- work_type: string | null (optional)
- employment: string | null (optional)
- interval: string | null (optional) — Interval
- period: string | null (optional) — Period
- location: string | null (optional) — Location
- description: string | null (optional) — Description
- medias: array | null (optional) — Medias
---
#### POST /api/linkedin/user/honors
Linkedin Get User Honors **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- name: string (required) — Name
- issued_by: string | null (optional) — Issued By
- issued_at: string | null (optional) — Issued At
- text: string | null (optional) — Text
---
#### POST /api/linkedin/user/languages
Linkedin Get User Languages **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- name: string (required) — Name
- level: string | null (optional) — Level
---
#### POST /api/linkedin/user/patents
Linkedin Get User Patents **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- name: string (required) — Name
- id: string | null (optional) — Id
- issued_at: string | null (optional) — Issued At
- text: string | null (optional) — Text
- url: string | null (optional) — Url
- inventor_count: integer | null (optional) — Inventor Count
---
#### POST /api/linkedin/user/posts
Linkedin Get User Posts **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: string | object (required) — User URN, only fsd_profile urn type is allowed. Or user url
- count: integer (required) — Max result count [min: >0]
- posted_after: integer | null (optional) — Filter posts that created after the specified date. Accepts timestamp [min: >1114905600]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
#### POST /api/linkedin/user/reactions
Linkedin Get User Reactions **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- urn: object (required) — LinkedinURN
- url: string (required) — Url
- share_url: string | null (optional) — Share Url
- author: object | object | object | null (optional) — Author
- created_at: integer (optional) — Created At [default: 0]
- share_urn: object | null (optional)
- is_empty_repost: boolean | null (optional) — Is Empty Repost
- repost: object | null (optional)
- images: array | null (optional) — Images
- video_url: string | null (optional) — Video Url
- text: string | null (optional) — Text
- comment_count: integer | null (optional) — Comment Count
- share_count: integer | null (optional) — Share Count
- reactions: array | null (optional) — Reactions
- event: object | null (optional)
- article: object | null (optional)
- document: object | null (optional)
- mentioned: array | null (optional) — Mentioned
---
#### POST /api/linkedin/user/skills
Linkedin Get User Skills **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- urn: object (required) — LinkedinURN[Literal[]]
- count: integer (required) — Max result count [min: >0, max: 100]
**Response (array of objects):**
- name: string (required) — Name
- urn: object | null (optional)
---
### LinkedIn Web Search (1 endpoints)
#### POST /api/linkedin/google/company
Linkedin Bulk Search Companies by keywords.
First result is the best match. **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- keywords: array[string] (required) — Company keywords. For example, company name or company website [maxItems: 15]
- with_urn: boolean (optional) — If you need to include urns to the response. It increases execution times. [default: False]
- count: integer (optional) — Max result count [min: >0, max: <1000] [default: 100]
**Response (array of objects):**
- url: string (required) — Url
- urn: object | null (required)
- alias: string (required) — Alias
- title: string (required) — Title
- description: string (required) — Description
---
### Reddit Posts (2 endpoints)
#### POST /api/reddit/posts
Get Reddit Post **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- post_url: string (required) — Reddit post URL or path (e.g., /r/DogAdvice/comments/1o2g2pq/title/ or full URL)
**Response (array of objects):**
- id: string (required) — Id
- title: string (required) — Title
- url: string (required) — Url
- author: object | null (optional)
- subreddit: string | null (optional) — Subreddit
- subreddit_id: string | null (optional) — Subreddit Id
- created_at: integer | null (optional) — Created At
- score: integer | null (optional) — Score
- comment_count: integer | null (optional) — Comment Count
- post_type: string | null (optional) — Post Type
- content_url: string | null (optional) — Content Url
- text: string | null (optional) — Text
- nsfw: boolean (optional) — Nsfw [default: False]
---
#### POST /api/reddit/posts/comments
Get Reddit Post Comments **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- post_url: string (required) — Reddit post URL or path
**Response (array of objects):**
- id: string (required) — Id
- author: object | null (optional)
- text: string | null (optional) — Text
- score: integer | null (optional) — Score
- created_at: integer | null (optional) — Created At
- depth: integer (optional) — Depth [default: 0]
- parent_id: string | null (optional) — Parent Id
- is_submitter: boolean (optional) — Is Submitter [default: False]
- is_deleted: boolean (optional) — Is Deleted [default: False]
- replies_count: integer (optional) — Replies Count [default: 0]
- replies: array[object] (optional) — Replies [default: []]
---
### Reddit Search (1 endpoints)
#### POST /api/reddit/search/posts
Reddit Search Posts **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (required) — Main search query
- sort: enum[relevance, hot, top, new, comments] (optional) — Type of search results sorting [default: relevance]
- time_filter: enum[all, year, month, week, day, hour] (optional) — Time filter for search results [default: all]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- title: string (required) — Title
- url: string (required) — Url
- created_at: integer | null (optional) — Created At
- subreddit: object | null (optional)
- vote_count: integer | null (optional) — Vote Count
- comment_count: integer | null (optional) — Comment Count
- thumbnail_url: string | null (optional) — Thumbnail Url
- nsfw: boolean (optional) — Nsfw [default: False]
- spoiler: boolean (optional) — Spoiler [default: False]
---
### Reddit Users (2 endpoints)
#### POST /api/reddit/user/comments
Get Reddit User Comments **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- username: string (required) — Reddit username
- count: integer (optional) — Max result count [min: >0] [default: 25]
**Response (array of objects):**
- id: string (required) — Id
- author: object | null (optional)
- text: string | null (optional) — Text
- score: integer | null (optional) — Score
- created_at: integer | null (optional) — Created At
- permalink: string (required) — Permalink
- post_url: string | null (optional) — Post Url
- subreddit: string | null (optional) — Subreddit
---
#### POST /api/reddit/user/posts
Get Reddit User Posts (Submitted) **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- username: string (required) — Reddit username
- count: integer (optional) — Max result count [min: >0] [default: 25]
**Response (array of objects):**
- id: string (required) — Id
- title: string (required) — Title
- url: string (required) — Url
- author: object | null (optional)
- subreddit: string | null (optional) — Subreddit
- subreddit_id: string | null (optional) — Subreddit Id
- created_at: integer | null (optional) — Created At
- score: integer | null (optional) — Score
- comment_count: integer | null (optional) — Comment Count
- post_type: string | null (optional) — Post Type
- content_url: string | null (optional) — Content Url
- text: string | null (optional) — Text
- nsfw: boolean (optional) — Nsfw [default: False]
---
### SEC (2 endpoints)
#### POST /api/sec/document
Retrieve SEC EDGAR document by accession number **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- document_url: string (required) — Direct URL to SEC EDGAR document (from search results document_url field)
**Response (array of objects):**
- document_url: string (required) — Document Url
- content: string (required) — Content
- content_type: string (required) — Content Type
---
#### POST /api/sec/search/companies
Search SEC EDGAR companies and filings with filters **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- entity_name: string (optional) — Company name or ticker symbol to search for [default: ]
- forms: array | null (optional) — List of form types to filter by. Prefix with '-' to exclude (e.g., ['-3', '-4', '-5'])
- location_codes: array | null (optional) — State codes to filter by (e.g., ['CA', 'NY'])
- date_from: string | null (optional) — Start date in YYYY-MM-DD format
- date_to: string | null (optional) — End date in YYYY-MM-DD format
- count: integer (required) — Maximum number of results to return [min: >0, max: 100]
**Response (array of objects):**
- accession_number: string (required) — Accession Number
- file_name: string (required) — File Name
- document_url: string (required) — Document Url
- filing_type: string | null (optional) — Filing Type
- file_date: string | null (optional) — File Date
- period_ending: string | null (optional) — Period Ending
- ciks: array | null (optional) — Ciks
- display_names: array | null (optional) — Display Names
- file_description: string | null (optional) — File Description
- biz_locations: array | null (optional) — Biz Locations
- biz_states: array | null (optional) — Biz States
- inc_states: array | null (optional) — Inc States
- sics: array | null (optional) — Sics
- items: array | null (optional) — Items
---
### Siemens (2 endpoints)
#### POST /api/siemens/search/partners
Search Siemens partners **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- partner_type: enum[Solution Partner, Distributor / Approved Partner - Value Added Reseller, Repair Partner / Approved Partner - Industry Services] (required) — PartnerType
- country: string (optional) — Country name [default: ]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- name: string (optional) — Name [default: ]
- partner_type: string (optional) — Partner Type [default: ]
- company_logo: string (optional) — Company Logo [default: ]
- email: string (optional) — Email [default: ]
- phone: string (optional) — Phone [default: ]
- website: string (optional) — Website [default: ]
- street: string (optional) — Street [default: ]
- city: string (optional) — City [default: ]
- postal_code: string (optional) — Postal Code [default: ]
- country_code: string (optional) — Country Code [default: ]
- country: string (optional) — Country [default: ]
- latitude: number (optional) — Latitude [default: 0.0]
- longitude: number (optional) — Longitude [default: 0.0]
- location_count: integer (optional) — Location Count [default: 0]
- is_child: boolean (optional) — Is Child [default: False]
- modules: array[string] (optional) — Modules [default: []]
---
#### POST /api/siemens/search/partners/digital
Search Digital Industries Software partner. **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- partner_name: string (optional) — Partner name search text [default: ]
- country: string (required) — Country code (AU, TR, US, etc.)
- location: string (optional) — Location text [default: ]
- your_needs: enum[All, Solution Providers (VAR/Resellers), Software & Technology Partner, Consulting & System Integrator] (optional) — YourNeeds
- product_category: enum[All, ADDITIVE MANUFACTURING, ASSEMBLY, CLOUD SOLUTIONS, COMOS, DI HOSTED BUSINESS, FEMAP, HEEDS, INSIGHTS HUB, INTEGRATED ELECTRICAL SYSTEMS, LEARNING SERVICES, LOGISTICS SCHEDULING, MANUFACTURING EXECUTION, MENDIX, MOTION CONTROL, NX FOR DESIGN, NX FOR MANUFACTURING, OPCENTER-APS, OPEN TOOLS, PADS, PERFORMANCE TESTING, PLM-MULTI, POLARION, PRODUCT COSTING, QUALITY MANAGEMENT, RESEARCH DEVELOPMENT &LABORATORY, RULESTREAM, SERVICES, SIMCENTER 3D SOLUTIONS, SIMCENTER-AMESIM, SIMCENTER-FloEFD, SIMCENTER-FLOTHERM, SIMCENTER-STAR-CCM+, SIMULATION AND TEST SOLUTIONS, SOLID EDGE, SUPPLYFRAME, TC CONTENT AND DOCUMENT MANAGEMENT, TC PRODUCT CONFIGURATOR, TEAMCENTER, VALOR] (optional) — ProductCategory
- industry_focus: enum[All, Aerospace and Defense, Automotive and Transportation, Banking, Financial &Credit Institution, Battery, Business Services, Clearing House Review, Consumer Products And Retail, Education, Electronics and Semiconductor, Energy and Utilities, Government, Healthcare, Heavy Equipment, Industrial Machinery, Infrastructure &Construction, Insurance, Marine, Medical Device and Pharmaceutical, Other Industries, Process Industries, Real Estate, Service Industries, Software &IT] (optional) — IndustryFocus
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- name: string (required) — Name
- partner_type: string (optional) — Partner Type [default: ]
- locations_count: integer (optional) — Locations Count [default: 0]
- location_name: string (optional) — Location Name [default: ]
- mailing_address: string (optional) — Mailing Address [default: ]
- contact: string (optional) — Contact [default: ]
- email: string (optional) — Email [default: ]
- phone: string (optional) — Phone [default: ]
- website: string (optional) — Website [default: ]
- product_specialization: string (optional) — Product Specialization [default: ]
- logo_url: string (optional) — Logo Url [default: ]
- latitude: number (optional) — Latitude [default: 0.0]
- longitude: number (optional) — Longitude [default: 0.0]
---
### Token Management (3 endpoints)
#### GET /token/requests
**URL Parameters:**
- start_time (query, optional): string —
- end_time (query, optional): string —
- limit (query, optional): integer —
- cursor (query, optional): string — Cursor for pagination (started_at timestamp)
**Response (array of objects):**
- id: string (required) — Id
- cost: integer (required) — Cost
- points_left: integer | null (optional) — Points Left
- is_paid: boolean (required) — Is Paid
- endpoint: string (required) — Endpoint
- token_id: string | null (optional) — Token Id
- plan: string (required) — Plan
- started_at: string (required) — Started At
- duration: number | null (optional) — Duration
- response_status_code: integer | null (optional) — Response Status Code
- response_error_text: string | null (optional) — Response Error Text
- response_count: integer | null (optional) — Response Count
- response_execution_time: number | null (optional) — Response Execution Time
- response_request_id: string | null (optional) — Response Request Id
- timeout: integer | null (optional) — Timeout
- is_token_expired: boolean | null (optional) — Is Token Expired
- is_points_run_out: boolean | null (optional) — Is Points Run Out
---
#### GET /token/requests/count
**URL Parameters:**
- start_time (query, optional): string —
- end_time (query, optional): string —
**Response:**
- total: integer (required) — Total
---
#### GET /token/statistic
**URL Parameters:**
- include_mcp (query, optional): boolean —
**Response (array of objects):**
- id: string (required) — Id
- user: object (required) — User
- is_primary: boolean (required) — Is Primary
- points: integer (required) — Points
- purchase_credits: integer (optional) — Purchase Credits [default: 0]
- plan: string (required) — Plan
- usage_context: enum[standard, mcp_only] (required) — TokenUsageContext
- ten_second_limit: integer | null (optional) — Ten Second Limit
- minutely_limit: integer | null (optional) — Minutely Limit
- hourly_limit: integer | null (optional) — Hourly Limit
- daily_limit: integer | null (optional) — Daily Limit
- monthly_limit: integer | null (optional) — Monthly Limit
- ten_second_usage: integer | null (optional) — Ten Second Usage
- minutely_usage: integer | null (optional) — Minutely Usage
- hourly_usage: integer | null (optional) — Hourly Usage
- daily_usage: integer | null (optional) — Daily Usage
- monthly_usage: integer | null (optional) — Monthly Usage
- expires_at: string | null (required) — Expires At
- created_at: string (required) — Created At
- last_used_at: string | null (required) — Last Used At
- is_recommended: boolean (optional) — Is Recommended [default: False]
---
### Twitter Search (2 endpoints)
#### POST /api/twitter/search/posts
Twitter Search Tweets **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (optional) — Main search query. Can include special operators like from:user, to:user, #hashtag, etc. [default: ]
- exact_phrase: string (optional) — Exact phrase (in quotes). Will be added as "phrase" to the query. [default: ]
- any_of_these_words: array | null (optional) — Any of these words (OR condition)
- none_of_these_words: array | null (optional) — None of these words (NOT condition)
- these_hashtags: array | null (optional) — These hashtags
- language: string | null (optional) — Language of tweets
- from_these_accounts: array | null (optional) — From these accounts
- to_these_accounts: array | null (optional) — To these accounts
- mentioning_these_accounts: array | null (optional) — Mentioning these accounts (username with @)
- min_replies: integer | null (optional) — Minimum number of replies
- min_likes: integer | null (optional) — Minimum number of likes
- min_retweets: integer | null (optional) — Minimum number of retweets
- from_date: integer | null (optional) — Starting date for tweets search. Accepts timestamp [min: >1136073600]
- to_date: integer | null (optional) — Ending date for tweets search. Accepts timestamp [min: >1136073600]
- search_type: enum[Top, Latest] (optional) — TwitterSearchPostsType
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- created_at: integer | null (optional) — Created At
- url: string (required) — Url
- text: string (required) — Text
- user: object (required) — TwitterPostUser
- retweet_count: integer (optional) — Retweet Count [default: 0]
- favorite_count: integer (optional) — Favorite Count [default: 0]
- reply_count: integer (optional) — Reply Count [default: 0]
- quote_count: integer (optional) — Quote Count [default: 0]
- view_count: string | null (optional) — View Count
- is_retweet: boolean (optional) — Is Retweet [default: False]
- retweeted: object | null (optional)
- is_quote: boolean (optional) — Is Quote [default: False]
- quoted: object | null (optional)
- in_reply_to_status_id: string | null (optional) — In Reply To Status Id
- in_reply_to_user_id: string | null (optional) — In Reply To User Id
- in_reply_to_screen_name: string | null (optional) — In Reply To Screen Name
- lang: string | null (optional) — Lang
- source: string | null (optional) — Source
- possibly_sensitive: boolean (optional) — Possibly Sensitive [default: False]
- medias: array[object] (optional) — Medias [default: []]
- urls: array[object] (optional) — Urls [default: []]
- hashtags: array[object] (optional) — Hashtags [default: []]
- user_mentions: array[object] (optional) — User Mentions [default: []]
- card: object | null (optional)
- poll: object | null (optional)
---
#### POST /api/twitter/search/users
Twitter Search Users **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (optional) — Main search users query [default: ]
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- internal_id: string (required) — Internal Id
- rest_id: string (required) — Rest Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- description: string | null (optional) — Description
- location: string | null (optional) — Location
- follower_count: integer | null (optional) — Follower Count
- following_count: integer | null (optional) — Following Count
- tweet_count: integer | null (optional) — Tweet Count
- listed_count: integer | null (optional) — Listed Count
- favorites_count: integer | null (optional) — Favorites Count
- media_count: integer | null (optional) — Media Count
- image: string | null (optional) — Image
- banner_url: string | null (optional) — Banner Url
- verified: boolean (optional) — Verified [default: False]
- verified_type: string | null (optional) — Verified Type
- is_blue_verified: boolean (optional) — Is Blue Verified [default: False]
- created_at: integer | null (optional) — Created At
- professional: object | null (optional)
- verification_info: object | null (optional)
- profile_urls: array[object] (optional) — Profile Urls [default: []]
- mentions: array[object] (optional) — Mentions [default: []]
- birthdate: object | null (optional)
- is_profile_translatable: boolean (optional) — Is Profile Translatable [default: False]
- has_hidden_subscriptions: boolean (optional) — Has Hidden Subscriptions [default: False]
- can_highlight_tweets: boolean (optional) — Can Highlight Tweets [default: False]
- highlighted_tweets_count: integer (optional) — Highlighted Tweets Count [default: 0]
- user_seed_tweet_count: integer (optional) — User Seed Tweet Count [default: 0]
- premium_gifting_eligible: boolean (optional) — Premium Gifting Eligible [default: False]
- creator_subscriptions_count: integer (optional) — Creator Subscriptions Count [default: 0]
---
### Twitter Users (2 endpoints)
#### POST /api/twitter/user
Twitter Get User **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User Alias or URL
**Response (array of objects):**
- internal_id: string (required) — Internal Id
- rest_id: string (required) — Rest Id
- name: string (required) — Name
- alias: string (required) — Alias
- url: string (required) — Url
- description: string | null (optional) — Description
- location: string | null (optional) — Location
- follower_count: integer | null (optional) — Follower Count
- following_count: integer | null (optional) — Following Count
- tweet_count: integer | null (optional) — Tweet Count
- listed_count: integer | null (optional) — Listed Count
- favorites_count: integer | null (optional) — Favorites Count
- media_count: integer | null (optional) — Media Count
- image: string | null (optional) — Image
- banner_url: string | null (optional) — Banner Url
- verified: boolean (optional) — Verified [default: False]
- verified_type: string | null (optional) — Verified Type
- is_blue_verified: boolean (optional) — Is Blue Verified [default: False]
- created_at: integer | null (optional) — Created At
- professional: object | null (optional)
- verification_info: object | null (optional)
- profile_urls: array[object] (optional) — Profile Urls [default: []]
- mentions: array[object] (optional) — Mentions [default: []]
- birthdate: object | null (optional)
- is_profile_translatable: boolean (optional) — Is Profile Translatable [default: False]
- has_hidden_subscriptions: boolean (optional) — Has Hidden Subscriptions [default: False]
- can_highlight_tweets: boolean (optional) — Can Highlight Tweets [default: False]
- highlighted_tweets_count: integer (optional) — Highlighted Tweets Count [default: 0]
- user_seed_tweet_count: integer (optional) — User Seed Tweet Count [default: 0]
- premium_gifting_eligible: boolean (optional) — Premium Gifting Eligible [default: False]
- creator_subscriptions_count: integer (optional) — Creator Subscriptions Count [default: 0]
---
#### POST /api/twitter/user/posts
Twitter Get User Posts **Price:** 1 credit per 20 results
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- user: string (required) — User ID, alias or URL
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: string (required) — Id
- created_at: integer | null (optional) — Created At
- url: string (required) — Url
- text: string (required) — Text
- user: object (required) — TwitterPostUser
- retweet_count: integer (optional) — Retweet Count [default: 0]
- favorite_count: integer (optional) — Favorite Count [default: 0]
- reply_count: integer (optional) — Reply Count [default: 0]
- quote_count: integer (optional) — Quote Count [default: 0]
- view_count: string | null (optional) — View Count
- is_retweet: boolean (optional) — Is Retweet [default: False]
- retweeted: object | null (optional)
- is_quote: boolean (optional) — Is Quote [default: False]
- quoted: object | null (optional)
- in_reply_to_status_id: string | null (optional) — In Reply To Status Id
- in_reply_to_user_id: string | null (optional) — In Reply To User Id
- in_reply_to_screen_name: string | null (optional) — In Reply To Screen Name
- lang: string | null (optional) — Lang
- source: string | null (optional) — Source
- possibly_sensitive: boolean (optional) — Possibly Sensitive [default: False]
- medias: array[object] (optional) — Medias [default: []]
- urls: array[object] (optional) — Urls [default: []]
- hashtags: array[object] (optional) — Hashtags [default: []]
- user_mentions: array[object] (optional) — User Mentions [default: []]
- card: object | null (optional)
- poll: object | null (optional)
---
### Webparser (2 endpoints)
#### POST /api/webparser/parse
Parse and clean HTML from web page **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- url: string (required) — URL of the page to parse [minLength: 10, maxLength: 2083]
- include_tags: array | null (optional) — CSS selectors of elements to include (keep only these)
- exclude_tags: array | null (optional) — CSS selectors or wildcard masks of elements to exclude. Examples: '.sidebar', '.advertisement', '*promo*', '*banner*'
- only_main_content: boolean (optional) — Extract only main content of the page (heuristic algorithm) [default: False]
- remove_comments: boolean (optional) — Remove HTML comments [default: True]
- resolve_srcset: boolean (optional) — Convert image srcset to src (selects the largest image) [default: True]
- return_full_html: boolean (optional) — Return full HTML document (True) or only body content (False) [default: False]
- min_text_block: integer (optional) — Minimum text block size for main content detection (in characters) [min: 0] [default: 200]
- remove_base64_images: boolean (optional) — Remove base64-encoded images (reduces output size) [default: True]
- strip_all_tags: boolean (optional) — Remove all HTML tags and return plain text only [default: False]
- extract_contacts: boolean (optional) — Extract links, emails, and phone numbers from the page [default: False]
- same_origin_links: boolean (optional) — Only extract links from the same domain (used with extract_contacts) [default: False]
- social_links_only: boolean (optional) — Only extract social media links (LinkedIn, Twitter/X, Facebook, Instagram, etc.) [default: False]
- extract_minimal: boolean (optional) — Use minimal extraction (only links, title, emails, phones if set) [default: False]
**Response (array of objects):**
- cleaned_html: string (required) — Cleaned HTML
- url: string (required) — URL of the original page
- title: string | null (optional) — Page title (from tag)
- meta_description: string | null (optional) — Meta description
- metadata: object (optional) — Additional metadata
- links: array | null (optional) — Extracted URLs from the page
- emails: array | null (optional) — Extracted email addresses
- phones: array | null (optional) — Extracted phone numbers
---
#### POST /api/webparser/sitemap
Fetch URLs from website sitemap **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- url: string (required) — Website URL to fetch sitemap from [minLength: 1, maxLength: 2083]
- include_patterns: array | null (optional) — Regex patterns for URL paths to include (all URLs if not specified)
- exclude_patterns: array | null (optional) — Regex patterns for URL paths to exclude
- same_host_only: boolean (optional) — Only include URLs from the same host as the base URL [default: True]
- respect_robots: boolean (optional) — Check robots.txt and respect disallowed URLs [default: True]
- count: integer | null (optional) — Maximum number of URLs to return [min: 1]
- return_details: boolean (optional) — Return detailed sitemap entries (lastmod, changefreq, priority) instead of just URLs [default: False]
**Response (array of objects):**
- urls: array[string] (required) — List of URLs found in sitemap(s)
- entries: array | null (optional) — Detailed sitemap entries (if return_details=True)
- total_found: integer (required) — Total number of URLs found
- sitemap_locations: array[string] (required) — Sitemap URLs that were processed
---
### Y Combinator (3 endpoints)
#### POST /api/yc/company
Get YC company information by slug **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- company: string (required) — YC company slug identifier (e.g., 'airbnb', 'stripe', 'openai')
**Response (array of objects):**
- id: integer (required) — Id
- name: string (required) — Name
- slug: string (required) — Slug
- website: string | null (optional) — Website
- one_liner: string | null (optional) — One Liner
- long_description: string | null (optional) — Long Description
- team_size: integer | null (optional) — Team Size
- industry: string | null (optional) — Industry
- subindustry: string | null (optional) — Subindustry
- industries: array[string] (optional) — Industries [default: []]
- regions: array[string] (optional) — Regions [default: []]
- batch: string | null (optional) — Batch
- status: string | null (optional) — Status
- stage: string | null (optional) — Stage
- tags: array[string] (optional) — Tags [default: []]
- is_hiring: boolean | null (optional) — Is Hiring
- nonprofit: boolean | null (optional) — Nonprofit
- top_company: boolean | null (optional) — Top Company
- launched_at: integer | null (optional) — Launched At
- all_locations: string | null (optional) — All Locations
- small_logo_thumb_url: string | null (optional) — Small Logo Thumb Url
- former_names: array[string] (optional) — Former Names [default: []]
- app_video_public: boolean | null (optional) — App Video Public
- demo_day_video_public: boolean | null (optional) — Demo Day Video Public
- app_answers: boolean | null (optional) — App Answers
- question_answers: boolean | null (optional) — Question Answers
- founders: array[object] (optional) — Founders [default: []]
- jobs: array[object] (optional) — Jobs [default: []]
- social_links: object | null (optional)
- year_founded: integer | null (optional) — Year Founded
- city: string | null (optional) — City
- country: string | null (optional) — Country
- logo_url: string | null (optional) — Logo Url
- news_items: array[object] (optional) — News Items [default: []]
- launches: array[object] (optional) — Launches [default: []]
- company_photos: array[object] (optional) — Company Photos [default: []]
- primary_partner: object | null (optional)
---
#### POST /api/yc/search/companies
Search YC companies with filters **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (optional) — Text search query [default: ]
- industries: array | null (optional) — Filter by industries (e.g., 'Healthcare', 'B2B')
- regions: array | null (optional) — Filter by regions (e.g., 'Latin America', 'Europe')
- batches: array | null (optional) — Filter by batches (e.g., 'Winter 2026', 'Summer 2025')
- is_hiring: boolean | null (optional) — Filter by hiring status
- nonprofit: boolean | null (optional) — Filter by nonprofit status
- top_company: boolean | null (optional) — Filter by top company status
- team_size_min: integer | null (optional) — Minimum team size [min: 1]
- team_size_max: integer | null (optional) — Maximum team size [max: 10000]
- count: integer (required) — Max result count [min: >0]
- sort_by: enum[relevance, launch_date] (optional) — Sort results by relevance or launch date [default: relevance]
**Response (array of objects):**
- id: integer (required) — Id
- name: string (required) — Name
- slug: string (required) — Slug
- website: string | null (optional) — Website
- one_liner: string | null (optional) — One Liner
- long_description: string | null (optional) — Long Description
- team_size: integer | null (optional) — Team Size
- industry: string | null (optional) — Industry
- subindustry: string | null (optional) — Subindustry
- industries: array[string] (optional) — Industries [default: []]
- regions: array[string] (optional) — Regions [default: []]
- batch: string | null (optional) — Batch
- status: string | null (optional) — Status
- stage: string | null (optional) — Stage
- tags: array[string] (optional) — Tags [default: []]
- is_hiring: boolean | null (optional) — Is Hiring
- nonprofit: boolean | null (optional) — Nonprofit
- top_company: boolean | null (optional) — Top Company
- launched_at: integer | null (optional) — Launched At
- all_locations: string | null (optional) — All Locations
- small_logo_thumb_url: string | null (optional) — Small Logo Thumb Url
- former_names: array[string] (optional) — Former Names [default: []]
- app_video_public: boolean | null (optional) — App Video Public
- demo_day_video_public: boolean | null (optional) — Demo Day Video Public
- app_answers: boolean | null (optional) — App Answers
- question_answers: boolean | null (optional) — Question Answers
- founders: array[object] (optional) — Founders [default: []]
- jobs: array[object] (optional) — Jobs [default: []]
- social_links: object | null (optional)
- year_founded: integer | null (optional) — Year Founded
- city: string | null (optional) — City
- country: string | null (optional) — Country
- logo_url: string | null (optional) — Logo Url
- news_items: array[object] (optional) — News Items [default: []]
- launches: array[object] (optional) — Launches [default: []]
- company_photos: array[object] (optional) — Company Photos [default: []]
- primary_partner: object | null (optional)
---
#### POST /api/yc/search/founders
Search YC founders with filters **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (optional) — Text search query (name, company, etc.) [default: ]
- industries: array | null (optional) — Filter by industries (e.g., 'Education', 'Fintech')
- titles: array | null (optional) — Filter by titles (e.g., 'CEO', 'Founder', 'CTO')
- batches: array | null (optional) — Filter by YC batches (e.g., 'W25', 'S25', 'F25')
- top_company: boolean | null (optional) — Filter by top company status
- count: integer (required) — Max result count [min: >0]
**Response (array of objects):**
- id: integer (required) — Id
- first_name: string (required) — First Name
- last_name: string (required) — Last Name
- hnid: string | null (optional) — Hnid
- avatar_thumb: string | null (optional) — Avatar Thumb
- current_company: string | null (optional) — Current Company
- current_title: string | null (optional) — Current Title
- company_slug: string | null (optional) — Company Slug
- top_company: boolean | null (optional) — Top Company
- url_slug: string | null (optional) — Url Slug
- all_companies_text: string | null (optional) — All Companies Text
- current_region: string | null (optional) — Current Region
- yc_industries: array[array] (optional) — Yc Industries [default: []]
- yc_parent_industries: array[string] (optional) — Yc Parent Industries [default: []]
- yc_subindustries: array[string] (optional) — Yc Subindustries [default: []]
- yc_titles: array[string] (optional) — Yc Titles [default: []]
- batches: array[string] (optional) — Batches [default: []]
---
### YouTube (5 endpoints)
#### POST /api/youtube/channel/videos
Get all videos from a YouTube channel **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- channel: string (required) — YouTube channel URL, alias, or ID
- count: integer (optional) — Max number of videos to fetch [min: 1, max: 1000] [default: 30]
**Response (array of objects):**
- id: string (required) — Id
- title: string (required) — Title
- url: string (required) — Url
- author: object | null (optional)
- duration_seconds: integer | null (optional) — Duration Seconds
- view_count: integer | null (optional) — View Count
- published_at: integer | null (optional) — Published At
- image: string | null (optional) — Image
---
#### POST /api/youtube/search/videos
Search YouTube videos **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- query: string (required) — Search query
- count: integer (required) — Max number of results [min: 1, max: 600]
**Response (array of objects):**
- id: string (required) — Id
- title: string (required) — Title
- url: string (required) — Url
- author: object | null (optional)
- duration_seconds: integer | null (optional) — Duration Seconds
- view_count: integer | null (optional) — View Count
- published_at: integer | null (optional) — Published At
- image: string | null (optional) — Image
---
#### POST /api/youtube/video
Get YouTube video details **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- video: string (required) — YouTube video ID or URL (e.g., 'dQw4w9WgXcQ' or 'https://www.youtube.com/watch?v=dQw4w9WgXcQ')
**Response (array of objects):**
- id: string (required) — Id
- url: string (required) — Url
- title: string | null (optional) — Title
- description: string | null (optional) — Description
- author: object | null (optional)
- duration_seconds: integer | null (optional) — Duration Seconds
- view_count: integer | null (optional) — View Count
- subtitles: object | null (optional)
---
#### POST /api/youtube/video/comments
Get comments for a YouTube video **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- video: string (required) — YouTube video ID or URL
- count: integer (required) — Max number of comments to fetch [min: 1, max: 2000]
**Response (array of objects):**
- id: string (required) — Id
- text: string (required) — Text
- author: object | null (optional)
- published_at: integer | null (optional) — Published At
- like_count: integer | null (optional) — Like Count
- reply_count: integer | null (optional) — Reply Count
- reply_level: integer (optional) — Reply Level [default: 0]
---
#### POST /api/youtube/video/subtitles
Get YouTube video subtitles/captions **Price:** 1 credit
**Request Body (JSON):**
- timeout: integer (optional) — Max scrapping execution timeout (in seconds) [min: 20, max: 1500] [default: 300]
- video: string (required) — YouTube video ID or URL (e.g., 'dQw4w9WgXcQ' or 'https://www.youtube.com/watch?v=dQw4w9WgXcQ')
- lang: string (optional) — Language code (e.g., 'en', 'ru') [default: en]
**Response (array of objects):**
- text: string (required) — Text
- subtitle_count: integer (required) — Subtitle Count
- language: string (required) — Language
- subtitles: array[object] (optional) — Subtitles [default: []]
---
## Authentication Details
All requests require the `access-token` header:
```
access-token: your_api_token_here
Content-Type: application/json
```
Get your token at https://app.anysite.io/
## Rate Limits & Pricing
Each endpoint costs credits (shown in description). Check usage:
- GET /token/statistic — usage statistics
- GET /token/requests/count — request count
- GET /token/requests — request history
## Support
- Docs: https://docs.anysite.io
- Email: support@anysite.io
- GitHub: https://github.com/anysiteio