English
Help Center
User Guide
Parameter Description
Parameter Description
2025-09-09 10:44
1.Basic parameters
The parameters of different crawlers are different in context and need to be included in it
| Parameter Name | Description | Type | Required |
| locale | Language/region settings (e.g., "en-US") | string | No |
| source | Data source type, | string | Yes |
| geo | Locale | string | No |
| format | Desired response format | []string | No |
| js_render | Whether to enable JavaScript rendering (false: disable, true: enable, defaults to (false)" | boll | No |
| context | Query context container | object | Yes |
2.Youtube crawling parameters
| Function Name | Parameter Name | Description | Type | Required |
| YouTube-Video Details | url_list ├─ url |
List of video URLs (an array containing multiple video objects) | array<object> | Yes |
| A single YouTube video link | string | Yes | ||
| Youtube-Video Search | keyword | Search keyword | string/null | Yes |
| continuation | Search result pagination cursor (for fetching more results) | string/null | No | |
| Youtube-Video Subtitles | url | Full YouTube video link | string/null | Yes |
| output_format | Subtitle output format, currently supports "srt" | string | No | |
| Youtube-User Information Acquisition | url_list ├─ url |
List of user homepage URLs, containing multiple user objects | array<object> | Yes |
| A single YouTube user homepage link | string | Yes |
The following example uses YouTube subtitle extraction：
"request_example": { "locale": "en", "context": { "video_url": "https://www.youtube.com/watch?v=N0p05Tq7oq0", "output_format": "srt" } } youtube字幕下载
3.Facebook crawling parameters
| Function Name | Parameter Name | Description | Type | Required | Optional Values |
| Facebook-User Profile | url_list | List of Facebook user or page URLs to extract profile information from | list | Yes | - |
| list | A valid Facebook profile or page URL | string | Yes | - |
Here we take the example of grabbing FB user information：
"request_example": { "locale": "en-US", "source": "facebook_user_profile", "context": { "url_list": [ { "url": "https://www.facebook.com/zuck/" } ] } }
4.Amazon crawl parameters
| Function Name | Parameter Name | Description | Type | Required |
| Amazon-Product Search | keyword_list ├─ keyword |
Search keyword list, supports multiple keywords for crawling | list (object[]) | Yes |
| Single search keyword to crawl | string | Yes | ||
| start_pages | Start page number, which page to start crawling (e.g., page 1) | number | No | |
| pages | Number of crawled pages, which total number of pages to crawl | number | No | |
| Amazon-Best Seller | category_list ├─ category_id |
Category ID list (array), containing multiple category objects | array<object> | Yes |
| Category unique identifier | string | Yes | ||
| start_page | Start page number, which page to start crawling | integer | No | |
| pages | Total number of crawled pages, which total number of pages to crawl | integer | No | |
| Amazon product reviews | product_url_list ├─ product_url |
Product URL list, containing multiple product objects | array<object> | Yes |
| URL for a single product | string | Yes | ||
| Amazon product listings | product_url_list ├─ product_url |
Product URL list, containing multiple product objects | array<object> | Yes |
| URL for a single product | string | Yes |
Here we take the example of crawling Amazon product keywords：
"request_example": { "geo": "US", "format": false, "locale": "en-US", "source": "amazon_search", "context": { "pages": 2, "start_page": 1, "keyword_list": [ { "keyword": "1077068" } ] }, "js_render": false }
5.TikTok crawling parameters
| Function Name | Parameter Name | Description | Type | Required |
| TK Video Search | keyword | Search for a keyword; the system will find videos based on that keyword. | string | Yes |
| TK Comments | video_id | TikTok video ID, used to locate the video. | string | Yes |
| cursor | Cursor, used to paginate and retrieve more replies. | string | No | |
| count | Limits the number of replies returned per page. | integer | No | |
| TK User Information Search | url_list ├─ user_url |
User URL list (an array containing multiple user objects). | array<object> | Yes |
| A single TikTok user's homepage URL. | string | Yes |
Here we take grabbing TK video information as an example：
"request_example": { "source": "tiktok_video", "context": { "sec_uid": "OmegaProxy" } }
6.X-Crawl Parameters
| Function Name | Parameter Name | Description | Type | Required |
| X tweet information | user_id | The ID of a Twitter user, used to get tweets from that user | string | yes |
Here we take the example of grabbing X tweet information：
"request_example": { "locale": "en-US", "source": "twitter_tweets", "context": { "url_list": [ { "tweet_id": "44196397" } ] } }
7.Google crawl parameters
| Function Name | Parameter Name | Description | Type | Required | Optional |
| Google Job Search | job_name | Job title keywords | string | Yes | - |
| job_location_list ├job_location |
Location list | array<object> | No | - | |
| experiences | Work experience filter value | array<string> | No | INTERN_AND_APPRENTICE EARLY MID ADVANCED DIRECTOR_PLUS |
|
| has_remote | Remote position | boolean | No | - | |
| skills | Skill keywords (comma-separated) | string | No | - | |
| degree | Education filter value | array<string> | No | PURSUING_DEGREE ASSOCIATE BACHELORS MASTERS DOCTORATE |
|
| employment_type | Job type | array<string> | No | FULL_TIME PART_TIME TEMPORARY INTERN |
|
| sort_by | Sort field (relevance/time) | string | No | relevance date |
|
| page | Page number (starting at 1) | integer (建议) / string | Yes | - | |
| Google Events | keywords_list | Keyword list (array, containing the keyword field) | array<object> | No | - |
| start_page | Start page number (page to start crawling) | integer | No | - | |
| end_page | End page number (page to end crawling) | integer | Yes | - | |
| Google Images | keywords_list ├keyword |
Array of keyword objects, used to specify search keywords | array<object> | Yes | - |
| Search keywords | string | Yes | - | ||
| start_page | Start page number (page to start crawling) | integer / null | Yes | - | |
| end_page | End page number (page to end crawling) | integer / null | Yes | - | |
| Google Auto-association | keywords_list ├keyword |
Array of keyword objects | array<object> | Yes | - |
| Search keywords, used to get autocomplete suggestions | string | No | - | ||
| Google Finance | keywords_list ├keyword |
Array of keyword objects | array<object> | No | - |
| Search keywords (such as company names, stock symbols, etc.) | string | Yes | - | ||
| Google Search | keywords_list ├keyword |
Array of search keyword objects | array<object> | Yes | - |
| Search keyword strings (such as product names, brand names, etc.) | string | Yes | - | ||
| start_page | Start search results page number (page to start searching on, e.g., 1) | int/null | No | - | |
| end_page | End search results page number (page to end searching on, e.g., 3) | int/null | No | - |
Here we take crawling Google job as an example：
"request_example": { "locale": "en-US", "source": "google_job_search", "context": { "page": "1", "degree": "BACHELOR", "skills": "python, sql", "sort_by": "date", "job_name": "software engineer", "locations": [ { "location": "London" } ], "has_remote": true, "experience_list": [ { "experience": "MID" } ], "employment_type_list": [ { "employment_type": "FULL_TIME" } ] } }, "response_example": { "result": [ { "job_href": "jobs/results/108913291534705350-senior-software-engineer-generative-ai-google-workspace?q=Software&has_remote=true&page=1", "job_title": "Senior Software Engineer, Generative AI, Google Workspace", "job_detail": "Minimum qualifications....", "job_remote": "Remote eligible", "job_company": "Google", "job_location": "New York, NY, USA; Boulder, CO, USA; +4 more; +3 more" } ] }
