OVERVIEW

This is a Java client providing you, as a developer, with a tool for obtaining the necessary data from DataForSEO APIs. You don't have to figure out how to make a request and process a response - all that is readily available in this client.

DataForSEO API uses REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows using our API with almost any programming language.

Client contains 12 sections (aka APIs):

• AI Optimization API (source docs | api docs)
• SERP (source docs | api docs)
• Keywords Data (source docs | api docs)
• Domain Analytics (source docs | api docs)
• DataForSEO Labs (source docs | api docs)
• Backlinks (source docs | api docs)
• OnPage (source docs | api docs)
• Content Analysis (source docs | api docs)
• Merchant (source docs | api docs)
• App Data (source docs | api docs)
• Business Data (source docs | api docs)
• Appendix (source docs | api docs)

API Contains 2 types of requests:

1. Live (Simple HTTP request/response message)
2. Task-based (Requires sending a 'Task' entity to execute, waiting until the 'Task' status is ready, and getting the 'Task' result in a special endpoint. Usually, it is represented by 3 types of endpoints: 'TaskPost', 'TaskReady', and 'TaskGet')

For more details, please follow here

YAML Spec

Our API description is based on the Open API syntax in YAML format. The YAML file attached to the project root

Code generation

Code generated using the openapi generator cli

Documentation

The documentation for code objects, formatted in Markdown (.md) is available here. Official documentation for DataForSEO API is available here.

Package source

Information about adding the package to your project you can see here

Examples of usage

Example of live request

importjava.util.ArrayList;
importjava.util.List;
importio.github.dataforseo.client.ApiClient;
importio.github.dataforseo.client.ApiException;
importio.github.dataforseo.client.api.SerpApi;
importio.github.dataforseo.client.auth.*;
importio.github.dataforseo.client.model.*;
importio.github.dataforseo.client.Configuration;
publicclassApp {
publicstaticvoidmain( String[] args )
{
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.dataforseo.com");
// Configure HTTP basic authorization: basicAuthHttpBasicAuthbasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("USERNAME"); //set your usernamebasicAuth.setPassword("PASSWORD"); //set your passwordSerpApiapiInstance = newSerpApi(defaultClient);
try {
SerpGoogleOrganicLiveAdvancedRequestInfotask = newSerpGoogleOrganicLiveAdvancedRequestInfo();
task.setLocationCode(2840);
task.setLanguageCode("en");
task.setKeyword("albert einstein");
List<SerpGoogleOrganicLiveAdvancedRequestInfo> serpTaskRequestInfo = newArrayList<SerpGoogleOrganicLiveAdvancedRequestInfo>();
serpTaskRequestInfo.add(task);
SerpGoogleOrganicLiveAdvancedResponseInforesult = apiInstance.googleOrganicLiveAdvanced(serpTaskRequestInfo);
System.out.println(result);
} catch (ApiExceptione) {
System.err.println("Exception when calling SerpApi#googleOrganicTaskGetAdvanced");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Example of Task-based endpoint

importjava.util.ArrayList;
importjava.util.List;
importjava.util.concurrent.TimeUnit;
importio.github.dataforseo.client.ApiClient;
importio.github.dataforseo.client.ApiException;
importio.github.dataforseo.client.api.SerpApi;
importio.github.dataforseo.client.auth.*;
importio.github.dataforseo.client.model.*;
importokhttp3.internal.concurrent.Task;
importio.github.dataforseo.client.Configuration;
publicclassApp {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.dataforseo.com");
// Configure HTTP basic authorization: basicAuthHttpBasicAuthbasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("USERNAME"); //set your usernamebasicAuth.setPassword("PASSWORD"); //set your passwordSerpApiapiInstance = newSerpApi(defaultClient);
try {
SerpTaskRequestInfotask = newSerpTaskRequestInfo();
task.setLocationCode(2840);
task.setLanguageCode("en");
task.setKeyword("albert einstein");
List<SerpTaskRequestInfo> serpTaskRequestInfo = newArrayList<SerpTaskRequestInfo>();
serpTaskRequestInfo.add(task);
SerpGoogleOrganicTaskPostResponseInfotaskPost = apiInstance.googleOrganicTaskPost(serpTaskRequestInfo);
StringtaskId = taskPost.getTasks().get(0).getId();
longstartTime = System.currentTimeMillis();
booleanisTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);
while (!isTaskReady && (System.currentTimeMillis() - startTime) < 60000) {
isTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);
try {
TimeUnit.SECONDS.sleep(1);
} catch (InterruptedExceptione) {
Thread.currentThread().interrupt();
System.err.println("Thread was interrupted, Failed to complete operation");
break;
}
}
SerpGoogleOrganicTaskGetAdvancedResponseInforesult = apiInstance.googleOrganicTaskGetAdvanced(taskId);
System.out.println(result);
} catch (ApiExceptione) {
System.err.println("Exception when calling SerpApi#googleOrganicLiveAdvanced");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
privatestaticbooleanGoogleOrganicTaskReady(SerpApiserpApi, StringtaskId) throwsApiException {
SerpGoogleOrganicTasksReadyResponseInforesult = serpApi.googleOrganicTasksReady();
for (SerpGoogleOrganicTasksReadyTasktask : result.getTasks()) {
for (SerpGoogleTasksReadyResultInfoxx : task.getResult()) {
if (xx.getId().equals(taskId)) {
returntrue;
}
}
}
returnfalse;
}
}