mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
49 lines
1.1 KiB
Markdown
Vendored
49 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: tob
|
|
description: Get top of book bid and ask for any ticker on the CBOE exchange using
|
|
the OpenBB Terminal. Default exchange is BZX, but can be changed to EDGX, BYX, or
|
|
EDGA. Returns a Dataframe of Bids.
|
|
keywords:
|
|
- Top of Book bid
|
|
- Ask for ticker
|
|
- CBOE
|
|
- BZX
|
|
- EDGX
|
|
- BYX
|
|
- EDGA
|
|
- OpenBB Stocks
|
|
- Dataframe of Bids
|
|
- OpenBB finance
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.tob - Reference | OpenBB SDK Docs" />
|
|
|
|
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 |
|
|
---
|