{"_id":"@crawlfox.io/crawlfox","_rev":"3-51f99bf4932d894c2f549bf485ded33c","name":"@crawlfox.io/crawlfox","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@crawlfox.io/crawlfox","version":"0.1.0","keywords":["crawlfox","web-scraping","serp","markdown","llm"],"author":{"name":"Automote LLC"},"license":"MIT","_id":"@crawlfox.io/crawlfox@0.1.0","maintainers":[{"name":"pratikmishra79","email":"pratik@automote.io"},{"name":"crawlfox","email":"crawlfox.io@gmail.com"}],"homepage":"https://crawlfox.io","bugs":{"url":"https://github.com/Automote-LLC/crawlfox-integrations/issues"},"dist":{"shasum":"aff152f0919c3cd3f7fbd2a949f29de77170b967","tarball":"https://registry.npmjs.org/@crawlfox.io/crawlfox/-/crawlfox-0.1.0.tgz","fileCount":6,"integrity":"sha512-tML/su4QG4RcMtPz4NzzL9GFnAfLuExx0B3QP9XNuksdU9PjM51I2j/nHURxP4GK0RdMQfqHzjWEn+Tzoxrlpw==","signatures":[{"sig":"MEUCIQD2vqDZRIumwEgIzxM5vfeElY18JYjtKaa1iohdJmWClgIgQVXEH66xtgVeVFghGACHgupuvGoY0sjTYxkO8vgZVhU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":31406},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"b0c776284a0d232f531e21f9cbfa25e6d057c06a","scripts":{"test":"node --import tsx --test test/*.test.ts","build":"tsup src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"pratikmishra79","email":"pratik@automote.io"},"repository":{"url":"git+https://github.com/Automote-LLC/crawlfox-integrations.git","type":"git","directory":"packages/js"},"_npmVersion":"10.9.8","description":"Official JavaScript SDK for the CrawlFox web scraping and search API","directories":{},"sideEffects":false,"_nodeVersion":"22.23.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.3","tsup":"^8.4.0","typescript":"^5.8.2","@types/node":"^22.13.10"},"_npmOperationalInternal":{"tmp":"tmp/crawlfox_0.1.0_1788955999088_0.14852127848896468","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Moved to crawlfox. Use: npm install crawlfox"},"0.1.1":{"name":"@crawlfox.io/crawlfox","version":"0.1.1","keywords":["crawlfox","web-scraping","serp","markdown","llm"],"author":{"name":"Automote LLC"},"license":"MIT","_id":"@crawlfox.io/crawlfox@0.1.1","maintainers":[{"name":"pratikmishra79","email":"pratik@automote.io"},{"name":"crawlfox","email":"crawlfox.io@gmail.com"}],"homepage":"https://crawlfox.io","bugs":{"url":"https://github.com/Automote-LLC/crawlfox-integrations/issues"},"dist":{"shasum":"c6e5e1595f6b33f067992ec603d15810161a765e","tarball":"https://registry.npmjs.org/@crawlfox.io/crawlfox/-/crawlfox-0.1.1.tgz","fileCount":6,"integrity":"sha512-zldgFSTjzPnrHycWBlJSEeGk5PPQPDTpUtqEAEJQ5ExI2pFp4hyDvalm2qZG4voQ/0faK4XH4mIR8gCJqjXa/Q==","signatures":[{"sig":"MEUCIE2cnry3NpmZsco5w5evq8Z2v+osk2R+10M1nhyYDvspAiEAi6HN7Qx7bhBT3qeuULeNDYCEw9T4Slcpa36zLqjIMEk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":31334},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"b0c776284a0d232f531e21f9cbfa25e6d057c06a","scripts":{"test":"node --import tsx --test test/*.test.ts","build":"tsup src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"pratikmishra79","email":"pratik@automote.io"},"repository":{"url":"git+https://github.com/Automote-LLC/crawlfox-integrations.git","type":"git","directory":"packages/js"},"_npmVersion":"10.9.8","description":"Official JavaScript SDK for the CrawlFox web scraping and search API","directories":{},"sideEffects":false,"_nodeVersion":"22.23.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.3","tsup":"^8.4.0","typescript":"^5.8.2","@types/node":"^22.13.10"},"_npmOperationalInternal":{"tmp":"tmp/crawlfox_0.1.1_1788956453033_0.04018450371665527","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Moved to crawlfox. Use: npm install crawlfox"}},"time":{"created":"2026-09-09T12:13:18.920Z","modified":"2026-09-09T12:48:26.656Z","0.1.0":"2026-09-09T12:13:19.229Z","0.1.1":"2026-09-09T12:20:53.178Z"},"bugs":{"url":"https://github.com/Automote-LLC/crawlfox-integrations/issues"},"author":{"name":"Automote LLC"},"license":"MIT","homepage":"https://crawlfox.io","keywords":["crawlfox","web-scraping","serp","markdown","llm"],"repository":{"url":"git+https://github.com/Automote-LLC/crawlfox-integrations.git","type":"git","directory":"packages/js"},"description":"Official JavaScript SDK for the CrawlFox web scraping and search API","maintainers":[{"name":"crawlfox","email":"crawlfox.io@gmail.com"},{"name":"pratikmishra79","email":"pratik@automote.io"}],"readme":"# crawlfox\n\nOfficial JavaScript / TypeScript SDK for the [CrawlFox](https://crawlfox.io) scrape and search API.\n\nScrape pages to markdown, search the web, batch URLs, and look up your request logs.\n\n## Install\n\n```bash\nnpm install @crawlfox.io/crawlfox\n```\n\nNode 18+. Set `CRAWLFOX_API_KEY` or pass `apiKey`. Optional `CRAWLFOX_API_URL` (default `https://api.crawlfox.io`).\n\n## Quickstart\n\n```ts\nimport { CrawlFox, CrawlFoxError } from \"@crawlfox.io/crawlfox\";\n\nconst app = new CrawlFox(); // or { apiKey: \"cfx_...\" }\n\nconst page = await app.scrape(\"https://example.com\");\nconsole.log(page.markdown); // Document fields sit on the object (Firecrawl-style)\n\nconst hits = await app.search(\"crawlfox\", { engine: \"google\", num: 5 });\nconsole.log(hits.web?.[0]?.url);\n\nconst batch = await app.batch([\"https://example.org\"], { formats: [\"markdown\"] });\nconsole.log(batch.data[0]?.markdown);\n```\n\n## Options\n\n```ts\nawait app.scrape(\"https://example.com\", {\n  formats: [\"markdown\", \"links\", \"html\"],\n  skipCache: true,\n  country: \"us\",\n  language: \"en\",\n  redactPII: true,\n});\n```\n\n`formats` defaults to `[\"markdown\"]`. Batch accepts at most 100 URLs.\n\n## Errors\n\nFailed requests throw `CrawlFoxError` (`status`, `code`, `retryable`). Quota `429` is **not** retried. `502`/`503`/`504` and `{ retryable: true }` are retried with exponential backoff.\n\n```ts\ntry {\n  await app.scrape(\"https://example.com\");\n} catch (err) {\n  if (err instanceof CrawlFoxError) {\n    console.error(err.status, err.code, err.retryable);\n  }\n}\n```\n\n## Other methods\n\n- `scrapeGet(url)` — `GET /v1/scrape/:url`\n- `searchStream(q, opts)` — NDJSON `page` / `done` / `error`\n- `getLog(id)` / `getLogResult(id)` — your own request logs\n\n## Docs\n\nhttps://docs.crawlfox.io\n","readmeFilename":"README.md"}