Skip to content
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.

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

improve docs structure for V4 #5586

Merged
merged 128 commits into from
Nov 6, 2023
Merged
Changes from 1 commit
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
4a1dbb5
improve docs structure for V4
Oct 20, 2023
1ce74c2
moving over changes
andrewkenreich Oct 20, 2023
33993c2
Add Docs to the navbar
Oct 21, 2023
86849d3
add some, re-order sidebar
deeleeramone Oct 21, 2023
1d78b1b
fix sentence
deeleeramone Oct 21, 2023
c452c9e
add docs install to source instructions
deeleeramone Oct 21, 2023
6a99493
insert a couple of links, fix a typo
deeleeramone Oct 23, 2023
6b354db
big terminal docs usage revamps
Oct 25, 2023
cb72276
improve toggle component for tutorials
Oct 26, 2023
ed40219
get rid of TOCs for all terminal docs for consistency and simplicity
Oct 26, 2023
8667a5b
improve platform docs
Oct 26, 2023
1717e62
improve bot docs content structure
Oct 26, 2023
52c9d6e
remove index from bot docs
Oct 26, 2023
2a244a0
improve ON THIS PAGE to only display TOC if at least 1 element
Oct 26, 2023
79bae79
make edit this page text and icon on same line
Oct 26, 2023
6edec26
add author and date to docs
Oct 26, 2023
1c26463
add basic syntax page to usage
deeleeramone Oct 26, 2023
48044c3
sidebar order for usage section
deeleeramone Oct 26, 2023
7d80a4d
move api start command to the top with the import python import
deeleeramone Oct 26, 2023
d95e4a0
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
hjoaquim Oct 27, 2023
7648083
some install page additions
deeleeramone Oct 27, 2023
0c56f80
small improvement
Oct 28, 2023
c7e0cee
refactor routines section
Oct 28, 2023
93d221b
Update introduction-to-routines.md
Oct 28, 2023
f32151a
Update pipeline-of-commands.md
Oct 28, 2023
da2a737
Update introduction-to-routines.md
Oct 28, 2023
ca0fc5a
Update routines-for-power-users.md
Oct 28, 2023
d3f91dd
Update community-routines.md
Oct 28, 2023
c98dca2
update keyboard hotkey macros
Oct 28, 2023
e141624
askobb page
Oct 28, 2023
7b782fd
Update askobb-feature.md
Oct 28, 2023
69e5cb8
Update index.md
Oct 28, 2023
e97619a
Update index.md
Oct 28, 2023
3f4ea79
Update index.md
Oct 28, 2023
989f690
Update index.md
Oct 28, 2023
5806855
fix images
Oct 28, 2023
3854328
remove HeadTitle from all files where it exist
Oct 28, 2023
63df4e3
get rid of extra spacing in markdown
Oct 28, 2023
7cc8c77
small update
Oct 28, 2023
620f6ed
small edit
Oct 28, 2023
8b15d7b
need index at the start because of main path when homepage of docs
Oct 28, 2023
2498497
use openAI to create SEO for front matter on my behalf
Oct 28, 2023
f88afa4
remove table of content from sdk page
Oct 28, 2023
dcbffac
finish improving metadata SEO for SDK docs
Oct 28, 2023
4f1a26f
update duplicate header
Oct 28, 2023
bf87df3
update HeadTitle to be more specific on product
Oct 28, 2023
8938de8
remove index from bot telegram reference
Oct 28, 2023
72e7ead
delete duplicated title for platform reference
Oct 28, 2023
788a090
another update
Oct 29, 2023
195bc05
Hotfix/econometrics export filename fix (#5508)
ssahaxd Oct 30, 2023
d4b7d6e
FIX #5600 Updated the Twitter logo to X logo (#5601)
professssor Oct 30, 2023
31f0ed4
Change Ultima paragraph (#5624)
hjoaquim Oct 30, 2023
d7d8eaf
Update CONTRIBUTING.md (#5623)
FarukhS52 Oct 30, 2023
23ae1ea
mobile line-brake fixed (#5604)
maxxsh Oct 30, 2023
e380382
start PR so screenshots can get attached via GitHub website
deeleeramone Oct 30, 2023
dde1dd9
Update qa.md
deeleeramone Oct 30, 2023
4ad995f
Docs/terminalpro and improvement (#5622)
Oct 30, 2023
b9c70ec
Add light blue banner, blue when clicking sidebar + fix link in docus…
Oct 30, 2023
43fbc80
Update crypto introduction.md
deeleeramone Oct 30, 2023
e8e7828
titles
deeleeramone Oct 30, 2023
a2403ec
another title
deeleeramone Oct 30, 2023
bceed7d
Update crypto dd.md
deeleeramone Oct 31, 2023
8ac07a3
Update defi.md
deeleeramone Oct 31, 2023
46d943f
Update disc.md
deeleeramone Oct 31, 2023
b2c5ea0
Update nft.md
deeleeramone Oct 31, 2023
3028c38
Update onchain.md
deeleeramone Oct 31, 2023
c9be363
Update ov.md
deeleeramone Oct 31, 2023
99ca283
Update introduction.md
deeleeramone Oct 31, 2023
ef517f2
Update introduction.md
deeleeramone Oct 31, 2023
7ecde8e
Update ba.md
deeleeramone Oct 31, 2023
f298b91
Update comparison.md
deeleeramone Nov 1, 2023
7662548
Update dark-pool-shorts.md
deeleeramone Nov 1, 2023
485f677
Update disc.md
deeleeramone Nov 1, 2023
478fd5e
fix docs (#5646)
andrewkenreich Nov 1, 2023
31bdf13
Update fa.md
deeleeramone Nov 1, 2023
51f7a01
Update gov.md
deeleeramone Nov 1, 2023
3186202
Update ins.md
deeleeramone Nov 1, 2023
1514be0
Update tradinghours.md
deeleeramone Nov 1, 2023
9840902
Delete website/content/terminal/menus/stocks/options/screener.md
deeleeramone Nov 2, 2023
22b0083
Update Options introduction.md
deeleeramone Nov 2, 2023
99ac3dd
Update screener head title
deeleeramone Nov 2, 2023
91b16cc
Update screener TOC
deeleeramone Nov 2, 2023
654e19a
Update econometrics.md
deeleeramone Nov 2, 2023
1b468db
Update economy head title
deeleeramone Nov 2, 2023
5c47f66
Update etf.md
deeleeramone Nov 3, 2023
e305f71
codespell
deeleeramone Nov 3, 2023
1386cbb
Fix the redirect for intro to the correct url for docs (#5658)
fadilparves Nov 3, 2023
9f3fcd3
Contributing guidelines (#5615)
hjoaquim Nov 3, 2023
51b4400
Merge branch 'feature/improve-sdk-v4-docs-struct' of https://github.c…
deeleeramone Nov 3, 2023
bad7d95
collapse options subfolder
deeleeramone Nov 3, 2023
cdc416e
codespell
deeleeramone Nov 3, 2023
504a4f4
Improve Pro documentation further (#5641)
Nov 3, 2023
80efde4
Update folders.md
Nov 3, 2023
90eb092
Update integrate-your-own-backend.md
Nov 3, 2023
454bd10
Update index.md
Nov 3, 2023
e5aad53
Update fixedincome.md
deeleeramone Nov 3, 2023
8470064
url
deeleeramone Nov 3, 2023
7138cc5
Update forecast.md
deeleeramone Nov 3, 2023
c10301f
Update settings.md (#5665)
Nov 3, 2023
b825697
Update forex.md
deeleeramone Nov 3, 2023
04f0a63
fix front matter (#5667)
Nov 3, 2023
dad6ffc
Merge branch 'develop' into temp/docs
piiq Nov 5, 2023
b68cf23
Sync new doc branches with develop
piiq Nov 5, 2023
5d1f0df
Fix conflict markers that got into markdown during previous merges
piiq Nov 5, 2023
d200d9b
Fix front matter list formatting
piiq Nov 5, 2023
bd40ad9
Fix typo
piiq Nov 5, 2023
cf41ce7
small typos
Nov 5, 2023
43285b8
small thing
Nov 5, 2023
099dd53
merge with openbb-sdk-v4
Nov 5, 2023
cf37f2c
fix hyperlinks
Nov 5, 2023
4204df1
Update .codespell.ignore
Nov 5, 2023
0b83600
output_type options
hjoaquim Nov 6, 2023
8d9edb7
Architectural considerations
hjoaquim Nov 6, 2023
8dd8c37
Update sidebar to hide pro section by default
piiq Nov 6, 2023
3c5e412
Minor copy changes
piiq Nov 6, 2023
a50c440
TET pattern
hjoaquim Nov 6, 2023
cc1b5a9
import statements
hjoaquim Nov 6, 2023
732e3f5
clarification on preferences
hjoaquim Nov 6, 2023
4d26102
Merge branch 'feature/improve-sdk-v4-docs-struct' of github.com:OpenB…
hjoaquim Nov 6, 2023
34098e7
Minor copy changes
piiq Nov 6, 2023
c485396
Lint markdown and python
piiq Nov 6, 2023
8658209
fix: open index on collapsible root elements
jose-donato Nov 6, 2023
2ebcd2a
remove old content
deeleeramone Nov 6, 2023
ba0cb03
options title
deeleeramone Nov 6, 2023
9d93e0a
Fix linting errors
piiq Nov 6, 2023
528b1ec
Merge remote-tracking branch 'upstream/feature/improve-sdk-v4-docs-st…
piiq Nov 6, 2023
81a8a78
Refactor sidebar label to url mapping condition
piiq Nov 6, 2023
672a4a7
Merge branch 'feature/openbb-sdk-v4' into feature/improve-sdk-v4-docs…
piiq Nov 6, 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
Prev Previous commit
Next Next commit
Update tradinghours.md
deeleeramone authored Nov 1, 2023
commit 1514be06b3e6c4eb0de720c3942bb2a509f0acb8
202 changes: 33 additions & 169 deletions website/content/terminal/menus/stocks/tradinghours.md
Original file line number Diff line number Diff line change
@@ -1,191 +1,55 @@
---
title: Trading Hours
description: This documentation pages describes what you can do in the trading hours menu, which includes checking the operating status of markets globally.
description: This introduces the Trading Hours sub-menu, within the Stocks menu of the OpenBB Terminal. Use these commands to check the operating status of markets globally.
keywords:
- trading hours
- trading
- market hours
- open
- close
- bursa
- pandasmarketcalendars
- status
- holidays
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Trading Hours - Stocks - Data Available | OpenBB Terminal Docs" />
This set of features is for checking the operating status of markets globally. To access the Trading Hours features, enter `th` from the <a href="/terminal/usage/intros/stocks/" target="_blank" rel="noreferrer noopener">Stocks menu</a>. Alternatively, a user can access the submenu with absolute path navigation from anywhere in the Terminal: `/stocks/th`
<HeadTitle title="Trading Hours - Stocks - Menus | OpenBB Terminal Docs" />

<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/218986176-7e995a97-8689-4440-beb8-43bde85f1a92.png"></img>
This set of features is for checking the operating status of markets globally.

## How to use
## Usage

A symbol is not required to be loaded. Once in the Trading Hours menu, the operation is simple. Choose from: <a href="/terminal/reference/stocks/th/open" target="_blank" rel="noreferrer noopener">open</a>, <a href="/terminal/reference/stocks/th/closed" target="_blank" rel="noreferrer noopener">closed</a>, <a href="/terminal/reference/stocks/th/all" target="_blank" rel="noreferrer noopener">all</a> or <a href="/terminal/reference/stocks/th/exchange" target="_blank" rel="noreferrer noopener">exchange</a>.

Below, examples are given what these commands display, note that the tables are purposely cut off to keep the introduction compact.

````
(🦋) /stocks/th/ $ open
Open markets
┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ ┃ name ┃ short_name ┃
┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ FRA │ Frankfurt Stock Exchange │ F │
├─────┼───────────────────────────────────┼────────────┤
│ STU │ Börse Stuttgart │ SG │
├─────┼───────────────────────────────────┼────────────┤
│ MUN │ Börse München │ MU │
├─────┼───────────────────────────────────┼────────────┤
│ DUS │ Börse Düsseldorf │ DU │
├─────┼───────────────────────────────────┼────────────┤
│ MEX │ Bolsa Mexicana de Valores │ MX │
├─────┼───────────────────────────────────┼────────────┤
│ FKA │ Frankfurt Stock Exchange │ F │
├─────┼───────────────────────────────────┼────────────┤
│ NYQ │ New York Stock Exchange │ NYSE │
├─────┼───────────────────────────────────┼────────────┤
│ VAN │ TSX Venture Exchange │ V │
├─────┼───────────────────────────────────┼────────────┤
<continues>
(🦋) /stocks/th/ $ closed
Closed markets
┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ ┃ name ┃ short_name ┃
┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ SHZ │ Shenzen Stock Exchange │ SHZE │
├─────┼──────────────────────────────────┼────────────┤
│ KSC │ Korea Exchange │ KRX │
├─────┼──────────────────────────────────┼────────────┤
│ KOE │ Korea Exchange │ KRX │
├─────┼──────────────────────────────────┼────────────┤
│ HKG │ Hong Kong Stock Exchange │ HKEX │
├─────┼──────────────────────────────────┼────────────┤
│ KLS │ Bursa Malaysia │ KLSE │
├─────┼──────────────────────────────────┼────────────┤
│ ENX │ Euronext │ NX │
├─────┼──────────────────────────────────┼────────────┤
│ TWO │ Taipei Exchange │ TWO │
├─────┼──────────────────────────────────┼────────────┤
│ HAM │ Hamburger Börse │ HM │
├─────┼──────────────────────────────────┼────────────┤
│ TW │ Taiwan Stock Exchange │ TWSE │
├─────┼──────────────────────────────────┼────────────┤
<continues>
(🦋) /stocks/th/ $ all
World markets
┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━┓
┃ ┃ name ┃ short_name ┃ open ┃
┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━┩
│ SHZ │ Shenzen Stock Exchange │ SHZE │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ KSC │ Korea Exchange │ KRX │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ KOE │ Korea Exchange │ KRX │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ HKG │ Hong Kong Stock Exchange │ HKEX │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ KLS │ Bursa Malaysia │ KLSE │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ FRA │ Frankfurt Stock Exchange │ F │ True │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ STU │ Börse Stuttgart │ SG │ True │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ ENX │ Euronext │ NX │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ TWO │ Taipei Exchange │ TWO │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
│ HAM │ Hamburger Börse │ HM │ False │
├─────┼───────────────────────────────────┼────────────┼───────┤
<continues>
````
Lastly, <a href="/terminal/reference/stocks/th/exchange" target="_blank" rel="noreferrer noopener">exchange</a> shows the status of a single venue.
Enter, `th`, from the [`/stocks/`](/website/content/terminal/menus/stocks/introduction.md) menu. Or, with the absolute path:

```console
/stocks/th
```
(🦋) /stocks/th/ $ exchange --name ARCA

PCX NYSE Arca
Name: name, dtype: object
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ┃ PCX ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ name │ NYSE Arca │
├───────────────────────┼──────────────────────────────────────────────┤
│ short_name │ ARCA │
├───────────────────────┼──────────────────────────────────────────────┤
│ website │ https://www.nyse.com/markets/hours-calendars │
├───────────────────────┼──────────────────────────────────────────────┤
│ market_open │ 09:30:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ market_close │ 16:00:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ lunchbreak_start │ None │
├───────────────────────┼──────────────────────────────────────────────┤
│ lunchbreak_end │ None │
├───────────────────────┼──────────────────────────────────────────────┤
│ opening_auction_start │ 04:00:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ opening_auction_end │ 09:30:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ closing_auction_start │ 16:00:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ closing_auction_end │ 20:00:00 │
├───────────────────────┼──────────────────────────────────────────────┤
│ timezone │ US/Eastern │
├───────────────────────┼──────────────────────────────────────────────┤
│ flag │ 🇺🇸 │
├───────────────────────┼──────────────────────────────────────────────┤
│ open │ False │
└───────────────────────┴──────────────────────────────────────────────┘
```

## Examples
![Screenshot 2023-11-01 at 2 21 56 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/66fe02c2-22d1-4ce3-a410-7df6f7f4defa)

Below an example is given for a symbol and whether that market is open. By calling <a href="/terminal/reference/stocks/th/exchange" target="_blank" rel="noreferrer noopener">exchange</a> you can obtain more information about the exchange (e.g. enter `BO`)
````
(🦋) /stocks/th/ $ symbol RY.TO
### Exchange

Selected symbol
Symbol: RY.TO
Name: ROYAL BANK OF CANADA
Market open: False
Get the regular market hours and status of a particular exchange.

(🦋) /stocks/th/ $ symbol FB2.L
Selected symbol
Symbol: FB2.L
Name: LEVERAGE SHARES PUBLIC LIMITED
Market open: False
```console
/stocks/th/exchange -n ASX
```

(🦋) /stocks/th/ $ exchange BO
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ┃ BSE ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ name │ BSE │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ short_name │ BO │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ website │ https://www.bseindia.com/static/markets/equity/EQReports/tra_trading.aspx │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ market_open │ 09:15:00 │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ market_close │ 15:30:00 │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ lunchbreak_start │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ lunchbreak_end │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ opening_auction_start │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ opening_auction_end │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ closing_auction_start │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ closing_auction_end │ None │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ timezone │ Asia/Kolkata │
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ flag │ 🇮🇳
├───────────────────────┼───────────────────────────────────────────────────────────────────────────┤
│ open │ False │
└───────────────────────┴───────────────────────────────────────────────────────────────────────────┘
````
| | ASX |
|:----------------------|:--------------------------------------------------------------------------------------------------|
| name | Australian Securities Exchange |
| short_name | AX |
| website | https://www2.asx.com.au/markets/market-resources/trading-hours-calendar/cash-market-trading-hours |
| market_open | 10:00:00 |
| market_close | 16:00:00 |
| lunchbreak_start | |
| lunchbreak_end | |
| opening_auction_start | 07:00:00 |
| opening_auction_end | 10:00:00 |
| closing_auction_start | 16:10:00 |
| closing_auction_end | 16:12:00 |
| timezone | Australia/Sydney |
| flag | 🇦🇺 |
| open | False |