kick-api-types

A TypeScript type definition library for the Kick.com API, providing strongly typed interfaces and route definitions for Kick’s public API. This project aims to make interacting with the Kick API easier by providing accurate and structured TypeScript typings for developers.

🚀 Status: Work in Progress

This project is unfinished and actively under development. While we have started defining types for major Kick API routes, many endpoints are still incomplete.

We welcome contributions from the community to help improve, refine, and expand the typings.

📌 Goals

• Provide fully typed interfaces for all Kick API endpoints
• Maintain strict type safety for request and response payloads
• Follow best practices for TypeScript API typings
• Ensure compatibility with REST API clients like Axios and Fetch
• Keep the types up to date as Kick updates their API

🤝 Contributing

How You Can Help

• Submit PRs for missing or incomplete typings
• Report issues if you find incorrect or outdated types
• Test the types in real-world applications and suggest improvements
• Enhance documentation with usage examples

Getting Started

1. Fork the repository
2. Install dependencies: npm install
3. Make your changes
4. Submit a Pull Request 🚀

📜 License

This project is licensed under the MIT License. By contributing, you agree to license your work under MIT.

Join us in making Kick API development smoother for everyone! 🚀