[GET] - Company Competitor Information API

Follow

Use the Company Competitor Information API's endpoint to retrieve competitors for a specific company using company id. This data is mostly available for public companies only.

Endpoint

GET https://api.insideview.com/api/v1/company/{companyId}/competitors

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes

Valid access token.
See Authentication and Authorization Overview for more details.

Accept String No Selects the response's content type.  
Valid values are application/json and application/xml (default).

URI Parameters

Parameter Name Type Required Description
companyId String Yes A valid company ID

 

Responses

Here are the major responses the API may return.

for details on the errors, please refer to the API Error Codes article.

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

Name type Description
competitors Array Array of competitor companies
competitors>id String Company id
competitors>name String Company Name
competitors>city String City
competitors>state String State
competitors>country String Country

application/json Example

{
  "competitors": [
    {
      "id": "729443",
      "name": "jal",
      "city": "jal",
      "state": "jal",
      "country": "United States"
    },
    {
      "id": "726263",
      "name": "Microsoft Corporation",
      "city": "Hyderabad",
      "state": "TS",
      "country": "India"
    },
    {
      "id": "730247",
      "name": "Amazon.com, Inc.",
      "city": "Seattle",
      "state": "WA",
      "country": "United States"
    },
    {
      "id": "729989",
      "name": "Monster Worldwide, Inc.",
      "city": "Weston",
      "state": "MA",
      "country": "United States"
    }
  ]
}

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<competitors>
    <competitor>
        <city>jal</city>
        <country>United States</country>
        <id>729443</id>
        <name>jal</name>
        <state>jal</state>
    </competitor>
    <competitor>
        <city>Hyderabad</city>
        <country>India</country>
        <id>726263</id>
        <name>Microsoft Corporation</name>
        <state>TS</state>
    </competitor>
    <competitor>
        <city>Seattle</city>
        <country>United States</country>
        <id>730247</id>
        <name>Amazon.com, Inc.</name>
        <state>WA</state>
    </competitor>
    <competitor>
        <city>Weston</city>
        <country>United States</country>
        <id>729989</id>
        <name>Monster Worldwide, Inc.</name>
        <state>MA</state>
    </competitor>
</competitors>

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.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk