Module owler
ballerinax/owler Ballerina library
1.5.2
Overview
The Owler API v1.0 connector(https://corp.owler.com/) OpenAPI specification.
Search for information on companies using a website or company name and get access to Company Data, News, Blog Posts, Competitor Lists and much more.
Clients
owler: Client
Isolated
Search for information on companies using a website or company name and get access to Company Data, News, Blog Posts, Competitor Lists and much more.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an Owler account and obtain the API key.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.owler.com/" - URL of the target service
basicCompanySearch
Isolated FunctionRemote Function
function basicCompanySearch(string q, string[]? fields, string? 'limit, string format) returns BasicResults|errorBasic Search Company by Ticker or Website or Name or PermID
Parameters
- q string - Search term
- fields string[]? (default ()) - Fields to be searched - name, website, ticker, permid. If not specfied, will be searched against all fields
- 'limit string? (default ()) - Number of results to be displayed - 10 (by default, if not specified) to 30
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- BasicResults|error - Search Results
geCompetiterInformationById
Isolated FunctionRemote Function
function geCompetiterInformationById(string companyId, string format) returns CompanyCompetitorVO|errorGet Competitor information by Id
Parameters
- companyId string - Company Id
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- CompanyCompetitorVO|error - Competitors Data
getCompetitorInformationByUrl
Isolated FunctionRemote Function
function getCompetitorInformationByUrl(string website, string format) returns CompanyCompetitorVO|errorGet Competitor information by URL
Parameters
- website string - Company Id
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- CompanyCompetitorVO|error - Competitors Data
getCompetitorInformationByIdPremium
Isolated FunctionRemote Function
function getCompetitorInformationByIdPremium(string companyId, string? paginationId, string format) returns Competitors|errorGet Competitor information by Id
Parameters
- companyId string - Company Id
- paginationId string? (default ()) - Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can be passed in the subsequent API request to get the next set of competitors. Repeat this process until needed or till the pagination_id returned is blank. Note:Every response will have maximum of 50 competitors.
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- Competitors|error - Competitors Data
getCompetitorInformationByUrlPremium
Isolated FunctionRemote Function
function getCompetitorInformationByUrlPremium(string website, string? paginationId, string format) returns Competitors|errorGet Competitor information by Url
Parameters
- website string - Company Id
- paginationId string? (default ()) - Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can be passed in the subsequent API request to get the next set of competitors. Repeat this process until needed or till the pagination_id returned is blank. Note:Every response will have maximum of 50 competitors.
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- Competitors|error - Competitors Data
fuzzyCompanySearch
Isolated FunctionRemote Function
function fuzzyCompanySearch(string q, string[] fields, string? 'limit, string format) returns FuzzyResults|errorFuzzy Search Company by Name or Address or Phone
Parameters
- q string - Search term
- fields string[] - Fields to be searched - name, website, ticker, permid, address, phone. Each field and its corresponding value has to be specified
- 'limit string? (default ()) - Number of results to be displayed - 10 (by default, if not specified) to 30
- format string (default "json") - Format of the response content - json (by default if not specified), xml
Return Type
- FuzzyResults|error - Search Results
getCompanyById
Isolated FunctionRemote Function
Get Company by Id
Parameters
- companyId string - Company Id
- format string (default "json") - Format of the response content - json (by default if not specified), xml
searchCompany
Isolated FunctionRemote Function
function searchCompany(string q, string[]? fields, string? 'limit, string format) returns Results|errorSearch Company by Ticker or Website or Name or PermID
Parameters
- q string - Search term
- fields string[]? (default ()) - Fields to be searched - name, website, ticker. If not specified, will be searched against all fields
- 'limit string? (default ()) - Number of results to be displayed - 10 (by default, if not specified) to 30
- format string (default "json") - Format of the response content - json (by default if not specified), xml
getCompanyByUrl
Isolated FunctionRemote Function
Get Company by URL
Parameters
- website string - Company Domain
- format string (default "json") - Format of the response content - json (by default if not specified), xml
getCompanyByIdPremium
Isolated FunctionRemote Function
Get Complete Company Info by Id
Parameters
- companyId string - Company Id
- format string (default "json") - Format of the response content - json (by default if not specified), xml
getCompanyByUrlPremium
Isolated FunctionRemote Function
Get Basic Company Info by Url
Parameters
- website string - Company Domain
- format string (default "json") - Format of the response content - json (by default if not specified), xml
getFeedsForCompanyIds
Isolated FunctionRemote Function
function getFeedsForCompanyIds(string[] companyId, string format, string 'limit, string paginationId, string[]? category) returns Results|errorGet Feeds for given Company Ids
Parameters
- companyId string[] - Company Ids separated by comma (Maximum of 150 Company Ids)
- format string (default "json") - Format of the response content - json (by default if not specified), xml
- 'limit string (default "10") - Number of results to be displayed - 10 (by default, if not specified) to 100
- paginationId string (default "*") - Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id which can be passed in the subsequent API request to get the next set of feeds. Repeat this process until needed or till the pagination_id returned is blank
- category string[]? (default ()) - Categories separated by comma. If not specified, will search against all categories
getFeedsForCompanyUrls
Isolated FunctionRemote Function
function getFeedsForCompanyUrls(string[] domain, string format, string 'limit, string paginationId, string[]? category) returns Results|errorGet Feeds for given Company Websites
Parameters
- domain string[] - Company Websites separated by comma (Maximum of 10 Company Websites)
- format string (default "json") - Format of the response content - json (by default if not specified), xml
- 'limit string (default "10") - Number of results to be displayed - 10 (by default, if not specified) to 100
- paginationId string (default "*") - Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id which can be passed in the subsequent API request to get the next set of feeds. Repeat this process until needed or till the pagination_id returned is blank
- category string[]? (default ()) - Categories separated by comma. If not specified, will search against all categories
Records
owler: Acquisition
Fields
- acquirer_company_id? string -
- amount? string -
- company_id? string -
- date? string -
- name? string -
- status? string -
- undisclosed? string -
- website? string -
owler: Address
Fields
- city? string -
- country? string -
- phone? string -
- postal_code? string -
- state? string -
- street1? string -
- street2? string -
owler: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- userKey string - Represents API Key
user_key
owler: BasicResults
Fields
- company? CompanyBasicSearchVO[] -
owler: Ceo
Fields
- ceo_rating? string -
- first_name? string -
- image_url? string -
- last_name? string -
owler: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
owler: Company
Fields
- acquisition? Acquisition[] -
- ceo? Ceo -
- company_id int -
- company_type? string -
- description? string -
- employee_count? string -
- facebook_link? string -
- founded_date? string -
- funding? Funding[] -
- hq_address? Address -
- industries? string[] -
- linkedin_link? string -
- logo_url string -
- name string -
- perm_id? string -
- portfolio_company_ids? int[] -
- profile_url string -
- revenue? string -
- sectors? SectorVO[] -
- short_name? string -
- stock? Stock -
- twitter_link? string -
- website string -
- youtube_link? string -
owler: CompanyBasicSearchVO
Fields
- company_id? int -
- hq_address? Address -
- name? string -
- perm_id? string -
- profile_url? string -
- short_name? string -
- website? string -
owler: CompanyBasicVO
Fields
- company_id int -
- logo_url string -
- name string -
- profile_url string -
- short_name? string -
- website string -
owler: CompanyCompetitorVO
Fields
- competitor? CompanyBasicVO[] -
owler: CompanySearchResultVO
Fields
- company_id int -
- company_type? string -
- description? string -
- hq_address? Address -
- logo_url string -
- name string -
- perm_id? string -
- profile_url string -
- short_name? string -
- stock? Stock -
- website string -
owler: CompetitorBasicVO
Fields
- company_id int -
- logo_url string -
- name string -
- profile_url string -
- score int -
- short_name? string -
- website string -
owler: Competitors
Fields
- competitor? CompetitorBasicVO[] -
- pagination_id? string -
owler: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
owler: FeedsVO
Fields
- category? string -
- company? CompanyBasicVO -
- enclosure_image? string -
- feed_date? string -
- id? string -
- owler_feed_url? string -
- publisher_logo? string -
- publisher_name? string -
- source_url? string -
- title? string -
owler: Funding
Fields
- amount? string -
- date? string -
- investor? Investor[] -
- 'type? string -
- undisclosed? string -
owler: FuzzyResults
owler: Investor
Fields
- company_id? string -
- name? string -
- website? string -
owler: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
owler: Results
Fields
- feeds? FeedsVO[] -
- pagination_id? string -
owler: SectorVO
Fields
- name? string -
- parent_industry? string -
owler: Stock
Fields
- exchange? string -
- ticker? string -