Hoover's API Version 3.0 - Person
Queries - Person Information
New features are highlighted.
1 Find Person By Keyword Search
1.1 Overview
Returns search result of people based on keyword. The keyword should be a person's name or part of a name.
1.2 Input Parameters
Required fields are indicated with.
| Field Name | Value | Notes |
| keyword | String containing a keyword. Keyword should be a name of a person or part of a name | |
| maxRecords | Between 1-200. Default = 20 | |
| hitOffset | 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 now zero-based. |
| sortDirection | Values defined in WSDL: sortDirectionTypes - Ascending or Descending | This has no effect without a valid orderBy. |
| orderBy | Values defined in WSDL, orderByTypes | Default order by is relevance. Other values for this search include:
|
| returnSearchNavigation | 'true' or 'false' | If true navigators will be returned in the response to enable drill down into search results |
| \searchNavigation\ jobFunctionSearchNavigation\ jobFunctionSearchNavigationValue | A job function navigation link which can be fed back into other calls. | The job function navigation link must be used to drill down by number of people with that job. |
1.3 Output Parameters
| Field Name | Value | Notes |
| \return\resultSet\firstHit | First Hit | Now named firstHit instead of first-hit |
| \return\resultSet\hit\coOfficialResults\coOfficialId | Hoovers Official ID | Now named coOfficialId instead of co-official-id |
| \return\resultSet\hit\coOfficialResults\companyId | Hoovers Company ID | Now named companyId instead of company-id |
| \return\resultSet\hit\coOfficialResults\duns | DUNS | |
| \return\resultSet\hit\coOfficialResults\firstName | Person First Name | Now named firstName instead of pnamefirst |
| \return\resultSet\hit\coOfficialResults\lastName | Person Last Name | Now named lastName instead of pnamelast |
| \return\resultSet\hit\coOfficialResults\middleName | Person Middle Name | Now named middleName instead of pnamemiddle |
| \return\resultSet\hit\coOfficialResults\suffix | Person Suffix | Now named suffix instead of psuffix |
| \return\resultSet\hit\coOfficialResults\title | Person Title | Now named title instead of ptitle |
| \return\resultSet\hit\coOfficialResults\companyName | Company Name | Now named companyName instead of recname |
| \return\resultSet\hit\hitNumber | Hit Number | Now named hitNumber instead of number |
| \return\resultSet\hits | Total Number of Hits in this Response | |
| \return\resultSet\lastHit | Last Hit | Now named lastHit instead of last-hit |
| \return\resultSet\totalHits | Aggregate Total Number of Hits | This is the total number of results the search returned Now named totalHits instead of total-hit |
| \return\navigators | Contains lists of navigation links | The values in the navigation link lists must be fed back into other calls with the same keyword |
| \return\navigators\jobFunctionNavigators\jobFunctionNavigator\jobFunctionNavigatorValue | The value of a navigation link for job functions | To drill down on job functions a value from this element must be fed back into another call with the same keyword. |
| \return\navigators\jobFunctionNavigators\jobFunctionNavigator\jobFunctionNavigatorDescription | The description of a navigation link for job functions | Could be used as a display value for the link |
2 Get Person Detail
2.1 Overview
Returns search result of detailed person information based on criteria of a Hoover's Official ID and Company ID.
When calling this service, ensure the Hoover's Official ID you send is a recent value from the Find Person by Keyword Search. These IDs are not constant and therefore sending an "old" Hoover's Official ID will cause either invalid or no results.
2.2 Input Parameters
Required fields are indicated with.
| Field Name | Value | Notes |
| coOfficialId | Hoovers Official ID | Now named coOfficialId instead of uniqueId |
| uniqueCompanyId | Hoover's Company ID or DUNS |
2.3 Output Parameters
| Field Name | Value | Notes |
| \return\official\companyId | Hoovers Company ID | Now named companyId instead of company-id |
| \return\official\duns | DUNS number | |
| \return\official\coOfficialId | Hoovers Official ID | Now named coOfficialId instead of co-official-id |
| \return\official\biography | Biographic Information | |
| \return\official\biographySource | Biography Source Name | |
| \return\official\latestPosition | Most recent position information | Now named latestPosition instead of latest-position |
| \return\official\latestPosition\title | Person Title | |
| \return\official\latestPosition\startYear | Latest position start year | Now named startYear instead of start-year |
| \return\official\latestPosition\endYear | Latest position end year | Now named endYear instead of end-year |
| \return\official\positionHistory | Collection on position elements (position history for the official) | Now named positionHistory instead of position-history |
| \return\official\positionHistory\position\title | Person Title | |
| \return\official\positionHistory\position\startYear | Position start year | Now named startYear instead of start-year |
| \return\official\positionHistory\position\endYear | Position end year | Now named endYear instead of end-year |
| \return\official\latestSalary | Most recent salary information | Now named latestSalary instead of latest-salary |
| \return\official\latestSalary\year | Latest salary year | |
| \return\official\latestSalary\salary | Salary for the year, excluding bonus in USD | |
| \return\official\latestSalary\totalSalary | Total compensation for the year, including any bonus or other compensation in USD | Now named totalSalary instead of total-salary |
| \return\official\latestSalary\bonus | Bonus for the year in USD | |
| \return\official\salaryHistory | Collection of salary elements (salary history for the official) | Now named salaryHistory instead of salary-history |
| \return\official\salaryHistory\salary\year | Salary Year | |
| \return\official\salaryHistory\salary\salary | Salary for the year excluding bonus in USD | |
| \return\official\salaryHistory\salary\totalSalary | Total compensation including bonus in USD | Now named totalSalary instead of total-salary |
| \return\official\salaryHistory\bonus | Bonus for the year in USD | |
| \return\official\person\fullName | Person Full Name | |
| \return\official\person\lastName | Person Last Name | |
| \return\official\person\firstName | Person First Name | |
| \return\official\person\middleName | Person Middle Name | |
| \return\official\person\suffix | Person Suffix | |
| \return\official\person\prefix | Person Prefix | |
| \return\official\person\age | Person Age |
3 Advanced Person Search
3.1 Overview
Returns search result of people based on various different criteria
3.2 Input Parameters
Required fields are indicated with.
| Field Name | Value | Notes |
| \bal\maxrecords | Max Records | Between 1-200. Default = 20 |
| \bal\hitOffset | 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 now zero-based. |
| \bal\sortdirection | Sort Direction | Values defined in WSDL: SortDirectionTypes - Ascending or Descending |
| \bal\orderby | Order By | Values defined in WSDL, BaseOrderByTypes |
| \bal\companySize\employeesFrom | Total Employees Lower Bound | now named companySize instead of companysize |
| \bal\companySize\employeesTo | Total Employees Upper Bound | now named companySize instead of companysize |
| \bal\companySize\employeesGrowthFrom | Total Employees Growth Percentage Lower Bound | now named companySize instead of companysize |
| \bal\companySize\employeesGrowthTo | Total Employees Growth Percentage Upper Bound | now named companySize instead of companysize |
| \bal\companySize\employeesThisLocationFrom | Employees at this Location Lower Bound | now named companySize instead of companysize |
| \bal\companySize\employeesThisLocationTo | Employees at this Location Upper Bound | now named companySize instead of companysize |
| \bal\companySize\marketCapFrom | Market Cap ($ mil) Lower Bound | now named companySize instead of companysize |
| \bal\companySize\marketCapTo | Market Cap ($ mil) Upper Bound | now named companySize instead of companysize |
| \bal\companySize\salesFrom | Annual Sales ($ mil) Lower Bound | now named companySize instead of companysize |
| \bal\companySize\salesTo | Annual Sales ($ mil) Upper Bound | now named companySize instead of companysize |
| \bal\companySize\salesGrowthFrom | Annual Sales Growth (%) Lower Bound | now named companySize instead of companysize |
| \bal\companySize\salesGrowthTo | Annual Sales Growth (%) Upper Bound | now named companySize instead of companysize |
| \bal\companyType\location | Location Type | Now named companyType\locationType instead of companytype\location. ID Value from GetAdvancedSearchLookups |
| \bal\companyType\companyType | Now named companyType\companyType instead of companytype\publicprivate. Valid values are either 1 (Public) or 2 (Private). | |
| \bal\companyType\subsidiaryStatus | Subsidiary Status | Now named companyType\subsidiaryStatus instead of companytype\status. Subsidiary or Not a Subsidiary |
| \bal\financialdata\advertisingExpenseFrom | Ad Expense ($ mil) Lower Bound. | |
| \bal\financialdata\advertisingExpenseTo | Ad Expense ($ mil) Upper Bound. | |
| \bal\financialdata\assetsFrom | Assets ($ mil) Lower Bound. | |
| \bal\financialdata\assetsTo | Assets ($ mil) Upper Bound. | |
| \bal\financialdata\filingDateFrom | Filing Date Lower Bound | MM/DD/YYYY |
| \bal\financialdata\filingDateTo | Filing Date Upper Bound | MM/DD/YYYY |
| \bal\financialdata\fiscalYearEnd | Fiscal Year End Month | |
| \bal\financialdata\incomeFrom | Net Income ($ mil) Lower Bound. | |
| \bal\financialdata\incomeGrowthFrom | Net Income Growth (%) Lower Bound | |
| \bal\financialdata\incomeGrowthTo | Net Income Growth (%) Upper Bound | |
| \bal\financialdata\incomeTo | Net Income ($ mil) Upper Bound | |
| \bal\financialdata\offerFrom | US IPO Data - Offer Amount ($ mil.) Lower Bound | |
| \bal\financialdata\offerTo | US IPO Data - Offer Amount ($ mil.) Upper Bound | |
| \bal\financialdata\priceRangeFrom | US IPO Data - Price Range ($) Lower Bound | |
| \bal\financialdata\priceRangeTo | US IPO Data - Price Range ($) Upper Bound | |
| \bal\financialdata\researchExpenseFrom | R&D Expense ($ mil) Lower Bound | |
| \bal\financialdata\researchExpenseTo | R&D Expense ($ mil) Upper Bound | |
| \bal\financialdata\tradingDateFrom | Trading Date Lower Bound | MM/DD/YYYY |
| \bal\financialdata\tradingDateTo | Trading Date Upper Bound | MM/DD/YYYY |
| \bal\financialdata\underwriterId | Underwriters | Now named underwriterId instead of underwriters. ID Value from GetAdvancedSearchLookups |
| \bal\industry\hooversIndustryCode | Hoovers Industry Name | Now named hooversIndustryCode instead of hooversindustryname. ID Value from GetAdvancedSearchLookups |
| \bal\industry\primaryOnly | Primary Industry Only | Boolean |
| \bal\industry\nAICS | NAICS Code | Enter at least two digits per code and separate multiple codes with commas; to range search, use a dash between codes. |
| \bal\industry\sIC | US SIC Code | Now named sIC instead of sIAC. Enter at least two digits per code and separate multiple codes with commas; to range search, use a dash between codes. |
| \bal\industry\uKSIC | UK SIC Code | Enter at least two digits per code and separate multiple codes with commas; to range search, use a dash between codes. |
| \bal\location\areacode | US/Canada Area Code | e.g. 512 or 210, 512, 212 |
| \bal\location\city | City | e.g. Madrid or New York (single city only) |
| \bal\location\countryId | Country | Now named countryId instead of country. ID Value from GetAdvancedSearchLookups |
| \bal\location\globalState | Global State/Province | e.g Queensland or NY (single province/state only) |
| \bal\location\metropolitanId | US Metropolitan Area | Now named metropolitanId instead of metropolitan. ID Value from GetAdvancedSearchLookups |
| \bal\location\regionId | World Region | Now named regionId instead of region. ID Value from GetAdvancedSearchLookups |
| \bal\location\state | US State/Canada Province | |
| \bal\location\postalCode | Postal Code | e.g. 78701 or "SW1P 1JA" or "SW1" or Separate multiple ZIP codes by commas. |
| \bal\usZipCodeRange\from | US ZIP Code Lower Bound | |
| \bal\usZipCodeRange\to | US ZIP Code Upper Bound | |
| \bal\location\zipAreaSearch\scale | Units to search in: miles or kilometers | Now named zipAreaSearch\scale instead of zipareascale. 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. |
| \bal\location\zipAreaSearch\radius | # of miles or kilometers to search within. | Now named zipAreaSearch\radius instead of zipareawithin. 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. |
| \bal\location\zipAreaSearch\zipCode | Zipcode to search within (78745 in the example) | Now named zipAreaSearch\zipCode instead of zipareazipcode. 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. |
| \bal\location\latLongSearch\scale | Units to search in: miles or kilometers | Requires radius, latitude, and longitude. |
| \bal\location\latLongSearch\radius | # of miles or kilometers to search within. | Requires scale, latitude, and longitude. |
| \bal\location\latLongSearch\latitude | latitude | Requires scale, radius, and longitude. |
| \bal\location\latLongSearch\longitude | longitude | Requires scale, radius, and latitude. |
| \bal\location\allAny | 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 |
| \bal\location\ukCounty | UK County | ID Value from GetAdvancedSearchLookups |
| \bal\specialtyCriteria\auditorId | Auditors | Now named auditorId instead of auditors. ID Value from GetAdvancedSearchLookups |
| \bal\specialtyCriteria\companyKeyword | Company Keyword | e.g. laptops or China or acquired, merged, takeover |
| \bal\specialtyCriteria\duns | DUNS Number | |
| \bal\specialtyCriteria\exchangeId | Exchange | Now named exchangeId instead of exchange. ID Value from GetAdvancedSearchLookups |
| \bal\specialtyCriteria\rankingId | Rankings/Indices | Now named rankingId instead of ranking. ID Value from GetAdvancedSearchLookups |
| \bal\specialtyCriteria\ukRegistration | UK Registration Number | Now named ukRegistration instead of uKRegistration. e.g. 3443456 or 3443456, 0764797 |
| \bal\specialtyCriteria\ukVat | UK Vat Number | Now named ukVat instead of ukvat. e.g. 906565610 or 906565610, 466264724 |
| \bal\specialtyCriteria\yearFoundingFrom | Year of Founding or Change in Control Lower Bound | YYYY |
| \bal\specialtyCriteria\yearFoundingTo | Year of Founding or Change in Control (YYYY) Upper Bound | YYYY |
| \bal\specialtyCriteria\ultimateParentDuns | The ultimate parent DUNS number for a family of companies | Now named ultimateParentDuns instead of ultimateParentDUNS. eg. 060902413 or 884364530 |
| \bal\specialtyCriteria\primaryUrl | Primary URL | |
| \bal\people\ageFrom | Person Age Lower Bound | |
| \bal\people\ageTo | Person Age Upper Bound | |
| \bal\people\bonusFrom | Person Bonus ($) Lower Bound | |
| \bal\people\bonusTo | Person Bonus ($) Upper Bound | |
| \bal\people\jobFunction | Person Job Function | ID Value from GetAdvancedSearchLookups |
| \bal\people\keywordsIn | Keywords In | Title, Bio, or Both |
| \bal\people\keywordSelect | Person Keyword | e.g. marketing or Harvard or ad sales |
| \bal\people\salaryFrom | Person Salary ($) Lower Bound | |
| \bal\people\salaryTo | Person Salary ($) Upper Bound | |
| \bal\people\totalPayFrom | Person Total Pay ($) Lower Bound | |
| \bal\people\totalPayTo | Person Total Pay ($) Upper Bound |
3.3 Output Parameters
| Field Name | Value | Notes |
| \return\people\firstHit | First Hit | Now named firstHit instead of first-hit |
| \return\people\hit\coOfficialResults\coOfficialId | Hoovers Official ID | Now named coOfficialId instead of co-official-id |
| \return\people\hit\coOfficialResults\companyId | Hoovers Company ID | Now named companyId instead of company-id |
| \return\people\hit\coOfficialResults\duns | DUNS | |
| \return\people\hit\coOfficialResults\firstName | Person First Name | Now named firstName instead of pnamefirst |
| \return\people\hit\coOfficialResults\lastName | Person Last Name | Now named lastName instead of pnamelast |
| \return\people\hit\coOfficialResults\middleName | Person Middle Name | Now named middleName instead of pnamemiddle |
| \return\people\hit\coOfficialResults\suffix | Person Suffix | Now named suffix instead of psuffix |
| \return\people\hit\coOfficialResults\title | Person Title | Now named title instead of ptitle |
| \return\people\hit\coOfficialResults\companyName | Company Name | Now named companyName instead of recname |
| \return\people\hit\hitNumber | Hit Number | Now named hitNumber instead of number |
| \return\people\hits | Total Number of Hits in this Response | |
| \return\people\lastHit | Last Hit | Now named lastHit instead of last-hit |
| \return\people\totalHits | Aggregate Total Number of Hits | This is the total number of results the search returned Now named totalHits instead of total-hit |
4 Get Person Detail Simple
4.1 Overview
Returns a reduced subset of person details for a given Unique Official ID
4.2 Input Parameters
Required fields are indicated with.
| Field Name | Value | Notes |
| coOfficialId | Hoovers Official ID | Now named coOfficialId instead of uniqueId |
| uniqueCompanyId | Hoover's Company ID or DUNS |
4.3 Output Parameters
| Field Name | Value | Notes |
| \return\official\coOfficialId | Hoovers Official ID | Now named coOfficialId instead of co-official-id |
| \return\official\latestPosition | Most recent position information | Now named latestPosition instead of latest-position |
| \return\official\latestPosition\title | Person Title | |
| \return\official\latestPosition\startYear | Latest position start year | Now named startYear instead of start-year |
| \return\official\latestPosition\endYear | Latest position end year | Now named endYear instead of end-year |
| \return\official\latestSalary | Most recent salary information | Now named latestSalary instead of latest-salary |
| \return\official\latestSalary\year | Latest salary year | |
| \return\official\latestSalary\salary | Salary for the year, excluding bonus in USD | |
| \return\official\latestSalary\totalSalary | Total compensation for the year, including any bonus or other compensation in USD | Now named totalSalary instead of total-salary |
| \return\official\latestSalary\bonus | Bonus for the year in USD | |
| \return\official\person\fullName | Person Full Name | |
| \return\official\person\lastName | Person Last Name | |
| \return\official\person\firstName | Person First Name | |
| \return\official\person\middleName | Person Middle Name | |
| \return\official\person\suffix | Person Suffix | |
| \return\official\person\prefix | Person Prefix | |
| \return\official\person\age | Person Age |
- Previous Versions
- Version 3.0 Documentation
- Queries - Person Information
