Sending keywords with commas to crawl regular SERP and local results as an array
The tasks.addKeywordList method allows sending keywords with commas to crawl regular SERP and local results as an array.
General request parameters and instructions for using Serpstat API
Request parameters for regular results | |||||
---|---|---|---|---|---|
Parameter | Description | Type | Optional | Default value | Value options |
id | The identifier of a current request, can be set manually or automatically | string | no | 1, test | |
method | API method name | string | no | tasks.addKeywordList | |
params | Object with parameters | object | no | ||
keywords | Keywords with commas for parsing | array | no | ["samsung, iphone", "nike, adidas"] | |
seId | Search engine identifier | int | no | 1 — Google | |
countryId | Country identifier. Country (for Google) is indicated in the document | int | no | 23 (USA) | |
regionId | Region or city identifier. | int | yes — Google | 21176 (Texas) | |
langId | Language identifier. | int | no | 1 (English) | |
typeId | Device type identifier | int | yes | Desktop | 1 — Desktop 2 — Mobile |
| |||||
type | Type of Google results | string | yes | By default the parameter is "regular"; "local" — for local results | local |
|
Response parameters | |
Parameter | Description |
id | Identifiers of the current request |
result | Contains the answer |
task_id | Crawling identifier |
blocked_keywords | Keywords with special symbols, which were rejected, credits won’t be charged |
Errors | |
Error | Description |
You have no keywords after filtrating, blocked keywords: [list of blocked keywords] | If all sent keywords were invalid |
Required parameter '[parameter]' missed | A parameter is missed |
Task (id=x) with such parameters has already been created today | You have already created a task with such parameters |
No such se_id | Invalid se_id |
device_type_id Invalid type id value | Invalid type_Id |
{
"id": "some_id" ,
"method": "tasks.addKeywordList",
"params": {
"keywords": ["samsung, iphone", "nike, adidas"],
"typeId": 1,
"seId": 1,
"countryId": 23,
"langId": 1
}
}
{
"id": "some_id",
"result": {
"task_id": "2071492",
"blocked_keywords": []
}
}
Serpstat API request drafts: link