{"id":28181817,"url":"https://github.com/dataforseo/javaclient","last_synced_at":"2025-10-23T23:40:46.249Z","repository":{"id":225716677,"uuid":"766646020","full_name":"dataforseo/JavaClient","owner":"dataforseo","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-20T18:05:26.000Z","size":38984,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T19:23:11.214Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dataforseo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-03T20:29:31.000Z","updated_at":"2025-04-20T18:05:43.000Z","dependencies_parsed_at":"2024-04-15T08:58:01.142Z","dependency_job_id":null,"html_url":"https://github.com/dataforseo/JavaClient","commit_stats":null,"previous_names":["dataforseo/javaclient"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dataforseo%2FJavaClient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dataforseo%2FJavaClient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dataforseo%2FJavaClient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dataforseo%2FJavaClient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dataforseo","download_url":"https://codeload.github.com/dataforseo/JavaClient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254459029,"owners_count":22074606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-16T03:13:51.653Z","updated_at":"2025-10-23T23:40:46.244Z","avatar_url":"https://github.com/dataforseo.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## OVERVIEW\n\nThis 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.\n\n[![GitHub issues](https://img.shields.io/github/issues/dataforseo/JavaClient.svg)](https://github.com/dataforseo/JavaClient/issues)\n[![GitHub license](https://img.shields.io/github/license/dataforseo/JavaClient.svg)](https://github.com/dataforseo/JavaClient)\n\nDataForSEO 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.\n\nClient contains 13 sections (aka APIs):\n\n- AI Optimization API (source docs | api docs)\n- SERP ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/SerpApi.md) | [api docs](https://docs.dataforseo.com/v3/serp/overview/?bash))\n- Keywords Data ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/KeywordsDataApi.md) | [api docs](https://docs.dataforseo.com/v3/keywords_data/overview/?bash))\n- Domain Analytics ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/DomainAnalyticsApi.md) | [api docs](https://docs.dataforseo.com/v3/domain_analytics/overview/?bash))\n- DataForSEO Labs ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/DataforseoLabsApi.md) | [api docs](https://docs.dataforseo.com/v3/dataforseo_labs/overview/?bash))\n- Backlinks ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/BacklinksApi.md) | [api docs](https://docs.dataforseo.com/v3/backlinks/overview/?bash))\n- OnPage ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/OnPageApi.md) | [api docs](https://docs.dataforseo.com/v3/on_page/overview/?bash))\n- Content Analysis ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/ContentAnalysisApi.md) | [api docs](https://docs.dataforseo.com/v3/content_analysis/overview/?bash))\n- Content Generation ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/ContentGenerationApi.md) | [api docs](https://docs.dataforseo.com/v3/content_generation/overview/?bash))\n- Merchant ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/MerchantApi.md) | [api docs](https://docs.dataforseo.com/v3/merchant/overview/?bash))\n- App Data ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/AppDataApi.md) | [api docs](https://docs.dataforseo.com/v3/app_data/overview/?bash))\n- Business Data ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/BusinessDataApi.md) | [api docs](https://docs.dataforseo.com/v3/business_data/overview/?bash))\n- Appendix ([source docs](https://github.com/dataforseo/JavaClient/tree/master/docs/AppendixApi.md) | [api docs](https://docs.dataforseo.com/v3/appendix/user_data/?bash))\n\nAPI Contains 2 types of requests:\n1) Live (Simple HTTP request/response message)\n2) 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')\n\nFor more details, please follow [here](https://docs.dataforseo.com/v3/?bash)\n\n## YAML Spec\n\nOur API description is based on the Open API [syntax](https://spec.openapis.org/oas/v3.1.0) in YAML format. The YAML file attached to the [project root](https://github.com/dataforseo/OpenApiDocumentation)\n\n## Code generation\n\nCode generated using the [openapi generator cli](https://openapi-generator.tech/docs/installation/)\n\n## Documentation\nThe documentation for code objects, formatted in Markdown (.md) is available [here](https://github.com/dataforseo/JavaClient/tree/master/docs/).\nOfficial documentation for DataForSEO API is available [here](https://docs.dataforseo.com/v3/?bash).\n\n## Package source\nInformation about adding the package to your project you can see [here](https://central.sonatype.com/artifact/io.github.dataforseo/dataforseo-client)\n\n## Examples of usage\n\nExample of live request\n```java\nimport java.util.ArrayList;\nimport java.util.List;\nimport io.github.dataforseo.client.ApiClient;\nimport io.github.dataforseo.client.ApiException;\nimport io.github.dataforseo.client.api.SerpApi;\nimport io.github.dataforseo.client.auth.*;\nimport io.github.dataforseo.client.model.*;\nimport io.github.dataforseo.client.Configuration;\n\npublic class App \n{\n    public static void main( String[] args )\n    {\n        ApiClient defaultClient = Configuration.getDefaultApiClient();\n        defaultClient.setBasePath(\"https://api.dataforseo.com\");\n        \n        // Configure HTTP basic authorization: basicAuth\n        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication(\"basicAuth\");\n        basicAuth.setUsername(\"USERNAME\"); //set your username\n        basicAuth.setPassword(\"PASSWORD\"); //set your password\n    \n        SerpApi apiInstance = new SerpApi(defaultClient);\n        try {\n\n          SerpGoogleOrganicLiveAdvancedRequestInfo task = new SerpGoogleOrganicLiveAdvancedRequestInfo();\n\n          task.setLocationCode(2840);\n          task.setLanguageCode(\"en\");\n          task.setKeyword(\"albert einstein\");\n    \n          List\u003cSerpGoogleOrganicLiveAdvancedRequestInfo\u003e serpTaskRequestInfo = new ArrayList\u003cSerpGoogleOrganicLiveAdvancedRequestInfo\u003e();\n          serpTaskRequestInfo.add(task);\n\n          SerpGoogleOrganicLiveAdvancedResponseInfo result = apiInstance.googleOrganicLiveAdvanced(serpTaskRequestInfo);\n          System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling SerpApi#googleOrganicTaskGetAdvanced\");\n            System.err.println(\"Status code: \" + e.getCode());\n            System.err.println(\"Reason: \" + e.getResponseBody());\n            System.err.println(\"Response headers: \" + e.getResponseHeaders());\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n\nExample of Task-based endpoint\n```java\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.concurrent.TimeUnit;\n\nimport io.github.dataforseo.client.ApiClient;\nimport io.github.dataforseo.client.ApiException;\nimport io.github.dataforseo.client.api.SerpApi;\nimport io.github.dataforseo.client.auth.*;\nimport io.github.dataforseo.client.model.*;\n\nimport okhttp3.internal.concurrent.Task;\n\nimport io.github.dataforseo.client.Configuration;\n\npublic class App {\n  public static void main(String[] args) {\n    ApiClient defaultClient = Configuration.getDefaultApiClient();\n    defaultClient.setBasePath(\"https://api.dataforseo.com\");\n\n    // Configure HTTP basic authorization: basicAuth\n    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication(\"basicAuth\");\n    basicAuth.setUsername(\"USERNAME\"); //set your username\n    basicAuth.setPassword(\"PASSWORD\"); //set your password\n\n    SerpApi apiInstance = new SerpApi(defaultClient);\n\n    try {\n\n      SerpTaskRequestInfo task = new SerpTaskRequestInfo();\n\n      task.setLocationCode(2840);\n      task.setLanguageCode(\"en\");\n      task.setKeyword(\"albert einstein\");\n\n      List\u003cSerpTaskRequestInfo\u003e serpTaskRequestInfo = new ArrayList\u003cSerpTaskRequestInfo\u003e();\n      serpTaskRequestInfo.add(task);\n\n      SerpGoogleOrganicTaskPostResponseInfo taskPost = apiInstance.googleOrganicTaskPost(serpTaskRequestInfo);\n      String taskId = taskPost.getTasks().get(0).getId();\n\n      long startTime = System.currentTimeMillis();\n\n      boolean isTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);\n      while (!isTaskReady \u0026\u0026 (System.currentTimeMillis() - startTime) \u003c 60000) {\n        isTaskReady = GoogleOrganicTaskReady(apiInstance, taskId);\n        try {\n          TimeUnit.SECONDS.sleep(1);\n        } catch (InterruptedException e) {\n          Thread.currentThread().interrupt();\n          System.err.println(\"Thread was interrupted, Failed to complete operation\");\n          break;\n        }\n      }\n\n      SerpGoogleOrganicTaskGetAdvancedResponseInfo result = apiInstance.googleOrganicTaskGetAdvanced(taskId);\n      System.out.println(result);\n\n    } catch (ApiException e) {\n      System.err.println(\"Exception when calling SerpApi#googleOrganicLiveAdvanced\");\n      System.err.println(\"Status code: \" + e.getCode());\n      System.err.println(\"Reason: \" + e.getResponseBody());\n      System.err.println(\"Response headers: \" + e.getResponseHeaders());\n      e.printStackTrace();\n    }\n  }\n\n  private static boolean GoogleOrganicTaskReady(SerpApi serpApi, String taskId) throws ApiException {\n\n    SerpGoogleOrganicTasksReadyResponseInfo result = serpApi.googleOrganicTasksReady();\n    for (SerpGoogleOrganicTasksReadyTask task : result.getTasks()) {\n      for (SerpGoogleTasksReadyResultInfo xx : task.getResult()) {\n        if (xx.getId().equals(taskId)) {\n          return true;\n        }\n      }\n    }\n\n    return false;\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataforseo%2Fjavaclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdataforseo%2Fjavaclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataforseo%2Fjavaclient/lists"}