{"id":20172609,"url":"https://github.com/screenshotone/jsdk","last_synced_at":"2025-08-29T05:04:40.035Z","repository":{"id":121176858,"uuid":"499159929","full_name":"screenshotone/jsdk","owner":"screenshotone","description":"A Java SDK for the ScreenshotOne.com API to take screenshots of any URL","archived":false,"fork":false,"pushed_at":"2022-11-03T07:52:05.000Z","size":72,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T03:01:42.762Z","etag":null,"topics":["screenshot","screenshot-api","screenshot-as-a-service","screenshot-bot","screenshot-generator","screenshot-library","screenshot-testing","screenshots","screenshotscloud"],"latest_commit_sha":null,"homepage":"https://screenshotone.com","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/screenshotone.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,"publiccode":null,"codemeta":null}},"created_at":"2022-06-02T14:05:10.000Z","updated_at":"2025-02-21T04:08:56.000Z","dependencies_parsed_at":"2023-04-27T19:32:09.625Z","dependency_job_id":null,"html_url":"https://github.com/screenshotone/jsdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/screenshotone/jsdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotone%2Fjsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotone%2Fjsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotone%2Fjsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotone%2Fjsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screenshotone","download_url":"https://codeload.github.com/screenshotone/jsdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotone%2Fjsdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272631632,"owners_count":24967104,"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","status":"online","status_checked_at":"2025-08-29T02:00:10.610Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["screenshot","screenshot-api","screenshot-as-a-service","screenshot-bot","screenshot-generator","screenshot-library","screenshot-testing","screenshots","screenshotscloud"],"created_at":"2024-11-14T01:31:33.773Z","updated_at":"2025-08-29T05:04:40.012Z","avatar_url":"https://github.com/screenshotone.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jsdk\n\n[![Build](https://github.com/screenshotone/jsdk/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/screenshotone/jsdk/actions/workflows/build.yml)\n\nAn official [Screenshot API](https://screenshotone.com/) client for Java. \n\nIt takes minutes to start taking screenshots. Just [sign up](https://screenshotone.com/) to get access and secret keys, import the client, and you are ready to go. \n\nThe SDK client is synchronized with the latest [screenshot API options](https://screenshotone.com/docs/options/).\n\n## Installation\n\nAdd the library as a dependency to your Maven project: \n```\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.screenshotone.jsdk\u003c/groupId\u003e\n        \u003cartifactId\u003escreenshotone-api-jsdk\u003c/artifactId\u003e\n        \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e    \n```\n\nOr Gradle: \n```\ndependencies {\n    compile 'com.screenshotone.jsdk:screenshotone-api-jsdk:1.0.0'\n}\n```\n\n## Usage\n\nGenerate a screenshot URL without executing request: \n```java\nimport com.screenshotone.jsdk.Client;\nimport com.screenshotone.jsdk.TakeOptions;\n\npublic class App {\n    public static void main(String[] args) throws Exception {\n        final Client client = Client.withKeys(\"IVmt2ghj9TG_jQ\", \"Sxt94yAj9aQSgg\");\n        TakeOptions takeOptions = TakeOptions.url(\"https://scalabledeveloper.com\")\n                .fullPage(true)\n                .deviceScaleFactor(1)\n                .viewportHeight(1200)\n                .viewportWidth(1200)\n                .format(\"png\")\n                .omitBackground(true);\n        final String url = client.generateTakeUrl(takeOptions);\n\n        System.out.println(url);\n        // Output: https://api.screenshotone.com/take?access_key=IVmt2ghj9TG_jQ\u0026device_scale_factor=1\u0026format=png\u0026full_page=true\u0026omit_background=true\u0026url=https%3A%2F%2Fscalabledeveloper.com\u0026viewport_height=1200\u0026viewport_width=1200\u0026signature=3c0c5543599067322e8c84470702330e3687c6a08eef6b7311b71c32d04e1bd5\n    }\n}\n```\n\nTake a screenshot and save the image in the file: \n```java\nimport com.screenshotone.jsdk.Client;\nimport com.screenshotone.jsdk.TakeOptions;\n\nimport java.io.File;\nimport java.nio.file.Files;\n\npublic class App {\n    public static void main(String[] args) throws Exception {\n        final Client client = Client.withKeys(\"IVmt2ghj9TG_jQ\", \"Sxt94yAj9aQSgg\");\n        TakeOptions takeOptions = TakeOptions.url(\"https://scalabledeveloper.com\")\n                .fullPage(true)\n                .deviceScaleFactor(1)\n                .viewportHeight(1200)\n                .viewportWidth(1200)\n                .format(\"png\")\n                .omitBackground(true);\n        final byte[] image = client.take();\n\n        Files.write(new File(\"./example.png\").toPath(), image);\n    }\n}\n```\n\n## Tests \n\nTo run tests, just execute: \n```shell\n./gradlew test\n```\n\n## License \n\n`screenshotone/jsdk` is released under [the MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreenshotone%2Fjsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscreenshotone%2Fjsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreenshotone%2Fjsdk/lists"}