Search Volume
Search Volume API provides endpoints to submit keyword search volume check requests, retrieve the list of submitted requests, check request status and results, and delete requests.
Add search volume check request
POST https://api4.seranking.com/key-volume/
Submits a request to check the search volume for one or multiple keywords. Checking one keyword costs $0.005. Checking multiple keywords (from 2 to 700) costs $0.2.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | String/Array of Strings | Yes | Search keyword or an array of keywords to check search volume for. |
Request example
POST https://api4.seranking.com/key-volume/
{
"query": ["keyword 1", "keyword 2"]
}Response parameters
If successful, the server returns the 200 HTTP status code and an object containing the request ID. Returns HTTP 400 if the request is invalid (for more information, see Error handling).
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the search volume check request. |
Response example
{
"id":1
}Get search volume check requests
GET https://api4.seranking.com/key-volume/
Returns a list of submitted search volume check requests.
Request parameters
No parameters.
Request example
GET https://api4.seranking.com/key-volume/Response parameters
If successful, the server returns the 200 HTTP status code and an array of search volume check requests.
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Unique request ID. |
| add_time | String | Date and time when the request was created (in YYYY-MM-DD HH:MM:SS). |
| total_queries | Integer | Total number of keywords in the request. |
| total_finished | Integer | Number of keywords for which the search volume check is completed. |
| country | String | Country where the search volume check was performed. |
Response example
[{
"id":1,
"add_time": "2018-08-15 12:51:21",
"total_queries" : 1,
"total_finished" : 1,
"country" : "USA"
}]
Get search volume check results
GET https://api4.seranking.com/key-volume/{task_id}
Returns the search volume check status or results for the specified request.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | Integer | Yes | Unique search volume check request ID (path parameter). |
Request example
GET https://api4.seranking.com/key-volume/1Response parameters
If successful, the server returns the 200 HTTP status code and either a status object or an array of keyword search volume results.
Status object parameters:
| Parameter | Type | Description |
|---|---|---|
| status | String | Current request status. |
Result object parameters:
| Parameter | Type | Description |
|---|---|---|
| query | String | Keyword that was checked. |
| volume | Integer | Search volume for the keyword. |
Response example
- If the result is still processing:
{
"status" : "processing"
}- If the result is ready:
[
{
"query": "query 1",
"volume": 2342
}
]Delete search volume check request
DELETE https://api4.seranking.com/key-volume/{task_id}
Deletes a submitted search volume check request.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | Integer | Yes | Unique search volume check request ID (path parameter). |
Request example
DELETE https://api4.seranking.com/key-volume/1Response parameters
If successful, the server returns the 204 HTTP status code.
Response example
No response body.
