\n
\n ![\"npm](\"https://img.shields.io/bundlephobia/min/rozod?style=for-the-badge\")
![\"npm\"](\"https://img.shields.io/npm/v/rozod?style=for-the-badge\")
![\"npm\"](\"https://img.shields.io/npm/dt/rozod?style=for-the-badge\")
\n Documentation •\n Quick Start •\n API Reference\n
\n\n---\n\nRoZod makes working with Roblox APIs simple and type-safe. **695+ classic web API endpoints** and **115+ OpenCloud endpoints**, all code-generated from official Roblox documentation, with authentication, CSRF tokens, cookie rotation, pagination, batching, and error parsing handled for you.\n\nWorks in Node.js, Bun, Deno, browsers, and browser extensions. Battle-tested in [RoGold](https://rogold.live), serving 800,000+ users with millions of API requests daily.\n\n## Installation\n\n```bash\nnpm install rozod\n```\n\n## Quick Start\n\n```ts\nimport { fetchApi, isAnyErrorResponse } from 'rozod';\nimport { getUsersUserid } from 'rozod/endpoints/usersv1';\n\nconst user = await fetchApi(getUsersUserid, { userId: 1 });\nif (!isAnyErrorResponse(user)) {\n console.log(user.displayName); // fully typed!\n}\n```\n\nOn a server, configure authentication once and every request uses it:\n\n```ts\nimport { configureServer } from 'rozod';\n\nconfigureServer({\n cookies: process.env.ROBLOX_COOKIE, // classic *.roblox.com APIs\n cloudKey: process.env.ROBLOX_CLOUD_KEY, // OpenCloud APIs\n});\n```\n\n## Documentation\n\nFull guides and reference at **[rozod.alrovi.com](https://rozod.alrovi.com)**:\n\n- [Installation & Setup](https://rozod.alrovi.com/getting-started/installation/)\n- [Authentication](https://rozod.alrovi.com/guides/authentication/) — cookie pools, rotation, OpenCloud keys, challenges\n- [Error Handling](https://rozod.alrovi.com/guides/error-handling/)\n- [Pagination](https://rozod.alrovi.com/guides/pagination/) & [Batch Requests](https://rozod.alrovi.com/guides/batch-requests/)\n- [Caching](https://rozod.alrovi.com/guides/caching/)\n- [OpenCloud](https://rozod.alrovi.com/guides/opencloud/) & [Long-Running Operations](https://rozod.alrovi.com/guides/long-running-operations/)\n- [Custom Endpoints](https://rozod.alrovi.com/guides/custom-endpoints/)\n- [Core API Reference](https://rozod.alrovi.com/reference/core-api/) — every exported function and type\n- [Coming from noblox.js?](https://rozod.alrovi.com/getting-started/migration-from-nobloxjs/)\n\n## Credits\n\nMaintained by Alrovi ApS, the company behind RoGold.\n\n## Disclaimer\n\nRoZod is not affiliated with, maintained, authorized, endorsed, or sponsored by Roblox Corporation or any of its affiliates.\n","readmeFilename":"README.md"}