-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* quodd * updated websocket endpoint
- Loading branch information
Showing
2 changed files
with
284 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Intrinio NodeJS SDK for Real-Time Stock Prices | ||
|
|
||
| [Intrinio](https://intrinio.com/) provides real-time stock prices from the [IEX stock exchange](https://iextrading.com/), via a two-way WebSocket connection. To get started, [subscribe here](https://intrinio.com/data/realtime-stock-prices) and follow the instructions below. | ||
| [Intrinio](https://intrinio.com/) provides real-time stock prices via a two-way WebSocket connection. To get started, [subscribe to a real-time data feed](https://intrinio.com/marketplace/data/prices/realtime) and follow the instructions below. | ||
|
|
||
| *NOTE*: For use in web JavaScript, we recommend [https://github.com/intrinio/intrinio-realtime-web-sdk](https://github.com/intrinio/intrinio-realtime-web-sdk) | ||
|
|
||
|
|
@@ -10,10 +10,7 @@ | |
|
|
||
| ## Features | ||
|
|
||
| * Receive streaming, real-time price quotes from the IEX stock exchange | ||
| * Bid, ask, and last price | ||
| * Order size | ||
| * Order execution timestamp | ||
| * Receive streaming, real-time price quotes (last trade, bid, ask) | ||
| * Subscribe to updates from individual securities | ||
| * Subscribe to updates for all securities (contact us for special access) | ||
|
|
||
|
|
@@ -30,6 +27,7 @@ var IntrinioRealtime = require('intrinio-realtime') | |
| var ir = new IntrinioRealtime({ | ||
| username: "INTRINIO_API_USERNAME", | ||
| password: "INTRINIO_API_PASSWORD", | ||
| provider: "iex" | ||
| }) | ||
|
|
||
| // Listen for quotes | ||
|
|
@@ -42,7 +40,118 @@ ir.onQuote(quote => { | |
| ir.join("AAPL", "MSFT", "GE") | ||
| ``` | ||
|
|
||
| ## Quote Fields | ||
| ## Providers | ||
|
|
||
| Currently, Intrinio offers realtime data from the following providers: | ||
|
|
||
| * IEX - [Homepage](https://iextrading.com/) | ||
| * QUODD - [Homepage](http://home.quodd.com/) | ||
|
|
||
| Each has distinct price channels and quote formats, but a very similar API. | ||
|
|
||
| Each data provider has a different format for their quote data. | ||
|
|
||
| ### QUODD | ||
|
|
||
| NOTE: Messages from QUOOD reflect _changes_ in market data. Not all fields will be present in every message. Upon subscribing to a channel, you will receive one quote and one trade message containing all fields of the latest data available. | ||
|
|
||
| #### Quote Message | ||
|
|
||
| ```javascript | ||
| { ticker: "AAPL.NB", | ||
| root_ticker: "AAPL", | ||
| protocol_id: 301, | ||
| last_price_4d: 1594850, | ||
| trade_volume: 100, | ||
| trade_exchange: "t", | ||
| change_price_4d: 24950, | ||
| percent_change_4d: 15892, | ||
| trade_time: 1508165070052, | ||
| up_down: "v", | ||
| vwap_4d: 1588482, | ||
| total_volume: 10209883, | ||
| day_high_4d: 1596600, | ||
| day_high_time: 1508164532269, | ||
| day_low_4d: 1576500, | ||
| day_low_time: 1508160605345, | ||
| prev_close_4d: 1569900, | ||
| volume_plus: 6333150, | ||
| ext_last_price_4d: 1579000, | ||
| ext_trade_volume: 100, | ||
| ext_trade_exchange: "t", | ||
| ext_change_price_4d: 9100, | ||
| ext_percent_change_4d: 5796, | ||
| ext_trade_time: 1508160600567, | ||
| ext_up_down: "-", | ||
| open_price_4d: 1582200, | ||
| open_volume: 100, | ||
| open_time: 1508141103583, | ||
| rtl: 30660, | ||
| is_halted: false, | ||
| is_short_restricted: false } | ||
| ``` | ||
|
|
||
| * **ticker** - Stock Symbol for the security | ||
| * **root_ticker** - Underlying symbol for a particular contract | ||
| * **last_price_4d** - The price at which the security most recently traded | ||
| * **trade_volume** - The number of shares that that were traded on the last trade | ||
| * **trade_exchange** - The market center where the last trade occurred | ||
| * **trade_time** - The time at which the security last traded in milliseconds | ||
| * **up_down** - Tick indicator - up or down - indicating if the last trade was up or down from the previous trade | ||
| * **change_price_4d** - The difference between the closing price of a security on the current trading day and the previous day's closing price. | ||
| * **percent_change_4d** - The percentage at which the security is up or down since the previous day's trading | ||
| * **total_volume** - The accumulated total amount of shares traded | ||
| * **volume_plus** - NASDAQ volume plus the volumes from other market centers to more accurately match composite volume. Used for NASDAQ Basic | ||
| * **vwap_4d** - Volume weighted Average Price. VWAP is calculated by adding up the dollars traded for every transaction (price multiplied by number of shares traded) and then dividing by the total shares traded for the day. | ||
| * **day_high_4d** - A security's intra-day high trading price. | ||
| * **day_high_time** - Time that the security reached a new high | ||
| * **day_low_4d** - A security's intra-day low trading price. | ||
| * **day_low_time** - Time that the security reached a new low | ||
| * **ext_last_price_4d** - Extended hours last price (pre or post market) | ||
| * **ext_trade_volume** - The amount of shares traded for a single extended hours trade | ||
| * **ext_trade_exchange** - Extended hours exchange where last trade took place (Pre or post market) | ||
| * **ext_trade_time** - Time of the extended hours trade in milliseconds | ||
| * **ext_up_down** - Extended hours tick indicator - up or down | ||
| * **ext_change_price_4d** - Extended hours change price (pre or post market) | ||
| * **ext_percent_change_4d** - Extended hours percent change (pre or post market) | ||
| * **is_halted** - A flag indicating that the stock is halted and not currently trading | ||
| * **is_short_restricted** - A flag indicating the stock is current short sale restricted - meaning you can not short sale the stock when true | ||
| * **open_price_4d** - The price at which a security first trades upon the opening of an exchange on a given trading day | ||
| * **open_time** - The time at which the security opened in milliseconds | ||
| * **open_volume** - The number of shares that that were traded on the opening trade | ||
| * **prev_close_4d** - The security's closing price on the preceding day of trading | ||
| * **protocol_id** - Internal Quodd ID defining Source of Data | ||
| * **rtl** - Record Transaction Level - number of records published that day | ||
|
|
||
| #### Trade Message | ||
|
|
||
| ```javascript | ||
| { ticker: "AAPL.NB", | ||
| root_ticker: "AAPL", | ||
| bid_size: 500, | ||
| ask_size: 600, | ||
| bid_price_4d: 1594800, | ||
| ask_price_4d: 1594900, | ||
| ask_exchange: "t", | ||
| bid_exchange: "t", | ||
| quote_time: 1508165070850, | ||
| protocol_id: 302, | ||
| rtl: 129739 } | ||
| ``` | ||
|
|
||
| * **ticker** - Stock Symbol for the security | ||
| * **root_ticker** - Underlying symbol for a particular contract | ||
| * **ask_price_4d** - The price a seller is willing to accept for a security | ||
| * **ask_size** - The amount of a security that a market maker is offering to sell at the ask price | ||
| * **ask_exchange** - The market center from which the ask is being quoted | ||
| * **bid_price_4d** - A bid price is the price a buyer is willing to pay for a security. | ||
| * **bid_size** - The bid size number of shares being offered for purchase at a specified bid price | ||
| * **bid_exchange** - The market center from which the bid is being quoted | ||
| * **quote_time** - Time of the quote in milliseconds | ||
| * **rtl** - Record Transaction Level - number of records published that day | ||
| * **protocol_id** - Internal Quodd ID defining Source of Data | ||
|
|
||
| ### IEX | ||
|
|
||
| ```javascript | ||
| { type: 'ask', | ||
|
|
@@ -52,23 +161,30 @@ ir.join("AAPL", "MSFT", "GE") | |
| price: 28.97 } | ||
| ``` | ||
|
|
||
| * **type** - the quote type | ||
| * **`last`** - represents the last traded price | ||
| * **`bid`** - represents the top-of-book bid price | ||
| * **`ask`** - represents the top-of-book ask price | ||
| * **timestamp** - a Unix timestamp (with microsecond precision) | ||
| * **ticker** - the ticker of the security | ||
| * **size** - the size of the `last` trade, or total volume of orders at the top-of-book `bid` or `ask` price | ||
| * **price** - the price in USD | ||
| * **type** - the quote type | ||
| * **`last`** - represents the last traded price | ||
| * **`bid`** - represents the top-of-book bid price | ||
| * **`ask`** - represents the top-of-book ask price | ||
| * **timestamp** - a Unix timestamp (with microsecond precision) | ||
| * **ticker** - the ticker of the security | ||
| * **size** - the size of the `last` trade, or total volume of orders at the top-of-book `bid` or `ask` price | ||
| * **price** - the price in USD | ||
|
|
||
| ## Channels | ||
|
|
||
| ### QUODD | ||
|
|
||
| To receive price quotes from QUODD, you need to instruct the client to "join" a channel. A channel can be | ||
| * A security ticker with data feed designation (`AAPL.NB`, `MSFT.NB`, `GE.NB`, etc) | ||
|
|
||
| ### IEX | ||
|
|
||
| To receive price quotes from the Intrinio Real-Time API, you need to instruct the client to "join" a channel. A channel can be | ||
| * A security ticker (`AAPL`, `MSFT`, `GE`, etc) | ||
| * The security lobby (`$lobby`) where all price quotes for all securities are posted | ||
| * The security last price lobby (`$lobby_last_price`) where only last price quotes for all securities are posted | ||
|
|
||
| Special access is required for both lobby channeles. [Contact us](mailto:[email protected]) for more information. | ||
| Special access is required for both lobby channels. [Contact us](mailto:[email protected]) for more information. | ||
|
|
||
| ## API Keys | ||
| You will receive your Intrinio API Username and Password after [creating an account](https://intrinio.com/signup). You will need a subscription to the [IEX Real-Time Stock Prices](https://intrinio.com/data/realtime-stock-prices) data feed as well. | ||
|
|
@@ -78,11 +194,12 @@ You will receive your Intrinio API Username and Password after [creating an acco | |
| ### Methods | ||
|
|
||
| `constructor(options)` - Creates a new instance of the IntrinioRealtime client. | ||
| * **Parameter** `options`: An object with a `username` and `password` property corresponding to your Intrinio API Username and Password. | ||
| * **Parameter** `options`: An object with `username`, `password`, and `provider` properties corresponding to your Intrinio API Username and Password and either "iex" or "quodd" providers. | ||
| ```javascript | ||
| var ir = new IntrinioRealtime({ | ||
| username: "INTRINIO_API_USERNAME", | ||
| password: "INTRINIO_API_PASSWORD", | ||
| provider: "iex" | ||
| }) | ||
| ``` | ||
|
|
||
|
|
||
Oops, something went wrong.