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.
Model Portfolio Info Fields¶
The Model Portfolio Info Field Endpoint is used to obtain information about one or more model portfolio.
Note
Full list of fields can be found in the Reference Guide
Request Info¶
Request Method |
GET |
URL |
/v3/model_portfolios/ |
Request Parameters¶
Parameter |
Required |
Description |
---|---|---|
symbol[s] |
Y |
The security id (e.g. ‘P:1234’) for a model portfolio, or a comma separated list of security ids |
field[s] |
Y |
One or more comma separated model portfolio fields. (See list below) |
Note
There is a maximum of 100 model portfolios per request. In addition, there is a maximum of 100 fields per request.
Examples¶
The following is an example successful response
Request URL
https://api.ycharts.com/v3/model_portfolios/P:1234/info/security_name,starting_level,rebalance_frequency
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/model_portfolios/P:1234/info/security_name,starting_level,rebalance_frequency"
},
"response": {
"P:1234": {
"meta": {
"status": "ok"
},
"results": {
"security_name": {
"data": "My Model Portfolio",
"meta": {
"status": "ok"
}
},
"starting_level": {
"data": 100000,
"meta": {
"status": "ok"
}
},
"rebalance_frequency": {
"data": "quarterly",
"meta": {
"status": "ok"
}
}
}
}
}
}
The following is an example successful multi model portfolio response
Request URL
https://api.ycharts.com/v3/model_portfolios/P:1234,P:5678/info/security_name,starting_level,rebalance_frequency
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/model_portfolios/P:1234,P:5678/info/security_name,starting_level,rebalance_frequency"
},
"response": {
"P:1234": {
"meta": {
"status": "ok"
},
"results": {
"security_name": {
"data": "My Model Portfolio",
"meta": {
"status": "ok"
}
},
"starting_level": {
"data": 100000,
"meta": {
"status": "ok"
}
},
"rebalance_frequency": {
"data": "quarterly",
"meta": {
"status": "ok"
}
}
}
},
"P:5678": {
"meta": {
"status": "ok"
},
"results": {
"security_name": {
"data": "My Other Model Portfolio",
"meta": {
"status": "ok"
}
},
"starting_level": {
"data": 200000,
"meta": {
"status": "ok"
}
},
"rebalance_frequency": {
"data": "monthly",
"meta": {
"status": "ok"
}
}
}
}
}
}
The following is an example incorrect request, which requests a model portfolio P:0000 that does not exist
Request URL
https://api.ycharts.com/v3/model_portfolios/P:0000/info/security_name,starting_level,rebalance_frequency
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/model_portfolios/P:0000/info/security_name,starting_level,rebalance_frequency"
},
"response": {
"P:0000": {
"meta": {
"error_code": 404,
"error_message": "Symbol Not Found.",
"status": "error"
}
}
}
}
The following is an example of an incorrect request that requests info fields that do not exist
Request URL
https://api.ycharts.com/v3/model_portfolios/P:1234/info/fake_field_one,fake_field_two
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/model_portfolios/P:1234/info/fake_field_one,fake_field_two"
},
"response": {
"P:1234": {
"meta": {
"status": "ok"
},
"results": {
"fake_field_one": {
"meta": {
"error_code": 404,
"error_message": "Info Field Not Found.",
"status": "error"
}
},
"fake_field_two": {
"meta": {
"error_code": 404,
"error_message": "Info Field Not Found.",
"status": "error"
}
}
}
}
}
}