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 Report Info Fields¶
The Indicator Report Info Field Endpoint is used to obtain information about one or more indicator reports.
Note
Full list of fields can be found in the Reference Guide
Request Info¶
Request Method |
GET |
URL |
/v3/indicator_reports/ |
Request Parameters¶
Parameter |
Required |
Description |
|---|---|---|
id[s] |
Y |
Unique id for an indicator report, or a comma separated list of ids |
field[s] |
Y |
A comma separated list of fields from the table below |
Note
There is a maximum of 100 indicator reports per request. In addition, there is a maximum of 100 fields per request.
Response Info¶
The response will contain one or more indicator report objects. The key for each indicator report object is the id passed in the request.
Field |
Type |
Description |
|---|---|---|
categories |
List |
The indicator report’s categories |
description |
String |
A description of the indicator report |
last_updated |
Datetime |
The date and time when the indicator report was last updated |
region |
String |
The name of the region which contains the indicator report |
report_frequency |
String |
The frequency with which the indicator report is released |
security_name |
String |
The the indicator report’s name |
short_name |
String |
A shorter name for the indicator report |
source |
String |
The name of the source for the indicator report |
url |
String |
The indicator report’s release page URL |
ycharts_url |
String |
The URL of the indicator report’s page on YCharts |
Examples¶
The following is an example successful response
Request URL
https://api.ycharts.com/v3/indicator_reports/1/info/description,source,region,security_name,category
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/indicator_reports/1/info/description,source,region,security_name,category"
},
"response": {
"1": {
"meta": {
"status": "ok"
},
"results": {
"category": {
"data": "Employment",
"meta": {
"status": "ok"
}
},
"description": {
"data": "The ADP National Employment Report estimates the changes in US employment using payroll data for over 500,000 firms from Automatic Data Processing, Inc. (ADP). This information is compiled by Macroeconomic Advisors, LLC into a report which shows aggregate numbers, as well as segments defined by company size, goods versus services, and manufacturing vs. non-manufacturing firms.\r\n\r\n",
"meta": {
"status": "ok"
}
},
"security_name": {
"data": "ADP Employment Report",
"meta": {
"status": "ok"
}
},
"region": {
"data": "United States",
"meta": {
"status": "ok"
}
},
"source": {
"data": 14,
"meta": {
"status": "ok"
}
}
}
}
}
}
The following is an example successful multi-indicator report response
Request URL
https://api.ycharts.com/v3/indicator_reports/1,33/info/description,source,region,security_name,category
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/indicator_reports/1,33/info/description,source,region,security_name,category"
},
"response": {
"1": {
"meta": {
"status": "ok"
},
"results": {
"category": {
"data": "Employment",
"meta": {
"status": "ok"
}
},
"description": {
"data": "The ADP National Employment Report estimates the changes in US employment using payroll data for over 500,000 firms from Automatic Data Processing, Inc. (ADP). This information is compiled by Macroeconomic Advisors, LLC into a report which shows aggregate numbers, as well as segments defined by company size, goods versus services, and manufacturing vs. non-manufacturing firms.\r\n\r\n",
"meta": {
"status": "ok"
}
},
"security_name": {
"data": "ADP Employment Report",
"meta": {
"status": "ok"
}
},
"region": {
"data": "United States",
"meta": {
"status": "ok"
}
},
"source": {
"data": 14,
"meta": {
"status": "ok"
}
}
}
},
"33": {
"meta": {
"status": "ok"
},
"results": {
"category": {
"data": "",
"meta": {
"status": "ok"
}
},
"description": {
"data": "The Major Sector Productivity program publishes quarterly and annual measures of output per hour and unit labor costs for the U.S. business, nonfarm business, and manufacturing sectors. These are the productivity statistics most often cited by the national media.",
"meta": {
"status": "ok"
}
},
"security_name": {
"data": "Major Sector Productivity and Costs",
"meta": {
"status": "ok"
}
},
"region": {
"data": "United States",
"meta": {
"status": "ok"
}
},
"source": {
"data": 17,
"meta": {
"status": "ok"
}
}
}
}
}
}
The following is an example incorrect request, which requests an indicator report that does not exist
Request URL
https://api.ycharts.com/v3/indicator_reports/1234/info/description,source,region,security_name,category
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/indicator_reports/1234/info/description,source,region,security_name,category"
},
"response": {
"1234": {
"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/indicator_reports/1/info/fake_field_one,fake_field_two
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/indicator_reports/1/info/fake_field_one,fake_field_two"
},
"response": {
"1": {
"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"
}
}
}
}
}
}