POST
/
v1
/
knowledge-graph
/
companies
Find Companies by Detail
curl --request POST \
  --url https://api.bigdata.com/v1/knowledge-graph/companies \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "query": "Apple",
  "types": [
    "PUBLIC"
  ],
  "countries": [
    "US",
    "FR"
  ],
  "sectors": [
    "Information Technology",
    "Communication Services",
    "Industrials"
  ]
}'
[
  {
    "id": "D8442A",
    "name": "Apple Inc.",
    "description": "Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide.",
    "type": "PUBLIC",
    "country": "US",
    "sector": "Technology",
    "industry_group": "Computer Hardware",
    "industry": "Computer Hardware",
    "favicon": "http://www.apple.com/favicon.ico",
    "webpage": "http://www.apple.com",
    "isin_values": [
      "CA03785Y1007",
      "TH0150120408",
      "TH0809121500",
      "US0378331005"
    ],
    "cusip_values": [
      "037833100",
      "03785Y100",
      "P0R684385",
      "Y100G4352",
      "Y49876132"
    ],
    "sedol_values": [
      "2046251",
      "BNC31R1",
      "BPXWT99",
      "BVBDDG1"
    ],
    "listing_values": [
      "XBKK:AAPL80",
      "XNAS:AAPL"
    ],
    "ticker": "AAPL"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Request body for finding companies. Each field is optional. However, you must provide at least one field to perform a valid search.

​
query
string

It accepts a partial or complete company name, webpage, ticker, ISIN, SEDOL, or CUSIP. Examples: 'Apple', 'AAPL', 'https://www.apple.com/', 'CA03785Y1007'

Example:

"Apple"

​
types
enum<string>[]

The company type can be PUBLIC or PRIVATE

Example:
["PUBLIC"]
​
countries
string[]

It accepts country codes using the ISO 3166-1 A-2, for instance "US" for the United States

Example:
["US", "FR"]
​
sectors
string[]

It accepts a list of sectors that can be retrieved with the endpoint "/knowledge-graph/companies/sectors"

Example:
[
  "Information Technology",
  "Communication Services",
  "Industrials"
]

Response

200 - application/json

Successful response with company data

​
id
string
required

Unique company identifier in the Knowledge Graph

Example:

"D8442A"

​
name
string
required

Company name

Example:

"Apple Inc."

​
type
enum<string>
required

Company type classification

Available options:
PUBLIC,
PRIVATE
Example:

"PUBLIC"

​
country
string
required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

​
description
string

Company description and business overview

Example:

"Apple Inc. (formerly Apple Computer Inc.), incorporated on January 03, 1977, designs, manufactures, and markets mobile communication and media devices, personal computing products, and portable digital music players worldwide."

​
sector
string

Business sector

Example:

"Technology"

​
industry_group
string

Industry group classification

Example:

"Computer Hardware"

​
industry
string

Specific industry classification

Example:

"Computer Hardware"

​
favicon
string<uri>

Company favicon URL

Example:

"http://www.apple.com/favicon.ico"

​
webpage
string<uri>

Company website URL

Example:

"http://www.apple.com"

​
isin_values
string[]

International Securities Identification Numbers

Example:
[
  "CA03785Y1007",
  "TH0150120408",
  "TH0809121500",
  "US0378331005"
]
​
cusip_values
string[]

Committee on Uniform Securities Identification Procedures numbers

Example:
[
  "037833100",
  "03785Y100",
  "P0R684385",
  "Y100G4352",
  "Y49876132"
]
​
sedol_values
string[]

Stock Exchange Daily Official List numbers

Example:
["2046251", "BNC31R1", "BPXWT99", "BVBDDG1"]
​
listing_values
string[]

Exchange listing identifiers

Example:
["XBKK:AAPL80", "XNAS:AAPL"]
​
ticker
string

Primary ticker symbol

Example:

"AAPL"