Skip to content

Commit 2931b2d

Browse files
Add dividend and split ids (#736)
* Add dividend and split ids * Added spec updates
1 parent 7fe4e37 commit 2931b2d

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

.polygon/rest.json

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24328,7 +24328,7 @@
2432824328
"operationId": "ListDividends",
2432924329
"parameters": [
2433024330
{
24331-
"description": "Return the dividends that contain this ticker.",
24331+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
2433224332
"in": "query",
2433324333
"name": "ticker",
2433424334
"schema": {
@@ -24708,6 +24708,7 @@
2470824708
"dividend_type": "CD",
2470924709
"ex_dividend_date": "2021-11-05",
2471024710
"frequency": 4,
24711+
"id": "E8e3c4f794613e9205e2f178a36c53fcc57cdabb55e1988c87b33f9e52e221444",
2471124712
"pay_date": "2021-11-11",
2471224713
"record_date": "2021-11-08",
2471324714
"ticker": "AAPL"
@@ -24718,6 +24719,7 @@
2471824719
"dividend_type": "CD",
2471924720
"ex_dividend_date": "2021-08-06",
2472024721
"frequency": 4,
24722+
"id": "E6436c5475706773f03490acf0b63fdb90b2c72bfeed329a6eb4afc080acd80ae",
2472124723
"pay_date": "2021-08-12",
2472224724
"record_date": "2021-08-09",
2472324725
"ticker": "AAPL"
@@ -24806,6 +24808,10 @@
2480624808
]
2480724809
}
2480824810
},
24811+
"id": {
24812+
"description": "The unique identifier of the dividend.",
24813+
"type": "string"
24814+
},
2480924815
"pay_date": {
2481024816
"description": "The date that the dividend is paid out.",
2481124817
"type": "string"
@@ -24832,7 +24838,8 @@
2483224838
"ex_dividend_date",
2483324839
"frequency",
2483424840
"cash_amount",
24835-
"dividend_type"
24841+
"dividend_type",
24842+
"id"
2483624843
],
2483724844
"type": "object",
2483824845
"x-polygon-go-struct-tags": {
@@ -25841,12 +25848,14 @@
2584125848
"results": [
2584225849
{
2584325850
"execution_date": "2020-08-31",
25851+
"id": "E36416cce743c3964c5da63e1ef1626c0aece30fb47302eea5a49c0055c04e8d0",
2584425852
"split_from": 1,
2584525853
"split_to": 4,
2584625854
"ticker": "AAPL"
2584725855
},
2584825856
{
2584925857
"execution_date": "2005-02-28",
25858+
"id": "E90a77bdf742661741ed7c8fc086415f0457c2816c45899d73aaa88bdc8ff6025",
2585025859
"split_from": 1,
2585125860
"split_to": 2,
2585225861
"ticker": "AAPL"
@@ -25870,6 +25879,10 @@
2587025879
"description": "The execution date of the stock split. On this date the stock split was applied.",
2587125880
"type": "string"
2587225881
},
25882+
"id": {
25883+
"description": "The unique identifier for this stock split.",
25884+
"type": "string"
25885+
},
2587325886
"split_from": {
2587425887
"description": "The second number in the split ratio.\n\nFor example: In a 2-for-1 split, split_from would be 1.",
2587525888
"format": "float",
@@ -25887,7 +25900,10 @@
2588725900
},
2588825901
"required": [
2588925902
"split_from",
25890-
"split_to"
25903+
"split_to",
25904+
"id",
25905+
"ticker",
25906+
"execution_date"
2589125907
],
2589225908
"type": "object"
2589325909
},

polygon/rest/models/dividends.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
@modelclass
66
class Dividend:
77
"Dividend contains data for a historical cash dividend, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount."
8+
id: Optional[int] = None
89
cash_amount: Optional[float] = None
910
currency: Optional[str] = None
1011
declaration_date: Optional[str] = None

polygon/rest/models/splits.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
@modelclass
66
class Split:
77
"Split contains data for a historical stock split, including the ticker symbol, the execution date, and the factors of the split ratio."
8+
id: Optional[int] = None
89
execution_date: Optional[str] = None
910
split_from: Optional[int] = None
1011
split_to: Optional[int] = None

0 commit comments

Comments
 (0)