For the complete documentation index, see llms.txt. This page is also available as Markdown.

πŸ“–Basic Usage

Complete guide on how to use buymeacoffee.js to your project.

First get your personal access token here, then create a coffee.json file and save your personal access token inside. Example below.

coffee.json
{
    "token":"access_token_here"
}

After that, create your JavaScript file. Example below.

index.js
const BMC = require('buymeacoffee.js'); // add BMC package
const access = require('./coffee.json'); // load your token
const coffee = new BMC(access.token); // add your token here

// retrieve supporters data
coffee.Supporters().then(data => console.log(data));

// retrieve subscribers data
coffee.Subscriptions().then(data => console.log(data));

// retrieve extras data
coffee.Extras().then(data => console.log(data));

You can play with the data and get specific information such as supporter name. Example below.

coffee.Supporters().then(data => {
    data = data.data[0].supporter_name;
    console.log(data);
});

We will add more features to the API interactions. If you have in mind, please let us know by submitting an issue here.

Last updated