Hoover's API Version 3.3 - Company REST

Queries - REST - Company Information

IMPORTANT: All calls on this page require an Username , Password, API key

1 Get Company Detail Simple - /company/{unique_id}

1.1 Overview

Returns a reduced subset of company details for a given Hoover's Company ID or DUNS

1.2 Input URI

This is a "GET" only call.

HTTP Methods accepted Context Path Headers Sample URL
GET HooversAPI-33/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/company/13193000000000?view=simple

1.3 Input Parameters

[application/json] - Required fields are indicated with .

The query and path parameters as listed below.

Path parameters Sample Path parameters Query parameters Sample Query parameters
company/{unique_id} company/13193000000000 view={view} view=simple (This value is case sensitive)

1.4 Output Parameters

Field Name Type Values(s)
name: String company name
companyId: Number Hoovers Company ID
primaryLocation: Object JSON object used to wrap location information
primaryLocation:{ address1: String Company Address1
primaryLocation:{ address2: String Company Address2
primaryLocation:{ city: String Company City
primaryLocation:{ country: String Company Country. returns name of country instead of ID
primaryLocation:{ state: String Company State
primaryLocation:{ zip: String Postal code
primaryLocation:{ zip4: String Postal code
primaryLocation:{ latitude: decimal Latitude
primaryLocation:{ longitude: decimal longitude
primaryLocation:{ latLongAccuracy: decimal latLongAccuracy
primaryPhone Object JSON object used to wrap phone information
primaryPhone:{ countryCode: String Address Country ID
primaryPhone:{ areaCode: String Phone Number Area Code
primaryPhone:{ phoneNumber: String Phone Number
primaryURL: String Primary URL for the company
legalStatus: String Legal Status description for the company
yearFounded: String Year the company was founded
minorityOwned: Boolean Indicates if the company is owned by a minority
womenOwned: Boolean Indicates if the company is owned by women

2 Get Company Detail Basic - /company/{unique_id}

2.1 Overview

Returns a reduced subset of company details for a given Hoover's Company ID or DUNS

2.2 Input URI

This is a "GET" only call.

HTTP Methods accepted Context Path Headers Sample URL
GET HooversAPI-33/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/company/13193000000000?view=basic

2.3 Input Parameters

[application/json] - Required fields are indicated with.

The query and path parameters as listed below.

Path parameters Sample Path parameters Query parameters Sample Query parameters.
company/{unique_id} company/13193000000000 view={view} view=basic (This value is case sensitive)

2.4 Output Parameters

Name Type Value(s)
company: Object Top level JSON object used to wrap Company output data.
company: { name: String Company name
company: { duns: Number DUNS Number
company: { companyId: Number Hoovers Company ID
company: { address1: String Company Address1
company: { address2: String Company Address2
company: { city: String Company City
company: { state: String Company State
company: { zip: String Postal code
company: { zip4: String Postal code
company: { country: String Company Country
company: { latitude: Number Company geo-located latitdue
company: { longitude: Number Company geo-located longitude
company: { phoneNumber: String Phone Number
company: { companyType: String Company Type
company: { locationType: String Company Location Type
company: { ultimateParentDuns: String Company's Parent DUNs
company: { ultimateParentName: String Company's Parent Name
company: { url: String Primary URL for the company
company: { annualSales: Number Copmany's Total Annual Sales
company: { marketingPrescreenScore: String Marketing pre-screen scores. Value of either 'L' Low, 'M' Medium or 'H' High
company: { hic: String Hoovers's Industry Code
company: { naics: String NAICS Code
company: { ussic: String US SIC Code
company: { uksic: String UK SIC Code

3 Get Company Detail Full - /company/{unique_id}

3.1 Overview

Returns all the company details for a given Hoover's Company ID or DUNS

3.2 Input URI

This is a "Get" only call.

HTTP Methods accepted Context Path Headers Sample URL
GET HooversAPI-33/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/company/13193000000000?view=full

3.3 Input Parameters

[application/json] - Required fields are indicated with .

The query and path parameters as listed below.

Path parameters Sample Path parameters Query parameters Sample Query parameters.
company/{unique_id} company/13193000000000 view={view} view=full (value is case sensitive)

3.4 Output Parameters

Name Type Value(s)
companyId: Number Hoovers Company ID
duns: Number Duns number of this company.
companyType: String Company Type such as Public, Private, etc
locationType: String Company Location Type such as Head Quarters, Single Location, etc
ultimateParentDuns: Number The Ultimate Parent DUNS number
ultimateParentName: String The Ultimate Parent name corresponding to the ultimate parent DUNS number
parentDuns: Number Hoover's ID of the company's immediate parent
parentName: String Company name of this company's immediate parent.
name: String Company Name
dbaNames: Object JSON object wrapping dbaNames
dbaNames:{ dbas[]: List Array of Strings depicting Doing Business As
industries: Object JSON object that wraps all the industries information.
industries:{ primaryHIC: String HIC Code
industries:{ primaryNAICS: String NAICS Code
industries:{ primaryUSSIC: String US SIC Code
industries:{ primaryUKSIC: String Primary UK SIC Code
industries:{ allUKSIC: JSON Object JSON Object containing all the UK SIC Codes
industries:allUKSIC:{ items[]: List Collection of all UK SIC Codes and descriptions.
industries:allUKSIC:items:{ code: String UK SIC Code
industries:allUKSIC:items:{ description: String Description of industry referred to
industries:{ allUSSIC: JSON Object JSON object wrapping all US SIC Codes
industries:allUSSIC:{ items[]: List Collection of all US SIC Codes
industries:allUSSIC:items:{ ussic: String US SIC Code
industries:allUSSIC:items:{ description: String Description of the industry represented by the USSIC
industries:{ allHIC: JSON Object JSON Object wrapping all Hoovers Industry Codes
industries:allHIC:{ items[]: List Collection of all Hoovers Industry Codes
industries:allHIC:items:{ hic: String Hoovers Industry Code
industries:allHIC:items:{ description: String Description of the industry represented by the HIC
industries:{ allNAICS: JSON Object JSON Object wrapping all the NAICS codes for the company
industries:allNAICS:{ items: List Collection NAICS codes for the company
industries:allNAICS:items:{ naics: String NAICS code
industries:allNAICS:items:{ description: String Description of the industry represented by the NAICS
subsidiaryStatus: Boolean Subsidiary Status
keyNumbersHistory: JSON Object JSON object wrapping all the history of Key Numbers
keyNumbersHistory:{ annualKeyNumbersHistory: JSON Object JSON Object wrapping all the Annual Financial Figures
keyNumbersHistory:{ quarterlyKeyNumbersHistory: JSON Ojbect JSON Object wrapping all the Quarterly Financial Figures
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:{ keyNumbers: List Financial Figures
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ sales: Decimal Annual Sales. This value is in US Dollars.
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ employeesAtThisLocation: Number Employees at this Location
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ totalEmployeeGrowthPercent: Decimal Total Employee Growth % for the Year
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ researchAndDevelopment: Decimal R&D Expenses for the Year. This value is in US Dollars.
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ advertising: Decimal Advertising Expenses for the Year. This value is in US Dollars.
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ employeesTotal: Number Total Employees
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ fiscalPeriod: String Fiscal Period
keyNumbersHistory: annualKeyNumbersHistory|quarterlyKeyNumbersHistory:keyNumbers:{ periodEndMonth: String Period End Month
locations JSON Object JSON object wrapping all the Company Addresses
locations:{ locations: List List containg all the locations
locations:locations:{ address1: String Company Address
locations:locations:{ address2: String Company Address Line 2
locations:locations:{ city: String Company City
locations:locations:{ county: String Company County
locations:locations:{ state: String Company State
locations:locations:{ country: String Company Country Name
locations:locations:{ countryId: Number Company Country ID
locations:locations:{ zip: String Company Zip Code
locations:locations:{ zip4: String Company Zip Plus 4
locations:locations:{ latitude: Decimal Latitude
locations:locations:{ longitude: Decimal Longitude
locations:locations:{ latLongAccuracy: String Accuracy of latitude and longitude
locations:locations:{ addressType: String Address Type such as Primary, Headquarters, Mailing etc.
locations:locations:{ metroArea: String The metorpolitan area for the location
ownershipYear: String Ownership Year
phones: JSON Object Company Phone Numbers
phones:{ phoneNumbers| faxNumbers[]: List Company Phone Numbers. Phone as well as faxNumbers are now under this element.
phones: phoneNumber|faxNumber:{ areaCode: String Phone Number Area Code
phones:phoneNumber| faxNumber:{ countryCode: String Address Country ID
phones:phoneNumber| faxNumber:{ phoneNumber: String Phone Number
synopsis: String Company Description
full-description: String Full Company Description
historicalIndicator: Boolean Flag to Indicate Boneyard Company. True means Boneyard Company
historicalText String Brief description of why the company is defunct
stocks: JSON Object JSON Ojbect wrapping all the Ticker information for this company.
stocks:{ tickerUS: String Ticker Symbol used for this company.
stocks:{ exchangeInfoList: JSON Object JSON Object wrapping all the Exchange information.
stocks:exchangeInfoList:{ exchangeInfos[]: List List of exchange information.
stocks:exchangeInfoList:exchangeInfos:{ country: String Country name where exchange is located.
stocks:exchangeInfoList:exchangeInfos:{ tickerSymbol: String Ticker Symbol used for this company in this exchange.
stocks:exchangeInfoList:exchangeInfos:{ exchangeName: String Exchange name where this company is traded.
topExecutives JSON Object JSON Object wrapping Top 3 Company Executives
topExecutives:{ officials[]: List List of Top Executives
topExecutives:officials:{ coOfficialId: Number Hoovers Official ID
topExecutives:officials:{ latestPosition: String Most recent position information
topExecutives:officials:latestPosition:{ title: String Person Title
topExecutives:officials:latestPosition:{ startYear: String Latest position start year
topExecutives:officials:latestPosition:{ endYear: String Latest position end year
topExecutives:officials:{ latestSalary: JSON Object JSON Object containg the most recent salary information
topExecutives:officials:latestSalary:{ year: Number Latest salary year
topExecutives:officials:latestSalary:{ salary: Decimal Salary for the year, excluding bonus in USD
topExecutives:officials:latestSalary:{ totalSalary: Decimal Total compensation for the year, including any bonus or other compensation in USD
topExecutives:officials:latestSalary:{ bonus: Decimal Bonus for the year, in USD
topExecutives:officials:{ person: JSON Object Most recent salary information
topExecutives:officials:person:{ fullName: String Person Full Name
topExecutives:officials:person:{ lastName: String Person Last Name
topExecutives:officials:person:{ firstName: String Person First Name
topExecutives:officials:person:{ middleName: String Person Middle Name
topExecutives:officials:person:{ suffix: String Person Suffix
topExecutives:officials:person:{ prefix: String Person Prefix
topExecutives:officials:person:{ age: Number Person Age
topExecutives:officials:connectMail JSON Object Wrapper element for ConnectMail indicators
topExecutives:officials:connectMail:{ connectMailNameSource: Boolean Indicates if official's name is a ConnectMail contact
topExecutives:officials:connectMail:{ connectMailEmailSource: Boolean Indicates if official's email is a ConnectMail contact
topExecutives:officials:connectMail:{ connectMailPhoneSource: Boolean Indicates if official's phone number is a ConnectMail contact
familyTreeLink String Corporate Family Tree Link
primaryURLs JSON Object Company Primary URLs in sorted in ascending order
primaryUrls:{ primaryUrls[]: List List of primary url information
primaryUrls:primaryUrls:{ sortOrder: Number A number indicating the relative order of the accompanying url among all primary urls
primaryUrls:primaryUrls:{ url: String A primary url for a company
otherURLs: JSON Object JSON Object wrapping information about other Company Urls
otherURLs:{ urls[]: List List of Company urls
accountingFirm: String The accounting firm/auditor for this company.
bankName: String The bank name for this company.
marketingPreScreenScore: String The D&B Marketing Prescreen value for this company.
keyFinancials: JSON Object JSON Object wrapping all the market value and income asset information.
keyFinancials:{ marketValueInfo: JSON Object Contains market value information
keyFinancials:marketValueInfo:{ marketValue: Decimal Market value (in millions of USD) of this company.
keyFinancials:marketValueInfo:{ marketValueDate: Date Date of market valuation.
keyFinancials:{ incomeAssets: JSON Object Contains income asset information.
keyFinancials:incomeAssets:{ period: String Fiscal Period reporting date.
keyFinancials:incomeAssets:{ assets: Decimal Total assets (in millions of USD) of this company.
keyFinancials:incomeAssets:{ salesGrowthPercent: Decimal Sales growth in percent for this company.
keyFinancials:incomeAssets:{ netIncome: Decimal Net income (in millions of USD) of this company.
keyFinancials:incomeAssets:{ netIncomeGrowthPercent: Decimal Net income growth in percent of this company.
ukSpecs: JSON Object UK-specific information.
ukSpecs:{ uKRegistration: String UK Registration Number. e.g. 3443456 or 3443456, 0764797
ukSpecs:{ uKVAT: String UK Vat Number. e.g. 906565610 or 906565610, 466264724
ukSpecs:{ numberOfSubsidiaries: JSON Object Number of subsidiaries
ukSpecs:numberOfSubsidiaries:{ domestic: Number Number of subsidiaries in the UK
numberOfPCs: Number Number of PCs at the company
spaceAtAddress: Number Space in square feet at the location
spaceAtAddressUnitOfMeasurement: String Unit of measurement for spaceAtAddress
spaceAtAddressAccuracy: Number Accuracy of spaceAtAddress field
ownedOrLeased: String Indicates if the company's location is owned/leased
manufacturingIndicator: String Indicates if the company is a manufacturer
legalStatus: String Legal Status description for the company
yearFounded: String Year the company was founded
minorityOwned: Boolean Indicates if the company is owned by a minority
ethnicity: String Ethnicity of business owner.
womenOwned: Boolean Indicates if the company is owned by women
rankings: JSON Object A list of rankings for the company such as Fortune 500
rankings:{ ranks: List A list of rankings for the company such as Fortune 500. It is a Json object
rankings:ranks{ rankNumber: Number Within a particular ranking this is the companies rank, such as number 100 on the Fortune 500
rankings:ranks{ definition: String The name of the ranking, such as Fortune 500

4 Advanced Company Search - search/company/advanced

4.1 Overview

Returns search result of companies based on varying different criteria

4.2 Input URI

This is a "POST" only call not requiring any query or path parameters other than listed.

HTTP Methods Accepted Context Path Headers Sample URL
POST HooversAPI-33/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/search/company/advanced?hit_offset=0&max_records=20&sort_direction=ascending&order_by=company_name

4.3 Input Parameters

4.3.1 Path Parameters

All path parameters are named in lowercase, with an underscore separator for multiple words.

Path Parameter Sample Type Value(s)
N/A N/A N/A N/A

4.3.2 Query Parameters

All query parameters are named in lowercase, with an underscore separator for multiple words.

Query Parameter Sample Type Value(s)
hit_offset={hit_offset} hit_offset=0 Number Greater than or equal to 0 but less than or equal to 10,000. Default = 0. Paging support, the firstHit returned will be hitOffset + 1. hitOffset is zero-based.
max_records={max_records} max_records=20 Number Between 1-200. Default = 20
sort_direction={sort_direction} sort_direction=ascending String Default sort direction is ascending. Other values for this search include:
  • ascending
  • descending
return_search_navigation={return_search_navigation} return_search_navigation=false Boolean Default return search navigation is false. Other values for this search include:
  • false
  • true
order_by={order_by} order_by=company_name String Default order by is relevance. Other values for this search include:
  • company_name
  • company_type
  • country_name
  • city_name
  • state_name
  • phone_number
  • fax_number
  • sales_growth_12_mon
  • total_assets
  • sales_us
  • employees_total
  • employees_here
  • fiscal_year_end_month
  • merket_cap
  • net_income_growth_12_mon
  • employee_growth_12_mon
  • roe
  • roa
  • earnings_compairson
  • book_value_comparison
  • net_income
  • person_first_name
  • person_last_name
  • person_title

4.3.3 JSON Entity

Media type 'application/json'

Name Type Value(s)
companySize: Object Top level JSON object used to wrap CompanySize input data.
companySize: { employeesFrom: Number Total Employees Lower Bound
companySize: { employeesTo: Number Total Employees Upper Bound
companySize: { employeesGrowthFrom: Number Total Employees Growth Percentage Lower Bound
companySize: { employeesGrowthTo: Number Total Employees Growth Percentage Upper Bound
companySize: { employeesThisLocationFrom: Number Employees at this Location Lower Bound
companySize: { employeesThisLocationTo: Number Employees at this Location Upper Bound
companySize: { marketCapFrom: Number Market Cap ($ mil) Lower Bound
companySize: { marketCapTo: Number Market Cap ($ mil) Upper Bound
companySize: { salesFrom: Number Annual Sales ($ mil) Lower Bound
companySize: { salesTo: Number Annual Sales ($ mil) Upper Bound
companySize: { salesGrowthFrom: Number Annual Sales Growth (%) Lower Bound
companySize: { salesGrowthTo: Number Annual Sales Growth (%) Upper Bound
companyType: Object Top level JSON object used to wrap CompanyType input data.
companyType: { locationType: [n,n...] Array of Numbers ID Value from GetAdvancedSearchLookups<
companyType: { ownershipType: [n,n...] Array of Numbers Values are 1 (Public), 21 (Owned by a Public Company) or 0 (Non-Public)
companyType: { subsidiaryStatus: [n,n...] Array of Numbers Subsidiary or Not a Subsidiary
financialData: Object Top level JSON object used to wrap FinancialData input data.
financialData: { advertisingExpenseFrom: Number Ad Expense ($ mil) Lower Bound.
financialData: { advertisingExpenseTo: Number Ad Expense ($ mil) Upper Bound.
financialData: { assetsFrom: Number Assets ($ mil) Lower Bound.
financialData: { assetsTo: Number Assets ($ mil) Upper Bound.
financialData: { filingDateFrom: String Filing Date Lower Bound. Format - YYYY-MM-DD
financialData: { filingDateTo: String Filing Date Upper Bound. Format - YYYY-MM-DD
financialData: { fiscalYearEnd: Array of Numbers Fiscal Year End Month
financialData: { incomeFrom: Number Net Income ($ mil) Lower Bound.
financialData: { incomeGrowthFrom: Number Net Income Growth (%) Lower Bound
financialData: { incomeGrowthTo: Number Net Income Growth (%) Upper Bound
financialData: { incomeTo: Number Net Income ($ mil) Upper Bound
financialData: { marketingPreScreenScore: Array of Strings Values of either 'l' Low, 'm' Medium or 'h' High accepted. Allows for unique combinations of the preseeding values from 0 to 3.
financialData: { offerFrom: Number US IPO Data - Offer Amount ($ mil.) Lower Bound
financialData: { offerTo: Number US IPO Data - Offer Amount ($ mil.) Upper Bound
financialData: { priceRangeFrom: Number US IPO Data - Price Range ($) Lower Bound
financialData: { priceRangeTo: Number US IPO Data - Price Range ($) Upper Bound
financialData: { researchExpenseFrom: Number R&D Expense ($ mil) Lower Bound
financialData: { researchExpenseTo: Number R&D Expense ($ mil) Upper Bound
financialData: { tradingDateFrom: String Trading Date Lower Bound. Format - YYYY-MM-DD
financialData: { tradingDateTo: String Trading Date Upper Bound. Format - YYYY-MM-DD
financialData: { underwriterId: Array of Numbers ID Value from GetAdvancedSearchLookups It searches only the lead underwriter for the given underwriterId.
industry: Object Top level JSON object used to wrap Industry input data.
industry: { hooversIndustryCode: Array of Strings ID Value from GetAdvancedSearchLookups
industry: { primaryOnly: Boolean Primary Industry Only
industry: { nAICS: Array of Strings Enter at least two digits per code. No CSV or Ranges can be specified
industry: { nAICSRange:[ {from:,to:}... ] Array of Objects Enter one or more range object. Each range object must contain 'from' and a 'to' object.
industry: { uSSIC: Array of Strings Enter at least two digits per code. No CSV or Ranges can be specified
industry: { uSSICRange:[ {from:,to:}... ] Array of Objects Enter one or more range object. Each range object must contain 'from' and a 'to' object.
industry: { uKSIC: Array of Strings Enter at least two digits per code. No CSV or Ranges can be specified
industry: { uKSICRange:[ {from:,to:}... ] Array of Objects Enter one or more range object. Each range object must contain 'from' and a 'to' object.
location: Object Top level JSON object used to wrap Location input data.
location: { areacode: Array of Strings US/Canada Area Code
location: { streetAddress: Array of Strings Street Address - e.g. 1700 Pennsylvania Ave.
location: { county: Array of county Objects  
location: { county: { countyId: String ID Value from GetAdvancedSearchLookups
location: { county: { state: String ID Value from GetAdvancedSearchLookups
location: { county: { countryId: String ID Value from GetAdvancedSearchLookups
location: { city: Array of Strings City - e.g. Madrid or New York
location: { countryId: Array of Numbers ID Value from GetAdvancedSearchLookups
location: { globalState: Array of Strings Global State/Province - e.g Queensland or NY
location: { metropolitanId: Number US Metropolitan Area - ID Value from GetAdvancedSearchLookups
location: { regionId: Array of Numbers World Region - ID Value from GetAdvancedSearchLookups
location: { usStateCanadaProvince: Array of Strings US State/Canada Province
location: { postalCode: Array of Strings Postal Code - e.g. 78701 or "SW1P 1JA" or "SW1"
location: { usZipCodeRange: Array of Objects Top level JSON object used to wrap USZipCodeRange input data.
location: { usZipCodeRange: { from: Number US ZIP Code Lower Bound
location: { usZipCodeRange: { to: Number US ZIP Code Upper Bound
location: { zipAreaSearch: Object Top level JSON object used to wrap ZipAreaSearch input data.
location: { zipAreaSearch: { scale: String Units to search in: miles or kilometers - e.g. Find results within 50 miles of 78745 (up to a maximum radius of 100 miles or 160 km). Use only one 5-digit ZIP code. Requires zipareawithin and zipareazipcode.
  • miles
  • kilometers
location: { zipAreaSearch: { radius:: Number # of miles or kilometers to search within - e.g. Find results within 50 miles of 78745 (up to a maximum radius of 100 miles or 160 km). Use only one 5-digit ZIP code. Requires zipareawithin and zipareazipcode.
location: { zipAreaSearch: { zipCode: String Zipcode to search within (78745 in the example) - e.g. Find results within 50 miles of 78745 (up to a maximum radius of 100 miles or 160 km). Use only one 5-digit ZIP code. Requires zipareawithin and zipareazipcode.
location: { latLongSearch: Object Top level JSON object used to wrap LatLongSearch input data.
location: { latLongSearch: { scale: String Units to search in: miles or kilometers
  • miles
  • kilometers
Requires radius, latitude, and longitude.
location: { latLongSearch: { radius: Number # of miles or kilometers to search within. Requires scale, latitude, and longitude.
location: { latLongSearch: { latitude: Number latitude. Requires scale, radius, and longitude.
location: { latLongSearch: { longitude: Number longitude. Requires scale, radius, and latitude.
location: { allAny: String All or Any Matches on Location Criteria. Matching ALL means a company would have to match each type of criteria entered. Matching ANY means that a company could match any single type of criteria entered. Valid values All or Any
  • all
  • any
location: { ukCounty: Array of Strings A valid UK county name
specialtyCriteria: Object Top level JSON object used to wrap SpecialtyCriteria input data.
specialtyCriteria: { auditorId: Array of Numbers ID Value from GetAdvancedSearchLookups
specialtyCriteria: { companyKeyword: String Company Keyword - e.g. laptops or China or acquired, merged, takeover
specialtyCriteria: { duns: Array of Numbers DUNS Number. The duns number must not be more than 9 digits.
specialtyCriteria: { exchangeId: Array of Numbers ID Value from GetAdvancedSearchLookups
specialtyCriteria: { rankingId: Array of Numbers ID Value from GetAdvancedSearchLookups
specialtyCriteria: { ukRegistration: Array of Strings UK Registration Number - e.g. 3443456
specialtyCriteria: { ukVat: Array of Strings UK Vat Number - e.g. 906565610
specialtyCriteria: { yearFoundingFrom: Number Year of Founding or Change in Control Lower Bound. Format - YYYY
specialtyCriteria: { yearFoundingTo: Number Year of Founding or Change in Control Upper Bound. Format - YYYY
specialtyCriteria: { ultimateParentDuns: Array of Numbers The ultimate parent DUNS number for a family of companies - eg. 060902413 or 884364530
specialtyCriteria: { primaryUrl: Array of Strings Primary URL
specialtyCriteria: { companyName: String Company Name
specialtyCriteria: { minorityOwned: Boolean Minority Owned Company (true/false)
specialtyCriteria: { womenOwned: Boolean Women Owned Company (true/false)
specialtyCriteria: { squareFootageFrom: Number Company square foot range from
specialtyCriteria: { squareFootRangeTo: Number Company square foot range to
specialtyCriteria: { ethnicity: Array of Strings Ethnicity of the company owner
  • asn
  • blk
  • hsp
  • isu
  • nat
  • unk
specialtyCriteria: { legalStatus: Array of Strings Legal Status of the company
  • corporation
  • partnership
  • proprietorship
  • national_government_entity
  • regional_local_government_entity
  • joint_venture
  • non_profit_organization
  • co_operative_mutual_organization
  • foreign_company
specialtyCriteria: { ownedOrRented: String Company resides in Owned or Rented Space
  • owned
  • rented
searchNavigation: Object Top level JSON object used to wrap Search Navigation input data.
searchNavigation: { employeeSearchNavigation: Object Top level JSON object used to wrap Employee Search Navigation input data.
searchNavigation { employeeSearchNavigation: { employeeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { ownershipTypeSearchNavigation: Object Top level JSON object used to wrap OwnerShip type Search Navigation input data.
searchNavigation { ownershipTypeSearchNavigation: { ownershipTypeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { locationTypeSearchNavigation: Object Top level JSON object used to wrap Location type Search Navigation input data.
searchNavigation { locationTypeSearchNavigation: { locationTypeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { salesSearchNavigation: Object Top level JSON object used to wrap sales Search Navigation input data.
searchNavigation { salesSearchNavigation: { salesSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { locationSearchNavigation: Object Top level JSON object used to wrap Location Search Navigation input data.
searchNavigation { locationSearchNavigation: { countryNavigation: Object Top level JSON object used to wrap Country Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation: { countryNavigationValue: String Value from GetAdvancedSearchLookups
searchNavigation { locationSearchNavigation { countryNavigation: { stateNavigation: Object Top level JSON object used to wrap State Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation: { stateNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation: { cityNavigation: Object Top level JSON object used to wrap City Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation { cityNavigation: { cityNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { industrySearchNavigation: Object Top level JSON object used to wrap sales Industry Navigation input data.
searchNavigation { industrySearchNavigation: { industrySearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { industrySearchNavigation: { ussicSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { industrySearchNavigation: { naicsSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups

4.3.4 Sample JSON for POST - contains ALL fields with invalid values, only use what you need

    
{
    "companySize":{
        "employeesFrom":n,
        "employeesTo":n,
        "employeesGrowthFrom":n,
        "employeesGrowthTo":n,
        "employeesThisLocationFrom":n,
        "employeesThisLocationTo":n,
        "marketCapFrom":n,
        "marketCapTo":n,
        "salesFrom":n,
        "salesTo":n,
        "salesGrowthFrom":n,
        "salesGrowthTo":n,
    },
    "companyType":{
        "locationType": [n,n...],
        "ownershipType": [n,n...],
        "subsidiaryStatus": [n,n...]
    },
    "financialData":{
        "advertisingExpenseFrom":n,
        "advertisingExpenseTo":n,
        "assetsFrom":n,
        "assetsTo":n,
        "filingDateFrom":"",
        "filingDateTo":"",
        "fiscalYearEnd":[n,n,...],
        "incomeFrom":n,
        "incomeGrowthFrom":n,
        "incomeGrowthTo":n,
        "incomeTo":n,
        "marketingPrescreenScore":["","",...],
        "offerFrom":n,
        "offerTo":n,
        "priceRangeFrom":n,
        "priceRangeTo":n,
        "researchExpenseFrom":n,
        "researchExpenseTo":n,
        "tradingDateFrom":"",
        "tradingDateTo":"",
        "underwriterId":[n,n,...],
    },
    "industry":{
        "hooversIndustryCode":["","",...],
        "primaryOnly":boolean,
        "nAICS":["","",...],
        "nAICSRange":[{from:"",to:""}... ],
        "uSSIC":["","",...],
        "uSSICRange":[{from:"",to:""}... ],
        "uKSIC":["","",...],
        "uKSICRange":[{from:"",to:""}... ]
    },
    "location":{
        "areacode":["","",...],
        "streetAddress":["","",...],
        "county":[
            {
                "countyId":n,
                "state":"",
                "countryId":n
            },
            ...
        ],
        "city":["","",...],
        "countryId":[n,n,...],
        "globalState":["","",...],
        "metropolitanId":[n,n,...],
        "regionId":[n,n,...],
        "usStateCanadaProvince":["","",...],
        "postalCode":["","",...],
        "usZipCodeRange":[{"from":n,"to":n},...],
        "zipAreaSearch":{
            "scale":"",
            "radius":n,
            "zipCode":""
        },
        "latLongSearch":{
            "scale":"",
            "radius":n,
            "latitude":n,
            "longitude":n
        },
        "allAny":"",
        "ukCounty":["","",...],
    },
    "specialtyCriteria":{
        "auditorId":[n,n,...],
        "companyKeyword":"",
        "duns":[n,n,...],
        "exchangeId":[n,n,...],
        "rankingId":[n,n,...],
        "ukRegistration":["","",...],
        "ukVat":["","",...],
        "yearFoundingFrom":n,
        "yearFoundingTo":n,
        "ultimateParentDuns":[n,n,...],
        "primaryUrl":["","",...],
        "companyName":"",
        "minorityOwned":boolean,
        "womenOwned":boolean,
        "squareFootageFrom":n,
        "squareFootRangeTo":n,
        "ethnicity":["","",...],
        "legalStatus":["","",...],
        "ownedOrRented":""
    },
    "searchNavigation":{
        "employeeSearchNavigation":{
            "employeeSearchNavigationValue":["","",...]
        },
        "ownershipTypeSearchNavigation":{
            "ownershipTypeSearchNavigationValue":["","",...]
        },
        "locationTypeSearchNavigation":{
            "locationTypeSearchNavigationValue":["","",...]
        },
        "salesSearchNavigation":{
            "salesSearchNavigationValue":["","",...]
        },
        "locationSearchNavigation":{
            "countryNavigation":{
                "countryNavigationValue":["","",...],
                "stateNavigation":{
                    "stateNavigationValue":["","",...],
                        "cityNavigation":{
                            "cityNavigationValue":["","",...]
                        }
                }
            }
        },
        "industrySearchNavigation":{
            "industrySearchNavigationValue":["","",...],
            "ussicSearchNavigationValue":["","",...],
            "naicsSearchNavigationValue":["","",...]
        }
    }
}
    

4.4 Output Parameters

Media type 'application/json; charset=UTF-8;'

Name Type Value(s)
companies: Object  
companies: { firstHit Number First Hit
companies: { lastHit Number Last Hit
companies: { hits Number Total Number of Hits in this Response
companies: { totalHits Number Aggregate Total Number of Hits. This is the total number of results the search returned.
companies: { hit: Object  
companies: { hit: { hitNumber Number Hit Number
companies: { hit: { companyResults: Object  
companies: { hit: { companyResults: { locationType: String location type of the company
companies: { hit: { companyResults: { address1: String Address of the company
companies: { hit: { companyResults: { city: String City
companies: { hit: { companyResults: { country: String Country
companies: { hit: { companyResults: { countryId: Number Country Id
companies: { hit: { companyResults: { stateOrProvince: String State or Province
companies: { hit: { companyResults: { primaryUrl: String Primary Url of the company
companies: { hit: { companyResults: { parentDuns: Number Parent Duns Number
companies: { hit: { companyResults: { ultimateParentDuns: Number Ultimate Parent Duns
companies: { hit: { companyResults: { sales: Number Sales of the company
companies: { hit: { companyResults: { hqPhone: String Head Quarters Phone Number
companies: { hit: { companyResults { dbas { dba: [ Array of Strings dbas
companies: { hit: { companyResults:: { historicalIndicator Boolean Indicates any boneyard companies
companies: { hit: { companyResults: { companyName: String Company Name
companies: { hit: { companyResults: { companyId: Number Company Id
companies: { hit: { companyResults: { duns: Number Duns Id of the comapany
navigators: { Object Navigation values for the companies
navigators:{ employeeNavigators: { Object Employee Navigation values for the companies
navigators:{ employeeNavigators: { employeeNavigator: [ List List of Employee navigation values
navigators:{ employeeNavigators: {employeeNavigator: [employeeNavigatorValue: String Employee Navigator value
navigators:{ employeeNavigators: {employeeNavigator: [employeeNavigatorDescription: String Employee Navigator Description
navigators:{ locationTypeNavigators: { Object Location Type Navigation values for the companies
navigators:{ locationTypeNavigators: {locationTypeNavigator: [ List of Location Type Navigators List of Location Type navigation values
navigators:{ locationTypeNavigators: {locationTypeNavigator: [locationTypeNavigatorValue: String Location Type Navigator value
navigators:{ locationTypeNavigators: {locationTypeNavigator: [locationTypeNavigatorDescription: String Location Type Navigator Description
navigators:{ ownershipTypeNavigators: { Object Ownership Type Navigation values for the companies
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ List of Ownership Type Navigators List of Ownership Type navigation values
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ownershipTypeNavigatorValue: String Ownership Type Navigator value
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ownershipTypeNavigatorDescription: String Ownership Type Navigator Description
navigators:{ salesNavigators: { Object Sales Navigation values for the companies
navigators:{ salesNavigators {salesNavigator: [ List of Sales Navigators List of Sales navigation values
navigators:{ salesNavigators: {salesNavigator: [salesNavigatorValue: String Sales Navigator value
navigators:{ salesNavigators: {salesNavigator: [salesNavigatorDescription: String Sales Navigator Description
navigators:{ locationNavigators: { Object Location Navigation values for the companies
navigators:{ locationNavigators: {countryNavigators { Object Country Navigators
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ List of Country Navigators Country Navigation values
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[countryNavigatorValue : String Country Navigation value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[countryNavigatorDescription : String Country Navigation value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[stateProvinceNavigator : { Object State or Province Navigator
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {stateProvinceNavigatorValue : String State or Province Navigator value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {stateProvinceNavigatorDescription : String State or Province Navigator description
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators :{ Object City Navigator
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ List list of City Navigators
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ cityNavigatorValue : String City Navigator value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ cityNavigatorDescription : String City Navigator Description
navigators:{ industryNavigators: { Object Industry Navigation values for the companies
navigators:{ industryNavigators: {industrySearchNavigationValue: [ Array of Strings List of Industry navigation values
navigators:{ industryNavigators: {naicsSearchNavigationValue: [ Array of Strings List of NAICS search navigation values
navigators:{ industryNavigators: {ussicSearchNavigationValue: [ Array of Strings List of USSIC search navigation values

5 Find Company By Keyword - /search/company/{keyword}

5.1 Overview

Returns search result of companies based on varying different criteria

5.2 Input URI

This is a "POST" only call not requiring any query or path parameters other than listed.

HTTP Methods Accepted Context Path Headers Sample URL
POST HooversAPI-33/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/search/company/Hoovers?hit_offset=0&max_records=20&sort_direction=ascending&order_by=company_name

5.3 Input Parameters

5.3.1 Path Parameters

All path parameters are named in lowercase, with an underscore separator for multiple words.

Path Parameter Sample Type Value(s)
search/company/{keyword} search/company/Hoovers

5.3.2 Query Parameters

All query parameters are named in lowercase, with an underscore separator for multiple words.

Query Parameter Sample Type Value(s)
hit_offset={hit_offset} hit_offset=0 Number Greater than or equal to 0 but less than or equal to 10,000. Default = 0. Paging support, the firstHit returned will be hitOffset + 1. hitOffset is zero-based.
max_records={max_records} max_records=20 Number Between 1-200. Default = 20
search_by={search_by} search_by=company_name String
  • company_name
  • stock_symbol
return_search_navigation={return_search_navigation} return_search_navigation=false Boolean Default return search navigation is false. Other values for this search include:
  • false
  • true
sort_direction={sort_direction} sort_direction=ascending String Default sort direction is ascending. Other values for this search include:
  • ascending
  • descending
order_by={order_by} order_by=company_name String Default order by is relevance. Other values for this search include:
  • company_name
  • company_type
  • country_name
  • city_name
  • state_name
  • phone_number
  • fax_number
  • sales_growth_12_mon
  • total_assets
  • sales_us
  • employees_total
  • employees_here
  • fiscal_year_end_month
  • merket_cap
  • net_income_growth_12_mon
  • employee_growth_12_mon
  • roe
  • roa
  • earnings_compairson
  • book_value_comparison
  • net_income
  • person_first_name
  • person_last_name
  • person_title

5.3.3 JSON Entity

Media type 'application/json'

Name Type Value(s)
searchNavigation: Object Top level JSON object used to wrap Search Navigation input data.
searchNavigation: { employeeSearchNavigation: Object Top level JSON object used to wrap Employee Search Navigation input data.
searchNavigation { employeeSearchNavigation: { employeeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { ownershipTypeSearchNavigation: Object Top level JSON object used to wrap OwnerShip type Search Navigation input data.
searchNavigation { ownershipTypeSearchNavigation: { ownershipTypeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { locationTypeSearchNavigation: Object Top level JSON object used to wrap Location type Search Navigation input data.
searchNavigation { locationTypeSearchNavigation: { locationTypeSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { salesSearchNavigation: Object Top level JSON object used to wrap sales Search Navigation input data.
searchNavigation { salesSearchNavigation: { salesSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { locationSearchNavigation: Object Top level JSON object used to wrap Location Search Navigation input data.
searchNavigation { locationSearchNavigation: { countryNavigation: Object Top level JSON object used to wrap Country Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation: { countryNavigationValue: String Value from GetAdvancedSearchLookups
searchNavigation { locationSearchNavigation { countryNavigation: { stateNavigation: Object Top level JSON object used to wrap State Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation: { stateNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation: { cityNavigation: Object Top level JSON object used to wrap City Navigation input data.
searchNavigation { locationSearchNavigation { countryNavigation { stateNavigation { cityNavigation: { cityNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation: { industrySearchNavigation: Object Top level JSON object used to wrap sales Industry Navigation input data.
searchNavigation { industrySearchNavigation: { industrySearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { industrySearchNavigation: { ussicSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups
searchNavigation { industrySearchNavigation: { naicsSearchNavigationValue: Array of Strings Value from GetAdvancedSearchLookups

5.3.4 Sample JSON for POST - contains ALL fields with invalid values, only use what you need

    
{
    "searchNavigation":{
        "employeeSearchNavigation":{
            "employeeSearchNavigationValue":["","",...]
        }
        "ownershipTypeSearchNavigation":{
            "ownershipTypeSearchNavigationValue":["","",...]
        }
        "locationTypeSearchNavigation":{
            "locationTypeSearchNavigationValue":["","",...]
        }
        "salesSearchNavigation":{
            "salesSearchNavigationValue":["","",...]
        }
        "locationSearchNavigation":{
            "countryNavigation":[{
                "countryNavigationValue":"",
                "stateNavigation":[{
                    "stateNavigationValue":"",
                        "cityNavigation":[{
                            "cityNavigationValue":""
                        }]
                }]
            }]
        }
        "industrySearchNavigation":{
            "industrySearchNavigationValue":["","",...],
            "ussicSearchNavigationValue":["","",...],
            "naicsSearchNavigationValue":["","",...]
        }
    }
}
    

5.4 Output Parameters

Media type 'application/json; charset=UTF-8;'

Name Type Value(s)
resultSet: Object  
resultSet: { firstHit Number First Hit
resultSet: { lastHit Number Last Hit
resultSet: { hits Number Total Number of Hits in this Response
resultSet: { totalHits Number Aggregate Total Number of Hits. This is the total number of results the search returned.
resultSet: { hit: Object  
resultSet: { hit: { hitNumber Number Hit Number
resultSet: { hit: { companyResults: Object  
resultSet: { hit: { companyResults: { locationType: String location type of the company
resultSet: { hit: { companyResults: { address1: String Address of the company
resultSet: { hit: { companyResults: { city: String City
resultSet: { hit: { companyResults: { country: String Country
resultSet: { hit: { companyResults: { countryId: Number Country Id
resultSet: { hit: { companyResults: { stateOrProvince: String State or Province
resultSet: { hit: { companyResults: { primaryUrl: String Primary Url of the company
resultSet: { hit: { companyResults: { parentDuns: Number Parent Duns Number
resultSet: { hit: { companyResults: { ultimateParentDuns: Number Ultimate Parent Duns
resultSet: { hit: { companyResults: { sales: Number Sales of the company
resultSet: { hit: { companyResults: { hqPhone: String Head Quarters Phone Number
resultSet: { hit: { companyResults { dbas { dba: [ Array of Strings dbas
resultSet: { hit: { companyResults:: { historicalIndicator Boolean Indicates any boneyard companies
resultSet: { hit: { companyResults: { companyName: String Company Name
resultSet: { hit: { companyResults: { companyId: Number Company Id
resultSet: { hit: { companyResults: { duns: Number Duns Id of the comapany
navigators: { Object Navigation values for the companies
navigators:{ employeeNavigators: { Object Employee Navigation values for the companies
navigators:{ employeeNavigators: { employeeNavigator: [ List List of Employee navigation values
navigators:{ employeeNavigators: {employeeNavigator: [employeeNavigatorValue: String Employee Navigator value
navigators:{ employeeNavigators: {employeeNavigator: [employeeNavigatorDescription: String Employee Navigator Description
navigators:{ locationTypeNavigators: { Object Location Type Navigation values for the companies
navigators:{ locationTypeNavigators: {locationTypeNavigator: [ List of Location Type Navigators List of Location Type navigation values
navigators:{ locationTypeNavigators: {locationTypeNavigator: [locationTypeNavigatorValue: String Location Type Navigator value
navigators:{ locationTypeNavigators: {locationTypeNavigator: [locationTypeNavigatorDescription: String Location Type Navigator Description
navigators:{ ownershipTypeNavigators: { Object Ownership Type Navigation values for the companies
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ List of Ownership Type Navigators List of Ownership Type navigation values
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ownershipTypeNavigatorValue: String Ownership Type Navigator value
navigators:{ ownershipTypeNavigators: {ownershipTypeNavigator: [ownershipTypeNavigatorDescription: String Ownership Type Navigator Description
navigators:{ salesNavigators: { Object Sales Navigation values for the companies
navigators:{ salesNavigators {salesNavigator: [ List of Sales Navigators List of Sales navigation values
navigators:{ salesNavigators: {salesNavigator: [salesNavigatorValue: String Sales Navigator value
navigators:{ salesNavigators: {salesNavigator: [salesNavigatorDescription: String Sales Navigator Description
navigators:{ locationNavigators: { Object Location Navigation values for the companies
navigators:{ locationNavigators: {countryNavigators { Object Country Navigators
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ List of Country Navigators Country Navigation values
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[countryNavigatorValue : String Country Navigation value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[countryNavigatorDescription : String Country Navigation value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[stateProvinceNavigator : { Object State or Province Navigator
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {stateProvinceNavigatorValue : String State or Province Navigator value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {stateProvinceNavigatorDescription : String State or Province Navigator description
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators :{ Object City Navigator
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ List list of City Navigators
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ cityNavigatorValue : String City Navigator value
navigators:{ locationNavigators: {countryNavigators :{countryNavigator :[ stateProvinceNavigator: {cityNavigators {:cityNavigator :[ cityNavigatorDescription : String City Navigator Description
navigators:{ industryNavigators: { Object Industry Navigation values for the companies
navigators:{ industryNavigators: {industrySearchNavigationValue: [ Array of Strings List of Industry navigation values
navigators:{ industryNavigators: {naicsSearchNavigationValue: [ Array of Strings List of NAICS search navigation values
navigators:{ industryNavigators: {ussicSearchNavigationValue: [ Array of Strings List of USSIC search navigation values

6 Find Company By Keyword Basic - Autocomplete - /search/company/basic/{keyword}

6.1 Overview

Returns limited search results of companies based on keyword. If you are implementing an autocomplete feature, we suggest using this call as it will be the quickest due to limited backend processing and a smaller payload on the response.

6.2 Input URI

This is a "GET" only call not requiring any query or path parameters other than listed.

HTTP Methods Accepted Context Path Headers Sample URL
GET HooversAPI-%version%/rest "username" and "password" HTTP headers are mandatory http://hapi.hoovers.com/HooversAPI-33/rest/search/company/basic/Hoovers?limit=5

6.3 Input Parameters

6.3.1 Path Parameters

All path parameters are named in lowercase, with an underscore separator for multiple words.

Path Parameter Sample Type Value(s)
search/company/basic/{keyword} search/company/basic/Hoovers

6.3.2 Query Parameters

All query parameters are named in lowercase, with an underscore separator for multiple words.

Query Parameter Sample Type Value(s)
limit={limit} limit=0 Number Greater than or equal to 0 but less than or equal to 10. Default = 5.

6.4 Output Parameters

Media type 'application/json; charset=UTF-8;'

Name Type Value(s)
companies: Array  
companies: { link: Object Contains a relative URI to the specific company and the URI's relationship to the company
companies: { link: { rel: String The URI's type, in this case, a link to the company's basic profile
companies: { link: { http: String URI of the basic view of the company
companies: { duns: Number DUNS of the company
companies: { companyId: Number Hoover's Company ID of the company
companies: { companyName: String Company Name
companies: { revenue: Number Annual Revenue in Millions USD
companies: { city: String City
companies: { state: String State