1.0.6 • Published 1 year ago

tipcc-api v1.0.6

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

tip.cc API Client for Java- and Typescript-based projects

ParamTypeDescription
tokenstringThe tip.cc API token of your bot.
optionsobjectOptions for the client.
options.baseUrlstringThe base url of the tip.cc API.
options.pollingIntervalnumberThe interval in which the client polls the tip.cc API for new transactions.
ParamTypeDescription
event'tip', 'ready'The event to listen for.
callback(data: any) => voidThe callback to execute when the event is emitted.
ParamTypeDescription
cachebooleanWhether to use the cache for the result.
ParamTypeDescription
cachebooleanWhether to use the cache for the result.
ParamTypeDescription
optionsobjectOptions for the request.
options.types'tip'The maximum amount of transactions to return.
options.sinceDateThe timestamp of the oldest transaction to return.
options.untilDateThe timestamp of the newest transaction to return.
options.limitnumberThe maximum amount of transactions to return.
options.offsetnumberThe offset of the transactions to return.

TipccClient#getExchangeRates (Method)

Obtain the exchange rates for all tip.cc crypto currencies

ParamTypeDescription

TipccClient#getExchangeRate (Method)

Obtain the exchange rate for a specific tip.cc crypto currency

ParamTypeDescription
currencyCodestringThe code of the crypto currency.

TipccClient#getTransaction (Method)

Get a specific transaction by its ID

ParamTypeDescription
idstringThe ID of the transaction.

TipccClient#postTip (Method)

Create a tip

ParamTypeDescription
optionsobjectOptions for the request.
options.servicediscordThe service to tip on.
options.recipientstringThe recipient of the tip.
options.amount.valuestringThe amount of the tip.
options.amount.currencystringThe currency of the tip.

TipccClient#getWallet (Method)

Get a specific wallet (Client Balance)

ParamTypeDescription
currencystringThe currency of the wallet.
fallbackbooleanWhether to fallback to a 0-value USD wallet if the wallet doesn't exist

TipccClient#getWallets (Method)

Get all wallets (Client Balances)

ParamTypeDescription

The author is not responsible for any loss which has been made through possible vulnerabilities. If you find one open a Github Issue (Critical Vulnerabilites via Discord to Walledgarden#0002 or via Email to info@walledgarden.cc)

Special thanks to oknu#7863 who made the first version of the event emitter, which is heavily recycled in this repository, and the tip.cc discord bot, which makes it really easy to use crypto currency on discord, with having a wallet connected to your user account 🐻

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.0

1 year ago