owler
Module owler
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_owler_1.2.0.png)
ballerinax/owler Ballerina library
Overview
This is a generated connector from Owler API v1.0 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![](/images/permalink.svg)
owler: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.owler.com/" - URL of the target service
basicCompanySearch![](/images/permalink.svg)
function basicCompanySearch(string q, string[]? fields, string? 'limit, string format) returns BasicResults|error
Basic 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![](/images/permalink.svg)
function geCompetiterInformationById(string companyId, string format) returns CompanyCompetitorVO|error
Get 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![](/images/permalink.svg)
function getCompetitorInformationByUrl(string website, string format) returns CompanyCompetitorVO|error
Get 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![](/images/permalink.svg)
function getCompetitorInformationByIdPremium(string companyId, string? paginationId, string format) returns Competitors|error
Get 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![](/images/permalink.svg)
function getCompetitorInformationByUrlPremium(string website, string? paginationId, string format) returns Competitors|error
Get 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![](/images/permalink.svg)
function fuzzyCompanySearch(string q, string[] fields, string? 'limit, string format) returns FuzzyResults|error
Fuzzy 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![](/images/permalink.svg)
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![](/images/permalink.svg)
function searchCompany(string q, string[]? fields, string? 'limit, string format) returns Results|error
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. 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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getFeedsForCompanyIds(string[] companyId, string format, string 'limit, string paginationId, string[]? category) returns Results|error
Get 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![](/images/permalink.svg)
function getFeedsForCompanyUrls(string[] domain, string format, string 'limit, string paginationId, string[]? category) returns Results|error
Get 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![](/images/permalink.svg)
owler: Acquisition![](/images/permalink.svg)
Fields
- acquirer_company_id string? -
- amount string? -
- company_id string? -
- date string? -
- name string? -
- status string? -
- undisclosed string? -
- website string? -
owler: Address![](/images/permalink.svg)
Fields
- city string? -
- country string? -
- phone string? -
- postal_code string? -
- state string? -
- street1 string? -
- street2 string? -
owler: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- userKey string - Represents API Key
user_key
owler: BasicResults![](/images/permalink.svg)
Fields
- company CompanyBasicSearchVO[]? -
owler: Ceo![](/images/permalink.svg)
Fields
- ceo_rating string? -
- first_name string? -
- image_url string? -
- last_name string? -
owler: Company![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- company_id int? -
- hq_address Address? -
- name string? -
- perm_id string? -
- profile_url string? -
- short_name string? -
- website string? -
owler: CompanyBasicVO![](/images/permalink.svg)
Fields
- company_id int -
- logo_url string -
- name string -
- profile_url string -
- short_name string? -
- website string -
owler: CompanyCompetitorVO![](/images/permalink.svg)
Fields
- competitor CompanyBasicVO[]? -
owler: CompanySearchResultVO![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- company_id int -
- logo_url string -
- name string -
- profile_url string -
- score int -
- short_name string? -
- website string -
owler: Competitors![](/images/permalink.svg)
Fields
- competitor CompetitorBasicVO[]? -
- pagination_id string? -
owler: FeedsVO![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- amount string? -
- date string? -
- investor Investor[]? -
- 'type string? -
- undisclosed string? -
owler: FuzzyResults![](/images/permalink.svg)
owler: Investor![](/images/permalink.svg)
Fields
- company_id string? -
- name string? -
- website string? -
owler: Results![](/images/permalink.svg)
Fields
- feeds FeedsVO[]? -
- pagination_id string? -
owler: SectorVO![](/images/permalink.svg)
Fields
- name string? -
- parent_industry string? -
owler: Stock![](/images/permalink.svg)
Fields
- exchange string? -
- ticker string? -
Import
import ballerinax/owler;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Analytics
Cost/Freemium
Contributors
Dependencies