Schedule SERP
Below you will find a detailed description of the fields you can use for setting a task. All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method when the array of tasks is sent into json format. We recommend to set up to 100 tasks at a time. Such limits were set due to the variations of task setting methods that you may use.
Requires authentication
POST https://api.serphouse.com/serp/schedule
Headers
Request Body
{
"status": "success",
"msg": "Task(s) successfully scheduled",
"results": [
{
"user_id": 4281,
"se": "google",
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"country_iso": "US",
"loc": "Alba,Texas,United States",
"lat": "32.79",
"long": "-95.63",
"device": "desktop",
"serp_type": "web",
"verbatim": 0,
"gfilter": 1,
"pingback_url": null,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"is_scheduled": 1,
"page": 1,
"num_result": 10,
"updated_at": "2023-05-30T10:29:54.000000Z",
"created_at": "2023-05-30T10:29:54.000000Z",
"id": 77224194
},
{
"user_id": 4281,
"se": "google",
"q": "Tea",
"domain": "google.com",
"lang": "en",
"country_iso": "US",
"loc": "Alba,Texas,United States",
"lat": "32.79",
"long": "-95.63",
"device": "desktop",
"serp_type": "web",
"verbatim": 0,
"gfilter": 1,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"postback_url": null,
"is_scheduled": 1,
"page": 1,
"num_result": 10,
"updated_at": "2023-05-30T10:29:54.000000Z",
"created_at": "2023-05-30T10:29:54.000000Z",
"id": 77224195
},
{
"user_id": 4281,
"se": "google",
"q": "Cold Cofee",
"domain": "google.co.uk",
"lang": "ar",
"country_iso": "GB",
"loc": "London,England,United Kingdom",
"lat": "51.51",
"long": "-0.13",
"device": "desktop",
"serp_type": "image",
"verbatim": 0,
"gfilter": 1,
"pingback_url": null,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"is_scheduled": 1,
"page": 1,
"num_result": 10,
"updated_at": "2023-05-30T10:29:54.000000Z",
"created_at": "2023-05-30T10:29:54.000000Z",
"id": 77224196
}
]
}{
"status": "error",
"msg": "validation_error",
"error": {
"data.0.q": [
"The data.0.q field is required."
]
}
}{
"status": "error",
"msg": "Your SERPHouse account has either run out of available credits (try upgrading your Plan), or there is a payment problem. Current available credit is -> -1",
"error": ""
}{
"status": "error",
"msg": "Unauthenticated"
}Example request:
curl --location --request POST 'https://api.serphouse.com/serp/schedule' \
--header 'Authorization: Bearer <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result":10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result":10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result":10
}
]
}'require "uri"
require "json"
require "net/http"
url = URI("https://api.serphouse.com/serp/schedule")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <YOUR_API_KEY>"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result": 10
}
]
})
response = https.request(request)
puts response.read_body
import requests
import json
url = "https://api.serphouse.com/serp/schedule"
payload = json.dumps({
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result": 10
}
]
})
headers = {
'Authorization': 'Bearer <YOUR_API_KEY>',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = JSON.stringify({
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result": 10
}
]
});
var config = {
method: 'post',
url: 'https://api.serphouse.com/serp/schedule',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer <YOUR_API_KEY>'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
<?php
$serphouse = new SERPHouse\SERPHouseClient('YOUR_API_KEY');
$body = [
'data' => [
[
'q' => 'Coffee',
'domain' => 'google.com',
'lang' => 'en',
'device' => 'desktop',
'serp_type' => 'web',
'loc' => 'Alba,Texas,United States',
'verbatim' => 0,
'postback_url' => 'https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208',
'page' => 1,
'num_result' => 100,
],
[
'q' => 'Tea',
'domain' => 'google.com',
'lang' => 'en',
'device' => 'desktop',
'serp_type' => 'web',
'loc' => 'Alba,Texas,United States',
'verbatim' => 0,
'pingback_url' => 'https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208',
'page' => 1,
'num_result' => 100,
],
[
'domain' => 'google.co.uk',
'lang' => 'ar',
'q' => 'Cold Cofee',
'loc' => 'London,England,United Kingdom',
'postback_url' => 'https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208',
'device' => 'desktop',
'serp_type' => 'image',
'num_result' => 100,
],
],
];
$res = $serphouse->serpApi->schedule($body);
echo $res->getResponse();
OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
JSONObject jsonObject = new JSONObject();
jsonObject.put("data", new JSONObject[]{
new JSONObject()
.put("q", "Coffee")
.put("domain", "google.com")
.put("lang", "en")
.put("device", "desktop")
.put("serp_type", "web")
.put("loc", "Alba,Texas,United States")
.put("verbatim", 0)
.put("postback_url", "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208")
.put("page", 1)
.put("num_result", 10),
new JSONObject()
.put("q", "Tea")
.put("domain", "google.com")
.put("lang", "en")
.put("device", "desktop")
.put("serp_type", "web")
.put("loc", "Alba,Texas,United States")
.put("verbatim", 0)
.put("pingback_url", "https://webhook.site/bdd3a89a-fa1d-4f02-a2a9-c1bbd9570c40")
.put("page", 1)
.put("num_result", 10),
new JSONObject()
.put("domain", "google.co.uk")
.put("lang", "ar")
.put("q", "Cold Coffee")
.put("loc", "London,England,United Kingdom")
.put("postback_url", "https://webhook.site/bdd3a89a-fa1d-4f02-a2a9-c1bbd9570c40")
.put("device", "desktop")
.put("serp_type", "image")
.put("num_result", 10)
});
String bodyJson = jsonObject.toString();
RequestBody body = RequestBody.create(mediaType,bodyJson);
Request request = new Request.Builder()
.url("https://api.serphouse.com/serp/schedule")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer <YOUR_API_KEY>")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <YOUR_API_KEY>");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result": 10
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.serphouse.com/serp/schedule", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.serphouse.com/serp/schedule"
method := "POST"
payload := strings.NewReader(`{
"data": [
{
"q": "Coffee",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"q": "Tea",
"domain": "google.com",
"lang": "en",
"device": "desktop",
"serp_type": "web",
"loc": "Alba,Texas,United States",
"verbatim": 0,
"pingback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"page": 1,
"num_result": 10
},
{
"domain": "google.co.uk",
"lang": "ar",
"q": "Cold Cofee",
"loc": "London,England,United Kingdom",
"postback_url": "https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208",
"device": "desktop",
"serp_type": "image",
"num_result": 10
}
]
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}var client = new RestClient("https://api.serphouse.com/serp/schedule");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer <YOUR_API_KEY>");
var body = @"{
""data"": [
{
""q"": ""Coffee"",
""domain"": ""google.com"",
""lang"": ""en"",
""device"": ""desktop"",
""serp_type"": ""web"",
""loc"": ""Alba,Texas,United States"",
""verbatim"": 0,
""postback_url"": ""https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208"",
""page"": 1,
""num_result"": 10
},
{
""q"": ""Tea"",
""domain"": ""google.com"",
""lang"": ""en"",
""device"": ""desktop"",
""serp_type"": ""web"",
""loc"": ""Alba,Texas,United States"",
""verbatim"": 0,
""pingback_url"": ""https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208"",
""page"": 1,
""num_result"": 10
},
{
""domain"": ""google.co.uk"",
""lang"": ""ar"",
""q"": ""Cold Cofee"",
""loc"": ""London,England,United Kingdom"",
""postback_url"": ""https://webhook.site/8f885f1f-c38a-4a10-8506-335441213208"",
""device"": ""desktop"",
""serp_type"": ""image"",
""num_result"": 10
}
]
}";
request.AddParameter("application/json", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);Last updated