Files
OpenBB/website/content/sdk/reference/stocks/tob.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

35 lines
685 B
Markdown
Vendored

---
title: tob
description: OpenBB SDK Function
---
# tob
Get top of book bid and ask for ticker on exchange [CBOE.com]
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/cboe_model.py#L12)]
```python
openbb.stocks.tob(symbol: str, exchange: str = "BZX")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| symbol | str | Ticker to get | None | False |
| exchange | str | Exchange to look at. Can be `BZX`,`EDGX`, `BYX`, `EDGA` | BZX | True |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DatatFrame | Dataframe of Bids |
---