# kahoot.js-api

> Interact with Kahoot Quizzes using nodejs

Latest version **2.4.0** (published 2021-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install kahoot.js-api
pnpm add kahoot.js-api
yarn add kahoot.js-api
bun add kahoot.js-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2021-06-09 |
| First published | 2021-06-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.9.0 |
| Dependencies | 3 |
| Unpacked size | 105.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | theusaf |
| Maintainers | craftit7 |

## Links

- npm: https://www.npmjs.com/package/kahoot.js-api
- Repository: https://github.com/theusaf/kahoot.js-updated
- Homepage: https://github.com/theusaf/kahoot.js-updated#readme
- Issues: https://github.com/theusaf/kahoot.js-updated/issues
- npm.io page: https://npm.io/package/kahoot.js-api

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) ^7.4.2
- [got](https://npm.io/package/got.md) ^11.8.1
- [random-useragent](https://npm.io/package/random-useragent.md) ^0.5.0

## Recent versions

- 2.4.0 (latest) — 2021-06-09

## README

# About
Kahoot.js is a library to interact with the Kahoot API. kahoot.js supports joining and interacting with quizzes and challenges.
**Installation requires Node.js 10.9.0 or higher.**

![NPM](https://nodei.co/npm/kahoot.js-updated.png)

![Dependencies](https://david-dm.org/theusaf/kahoot.js-updated.svg) [![Known Vulnerabilities](https://snyk.io/test/github/theusaf/kahoot.js-updated/badge.svg)](https://snyk.io/test/github/theusaf/kahoot.js-updated) [![HitCount](https://hits.dwyl.com/theusaf/kahoot.js-updated.svg)](https://hits.dwyl.com/theusaf/kahoot.js-updated) ![Builds](https://travis-ci.com/theusaf/kahoot.js-updated.svg?branch=master) ![Docs](https://inch-ci.org/github/theusaf/kahoot.js-updated.svg?branch=master)

**Note: If upgrading from version 1.x.x, read the latest documentation for the new api first.**

# Basic Example
```js
const Kahoot = require("kahoot.js-updated");
const client = new Kahoot();
console.log("Joining kahoot...");
client.join(9802345 /* Or any other kahoot game pin */, "kahoot.js");
client.on("Joined", () => {
  console.log("I joined the Kahoot!");
});
client.on("QuizStart", () => {
  console.log("The quiz has started!");
});
client.on("QuestionStart", question => {
  console.log("A new question has started, answering the first answer.");
  question.answer(0);
});
client.on("QuizEnd", () => {
  console.log("The quiz has ended.");
});
```

## Full API Documentation
See [Documentation.md](Documentation.md).

## Examples
See `examples/` and `tests/`.

---
_Source: https://npm.io/package/kahoot.js-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._