Use the Company Search resource to fetch a list of companies. The elements in the companies list contain an id value and enough additional information such that a user could narrow down the selection from the list. Using the selected id values you can retrieve additional company information through the Company Details endpoint.
Endpoint
GET https://api.insideview.com/api/v1/companies
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes |
Valid access token. |
Accept | String | No | Selects the response's content type. Valid values are application/json and application/xml (default). |
Query Parameters
Parameter Name | Type | Required | Description |
name | String | Yes1 | Company name |
website | String | Yes1 | Corporate website |
ticker | String | Yes1 | Stock market abbreviation |
country | String | No | Country name (e.g. United States, France) |
state | String | No | |
city | String | No | |
street | String | No | |
zip | String | No | |
phone | String | No | |
page | Integer | No | The page number of the result-set to return. Default: 1 |
resultsPerPage | Integer | No | The number of results in a page request. Min: 1, Max: 50, Default: 10 |
1: the request should include at least one of the three mandatory parameters.
Responses
HTTP 200
Returns either a JSON or XML data structure depending on the request Accept header.
Name | type | Description |
companies | Array | Array of search results |
companies companyId | Integer | InsideView Company ID |
companies name | String | Company name |
companies city | String | Company address: city |
companies state | String | Company address: state |
companies country | String | Company address: country |
page | Integer | Page number in the result set |
resultsPerPage | Integer | Number of search result per page |
totalResults | Integer | Total number of search results |
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"companies": {
"id": "companies",
"type": "array",
"items": [
{
"id": "0",
"type": "object",
"properties": {
"name": {
"id": "name",
"type": "string"
},
"city": {
"id": "city",
"type": "string"
},
"state": {
"id": "state",
"type": "string"
},
"country": {
"id": "country",
"type": "string"
},
"companyId": {
"id": "companyId",
"type": "integer"
}
}
}
]
},
"page": {
"id": "page",
"type": "integer"
},
"resultsPerPage": {
"id": "resultsPerPage",
"type": "integer"
},
"totalResults": {
"id": "totalResults",
"type": "integer"
}
}
}
Example
{
"companies": [
{
"name": "google",
"city": "Mountain View",
"state": "CA",
"country": "United States",
"companyId": 736233
},
{
"name": "google USA inc",
"city": "Boston",
"state": "MA",
"country": "United States",
"companyId": 2996
},
{
"name": "AdMob Google Inc.",
"city": "Mountain View",
"state": "CA",
"country": "United States",
"companyId": 2546544
},
{
"name": "Google Ireland Limited",
"city": "Dublin",
"country": "Ireland",
"companyId": 1475170
},
{
"name": "Google Affiliate Network Inc.",
"country": "United States",
"companyId": 1739593
},
{
"name": "Google India Private Limited",
"city": "Bengaluru",
"country": "India",
"companyId": 1750717
},
{
"name": "Google Australia Pty. Ltd.",
"city": "Sydney",
"state": "New South Wales",
"country": "Australia",
"companyId": 1456802
},
{
"name": "Google Canada Corporation Test1",
"city": "Halifax",
"state": "NS",
"country": "Canada",
"companyId": 2725793
},
{
"name": "Google Germany GmbH",
"city": "Hamburg",
"country": "Germany",
"companyId": 3221568
},
{
"name": "Google Brasil Internet Ltda.",
"city": "Sao Paulo",
"state": "São Paulo",
"country": "Brazil",
"companyId": 3221567
}
],
"page": 1,
"resultsPerPage": 10,
"totalResults": 59
}
Type: application/xml
Schema
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="companies">
<xs:complexType>
<xs:sequence>
<xs:element name="company" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:int" name="companyId"/>
<xs:element type="xs:string" name="city"/>
<xs:element type="xs:string" name="country"/>
<xs:element type="xs:string" name="name"/>
<xs:element type="xs:string" name="state"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="xs:int" name="page"/>
<xs:element type="xs:int" name="resultsPerPage"/>
<xs:element type="xs:int" name="totalResults"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Example
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<companies xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../schema/xsd/companies.xsd">
<company>
<companyId>736233</companyId>
<city>Mountain View</city>
<country>United States</country>
<name>google</name>
<state>CA</state>
</company>
<company>
<companyId>2996</companyId>
<city>Boston</city>
<country>United States</country>
<name>google USA inc</name>
<state>MA</state>
</company>
<company>
<companyId>2546544</companyId>
<city>Mountain View</city>
<country>United States</country>
<name>AdMob Google Inc.</name>
<state>CA</state>
</company>
<page>1</page>
<resultsPerPage>10</resultsPerPage>
<totalResults>59</totalResults>
</companies>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
Request is throttled.