Dividends

Get Dividends

Request

{{BASE}}/api/dividends

Request Headers

Header	Value
x-access-token	Bearer ...

Optional Query Params

Param	Type	Description
ticker	String	Filter by stock ticker
currency	String	Filter by currency
year	Int	Filter by year
paymentType	String	Filter by payment type. Accepts Utbytte and Tilbakebetaling
isTaxExempt	Boolean	Filter by tax exemption. Accepts true or false
limit	Int	Limit amount of response objects
orderBy	String	Order by property. See Dividend object for object properties.
order	String	Leave out for default (ascending) order. Enter keyword desc to override descending

Response

{
    "api": "Instream API v.1.0",
    "code": 200,
    "status": "Success",
    "filters": {
        "limit": 500,
        "skip": 0,
        "sort": "payment_date"
    },
    "documents": 2,
    "data": [
        {
            "_id": "62832f279a65b30f1febf821",
            "ticker": "RANA",
            "transacted_units": 150,
            "dividend_per_unit": 2.9,
            "exchange_rate": 1,
            "withholding_tax": 0,
            "currency": "NOK",
            "frequency": 4,
            "share_price": 69.36,
            "payment_date": "2021-05-26T00:00:00.000Z",
            "owner": "627d8868e30089ca8b8b24c1",
            "updatedAt": "2022-05-17T23:09:27.915Z",
            "createdAt": "2022-05-17T23:09:27.915Z",
            "__v": 0
        },
        {
            "_id": "6284306c9f65b30f1febf875",
            "ticker": "RANA",
            "transacted_units": 327,
            "dividend_per_unit": 3.86,
            "exchange_rate": 1,
            "withholding_tax": 0,
            "currency": "NOK",
            "frequency": 4,
            "share_price": 72.23,
            "payment_date": "2021-09-09T00:00:00.000Z",
            "owner": "627d8868e30089ca8b8b24c1",
            "updatedAt": "2022-05-17T23:31:56.504Z",
            "createdAt": "2022-05-17T23:31:56.504Z",
            "__v": 0
        }
 ]
}

Create Dividend

To be posted.

Update Dividend

To be posted.

Delete Dividend

To be posted.

---

Back to ToC