Files
OpenBB/website/content/terminal/reference/stocks/disc/divcal.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

73 lines
7.0 KiB
Markdown
Vendored

---
title: divcal
description: Guide to use divcal for acquiring dividend calendar for a selected date
in the stock market. The parameters include date, sort, and reverse. The data includes
Name, Symbol, Ex-Dividend date, Payment date, Record date, Dividend, and Annual
Dividend.
keywords:
- divcal
- dividend calendar
- stock market
- ex-dividend date
- payment date
- record date
- annual dividend
- announcement date
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="stocks/disc/divcal - Reference | OpenBB Terminal Docs" />
Get dividend calendar for selected date
### Usage
```python
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
```python
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 │
└──────────────────────────────┴────────┴──────────────────┴──────────────┴─────────────┴──────────┴─────────────────┘
```
---