GET api/bfg/v1/markets/dividends/upcoming
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SecurityCodes | Collection of string |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortBy | string |
None. |
|
| SortColumn | string |
None. |
|
| SortDirection | string |
None. |
|
| AfterId | integer |
None. |
|
| Search | string |
None. |
|
| SearchKeyword | string |
None. |
|
| FromDate | date |
None. |
|
| StartDate | date |
None. |
|
| ToDate | date |
None. |
|
| EndDate | date |
None. |
Body Parameters
None.
Response Information
Resource Description
GetUpcomingDividendsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | Collection of UpcomingDividendResponse |
None. |
|
| Pagination | HoldingPaginationInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"Items": [
{
"Id": 1,
"SecurityCode": "sample string 2",
"ShortName": "sample string 3",
"DividendType": "sample string 4",
"CurrentDividendAmount": 5.0,
"ExDate": "2026-11-17T11:17:47.8173824+11:00",
"PayableDate": "2026-11-17T11:17:47.8173824+11:00",
"FrankedPercent": 8.0,
"Comment": "sample string 9"
},
{
"Id": 1,
"SecurityCode": "sample string 2",
"ShortName": "sample string 3",
"DividendType": "sample string 4",
"CurrentDividendAmount": 5.0,
"ExDate": "2026-11-17T11:17:47.8173824+11:00",
"PayableDate": "2026-11-17T11:17:47.8173824+11:00",
"FrankedPercent": 8.0,
"Comment": "sample string 9"
}
],
"Pagination": {
"PageNumber": 1,
"PageSize": 2,
"TotalCount": 3,
"TotalPages": 4,
"HasNext": true
}
}
application/xml, text/xml
Sample:
<GetUpcomingDividendsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Market">
<Items>
<UpcomingDividendResponse>
<Comment>sample string 9</Comment>
<CurrentDividendAmount>5</CurrentDividendAmount>
<DividendType>sample string 4</DividendType>
<ExDate>2026-11-17T11:17:47.8173824+11:00</ExDate>
<FrankedPercent>8</FrankedPercent>
<Id>1</Id>
<PayableDate>2026-11-17T11:17:47.8173824+11:00</PayableDate>
<SecurityCode>sample string 2</SecurityCode>
<ShortName>sample string 3</ShortName>
</UpcomingDividendResponse>
<UpcomingDividendResponse>
<Comment>sample string 9</Comment>
<CurrentDividendAmount>5</CurrentDividendAmount>
<DividendType>sample string 4</DividendType>
<ExDate>2026-11-17T11:17:47.8173824+11:00</ExDate>
<FrankedPercent>8</FrankedPercent>
<Id>1</Id>
<PayableDate>2026-11-17T11:17:47.8173824+11:00</PayableDate>
<SecurityCode>sample string 2</SecurityCode>
<ShortName>sample string 3</ShortName>
</UpcomingDividendResponse>
</Items>
<Pagination xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
<d2p1:HasNext>true</d2p1:HasNext>
<d2p1:PageNumber>1</d2p1:PageNumber>
<d2p1:PageSize>2</d2p1:PageSize>
<d2p1:TotalCount>3</d2p1:TotalCount>
<d2p1:TotalPages>4</d2p1:TotalPages>
</Pagination>
</GetUpcomingDividendsResponse>