{"id":41621912,"url":"https://github.com/screenshotmax/typescript-sdk","last_synced_at":"2026-01-24T13:56:13.551Z","repository":{"id":296090756,"uuid":"974300197","full_name":"screenshotmax/typescript-sdk","owner":"screenshotmax","description":"Official Javascript \u0026 TypeScript SDK for the ScreenshotMAX.com API","archived":false,"fork":false,"pushed_at":"2026-01-01T17:27:52.000Z","size":356,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-06T23:53:07.189Z","etag":null,"topics":["api","javascript","nodejs","screenshot","screenshot-api","screenshot-as-a-service","screenshot-capture","screenshot-generator","screenshot-library","screenshot-testing","screenshot-tool","screenshot-utility","screenshots","typescript"],"latest_commit_sha":null,"homepage":"https://screenshotmax.com","language":"TypeScript","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/screenshotmax.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-28T15:03:15.000Z","updated_at":"2026-01-01T17:27:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"562122f7-aa24-46bf-96a7-129c3f27b19c","html_url":"https://github.com/screenshotmax/typescript-sdk","commit_stats":null,"previous_names":["screenshotmax/typescript-sdk"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/screenshotmax/typescript-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotmax%2Ftypescript-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotmax%2Ftypescript-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotmax%2Ftypescript-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotmax%2Ftypescript-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/screenshotmax","download_url":"https://codeload.github.com/screenshotmax/typescript-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/screenshotmax%2Ftypescript-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28729411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T10:24:43.181Z","status":"ssl_error","status_checked_at":"2026-01-24T10:24:36.112Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api","javascript","nodejs","screenshot","screenshot-api","screenshot-as-a-service","screenshot-capture","screenshot-generator","screenshot-library","screenshot-testing","screenshot-tool","screenshot-utility","screenshots","typescript"],"created_at":"2026-01-24T13:56:11.352Z","updated_at":"2026-01-24T13:56:13.547Z","avatar_url":"https://github.com/screenshotmax.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ScreenshotMAX TypeScript SDK\n\n[![build](https://github.com/screenshotmax/typescript-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/screenshotmax/typescript-sdk/actions/workflows/build.yml)\n[![test](https://github.com/screenshotmax/typescript-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/screenshotmax/typescript-sdk/actions/workflows/test.yml)\n\nThis is the official JavaScript \u0026 TypeScript SDK for the [ScreenshotMAX API](https://screenshotmax.com/).\n\nIt allows you to easily capture high-quality screenshots of any URL directly from your applications.\nThe SDK handles authentication, request signing, and provides a simple interface to integrate ScreenshotMAX’s powerful screenshot services into your TypeScript or JavaScript projects.\n\nGet started in minutes. Just [sign up](https://screenshotmax.com) to receive your access and secret keys, import the client, and you’re ready to capture screenshots.”\n\nThe SDK client is synchronized with the latest [ScreenshotMAX API options](https://docs.screenshotmax.com/guides/start/introduction).\n\n\n## Installation\n\n```shell\nnpm install @screenshotmax/sdk\n```\n\n## Usage\n\nUse the SDK to generate signed or unsigned URLs for screenshots, PDFs, web scraping, or animated screenshot—without executing the request. Or fetch and download the result directly. You have full control over when and how each capture runs.\n\n### Screenshot example\n```typescript\nimport fs from \"node:fs\";\nimport { SDK } from \"@screenshotmax/sdk\";\n\n// create API client \nconst sdk = new SDK(\"\u003cACCESS_KEY\u003e\", \"\u003cSECRET_KEY\u003e\");\n\n// set up options\nsdk.screenshot.setOptions({\n  url: \"https://example.com\",\n  format: \"png\"\n});\n\n// optionnaly: generate signed URL \n// (https://api.screenshotmax.com/v1/screenshot?url=https%3A%2F%2Fexample.com\u0026format=png\u0026access_key=\u003cACCESS_KEY\u003e\u0026signature=370f5b161bc59eed13b76........1f778635d7fc595dbab12)\nconst url = sdk.screenshot.getUrl();\n\n// generate screenshot\nconst result = await sdk.screenshot.fetch();\n\nfs.writeFileSync(\"screenshot.png\", Buffer.from(result.data, \"binary\"));\n```\n\n### Web scraping example\n```typescript\nimport fs from \"node:fs\";\nimport { SDK } from \"@screenshotmax/sdk\";\n\n// create API client \nconst sdk = new SDK(\"\u003cACCESS_KEY\u003e\", \"\u003cSECRET_KEY\u003e\");\n\n// set up options\nsdk.scrape.setOptions({\n  url: \"https://example.com\",\n  format: \"html\",\n});\n\nconst result = await sdk.scrape.fetch();\n\nfs.writeFileSync(\"scrape.html\", result.data);\n```\n\n### PDF generation example\n```typescript\nimport fs from \"node:fs\";\nimport { SDK } from \"@screenshotmax/sdk\";\n\n// create API client \nconst sdk = new SDK(\"\u003cACCESS_KEY\u003e\", \"\u003cSECRET_KEY\u003e\");\n\n// set up options and scrape content (chaining)\nconst result = await sdk.pdf\n  .setOptions({\n    url: \"https://example.com\",\n    pdf_paper_format: \"letter\",\n  })\n  .fetch();\n\nfs.writeFileSync(\"pdf.pdf\", Buffer.from(result.data, \"binary\"));\n```\n\n### Scheduled task example\n\n```typescript\nimport { SDK } from \"@screenshotmax/sdk\";\n\n// create API client \nconst sdk = new SDK(\"\u003cACCESS_KEY\u003e\", \"\u003cSECRET_KEY\u003e\");\n\n// get all tasks from account\nconst tasks = await sdk.task.getTasks();\n// {\n//   tasks: [\n//     {\n//       id: 5678133109850112,\n//       name: 'My cron test',\n//       api: 'screenshot',\n//       query: 'url=https%3A%2F%2Fexample.com',\n//       frequency: 'every_day',\n//       crontab: '25 13 * * *',\n//       timezone: 'Etc/UTC',\n//       enabled: true,\n//       created: 1747229104,\n//       last_run: 1748438712,\n//       runs: 16\n//     }\n//   ]\n// }\n```\n\n## License\n\n`@screenshotmax/sdk` is released under [the MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreenshotmax%2Ftypescript-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscreenshotmax%2Ftypescript-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreenshotmax%2Ftypescript-sdk/lists"}