diff --git a/README.md b/README.md index 7c768b8..c8ff136 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ -# Real Time Finance : a Financial WebSocket public API +# :chart: Real Time Finance : a Financial WebSocket public API Real Time Finance is a simple websocket public API to get real-time stock prices. The following markets are available at the moment : - Forex -- US and European stocks companies (around 10K stocks) +- US and European stocks companies (around 10K stocks) EURONEXT, NASDAQ, NYSE ... -# Get started +## Preview + + +# Get started :rocket: ## Installing Download rtf binaries : https://github.com/Real-time-finance/finance-websocket-API/releases Unix, macos and windows binaries available. -## Usage example +## Usage example Use market name and stock symbol to receive datas. In this example we get quotations from Netflix (nasdaq) : ```shell -./rtf add --market="NASDAQ" --stock="NFLX" +rtf add --market="NASDAQ" --stock="NFLX" ``` Another example to get quotations from Goldman Sachs (nyse) : ```shell -./rtf add --market="NYSE" --stock="GS" +rtf add --market="NYSE" --stock="GS" +``` +Forex example to get eur/usd quotation : +``` +rtf add --market="FX" --stock="EURUSD" ``` - ## Output example ``` diff --git a/demo0.gif b/demo0.gif new file mode 100644 index 0000000..777db65 Binary files /dev/null and b/demo0.gif differ
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: