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 Info Fields

The Indicator Info Field Endpoint is used to obtain information about one or more indicators.

Note

Full list of fields can be found in the Reference Guide

Request Info

Request Method	GET
URL	/v3/indicators/code[s]/info/field[s]

Request Parameters

Parameter	Required	Description
code[s]	Y	Unique code for an indicator, or a comma separated list of codes
fields[s]	Y	A comma separated list of info fields from the list below

Note

There is a maximum of 100 indicators 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/indicators/I:USICUI/info/adjustment,data_type,security_name,last_value,change_year_ago

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicators/I:USICUI/info/adjustment,data_type,security_name,last_value,change_year_ago"
    },
    "response": {
        "I:USICUI": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "adjustment": {
                    "data": "Seasonally Adjusted",
                    "meta": {
                        "status": "ok"
                    }
                },
                "change_year_ago": {
                    "data": -48000.0,
                    "meta": {
                        "status": "ok"
                    }
                },
                "data_type": {
                    "data": "figure",
                    "meta": {
                        "status": "ok"
                    }
                },
                "last_value": {
                    "data": 257000.0,
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "US Initial Jobless Claims",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

The following is an example successful multi-indicator response

Request URL

https://api.ycharts.com/v3/indicators/I:USICUI,I:10YTR/info/adjustment,data_type,security_name,last_value,change_year_ago

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicators/I:USICUI,I:10YTR/info/adjustment,data_type,security_name,last_value,change_year_ago"
    },
    "response": {
        "I:10YTR": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "adjustment": {
                    "data": "N/A",
                    "meta": {
                        "status": "ok"
                    }
                },
                "change_year_ago": {
                    "data": "-0.00130",
                    "meta": {
                        "status": "ok"
                    }
                },
                "data_type": {
                    "data": "percent",
                    "meta": {
                        "status": "ok"
                    }
                },
                "last_value": {
                    "data": "0.01870",
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "10 Year Treasury Rate",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        },
        "I:USICUI": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "adjustment": {
                    "data": "Seasonally Adjusted",
                    "meta": {
                        "status": "ok"
                    }
                },
                "change_year_ago": {
                    "data": -48000.0,
                    "meta": {
                        "status": "ok"
                    }
                },
                "data_type": {
                    "data": "figure",
                    "meta": {
                        "status": "ok"
                    }
                },
                "last_value": {
                    "data": 257000.0,
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "US Initial Jobless Claims",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

The following is an example incorrect request, which requests an indicator that does not exist

Request URL

https://api.ycharts.com/v3/indicators/I:ABCDEF/info/adjustment,data_type,security_name,last_value,change_year_ago

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicators/I:ABCDEF/info/adjustment,data_type,security_name,last_value,change_year_ago"
    },
    "response": {
        "I:ABCDEF": {
            "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/indicators/I:USICUI/info/fake_field_one,fake_field_two

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicators/I:USICUI/info/fake_field_one,fake_field_two"
    },
    "response": {
        "I:USICUI": {
            "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"
                    }
                }
            }
        }
    }
}