Connectors Reference

Bitvore Cellenus

Bitvore Cellenus is a data analytics platform that uses advanced AI techniques to provide business insights on hundreds of thousands of public and private companies from diverse sets of unstructured data (including news, press releases, SEC filings/proxy statements, earnings call transcripts and more),both public and licensed. Continuously updated on a 24/7 basis, Bitvore Cellenus derives material events, trended sentiment, growth and risk scoring to drive better business outcomes for customers.

 

Status: Preview

Tier: Premium

Version: 2.0

 

Actions:

Name

Summary

handleOrgLookupUsingGET ([Optional]string lookup, [advanced][Optional]string name, [advanced][Optional]string ticker, [advanced][Optional]string domainName, [advanced][Optional]string location, [advanced][Optional]string fips, [advanced][Optional]string zip, [advanced][Optional]string naics, [advanced][Optional]string sic, [advanced][Optional]string revRange, [advanced][Optional]string empRange, [advanced][Optional]integer pageNo, [advanced][Optional]integer pageSize)

Organization Search

handleGetOrgUsingGET (string id)

Organization Details

handleOrgMatchingUsingPOST (array specs)

Organization Matching

getVersionUsingGET_2 ()

Return API Version

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Exchange

 

IndustrySummary

 

OrganizationDetails

 

OrganizationMatchingResult

 

OrganizationMatchingSpecification

 

OrganizationSummary

 

OrgSearchResponse

 

PotentialOrganizationMatch

 

VersionAPIResponse

 

 

Actions:

handleOrgLookupUsingGET

Summary: Organization Search

Description: 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.

 

Syntax:

BitvoreCellenus.handleOrgLookupUsingGET ([Optional]string lookup, [advanced][Optional]string name, [advanced][Optional]string ticker, [advanced][Optional]string domainName, [advanced][Optional]string location, [advanced][Optional]string fips, [advanced][Optional]string zip, [advanced][Optional]string naics, [advanced][Optional]string sic, [advanced][Optional]string revRange, [advanced][Optional]string empRange, [advanced][Optional]integer pageNo, [advanced][Optional]integer pageSize)

 

Parameters:

Name

Type

Summary

Required

Related Action

lookup

string

(lookup)

Lookup option. Value is used to match multiple fields.

False

name

string

(name)

One or more names to search for.

False

ticker

string

(ticker)

One or more tickers to search for.

False

domainName

string

(domainName)

One or more domain names to search for.

False

location

string

(location)

One or more locations companies must have their headquarters in.

False

fips

string

(fips)

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

False

zip

string

(zip)

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

False

naics

string

(naics)

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

False

sic

string

(sic)

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

False

revRange

string

(revRange)

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.

False

empRange

string

(empRange)

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.

False

pageNo

integer(int32)

(pageNo)

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

False

pageSize

integer(int32)

(pageSize)

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

False

 

Returns:

          Type:OrgSearchResponse

          Description: Organization search response.

 

handleGetOrgUsingGET

Summary: Organization Details

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

 

Syntax:

