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 Search¶
The Model Portfolio Search Endpoint is used to return lists of model portfolios for use in other endpoints. The endpoint optionally supports a variety of search parameters to focus the returned model portfolio list.
Request Info¶
Request Method |
GET |
URL |
/v3/model_portfolios |
Request Parameters¶
Parameter |
Description |
---|---|
page |
The current page of results to view. Defaults to 1. |
<searchFilter> |
See Filter Options below. |
Search Filter Options¶
Filter |
Description |
---|---|
permission |
Owned by You or Shared with You |
portfolio_type |
Static or Dynamic |
Note
Only 1 search filter can be used at a time.
Each page contains 100 model portfolios.
Tip
Search filter parameter values can be found in our API Reference Guide found at API Reference Guide
Response Info¶
The response will contain a list of Model Portfolio Objects.
Field |
Type |
Description |
---|---|---|
symbol |
string |
The security id of the Model Portfolio. |
name |
string |
The name of the Model Portfolio. |
Examples¶
The following is an example successful response.
Request URL
https://api.ycharts.com/v3/model_portfolios?permission=owned&page=1
Response
{
"meta": {
"pagination_info": {
"current_page_num": 1,
"end_index": 100,
"num_items": 774,
"num_pages": 8,
"start_index": 1
},
"status": "ok",
"url": "https://api.ycharts.com/v3/model_portfolios?permission=owned&page=1"
},
"response": [
{
"name": "My Gold Medal Portfolio",
"symbol": "P:1"
},
{
"name": "My Silver Medal Portfolio",
"symbol": "P:2"
}
]
}