About The Project

Unofficial Trakteer Streaming API (Using websocket)

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use Trakteer.js and how to install them.

• npm

  npm install trakteerjs@latest

Usage

For examples, please refer to the Examples

Documentation

• Trakteer.js Documentation

Features

• Public API

| Features | Implemented? | How to use it | | ------------------- | ------------ | ----------------------- | | Quantity Given | Yes | .quantityGiven(email) | | Support History | Yes | .supportHistory() | | Current Balance | Yes | .currentBalance() | | Transaction History | Yes | .transactionHistory() |

• Stream API

| Features | Implemented? | How to use it | | ------------- | ------------ | ----------------------------------- | | Live Donation | Yes | .on("donation", (donation) => {}) | | Leaderboard | Yes | .getLeaderboard() | | Get Goal | Yes | .getGoal() | | Get Supporter | Yes | .getSupporter() |

• Payment API

| Features | Implemented? | How to use it | | --------------------- | ------------------ | ----------------------------- | | Get payment methods | Yes | .getPaymentMethods(creatorId, paymentMethod, amount, config) | | Get total amount | Yes | .getTotalAmount(paymentMethod, amount, is_payment_fee_by_supporter) | | Create payment | Yes | .createPayment(creatorId, paymentMethod, amount, config) |

See the API Documentation for more details. (Some features probably not listed here.) See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the APACHE 2.0 + DNH License. See LICENSE for more information.

Contact

BbayuGt - @BbayuGt - [email protected]

Discord - @bbayugt

Project Link: https://github.com/BbayuGt/Trakteer.js

Getting blocked by Cloudflare?

Some Server Provider may be blocked by Cloudflare, if you get blocked, please join the Official Trakteer Discord Server and open a ticket, trakteer moderator will help from there

Legal

Trakteer.js is NOT affiliated with, maintained, sponsored or endorsed by Trakteer or any of its affiliates. Use at your own risk!