https://github.com/idiidk/kahoot-api
An API for the Kahoot quiz service
https://github.com/idiidk/kahoot-api
api kahoot kahoot-tools live player quiz
Last synced: 7 months ago
JSON representation
An API for the Kahoot quiz service
- Host: GitHub
- URL: https://github.com/idiidk/kahoot-api
- Owner: idiidk
- Created: 2019-03-08T18:10:44.000Z (over 7 years ago)
- Default Branch: edu
- Last Pushed: 2023-01-03T00:50:47.000Z (over 3 years ago)
- Last Synced: 2024-08-10T02:51:51.143Z (almost 2 years ago)
- Topics: api, kahoot, kahoot-tools, live, player, quiz
- Language: JavaScript
- Homepage:
- Size: 3.07 MB
- Stars: 13
- Watchers: 3
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kahoot API
An API for the kahoot.it quiz platform. This release is intended for educational purposes only. The API is pretty outdated and I won't be supporting it any longer. It's still a good source for anyone looking to unravel the inner workings of Kahoot.
## Installation
Install with npm or yarn
```bash
yarn add kahoot-api
# or
npm install kahoot-api
```
## Usage
To get you started, here is a basic example of the Player authentication flow:
```JavaScript
import { Session, Adapters } from 'kahoot-api';
const session = new Session(000000 /** pin */, /** optional cors proxy, url string */)
session.openSocket() //Connect
.then(socket => {
const player = new Adapters.Player(socket); //Create player class
player.join('test') //Join with name
.then(() => {
console.log('Success!');
});
});
```
For usage please refer to the [documentation](https://idiidk.dev/kahoot-api)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)