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 Data Point¶
The Mutual Fund Data Point Endpoint is used to obtain a single date-value pair of data from one or more companies for one or more calculations. It takes an option date parameter and will return the latest value before the requested date.
Note
Full list of calcs can be found in the API Reference Guide
Request Info¶
Request Method |
GET |
URL |
https://api.ycharts.com/v3/mutual_funds/ |
Request Parameters¶
Parameter |
Required |
Description |
---|---|---|
symbol[s] |
Y |
The exchange symbol for a mutual fund, or a comma separated list of exchange symbols |
calc[s] |
Y |
The code for a calculation, or a comma separated list of calculations |
date |
N |
Date of the desired data point, defaults to the latest data point |
Note
There is a maximum of 100 companies per request.
There is a maximum of 100 calculations per request.
Tip
The code for a calculation can be found in the url of the mutual fund’s historical data page. For example, the price of M:FCNTX is found at https://ycharts.com/mutual_funds/M:FCNTX/price.
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.
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 calculation data objects. The key for each object is the code for the calculation. |
Field |
Type |
Description |
---|---|---|
data |
Array |
An array containing a date-value pair |
meta |
Meta |
This object contains information about the query for the data |
Examples¶
The following is an example successful request
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"price": {
"data": [
"2014-09-11",
102.48
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example successful request with a relative date
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price?date=-44
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price?date=-44"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"price": {
"data": [
"2014-08-04",
98.74
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example successful request with multiple calculations
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price,assets_under_management
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/price,assets_under_management"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"assets_under_management": {
"data": [
"2014-08-29",
77365946228.0
],
"meta": {
"status": "ok"
}
},
"price": {
"data": [
"2014-09-11",
102.48
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example successful request with mutliple mutual funds
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:VFIAX/points/price
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:VFIAX/points/price"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"price": {
"data": [
"2014-09-11",
102.48
],
"meta": {
"status": "ok"
}
}
}
},
"M:VFIAX": {
"meta": {
"status": "ok"
},
"results": {
"price": {
"data": [
"2014-09-11",
185.07
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example successful request with multiple calculations, multiple mutual funds, and an absolute date
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:VFIAX/points/price,dividend_yield?date=2014-08-02
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:VFIAX/points/price,dividend_yield?date=2014-08-02"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"dividend_yield": {
"data": [
"2014-08-01",
0.078643
],
"meta": {
"status": "ok"
}
},
"price": {
"data": [
"2014-08-01",
97.72
],
"meta": {
"status": "ok"
}
}
}
},
"M:VFIAX": {
"meta": {
"status": "ok"
},
"results": {
"dividend_yield": {
"data": [
"2014-08-01",
0.018631
],
"meta": {
"status": "ok"
}
},
"price": {
"data": [
"2014-08-01",
177.82
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example of an incorrect request, which contains an error in the calculation
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/bad_calc
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX/points/bad_calc"
},
"response": {
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"bad_calc": {
"meta": {
"error_code": 404,
"error_message": "Calc Not Found.",
"status": "error"
}
}
}
},
"meta": {
"status": "ok"
}
}
}
The following is an example of an incorrect request, which contains an error in one of the mutual funds
Request URL
https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:BADID/points/price
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/mutual_funds/M:FCNTX,M:BADID/points/price"
},
"response": {
"M:BADID": {
"meta": {
"error_code": 404,
"error_message": "Symbol Not Found.",
"status": "error"
}
},
"M:FCNTX": {
"meta": {
"status": "ok"
},
"results": {
"price": {
"data": [
"2014-09-11",
102.48
],
"meta": {
"status": "ok"
}
}
}
},
"meta": {
"status": "ok"
}
}
}