Sending keywords to crawl regular and local results and getting a task id for further queries
The tasks.addTask method allows sending keywords to crawl regular SERP and local results and get a task ID for further queries.
Note: Google AI Overview results are currently available within standard Desktop SERP Crawling requests at no additional cost. This allows you to access AI-generated summaries and reference sources as part of your regular SERP data. However, starting August 1, 2025, AI Overview data will become a separate optional parameter with additional pricing. After this date, you will need to specifically enable AI Overview in your API requests and account for the additional costs in your usage billing.
General request parameters and instructions for using Serpstat API
Request parameters for regular results | |||||
---|---|---|---|---|---|
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" | |
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 | yes | English by default | 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 |
The example of the request for Local results: |
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 |
{
"id": "some_id",
"method": "tasks.addTask",
"params": {
"keywords": "pizza, burger, iphone",
"typeId": 1,
"seId": 1,
"countryId": 23,
"regionId": 21176,
"langId": 1
}
}
{
"id": "some_id",
"result": {
"task_id": "2381968",
"blocked_keywords": []
}
}
Serpstat API request drafts: link