Warning

The YCharts API is available to our API customers for their internal use only. Any redistribution or commercial use of data from the API is strictly prohibited without prior written consent from YCharts. For more details on our API’s capabilities and pricing please contact sales@ycharts.com or call (866) 965-7552.

Mutual Fund Dividends

The Mutual Fund Dividends Endpoint is used to return a list of dividend objects that within the date range specified by the optional start and end date parameters.

Request Info

Request Method	GET
URL	https://api.ycharts.com/v3/mutual_funds/symbol[s]/dividends?start_date=start_date&end_date=end_date

Request Parameters

Parameter	Required	Description
symbol[s]	Y	The exchange symbol for a mutual fund, or a comma separated list of exchange symbols.
start_date	N	The first execution date of the desired date range.
end_date	N	The last execution date of the desired data range.

Note

• There is a maximum of 100 symbols per request.

Response Info

The response will contain one or more mutual fund objects. The key for each mutual fund object is the exchange symbol passed in the request.

Mutual Fund Object Fields

Field	Type	Description
meta	Meta	This object contains information about the query for the mutual fund object
results	Results	This object contains one or more dividend event objects.

Dividend Object Fields

Field	Type	Description
dividend_amount	decimal	Dividend Amount
adjusted_dividend_amount	decimal	Adjusted Dividend Amount
dividend_type	string	Dividend Type
currency_code	string	Currency Code
execution_date	date	Execution Date
declared_date	date	Declared Date
record_date	date	Record Date
pay_date	date	Pay Date

Examples

The following is an example successful request for 1 mutual fund.

Request URL

https://api.ycharts.com/v3/mutual_funds/M:VFIAX/dividends?start_date=2015-01-01&end_date=2015-06-01

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/mutual_funds/M:VFIAX/dividends?start_date=2015-01-01&end_date=2015-06-01"
    },
    "response": {
        "M:VFIAX": {
            "meta": {
                "status": "ok"
            },
            "results": [
                {
                    "adjusted_dividend_amount": 0.991,
                    "currency_code": null,
                    "declared_date": null,
                    "dividend_amount": 0.991,
                    "dividend_type": "non_qualified",
                    "execution_date": "2015-03-20",
                    "pay_date": null,
                    "record_date": null
                }
            ]
        }
    }
}

The following is an example successful request for multiple mutual funds.

Request URL

https://api.ycharts.com/v3/mutual_funds/M:VFIAX,M:VFINX/dividends?start_date=2015-01-01&end_date=2015-06-01

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/mutual_funds/M:VFIAX,M:VFINX/dividends?start_date=2015-01-01&end_date=2015-06-01"
    },
    "response": {
        "M:VFIAX": {
            "meta": {
                "status": "ok"
            },
            "results": [
                {
                    "adjusted_dividend_amount": 0.991,
                    "currency_code": null,
                    "declared_date": null,
                    "dividend_amount": 0.991,
                    "dividend_type": "non_qualified",
                    "execution_date": "2015-03-20",
                    "pay_date": null,
                    "record_date": null
                }
            ]
        },
      "M:VFINX": {
          "meta": {
              "status": "ok"
          },
          "results": [
              {
                  "adjusted_dividend_amount": 0.934,
                  "currency_code": null,
                  "declared_date": null,
                  "dividend_amount": 0.934,
                  "dividend_type": "non_qualified",
                  "execution_date": "2015-03-20",
                  "pay_date": null,
                  "record_date": null
              }
          ]
      }
    }
}

The following is an example incorrect request with an invalid date parameter.

Request URL

https://api.ycharts.com/v3/mutual_funds/M:VFIAX/dividends?start_date=2015-01-01&end_date=bad-date

Response

{
    "meta": {
        "error_code": 400,
        "error_message": "Invalid end_date format.",
        "status": "error",
        "url": "https://api.ycharts.com/v3/mutual_funds/M:VFIAX/dividends?start_date=2015-01-01&end_date=bad-date"
    },
    "response": {}
}