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.
Custom Security Search¶
The Custom Security Search Endpoint is used to return lists of custom securities for use in other endpoints. The endpoint optionally supports a variety of search parameters to focus the returned custom security list.
Request Info¶
Request Method |
GET |
URL |
/api/v3/custom_securities |
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 |
Note
Each page contains 100 custom securities.
Tip
Search filter parameter values can be found in our API Reference Guide found at https://ycharts.com/api.
Response Info¶
The response will contain a list of Custom Security Objects.
Field |
Type |
Description |
---|---|---|
symbol |
string |
The security id of the Custom Security. |
name |
string |
The name of the Custom Security. |
Examples¶
The following is an example successful response.
Request URL
https://ycharts.com/api/v3/custom_securities?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://ycharts.com/api/v3/custom_securities?permission=owned&page=1"
},
"response": [
{
"name": "My Custom Security",
"symbol": "Y:1"
},
{
"name": "My Other Custom Security",
"symbol": "Y:2"
},
...
]