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):
- 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)
- Content Generation (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:
- Live (Simple HTTP request/response message)
- 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
Our API description is based on the Open API syntax in YAML format. The YAML file attached to the project root
Code generated using the openapi generator cli
The documentation for code objects, formatted in Markdown (.md) is available here. Official documentation for DataForSEO API is available here.
Information about adding the package to your project you can see here
Example of live request
import java.util.ArrayList;
import java.util.List;
import io.github.dataforseo.client.ApiClient;
import io.github.dataforseo.client.ApiException;
import io.github.dataforseo.client.api.SerpApi;
import io.github.dataforseo.client.auth.*;
import io.github.dataforseo.client.model.*;
import io.github.dataforseo.client.Configuration;
public class App
{
public static void main( String[] args )
{
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.dataforseo.com");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("USERNAME"); //set your username
basicAuth.setPassword("PASSWORD"); //set your password
SerpApi apiInstance = new SerpApi(defaultClient);
try {
SerpGoogleOrganicLiveAdvancedRequestInfo task = new SerpGoogleOrganicLiveAdvancedRequestInfo();
task.setLocationCode(2840);
task.setLanguageCode("en");
task.setKeyword("albert einstein");
List<SerpGoogleOrganicLiveAdvancedRequestInfo> serpTaskRequestInfo = new ArrayList<SerpGoogleOrganicLiveAdvancedRequestInfo>();
serpTaskRequestInfo.add(task);
SerpGoogleOrganicLiveAdvancedResponseInfo result = apiInstance.googleOrganicLiveAdvanced(serpTaskRequestInfo);
System.out.println(result);
} catch (ApiException e) {
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
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;
import io.github.dataforseo.client.ApiClient;
import io.github.dataforseo.client.ApiException;
import io.github.dataforseo.client.api.SerpApi;
import io.github.dataforseo.client.auth.*;
import io.github.dataforseo.client.model.*;
import okhttp3.internal.concurrent.Task;
import io.github.dataforseo.client.Configuration;
public class App {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.dataforseo.com");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("USERNAME"); //set your username
basicAuth.setPassword("PASSWORD"); //set your password
SerpApi apiInstance = new SerpApi(defaultClient);
try {
SerpTaskRequestInfo task = new SerpTaskRequestInfo();
task.setLocationCode(2840);
task.setLanguageCode("en");
task.setKeyword("albert einstein");
List<SerpTaskRequestInfo> serpTaskRequestInfo = new ArrayList<SerpTaskRequestInfo>();
serpTaskRequestInfo.add(task);
SerpGoogleOrganicTaskPostResponseInfo taskPost = apiInstance.googleOrganicTaskPost(serpTaskRequestInfo);
String taskId = taskPost.getTasks().get(0).getId();
long startTime = System.currentTimeMillis();
boolean isTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);
while (!isTaskReady && (System.currentTimeMillis() - startTime) < 60000) {
isTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);
try {
TimeUnit.SECONDS.sleep(1);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
System.err.println("Thread was interrupted, Failed to complete operation");
break;
}
}
SerpGoogleOrganicTaskGetAdvancedResponseInfo result = apiInstance.googleOrganicTaskGetAdvanced(taskId);
System.out.println(result);
} catch (ApiException e) {
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();
}
}
private static boolean GoogleOrganicTaskReady(SerpApi serpApi, String taskId) throws ApiException {
SerpGoogleOrganicTasksReadyResponseInfo result = serpApi.googleOrganicTasksReady();
for (SerpGoogleOrganicTasksReadyTask task : result.getTasks()) {
for (SerpGoogleTasksReadyResultInfo xx : task.getResult()) {
if (xx.getId().equals(taskId)) {
return true;
}
}
}
return false;
}
}