Skip to content

Update readme launchpad #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antdjohns merged 6 commits into from
Jan 19, 2023
Merged

Update readme launchpad #366

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6eeca2
options param added to get_summaries
antdjohns Jan 17, 2023
47413c1
deleted unused imports
antdjohns Jan 17, 2023
eb7ba0e
README update
antdjohns Jan 19, 2023
2f80db8
Merge branch 'master' into update-readme
antdjohns Jan 19, 2023
4024ee9
re-ordering readme sections
antdjohns Jan 19, 2023
bae24b0
Merge branch 'master' into update-readme-launchpad
antdjohns Jan 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,33 @@ for quote in quotes:
Note: For parameter argument examples check out our docs. All required arguments are annotated with red asterisks " * " and argument examples are set.
Check out an example for Aggregates(client.get_aggs) [here](https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to)

## WebSocket Client

Import classes
```python
from polygon import WebSocketClient
from polygon.websocket.models import WebSocketMessage
from typing import List
```
### Using the client
Create a new client with your [API key](https://polygon.io/dashboard/api-keys) and subscription options.
```python
# Note: Multiple subscriptions can be added to the array
# For example, if you want to subscribe to AAPL and META,
# you can do so by adding "T.META" to the subscriptions array. ["T.AAPL", "T.META"]
# If you want to subscribe to all tickers, place an asterisk in place of the symbol. ["T.*"]
ws = WebSocketClient(api_key=<API_KEY>, subscriptions=["T.AAPL"])
```
Create a handler function and run the WebSocket.
```python
def handle_msg(msg: List[WebSocketMessage]):
for m in msg:
print(m)

ws.run(handle_msg=handle_msg)
```
Check out more detailed examples [here](https://github.com/polygon-io/client-python/tree/master/examples/websocket).

## Launchpad
Users of the Launchpad product will need to pass in certain headers in order to make API requests using the RequestOptionBuilder.
Example can be found [here](./examples/launchpad).
Expand Down Expand Up @@ -85,32 +112,6 @@ res = c.get_aggs("AAPL", 1, "day", "2022-04-04", "2022-04-04", options=options)
```
Checkout Launchpad readme for more details on RequestOptionBuilder [here](./examples/launchpad)

## WebSocket Client

Import classes
```python
from polygon import WebSocketClient
from polygon.websocket.models import WebSocketMessage
from typing import List
```
### Using the client
Create a new client with your [API key](https://polygon.io/dashboard/api-keys) and subscription options.
```python
# Note: Multiple subscriptions can be added to the array
# For example, if you want to subscribe to AAPL and META,
# you can do so by adding "T.META" to the subscriptions array. ["T.AAPL", "T.META"]
# If you want to subscribe to all tickers, place an asterisk in place of the symbol. ["T.*"]
ws = WebSocketClient(api_key=<API_KEY>, subscriptions=["T.AAPL"])
```
Create a handler function and run the WebSocket.
```python
def handle_msg(msg: List[WebSocketMessage]):
for m in msg:
print(m)

ws.run(handle_msg=handle_msg)
```
Check out more detailed examples [here](https://github.com/polygon-io/client-python/tree/master/examples/websocket).

## Contributing

Expand Down