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 Search¶
The Company Search Endpoint is used to return lists of companies for use in other endpoints. The endpoint optionally supports a variety of search parameters to focus the returned company list.
Request Info¶
Request Method |
GET |
URL |
/v3/companies |
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 |
---|---|
benchmark_index |
Benchmark Index |
exchange |
Exchange |
hq_region |
HQ Region |
incorporation_region |
Incorporation Region |
industry |
Industry |
naics_industry |
Naics Industry |
naics_sector |
Naics Sector |
sector |
Sector |
is_lp |
Is Limited Partnership (true or false) |
is_reit |
Is REIT (true or false) |
is_shell |
Is Shell Company (true or false) |
Note
Only 1 search filter can be used at a time.
Each Page contains 100 companies.
Tip
Search filter parameter values can be found in our API Reference Guide.
Response Info¶
The response will contain a list of Company Objects.
Field |
Type |
Description |
---|---|---|
symbol |
string |
The exchange symbol of the Company. |
name |
string |
The name of the Company. |
Examples¶
The following is an example successful response.
Request URL
https://api.ycharts.com/v3/companies?page=1?&exchange=NYSE
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/companies?page=1?&exchange=NYSE"
},
"response": [
{
"name": "Agilent Technologies Inc",
"symbol": "A"
},
{
"name": "Armor Minerals Inc",
"symbol": "A.V"
}
]
}