Pricing
Your account will not be charged for using this API
Your account will not be charged for using this API
This API call will provide you with the list of endpoints you can use for setting SERP API tasks.
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
| Field name | Type | Description |
|---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
post_id |
array | custom task identifier in your system or otherwise assigned by our system it’s also the key of an array |
id |
string | task identifier unique task identifier in our system in the UUID format |
post_id |
string | custom task identifier in your system |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the results array |
path |
array | URL path |
data |
array | the data specified in the API call |
result |
array | array of results this array contains the list of endpoints you can use for setting SERP API tasks |
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request GET "https://api.dataforseo.com/v3/serp/endpoints"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json" <?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
exit();
}
try {
// using this method you can get a list of endpoints
// GET /v3/serp/endpoints
$result = $client->get('/v3/serp/endpoints');
print_r($result);
// do something with result
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
}
$client = null;
?>const axios = require('axios');
axios({
method: 'get',
url: 'https://api.dataforseo.com/v3/serp/endpoints',
auth: {
username: 'login',
password: 'password'
},
headers: {
'content-type': 'application/json'
}
}).then(function (response) {
var result = response['data']['tasks'][0]['result'];
// Result data
console.log(result);
}).catch(function (error) {
console.log(error);
});from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
# using this method you can get a list of endpoints
# GET /v3/serp/endpoints
response = client.get("/v3/serp/endpoints")
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task serp_endpoints()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
// using this method you can get a list of endpoints
// GET /v3/serp/endpoints
var response = await httpClient.GetAsync("/v3/serp/endpoints");
var result = JsonConvert.DeserializeObject<dynamic>(await response.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}The above command returns JSON structured like this:
{
"version": "3.20191128",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.1118 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "11271450-0696-0147-0000-4812a6ed0729",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0001 sec.",
"cost": 0,
"result_count": 1,
"path": [
"v3",
"serp",
"map"
],
"data": {
"api": "serp",
"function": "map"
},
"result": [
[
"v3/serp/bing/languages",
"v3/serp/bing/local_pack/task_get/advanced/$id",
"v3/serp/bing/local_pack/task_get/html/$id",
"v3/serp/bing/local_pack/task_post",
"v3/serp/bing/local_pack/tasks_ready",
"v3/serp/bing/locations",
"v3/serp/bing/organic/languages",
"v3/serp/bing/organic/live/html",
"v3/serp/bing/organic/live/regular",
"v3/serp/bing/organic/locations",
"v3/serp/bing/organic/task_get/html/$id",
"v3/serp/bing/organic/task_get/regular/$id",
"v3/serp/bing/organic/task_post",
"v3/serp/bing/organic/tasks_ready",
"v3/serp/bing/tasks_ready",
"v3/serp/google/images/live/advanced",
"v3/serp/google/images/live/html",
"v3/serp/google/images/task_get/advanced/$id",
"v3/serp/google/images/task_get/html/$id",
"v3/serp/google/images/task_post",
"v3/serp/google/images/tasks_ready",
"v3/serp/google/languages",
"v3/serp/google/locations",
"v3/serp/google/maps/live/advanced",
"v3/serp/google/maps/live/html",
"v3/serp/google/maps/task_get/advanced/$id",
"v3/serp/google/maps/task_get/html/$id",
"v3/serp/google/maps/task_post",
"v3/serp/google/maps/tasks_ready",
"v3/serp/google/news/live/advanced",
"v3/serp/google/news/live/html",
"v3/serp/google/news/task_get/advanced/$id",
"v3/serp/google/news/task_get/html/$id",
"v3/serp/google/news/task_post",
"v3/serp/google/news/tasks_ready",
"v3/serp/google/organic/languages",
"v3/serp/google/organic/live/advanced",
"v3/serp/google/organic/live/html",
"v3/serp/google/organic/live/regular",
"v3/serp/google/organic/locations",
"v3/serp/google/organic/task_get/advanced/$id",
"v3/serp/google/organic/task_get/html/$id",
"v3/serp/google/organic/task_get/regular/$id",
"v3/serp/google/organic/task_post",
"v3/serp/google/organic/tasks_ready",
"v3/serp/google/tasks_ready",
"v3/serp/endpoints",
"v3/serp/tasks_ready",
"v3/serp/yahoo/languages",
"v3/serp/yahoo/locations",
"v3/serp/yahoo/organic/languages",
"v3/serp/yahoo/organic/live/regular",
"v3/serp/yahoo/organic/locations",
"v3/serp/yahoo/organic/task_get/html/$id",
"v3/serp/yahoo/organic/task_get/regular/$id",
"v3/serp/yahoo/organic/task_post",
"v3/serp/yahoo/organic/tasks_ready",
"v3/serp/yahoo/tasks_ready",
"v3/serp/yandex/languages",
"v3/serp/yandex/locations",
"v3/serp/yandex/organic/languages",
"v3/serp/yandex/organic/live/regular",
"v3/serp/yandex/organic/locations",
"v3/serp/yandex/organic/task_get/html/$id",
"v3/serp/yandex/organic/task_get/regular/$id",
"v3/serp/yandex/organic/task_post",
"v3/serp/yandex/organic/tasks_ready",
"v3/serp/yandex/tasks_ready"
]
]
}
]
}