https://github.com/waaverecords/kick-nodejs

Kick.com API for Nodejs.
https://github.com/waaverecords/kick-nodejs

kick-com nodejs puppeteer streaming typescript

Last synced: about 9 hours ago
JSON representation

Kick.com API for Nodejs.

• Host: GitHub
• URL: https://github.com/waaverecords/kick-nodejs
• Owner: waaverecords
• License: mit
• Created: 2023-06-18T17:34:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-18T18:12:50.000Z (over 1 year ago)
• Last Synced: 2024-11-09T16:08:22.321Z (5 days ago)
• Topics: kick-com, nodejs, puppeteer, streaming, typescript
• Language: TypeScript
• Homepage:
• Size: 41 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kick-nodejs

kick-nodejs is a Node.js library that provides methods for retrieving livestream data from the kick.com website. Behind the curtain, [Puppeteer](https://www.npmjs.com/package/puppeteer) is used to execute fetch requests to the unofficial API.

## Installation

To use KickNodeJS in your Node.js project, you can install it via npm. Run the following command:

```shell

npm install kick-nodejs

```

## Usage

Here's an example of how to use kick-nodejs:

```typescript

import { KickNodeJS } from 'kick-nodejs';

const kick = new KickNodeJS();

async function fetchLivestreams() {

    try {

        await kick.init();

        const livestreams = await kick.getLivestreams({

            page: 1,

            limit: 10,

            subcategory: 'sports',

            sort: 'desc',

        });

        console.log(livestreams);

    } catch (error) {

        console.error('Error fetching livestreams:', error);

    } finally {

        await kick.stop();

    }

}

fetchLivestreams();

```

## Contributing

Contributions are welcome! If you have any ideas, improvements, or bug fixes, please open an issue or submit a pull request.

To contribute to KickNodeJS, follow these steps:

1. Fork the repository.

2. Create a new branch for your feature/fix.

3. Make your changes and commit them with descriptive commit messages.

4. Push your changes to your forked repository.

5. Submit a pull request to the main repository.

Please ensure that your code adheres to the existing code style. Also, make sure to update the documentation as needed.

Together, we can make kick-nodejs better!

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.