mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 08:22:26 +00:00
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
6.5 KiB
Vendored
6.5 KiB
Vendored
title, description
| title | description |
|---|---|
| divcal | OpenBB Terminal Function |
divcal
Get dividend calendar for selected date
Usage
divcal [-d DATE] [-s {name,symbol,ex-dividend_date,payment_date,record_date,dividend,annual_dividend,announcement_date}] [-r]
Parameters
| Name | Description | Default | Optional | Choices |
|---|---|---|---|---|
| date | Date to get format for | datetime.now() | True | None |
| sort | Column to sort by | dividend | True | name, symbol, ex-dividend_date, payment_date, record_date, dividend, annual_dividend, announcement_date |
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
Examples
2022 Feb 16, 03:53 (🦋) /stocks/disc/ $ divcal
Dividend Calendar for 2022-02-16
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Symbol ┃ Ex-Dividend Date ┃ Payment Date ┃ Record Date ┃ Dividend ┃ Annual Dividend ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
│ Danaos Corporation │ DAC │ 02/16/2022 │ 02/28/2022 │ 02/17/2022 │ 0.75 │ 3.00 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Microsoft Corporation │ MSFT │ 02/16/2022 │ 03/10/2022 │ 02/17/2022 │ 0.62 │ 2.48 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Discover Financial Services │ DFS │ 02/16/2022 │ 03/03/2022 │ 02/17/2022 │ 0.50 │ 2.00 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Apartment Income REIT Corp. │ AIRC │ 02/16/2022 │ 02/25/2022 │ 02/17/2022 │ 0.45 │ 1.80 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Zions Bancorporation N.A. │ ZION │ 02/16/2022 │ 02/24/2022 │ 02/17/2022 │ 0.38 │ 1.52 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Southside Bancshares, Inc. │ SBSI │ 02/16/2022 │ 03/03/2022 │ 02/17/2022 │ 0.34 │ 1.36 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Fidelity D & D Bancorp, Inc. │ FDBC │ 02/16/2022 │ 03/10/2022 │ 02/17/2022 │ 0.33 │ 1.32 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ Xylem Inc. │ XYL │ 02/16/2022 │ 03/17/2022 │ 02/17/2022 │ 0.30 │ 1.20 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ D.R. Horton, Inc. │ DHI │ 02/16/2022 │ 02/25/2022 │ 02/17/2022 │ 0.23 │ 0.90 │
├──────────────────────────────┼────────┼──────────────────┼──────────────┼─────────────┼──────────┼─────────────────┤
│ CenterPoint Energy, Inc. │ CNP │ 02/16/2022 │ 03/10/2022 │ 02/17/2022 │ 0.17 │ 0.68 │
└──────────────────────────────┴────────┴──────────────────┴──────────────┴─────────────┴──────────┴─────────────────┘