Bitvore Cellenus (Preview)

The Entity API provides access to information about corporate entities available in the Bitvore database. Companies can be searched for based on some criteria (e.g. name, ticker, industry, etc) or directly using a Bitvore ID which uniquely identifies an entity.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Bitvore Support
URL https://bitvore.com/contact-us/
Email support@bitvore.com
Connector Metadata
Publisher Bitvore Corp.
Website https://bitvore.com/
Privacy policy https://bitvore.com/privacy-policy/
Categories Business Intelligence;AI

The corporate entities, companies or organizations, that the articles the Corporate News API returns are persisted in the Bitvore Knowledge Graph. The Entity API provides access to the information about those corporate entities.

Prerequisites

In order to use the connector, you need a valid API Key provided by Bitvore.

How to get credentials?

The Entity API is part of the corporate data set and requires a corporate data set API key for access. To register for an API Key please contact the Products Team.

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
API Key securestring The API Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Organization Details

Returns detailed information about the company with the given Bitvore ID.

Organization Matching

Attempts to find companies matching input specifications made up of a list of property values. Multiple companies can be matched in a single call.

Organization Search

Search can be performed using one of two approaches, a lookup or a parameterized query. A lookup takes a single string as input to matching entities. A paramaterized query takes one or more search parameters.

Return API Version

Deprecated

Organization Details

Returns detailed information about the company with the given Bitvore ID.

Parameters

Name Key Required Type Description
id
id True string

id

Returns

Detailed information about an organization.

Organization Matching

Attempts to find companies matching input specifications made up of a list of property values. Multiple companies can be matched in a single call.

Returns

Results of trying to match an organization using the input specification.

Search can be performed using one of two approaches, a lookup or a parameterized query. A lookup takes a single string as input to matching entities. A paramaterized query takes one or more search parameters.

Parameters

Name Key Required Type Description
lookup
lookup string

Lookup option. Value is used to match multiple fields.

name
name string

One or more names to search for.

ticker
ticker string

One or more tickers to search for.

domainName
domainName string

One or more domain names to search for.

location
location string

One or more locations companies must have their headquarters in.

fips
fips string

One or more FIPS codes identifying locations the companies must have their headquarters in.

zip
zip string

One or more zip codes identifying locations the companies must have their headquarters in.

naics
naics string

One or more NAICS codes identifying industries the companies must operate in.

sic
sic string

One or more SIC codes identifying industries the companies must operate in.

revRange
revRange string

Revenue range (in millions) companies must fall in. The range is formated as lower-upper where lower and upper must be one of 0, 1, 10, 50, 100, 200, 1000. The upper bound can be ommited to report over 1B.

empRange
empRange string

Employee range companies must fall in. The range is formated as lower-upper where lower and upper must be one of 1, 10, 50, 200, 500, 1000, 5000, 10000. The upper bound can be ommited to report over 1B.

pageNo
pageNo integer

Page number of the total result set to return, default is 1.

pageSize
pageSize integer

Number of results out of the total result set per page to return, default is 100, maximum is 1000.

Returns

Organization search response.

Return API Version

Deprecated

Returns

Properties common to most API responses.

Definitions

Exchange

Name Path Type Description
alias
alias string

More commonly used acronym for the exchange

mic
mic string

Market Identifier Code (MIC). Deprecated in favor of the market symbol.

symbol
symbol string

Exchange symbol

GeneralAPIResponse

Properties common to most API responses.

Name Path Type Description
reason
reason string

Text reason for the failure (if not successful)

reasonSupport
reasonSupport object

Additional information about the failure (if not successful)

response
response object

Response payload

success
success boolean

Indicates whether the call was successful or not

IndustrySummary

Summary information about an industry.

Name Path Type Description
code
code string

Unique ID of the industry

name
name string

Name of the industry

OrgSearchResponse

Organization search response.

Name Path Type Description
count
count integer

Deprecated, replaced by the returned property

reason
reason string

Text reason for the failure (if not successful)

reasonSupport
reasonSupport string

Additional information about the failure (if not successful)

response
response array of OrganizationSummary

Response payload

returned
returned integer

Number of organizations returned by search, may be less than total if paging used

success
success boolean

Indicates whether the call was successful or not

total
total integer

Total number of organizations matching search criteria

OrganizationDetails

Detailed information about an organization.

Name Path Type Description
aliases
aliases array of string

List of aliases for the organization

city
city string

City the organization is headquartered in

country
country string

Country the organization is headquartered in

description
description string

Description of the organization

domainName
domainName string

Domain name of the organization (if website known)

employees
employees string

Estimated number of employees (range based)

exchange
exchange Exchange
facebookUrl
facebookUrl string

Absolute URL to the company's Facebook page

fundingTotal
fundingTotal integer

Estimate of total funding the organization has received

id
id string

ID (BvId) of the organization

lastFundingAmount
lastFundingAmount integer

Estimate of the funding received in its last funding year

lastFundingYear
lastFundingYear integer

Last year the organization received funding

linkedInUrl
linkedInUrl string

Absolute URL to the company's LinkedIn page

monitored
monitored string

Indicates whether the orgnaization is being actively monitored.

naicsIndustry
naicsIndustry IndustrySummary

Summary information about an industry.

name
name string

Name of the organization

parent
parent OrganizationSummary

Summary information about an organization.

revenue
revenue string

Estimated annual revenue in millions (range based)

sicIndustry
sicIndustry IndustrySummary

Summary information about an industry.

state
state string

State the organization is headquartered in

ticker
ticker string

Stock ticker of the organization (if traded)

twitterUrl
twitterUrl string

Absolute URL to the company's Twitter page

ultimateParent
ultimateParent OrganizationSummary

Summary information about an organization.

yearClosed
yearClosed integer

Year the organization went out of business if no longer in business

yearFounded
yearFounded integer

Year the organization was founded

OrganizationSummary

Summary information about an organization.

Name Path Type Description
city
city string

City the organization is headquartered in

country
country string

Country the organization is headquartered in

domainName
domainName string

Domain name of the organization (if website known)

id
id string

ID (BvId) of the organization

monitored
monitored string

Indicates whether the orgnaization is being actively monitored.

name
name string

Name of the organization

parent
parent OrganizationSummary

Summary information about an organization.

state
state string

State the organization is headquartered in

ticker
ticker string

Stock ticker of the organization (if traded)

PotentialOrganizationMatch

One potential matching organization.

Name Path Type Description
hits
hits array of string

List of the properties in the input specification that this company has matches for

org
org OrganizationSummary

Summary information about an organization.

SingleOrganizationMatchingResult

Results of trying to match an organization using the input specification.

Name Path Type Description
candidates
candidates array of PotentialOrganizationMatch

List of candidate matches

spec
spec object

Input organization specification used to find candidates