Skip to content

Commit cd1c2a3

Browse files
committed
updated pydoc
1 parent 6a28fd4 commit cd1c2a3

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

openfeed/openfeed_client.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,10 @@ def add_symbol_subscription(self, symbol: Union[str, list], callback, service="R
8484
Your callback function for Market Data messages
8585
subscription_type: list, optional
8686
Default is ['QUOTE']. Can contain any of: 'ALL', 'QUOTE', 'QUOTE_PARTICIPANT', 'DEPTH_PRICE', 'DEPTH_ORDER', 'TRADES', 'OHLC'
87-
instrument_type: list, optional
88-
Spreads and Options must be explicitly requested. Can contain any of: 'SPREAD', 'OPTION', 'FUTURE', 'FOREX', 'EQUITY', 'INDEX', 'MUTUAL_FUND', 'MONEY_MARKET', 'MONEY_MARKET_FUND'
8987
9088
[Market Data]: https://docs.barchart.com/openfeed/#/proto?id=marketupdate
9189
[SubscriptionTypes]: https://docs.barchart.com/openfeed/#/proto?id=subscriptiontype
9290
[Service]: https://docs.barchart.com/openfeed/#/proto?id=service
93-
[InstrumentTypes]: https://docs.barchart.com/openfeed/#/proto?id=instrumentdefinitioninstrumenttype
9491
"""
9592
symbols = []
9693

@@ -119,9 +116,23 @@ def add_exchange_subscription(self, exchange: Union[str, list], callback, servic
119116
120117
Note: your credentials must have the correct service level (FEED) for this operation.
121118
119+
Parameters
120+
----------
121+
exchange: str, list
122+
Barchart Exchange code(s)
123+
service: str, optional
124+
Default is `REAL_TIME` for delayed market data, set it to `DELAYED`, or for snapshots set it as one of `REAL_TIME_SNAPSHOT` or `DELAYED_SNAPSHOT'
125+
callback: Callable
126+
Your callback function for Market Data messages
127+
subscription_type: list, optional
128+
Default is ['QUOTE']. Can contain any of: 'ALL', 'QUOTE', 'QUOTE_PARTICIPANT', 'DEPTH_PRICE', 'DEPTH_ORDER', 'TRADES', 'OHLC'
129+
instrument_type: list, optional
130+
Spreads and Options must be explicitly requested. Can contain any of: 'SPREAD', 'OPTION', 'FUTURE', 'FOREX', 'EQUITY', 'INDEX', 'MUTUAL_FUND', 'MONEY_MARKET', 'MONEY_MARKET_FUND'
131+
122132
[Market Data]: https://docs.barchart.com/openfeed/#/proto?id=marketupdate
123133
[SubscriptionTypes]: https://docs.barchart.com/openfeed/#/proto?id=subscriptiontype
124134
[Service]: https://docs.barchart.com/openfeed/#/proto?id=service
135+
[InstrumentTypes]: https://docs.barchart.com/openfeed/#/proto?id=instrumentdefinitioninstrumenttype
125136
"""
126137
exchanges = []
127138

0 commit comments

Comments
 (0)