BitvoreCellenus.handleGetOrgUsingGET (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(id)

id

True

 

Returns:

          Type:OrganizationDetails

          Description: Detailed information about an organization.

 

handleOrgMatchingUsingPOST

Summary: Organization Matching

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

 

Syntax:

BitvoreCellenus.handleOrgMatchingUsingPOST (array specs)

 

Parameters:

Name

Type

Summary

Required

Related Action

specs

array of (OrganizationMatchingSpecification)

 

 

True

 

Returns:

          Type:array of (OrganizationMatchingResult)

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

 

getVersionUsingGET_2

Summary: Return API Version

Description: Deprecated

 

Syntax:

BitvoreCellenus.getVersionUsingGET_2 ()

 

Returns:

          Type:VersionAPIResponse

          Description: Properties for a successful version request.

 


 

Exchange

Summary:

Description:

 

          Properties:

Name

Type

Summary

alias

string

 

More commonly used acronym for the exchange

mic

string

 

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

symbol

string

 

Exchange symbol


 

IndustrySummary

Summary:

Description: Summary information about an industry.

 

          Properties:

Name

Type

Summary

code

string

 

Unique ID of the industry

name

string

 

Name of the industry


 

OrganizationDetails

Summary:

Description: Detailed information about an organization.

 

          Properties:

Name

Type

Summary

aliases

array of (string)

 

List of aliases for the organization

city

string

 

City the organization is headquartered in

country

string

 

Country the organization is headquartered in

description

string

 

Description of the organization

domainName

string

 

Domain name of the organization (if website known)

employees

string

 

Estimated number of employees (range based)  Values: [1-10, 10-50, 50-100, 100-250, 250-500, 500-1000, 1000-5000, 5000-10000, 10000-]

exchange

Exchange

 

 

facebookUrl

string

 

Absolute URL to the company's Facebook page

fundingTotal

integer(int64)

 

Estimate of total funding the organization has received

id

string

 

ID (BvId) of the organization

lastFundingAmount

integer(int64)

 

Estimate of the funding received in its last funding year

lastFundingYear

integer(int32)

 

Last year the organization received funding

linkedInUrl

string

 

Absolute URL to the company's LinkedIn page

monitored

string

 

Indicates whether the orgnaization is being actively monitored.  Values: [inactive, pending, active]

naicsIndustry

IndustrySummary

 

Summary information about an industry.

name

string

 

Name of the organization

parent

OrganizationSummary

 

Summary information about an organization.

revenue

string

 

Estimated annual revenue in millions (range based)  Values: [0-1, 1-10, 10-50, 50-100, 100-500, 500-1000, 1000-10000, 10000-]

sicIndustry

IndustrySummary

 

Summary information about an industry.

state

string

 

State the organization is headquartered in

ticker

string

 

Stock ticker of the organization (if traded)

twitterUrl

string

 

Absolute URL to the company's Twitter page

ultimateParent

OrganizationSummary

 

Summary information about an organization.

yearClosed

integer(int32)

 

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

yearFounded

integer(int32)

 

Year the organization was founded


 

OrganizationMatchingResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

candidates

array of (PotentialOrganizationMatch)

 

List of candidate matches

spec

Spec

 

Input organization specification used to find candidates

 

Spec

Summary:

Description: Input organization specification used to find candidates

 

          Properties:

Name

Type

Summary

 


 

OrganizationMatchingSpecification

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OrganizationSummary

Summary:

Description: Summary information about an organization.

 

          Properties:

Name

Type

Summary

city

string

 

City the organization is headquartered in

country

string

 

Country the organization is headquartered in

domainName

string

 

Domain name of the organization (if website known)

id

string

 

ID (BvId) of the organization

monitored

string

 

Indicates whether the orgnaization is being actively monitored.  Values: [inactive, pending, active]

name

string

 

Name of the organization

parent

OrganizationSummary

 

Summary information about an organization.

state

string

 

State the organization is headquartered in

ticker

string

 

Stock ticker of the organization (if traded)


 

OrgSearchResponse

Summary:

Description: Organization search response.

 

          Properties:

Name

Type

Summary

count

integer(int32)

 

Deprecated, replaced by the returned property

reason

string

 

Text reason for the failure (if not successful)

reasonSupport

string

 

Additional information about the failure (if not successful)

response

array of (OrganizationSummary)

 

Response payload

returned

integer(int32)

 

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

success

boolean

 

Indicates whether the call was successful or not

total

integer(int32)

 

Total number of organizations matching search criteria


 

PotentialOrganizationMatch

Summary:

Description: One potential matching organization.

 

          Properties:

Name

Type

Summary

hits

array of (string)

 

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

org

OrganizationSummary

 

Summary information about an organization.


 

VersionAPIResponse

Summary:

Description: Properties for a successful version request.

 

          Properties:

Name

Type

Summary

response

string

 

Version number

success

boolean

 

Indicates whether the call was successful or not