Sending keywords to crawl and getting a task id for further queries (tasks.addTask)

The tasks.addTask method allows sending keywords to crawl and get a task ID for further queries.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Optional	Default value	Value options
id	Identifier of current request, can be set manually or automatically	string	no		1, test
method	API method name	string	no		tasks.addTask
params	Object with parameters	object	no
keywords	Keywords for parsing	string	no		"iphone,iphone X,iphone 10"
se_id	Search engine identifier	int	no		1 — Google 2 — Yandex
country_id	Country identifier. Country (for Google) is indicated in the document	int	no	If Yandex is chosen, country_id should be set as 1, default (as well as Yandex accepts only region_id as the setting for crawling).	23 (USA)
region_id	Region or city identifier. Region is indicated in the document	int	yes — Google; no — Yandex		21176 (Texas)
lang_id	Language identifier. Language is indicated in the document	int	yes	Language of country by default	1 (English)
type_id	Device type identifier	int	yes	Desktop	1 — Desktop 2 — Mobile

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 sent are invalid
Required parameter '[parameter]' missed	A parameter 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
Not enough money. You lack N$	When there's a lack of credits for such amount of keywords

Example

Request data:

{
    "id": "some_id",
    "method": "tasks.addTask",
    "params": {
        "keywords": "iphone,iphone X,iphone 10",
        "typeId": 1,
        "seId": 1,
        "countryId": 23,
        "regionId": 21176,
        "langId": 1
    }
}

Response data:

{
    "id": "some_id",
    "result": {
        "task_id": "2071484",
        "blocked_keywords": []
    }
}