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.
Indicator Search¶
The indicator Search Endpoint is used to return lists of indicators for use in other endpoints. The endpoint optionally supports a variety of search parameters to focus the returned indicator list.
Request Info¶
Request Method |
GET |
URL |
/v3/indicators |
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 |
---|---|
region |
Region |
report |
Report |
sector |
Sector |
Note
Only 1 search filter can be used at a time.
Each Page contains 100 indicators.
Tip
Search filter parameter values can be found in our API Reference Guide https://ycharts.com/securities/export_metric_reference_guide/api.
Response Info¶
The response will contain a list of indicator Objects.
Field |
Type |
Description |
---|---|---|
symbol |
string |
The code of the indicator. |
name |
string |
The name of the indicator. |
Examples¶
The following is an example successful response.
Request URL
https://api.ycharts.com/v3/indicators?page=1?®ion=USA
Response
{
"meta": {
"pagination_info": {
"current_page_num": 1,
"end_index": 100,
"num_items": 22387,
"num_pages": 224,
"start_index": 1
},
"status": "ok",
"url": "https://api.ycharts.com/v3/indicators?page=1?®ion=USA"
},
"response": [
{
"name": "30 Year Treasury Rate",
"symbol": "I:30YTRNY"
},
{
"name": "US GDP",
"symbol": "I:USGPD"
}
]
}