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.

Company Info Fields

The Company Info Field Endpoint is used to obtain information about one or more companies.

Note

Full list of fields can be found in the Reference Guide

Request Info

Request Method	GET
URL	/v3/companies/symbol[s]/info/field[s]

Request Parameters

Parameter	Required	Description
symbol[s]	Y	The exchange symbol for a company, or comma separated list of exchange symbols
field[s]	Y	One or more comma separated company fields. (See list below)

Note

There is a maximum of 100 companies 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/companies/AAPL/info/hq_country,naics_sector,y_rating

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/companies/AAPL/info/hq_country,naics_sector,y_rating"
    },
    "response": {
        "AAPL": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "hq_country": {
                    "data": "United States",
                    "meta": {
                        "status": "ok"
                    }
                },
                "naics_sector": {
                    "data": "Manufacturing",
                    "meta": {
                        "status": "ok"
                    }
                },
                "y_rating": {
                    "data": "Neutral",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

The following is an example successful multi company response

Request URL

https://api.ycharts.com/v3/companies/AAPL,MSFT/info/hq_country,naics_sector,y_rating

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/companies/AAPL,MSFT/info/hq_country,naics_sector,y_rating"
    },
    "response": {
        "AAPL": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "hq_country": {
                    "data": "United States",
                    "meta": {
                        "status": "ok"
                    }
                },
                "naics_sector": {
                    "data": "Manufacturing",
                    "meta": {
                        "status": "ok"
                    }
                },
                "y_rating": {
                    "data": "Neutral",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        },
        "MSFT": {
            "meta": {
                "status": "ok"
            },
            "results": {
                "hq_country": {
                    "data": "United States",
                    "meta": {
                        "status": "ok"
                    }
                },
                "naics_sector": {
                    "data": "Information",
                    "meta": {
                        "status": "ok"
                    }
                },
                "y_rating": {
                    "data": "Neutral",
                    "meta": {
                        "status": "ok"
                    }
                }
            }
        }
    }
}

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

Request URL

https://api.ycharts.com/v3/companies/BAD/info/hq_country,naics_sector,y_rating

Response

{
    "meta": {
        "status": "ok",
        "url": "https://api.ycharts.com/v3/companies/BAD/info/hq_country,naics_sector,y_rating"
    },
    "response": {
        "BAD": {
            "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/companies/AAPL/info/fake_field_one,fake_field_two

Response

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