{"_id":"@datablue/sdk","_rev":"3-513fe20e47f82d2c5b6f1bbf47c63ba6","name":"@datablue/sdk","dist-tags":{"latest":"1.2.0"},"versions":{"1.0.0":{"name":"@datablue/sdk","version":"1.0.0","license":"MIT","_id":"@datablue/sdk@1.0.0","maintainers":[{"name":"datablue","email":"databluedev@gmail.com"}],"dist":{"shasum":"26b592ca0c89a4aa4c6e371cf5fc5fd011890a56","tarball":"https://registry.npmjs.org/@datablue/sdk/-/sdk-1.0.0.tgz","fileCount":13,"integrity":"sha512-+PoAny+Arg2rAezTmhk0FBQMQjoRtmuKmgcnRCmLbfzChURso43nGkBCr5ptHxZYwhJ6K9UIfqCzrkItFM0ssQ==","signatures":[{"sig":"MEUCIGc/hFDxwkjmA96rWfUAnWpOblAqtLrljQ9D83hgdidVAiEA7hm254obtu9Fh/YUX9cFsSGAom/XhUB71mju9cksMrA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":282128},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"5078b5471f9262098950e77e9ad798123b6836d8","scripts":{"lint":"eslint src test --ext .ts","test":"node --experimental-vm-modules node_modules/jest/bin/jest.js","build":"tsup","typecheck":"tsc --noEmit"},"_npmUser":{"name":"datablue","email":"databluedev@gmail.com"},"_npmVersion":"11.6.2","description":"Official Node.js SDK for the DataBlue web scraping platform","directories":{},"_nodeVersion":"24.13.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.5.1","ts-jest":"^29.2.2","typescript":"^5.4.5","@types/jest":"^29.5.12","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.0.0_1783791849142_0.3246554970466351","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@datablue/sdk","version":"1.1.0","keywords":["datablue","web-scraping","scraping","serp","crawl","extract","typescript"],"license":"MIT","_id":"@datablue/sdk@1.1.0","maintainers":[{"name":"datablue","email":"databluedev@gmail.com"}],"dist":{"shasum":"ca6a3e9febd76ba06a29c0623914d4726f008ade","tarball":"https://registry.npmjs.org/@datablue/sdk/-/sdk-1.1.0.tgz","fileCount":14,"integrity":"sha512-WNGWA0c4BIkQk2LhGb+BxexnNn/kY7UXs8fAuBHb2mO8BMnPEMX2vmwLSnTiRaLy6jmIKTpdykAFK7UMxYSrZg==","signatures":[{"sig":"MEUCIQDdcu2zU/W31/LD7B0kHDyNX0KhJS0haLZJkHzAabc15gIgPQQ8zr7AcFNmoT+VVdDALiUigE63waMyyvO9Sz+hctg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":285477},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"b1fccdf6a2b9ec8a323774594aca7ba68f300ff5","scripts":{"lint":"eslint src test --ext .ts","test":"node --experimental-vm-modules node_modules/jest/bin/jest.js","build":"tsup","typecheck":"tsc --noEmit"},"_npmUser":{"name":"datablue","email":"databluedev@gmail.com"},"_npmVersion":"11.6.2","description":"Official Node.js SDK for the DataBlue web scraping platform","directories":{},"_nodeVersion":"24.13.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","tsup":"^8.5.1","ts-jest":"^29.2.2","typescript":"^5.4.5","@types/jest":"^29.5.12","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_1.1.0_1784042354519_0.8533755196104262","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@datablue/sdk","version":"1.2.0","description":"Official Node.js SDK for the DataBlue web scraping platform","type":"module","keywords":["datablue","web-scraping","scraping","serp","crawl","extract","typescript"],"publishConfig":{"access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"tsup","typecheck":"tsc --noEmit","test":"node --experimental-vm-modules node_modules/jest/bin/jest.js","lint":"eslint src test --ext .ts"},"devDependencies":{"@types/jest":"^29.5.12","@types/node":"^20.0.0","jest":"^29.7.0","ts-jest":"^29.2.2","tsup":"^8.5.1","typescript":"^5.4.5"},"engines":{"node":">=18.0.0"},"license":"MIT","_id":"@datablue/sdk@1.2.0","_nodeVersion":"24.13.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-U5Fe3WYl9CbR7fbCw3gc6VC9JxoMhZItbOvcePD7KdjwSLv6g1qbiD+MSMQHFdtaM37y6rapY8r2DUe9uvPTsA==","shasum":"342f6cf57f2c6efc4a04703c1f5bade3752a7686","tarball":"https://registry.npmjs.org/@datablue/sdk/-/sdk-1.2.0.tgz","fileCount":14,"unpackedSize":307278,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIC/+VrmOtzS9UtwLep1niq5jAuSVXwJcFZy0n9beop8/AiEA32hFRXfSME8Ypos8qXTRIk43BO9LJaryJ+MAxY4f0kc="}]},"_npmUser":{"name":"datablue","email":"databluedev@gmail.com"},"directories":{},"maintainers":[{"name":"datablue","email":"databluedev@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_1.2.0_1787639435729_0.8493364970171415"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-11T17:44:08.952Z","modified":"2026-08-25T06:30:36.023Z","1.0.0":"2026-07-11T17:44:09.300Z","1.1.0":"2026-07-14T15:19:14.778Z","1.2.0":"2026-08-25T06:30:35.874Z"},"license":"MIT","keywords":["datablue","web-scraping","scraping","serp","crawl","extract","typescript"],"description":"Official Node.js SDK for the DataBlue web scraping platform","maintainers":[{"name":"datablue","email":"databluedev@gmail.com"}],"readme":"# DataBlue Node SDK\r\n\r\nOfficial Node.js and TypeScript SDK for DataBlue.\r\n\r\n## Install\r\n\r\n```bash\r\nnpm install @datablue/sdk\r\n```\r\n\r\n## Usage\r\n\r\n```ts\r\nimport { DataBlue } from \"@datablue/sdk\";\r\n\r\nconst datablue = new DataBlue({\r\n  apiKey: process.env.DATABLUE_API_KEY,\r\n});\r\n\r\nconst result = await datablue.scrape(\"https://example.com\", {\r\n  formats: [\"markdown\"],\r\n});\r\n\r\nconsole.log(result.markdown);\r\n```\r\n\r\n## Data APIs\r\n\r\n```ts\r\nconst serp = await datablue.googleSerp({\r\n  q: \"best crm software\",\r\n  country: \"us\",\r\n  num: 10,\r\n});\r\n\r\nconst products = await datablue.amazonProducts({\r\n  query: \"wireless mouse\",\r\n  domain: \"amazon.com\",\r\n  num_results: 10,\r\n});\r\n```\r\n\r\nFor async Data API jobs, poll the native Data API job endpoint:\r\n\r\n```ts\r\nconst status = await datablue.getDataJobStatus(\"job-id\");\r\n```\r\n\r\n## Plan and credit usage\r\n\r\n```ts\r\nconst usage = await datablue.getUsageSummary();\r\n\r\nconsole.log(usage.plan?.display_name);\r\nconsole.log(usage.credits.remaining);\r\nconsole.log(usage.credits.payg_balance);\r\n```\r\n\r\nCredit measurements are `null` when there is no active billing period or the\r\nvalue is not measurable. Unlimited plans also return `null` for finite limits\r\nand remaining-credit fields.\r\n\r\n## Core Methods\r\n\r\n- `scrape`\r\n- `startCrawl`, `getCrawlStatus`, `cancelCrawl`, `crawl`\r\n- `startSearch`, `getSearchStatus`, `search`\r\n- `mapUrl`\r\n- `extract`\r\n- `dataApi`\r\n- `getDataJobStatus`\r\n- `getUsageSummary`\r\n\r\nDocumentation: https://docs.datablue.dev/docs\r\n","readmeFilename":"README.md"}