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

Note

Full list of fields can be found in the Reference Guide

Request Info

Request Method	GET
URL	/v3/indicator_sources/id[s]/field[s]

Request Parameters

Parameter	Required	Description
id[s]	Y	Unique id for an indicator source, 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 sources per request. In addition, there is a maximum of 100 fields per request.

Response Info

The response will contain one or more indicator source objects. The key for each indicator source object is the id passed in the request.

Indicator Source Object Fields

Field	Type	Description
category	String	The indicator source’s category
description	String	A description of the indicator source
region	String	The name of the indicator source’s region
security_id	String	The indicator source’s id
security_name	String	The indicator source’s name
url	String	The indicator source’s website URL
ycharts_url	String	The URL of the indicator source page on YCharts

Examples

The following is an example successful response

Request URL

https://api.ycharts.com/v3/indicator_sources/1/info/description,security_name,region,category

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicator_sources/1/info/description,security_name,region,category"
    },
    "response": {
        "1": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "category": {
                    "data": "",
                    "meta": {
                        "status": "ok"
                    }
                },
                "description": {
                    "data": "The Federal Reserve system is composed of the 12 regional Reserve Banks and the Board of Governors in Washington, D.C.  As the central banking system of the United States of America, it conducts monetary policy under the dual mandate of maximizing employment and maintaining stable prices. ",
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "Federal Reserve",
                    "meta": {
                        "status": "ok"
                    }
                },
                "region": {
                    "data": "United States",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

The following is an example successful multi indicator source response

Request URL

https://api.ycharts.com/v3/indicator_sources/1,71/info/description,security_name,region,category

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicator_sources/1,71/info/description,security_name,region,category"
    },
    "response": {
        "1": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "category": {
                    "data": "",
                    "meta": {
                        "status": "ok"
                    }
                },
                "description": {
                    "data": "The Federal Reserve system is composed of the 12 regional Reserve Banks and the Board of Governors in Washington, D.C.  As the central banking system of the United States of America, it conducts monetary policy under the dual mandate of maximizing employment and maintaining stable prices. ",
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "Federal Reserve",
                    "meta": {
                        "status": "ok"
                    }
                },
                "region": {
                    "data": "United States",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        },
        "71": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "category": {
                    "data": "Energy",
                    "meta": {
                        "status": "ok"
                    }
                },
                "description": {
                    "data": "Baker Hughes is one of the world's largest oilfield services companies. It operates in over 90 countries, providing the oil and gas industry with products and services for drilling, formation evaluation, completion, production and reservoir consulting.",
                    "meta": {
                        "status": "ok"
                    }
                },
                "security_name": {
                    "data": "Baker Hughes",
                    "meta": {
                        "status": "ok"
                    }
                },
                "region": {
                    "data": "",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

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

Request URL

https://api.ycharts.com/v3/indicator_sources/999/info/description,security_name,region,category

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicator_sources/999/info/description,security_name,region,category"
    },
    "response": {
        "999": {
            "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_sources/1/info/fake_field_one,fake_field_two

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/indicator_sources/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"
                    }
                }
            }
        }
    }
}