POST api/DividendPayers

get dividend history by key (stock symbol)

Request Information
URI Parameters

None.

Body Parameters

StockDividendFilter
NameDescriptionTypeAdditional information
key

string

None.

Request Formats
application/json, text/json
Sample:
{
  "key": "sample string 1"
}
text/html
Sample:
{"key":"sample string 1"}
application/xml, text/xml
Sample:
<StockDividendFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicApi.Model">
  <Symbol>sample string 1</Symbol>
</StockDividendFilter>
application/x-www-form-urlencoded
Sample:

Sample not available.

Response Information

Resource Description

StockDividendsApiResponse
NameDescriptionTypeAdditional information
Body

Collection of StockDividendItem

None.

RequestId

string

None.

ResponseId

string

None.

RequestDate

date

None.

ResponseDate

date

None.

ResponseDateEst

date

None.

Warnings

Collection of Warning

None.

Errors

Collection of Warning

None.

ResponseCode

string

None.

RecordsRemaining

integer

None.

CompleteProgress

decimal number

None.

Category

string

None.

Response Formats

application/json, text/json
Sample:
{
  "Body": [
    {
      "Symbol": "sample string 1",
      "CompanyName": "sample string 2",
      "Amount": 1.0,
      "AnnualYield": 1.0,
      "ExDate": "2024-10-08T22:09:56.4490771+00:00",
      "PaymentDate": "2024-10-08T22:09:56.4490771+00:00",
      "Frequency": "sample string 3"
    },
    {
      "Symbol": "sample string 1",
      "CompanyName": "sample string 2",
      "Amount": 1.0,
      "AnnualYield": 1.0,
      "ExDate": "2024-10-08T22:09:56.4490771+00:00",
      "PaymentDate": "2024-10-08T22:09:56.4490771+00:00",
      "Frequency": "sample string 3"
    }
  ],
  "RequestId": "sample string 1",
  "ResponseId": "sample string 2",
  "RequestDate": "2024-10-08T22:09:56.4490771+00:00",
  "ResponseDate": "2024-10-08T22:09:56.4490771+00:00",
  "ResponseDateEst": "2024-10-08T22:09:56.4490771+00:00",
  "Warnings": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "Errors": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "ResponseCode": "sample string 6",
  "RecordsRemaining": 1,
  "CompleteProgress": 1.0,
  "Category": "sample string 7"
}
text/html
Sample:
{"Body":[{"Symbol":"sample string 1","CompanyName":"sample string 2","Amount":1.0,"AnnualYield":1.0,"ExDate":"2024-10-08T22:09:56.4490771+00:00","PaymentDate":"2024-10-08T22:09:56.4490771+00:00","Frequency":"sample string 3"},{"Symbol":"sample string 1","CompanyName":"sample string 2","Amount":1.0,"AnnualYield":1.0,"ExDate":"2024-10-08T22:09:56.4490771+00:00","PaymentDate":"2024-10-08T22:09:56.4490771+00:00","Frequency":"sample string 3"}],"RequestId":"sample string 1","ResponseId":"sample string 2","RequestDate":"2024-10-08T22:09:56.4490771+00:00","ResponseDate":"2024-10-08T22:09:56.4490771+00:00","ResponseDateEst":"2024-10-08T22:09:56.4490771+00:00","Warnings":[{"Code":"sample string 1","Message":"sample string 2"},{"Code":"sample string 1","Message":"sample string 2"}],"Errors":[{"Code":"sample string 1","Message":"sample string 2"},{"Code":"sample string 1","Message":"sample string 2"}],"ResponseCode":"sample string 6","RecordsRemaining":1,"CompleteProgress":1.0,"Category":"sample string 7"}
application/xml, text/xml
Sample:
<StockDividendsApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicApi.Model">
  <Category>sample string 7</Category>
  <CompleteProgress>1</CompleteProgress>
  <Errors>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
  </Errors>
  <RecordsRemaining>1</RecordsRemaining>
  <RequestDate>2024-10-08T22:09:56.4490771+00:00</RequestDate>
  <RequestId>sample string 1</RequestId>
  <ResponseCode>sample string 6</ResponseCode>
  <ResponseDate>2024-10-08T22:09:56.4490771+00:00</ResponseDate>
  <ResponseDateEst>2024-10-08T22:09:56.4490771+00:00</ResponseDateEst>
  <ResponseId>sample string 2</ResponseId>
  <Warnings>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
    <Warning>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Warning>
  </Warnings>
  <Body>
    <StockDividendItem>
      <Amount>1</Amount>
      <AnnualYield>1</AnnualYield>
      <CompanyName>sample string 2</CompanyName>
      <ExDate>2024-10-08T22:09:56.4490771+00:00</ExDate>
      <Frequency>sample string 3</Frequency>
      <PaymentDate>2024-10-08T22:09:56.4490771+00:00</PaymentDate>
      <Symbol>sample string 1</Symbol>
    </StockDividendItem>
    <StockDividendItem>
      <Amount>1</Amount>
      <AnnualYield>1</AnnualYield>
      <CompanyName>sample string 2</CompanyName>
      <ExDate>2024-10-08T22:09:56.4490771+00:00</ExDate>
      <Frequency>sample string 3</Frequency>
      <PaymentDate>2024-10-08T22:09:56.4490771+00:00</PaymentDate>
      <Symbol>sample string 1</Symbol>
    </StockDividendItem>
  </Body>
</StockDividendsApiResponse>