maubot-ticker/README.md

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](https://github.com/maubot/maubot/wiki/Usage#adding-a-plugin)

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

- [RapidAPI](https://rapidapi.com/marketplace) (used for the [yahoo-finance api endpoints](https://rapidapi.com/apidojo/api/yh-finance/), which you must subscribe to in your account settings)
- [CoinAPI](https://www.coinapi.io/Pricing)

## 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](images/stonks.png)

and

`!hodl btc/ada`

would return something like this:

![hodl response](images/hodl.png)
add a basic readme 2021-01-08 02:07:50 +00:00			`a simple maubot module that responds with financial data about stock price or cryptocurrency exchange rate.`

include link to installation instructions 2021-01-29 07:03:58 +00:00			`To install, please see the [standard maubot plugin installation instructions](https://github.com/maubot/maubot/wiki/Usage#adding-a-plugin)`

add a basic readme 2021-01-08 02:07:50 +00:00			`note: this module depends on having an api key for the following services`
fix formatting for required services list 2022-03-07 18:53:15 +00:00
specified correct yahoo-finance api endpoint specified correct yahoo-finance api endpoint on rapidapi, as it was confusing for a new user 2022-11-12 02:22:17 +00:00			`- [RapidAPI](https://rapidapi.com/marketplace) (used for the [yahoo-finance api endpoints](https://rapidapi.com/apidojo/api/yh-finance/), which you must subscribe to in your account settings)`
fix formatting for required services list 2022-03-07 18:53:15 +00:00			`- [CoinAPI](https://www.coinapi.io/Pricing)`
add a basic readme 2021-01-08 02:07:50 +00:00
first pass at better readme with images 2021-01-12 00:04:40 +00:00			`## 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).`

update readme to include old rapidapi host value for reference. 2022-03-07 16:00:09 +00:00			`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.

first pass at better readme with images 2021-01-12 00:04:40 +00:00			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:`
fix newline in readme 2021-01-12 00:06:19 +00:00
first pass at better readme with images 2021-01-12 00:04:40 +00:00			`![stonks response](images/stonks.png)`

			`and`

			`!hodl btc/ada`

			`would return something like this:`
fix newline in readme 2021-01-12 00:06:19 +00:00
first pass at better readme with images 2021-01-12 00:04:40 +00:00			`![hodl response](images/hodl.png)`