API Description

Search volume

Adding a volume check request

Description

The method allows adding a request to check a search volume. Checking one keyword costs $0.005. Checking a few keywords (from 2 to 700) costs $0.2.

Request format

Title of the code block
Copy
POST https://api4.seranking.com/key-volume/

Parameters

If the region id is passed, the check is performed via Google.

NameRequiredDescription
queryYesSearch query or a query array 

Result

If successful, the server returns the request ID for checking.

Response example

Title of the code block
Copy
{
"id":1
}

Errors

HTTP codeError message
400Invalid

Request list

Request format

Title of the code block
Copy
GET https://api4.seranking.com/key-volume/

Result

If successful, the server returns the request list for the search volume check.

Response example

Title of the code block
Copy
[{
"id":1,
"add_time": "2018-08-15 12:51:21",
"total_queries" : 1,
"total_finished" : 1,
"country" : "USA"
}]

Check results

Request format

Title of the code block
Copy
GET https://api4.seranking.com/key-volume/{task_id}

Result

The server returns the check result or status.

Response example

If the result has not been received yet.

Title of the code block
Copy
{
  "status" : "processing"
}

If the result is ready.

Title of the code block
Copy

[{
  "query": "query 1",
"volume": 2342
}]

Deleting a volume check request

Request format

Title of the code block
Copy
DELETE https://api4.seranking.com/key-volume/{task_id}

Result

If successful, the server returns HTTP 204.