Feature Request: Stock market service widget to support non-US stocks as well

[Danie10]

Description

The widget is working for me for US-base stocks, but I'm not sure if I'm missing something for non-US stocks (syntax).

I'm looking to for example list a stock STX40 from Johannesburg stock exchange. Finnhub gives the exchange the code JO. But I tried adding STX40.JO and it gives an API error.

Other

No response

[eldyl]

It's somewhat subtle in the homepage docs, but you can view the documentation for the Finnhub endpoint here: https://finnhub.io/docs/api/quote.

The documentation for Finnhub says the endpoint provides US stock data, so I was a bit surprised that there was data for some non-US stocks and crypto. The non-US stock and crypto data appear to be inconsistent. I can't recommend using the stocks widgets for non-US stocks, or crypto at the time of writing this.

If there are other APIs that would be suitable to provide data for non-US stocks, I would be happy to look into implementing another provider for the widgets.

[Danie10]

Thanks, yes Yahoo Finance is often used for global prices e.g. at https://github.com/iprak/yahoofinance for Home Assistant. As free feeds are usually delayed no-one can expect super accurate prices. I think the big plus is just seeing whether some specific stocks / exchange rates are going up or down.

Yahoo would be great, as I'm already using it on my mobile to track some of my stocks.

[eldyl]

Thanks for sharing. I have a couple thoughts.

I considered using yahoo finance originally. To my knowledge, yahoo finance doesn't have a free and accessible API. The repo you provided is scraping the data from the yahoo finance website. To implement something similar in homepage, I would be building a scraper in the homepage repo. I think going this route would begin to go outside of the scope of homepage. Scrapers can also be a pain to maintain. However, those are just some of my thoughts.

This does have me thinking though. In theory, I could build a containerized API that would similarly scrape the data. This would obviously require running another container, in addition to homepage. If there was enough interest, I could look further into this. At the moment, I'm not sure the juice is worth the squeeze.

[rmonteremal]

@eldyl A couple months ago after you released your stock market widget and service I did start some work on a Yahoo Finance version of your widget, while officially there is no API you don't actually need to do web scraping as there are still publicly available (but not documented) endpoints. I did successfully implement said endpoints in your stock market widgets without running into any issue on Yahoo's end, however since they're unsupported they may be subject to change and/or get discontinued in the future (some endpoints that I previously used for a Discord bot did change about a year ago but the fix revolved around changing a couple URLs and query parameters)

I ran into issues by trying to implement this as another provider for the existing stock info widget and stock service - but that was mainly an issue in how Homepage is designed (or possibly my lack of fully understanding its code structure) and I was having trouble linking a provider name to a completely different API (Yahoo finance instead of finnhub) and endpoints

@Danie10 if the interest is still there I'll continue working into implementing a Yahoo Finance solution

EDIT: Yahoo finance also provides a lot more data than finnhub: not only international stocks, I did also manage to make it work for FOREX, crypto, indices and options, all of which isn't available on finnhub and other free providers

[Danie10]

@rmonteremal yes still interested as it may be a truly global option at least. Even if it is delayed by an hour or a day, that will still be very useful.

[eldyl]

@eldyl A couple months ago after you released your stock market widget and service I did start some work on a Yahoo Finance version of your widget, while officially there is no API you don't actually need to do web scraping as there are still publicly available (but not documented) endpoints.

Thanks for clarifying.

[Danie10]

Ah thanks, I had not realised they were scraping the data. Let me also look a bit further and see what else there may be.

Alpha Vantage API may be a good option.

Others could be:
Intrinio
Quandl

[eldyl]

Alpha Advantage - I gave this API another look. The data for quotes is updated once a day. Frequent updates get pricey. I tried the symbol STX40.JO, and I didn't get any data. I'm not sure this API will return non-US stock data.

Intrinio - I don't see a free API for this one. Data looks expensive.

Quandl - "Quandl is a premier publisher of alternative data", so I'm not sure this is the data we want. It looks like you can get a free API key, but then you have to contact a department to get the actual endpoint url? Getting access to the API is not straightforward, and I'm not sure it will provide the data we are after.

[Danie10]

Thanks for looking. Yes it does not look very good. I was hoping a delayed feed somewhere at least would be free and could do the job. Seems most are scraping data from Yahoo still - my mobile app widget is still doing that. They are least were fully universal and covering most countries.

[rmonteremal]

@Danie10 I have submitted a PR #4275 to add Yahoo Finance as a provider

@eldyl if you want to take a look at it and/or review it you're more than welcome to do so as I have implemented it as another provider for your existing widget

[eldyl]

Thank you. I will take a look later today and see if anything sticks out.

[Nespouique]

Hi, I saw that the PR was declined, I'm interested in having french stocks displayed, is there any alternative for this ?

[rmonteremal]

Hi, the PR was declined due to the "lack of interest" rule without review (ie not enough people want this feature). I see that we now have finally reached the 10 upvotes threshold so I'll probably update the code and try my luck again

If you want to start using it right away you can just use my fork and branch of the project, I've been personally using it since it was submitted a few months ago and haven't ran into any issue, it does work well with French stocks. Beware that since I haven't updated it since it was submitted it's still based on an older version of homepage