Is this an official Polymarket SDK?
Is this an official Polymarket SDK?
No. polymarket-data is community-maintained and not endorsed by the Polymarket team. It
targets public endpoints published by Polymarket. Confirm contractual or compliance requirements
with Polymarket before deploying to production.
Do I need an API key?
Do I need an API key?
Not for the endpoints currently implemented. If Polymarket introduces authentication, the
community will update the SDK accordingly.
Which environments are supported?
Which environments are supported?
- Node.js 18+ (native
fetch) - Serverless runtimes that support ESM modules
- Browser environments, provided CORS allows the target endpoints
fetch implementation if your runtime does not expose one.How are responses validated?
How are responses validated?
Every request and response flows through Zod schemas. Unexpected payloads throw descriptive
errors, helping you spot upstream changes immediately.
What happens if Polymarket changes an endpoint?
What happens if Polymarket changes an endpoint?
Zod validation will fail with a message like:Capture the new payload, open an issue, and submit a PR updating the schema. Include unit/integration
tests to lock the change in place.
How can I contribute?
How can I contribute?
- Fork the repository.
- Model the endpoint in Zod.
- Implement the method and export types.
- Add unit/integration tests.
- Run lint, build, and test scripts.
- Submit a detailed pull request.
Are there rate limits?
Are there rate limits?
Polymarket’s public APIs may enforce rate limits. Cache responses where possible and avoid
excessive polling. Consult Polymarket’s official docs for the latest policies.