A simple maubot plugin to return basic financial data about stocks and cryptocurrencies
Go to file
2023-06-26 10:21:40 -07:00
images first pass at better readme with images 2021-01-11 16:04:40 -08:00
base-config.yaml Abstract RapidAPI hostname to more easily handle name changes 2022-03-05 09:13:23 -05:00
LICENSE.txt add MIT license 2023-06-26 10:21:40 -07:00
maubot.yaml Abstract RapidAPI hostname to more easily handle name changes 2022-03-05 09:13:23 -05:00
README.md specified correct yahoo-finance api endpoint 2022-11-11 21:22:17 -05:00
sample-api-output.json initial commit 2020-12-05 00:30:52 -08:00
tickerbot.py Abstract RapidAPI hostname to more easily handle name changes 2022-03-05 09:13:23 -05:00

a simple maubot module that responds with financial data about stock price or cryptocurrency exchange rate.

To install, please see the standard maubot plugin installation instructions

note: this module depends on having an api key for the following services

Setup

plug in API keys for both your RapidAPI yahoo finance app and your CoinAPI account in the config file (either before packaging in the base-config, or directly in the maubot interface after loading).

when using rapidAPI for yahoo finance, the endpoints changed. currently, the default endpoint is yh-finance.p.rapidapi.com. However, if this gives you trouble, it may be because you created your "application" in RapidAPI before the change. Try setting the rapidapiHost value in your config to apidojo-yahoo-finance-v1.p.rapidapi.com. Most new installs will not need to mess with this.

update the commands you want to use, by default stock data is returned with the !stonks command, and crypto data is returned with !hodl command. for example:

!stonks tsla

would return something like this:

stonks response

and

!hodl btc/ada

would return something like this:

hodl response