Hoover's API Version 3.0 - Industry

Queries - Industry Information

New features are highlighted.

For the Hoover's API 3.0 release, the Industry calls will not be visible in the WSDL, but they ARE available in the new endpoint. These calls have not changed from version 2.0, so you should not have any issue calling these operations without any code modifications. Use the new endpoint for these calls.

Industry information is provided by First Research. In the Development environment, there will be limited sample industry data. Production contains hundreds of industry profiles.

1 Get All Industries Lookup

1.1 Overview

This service is used to retrieve profile Ids, North American Industry Classification System (NAICS) and Standard Industrial Classification (SIC) codes for industries. These values are relatively static, so caching this data can and should be taken advantage of with refreshes every 5 days as the suggested update time frame. Do not make a call to this service every time you need an Id or code, as this call counts towards your overall total and it is a large amount of data.

1.2 Input Parameters

-None-

1.3 Output Parameters

Field Name Value Notes
/return/industries Collection of Industry elements.  
/return/industries/industry Industry element data.  
/return/industries/industry/name Industry Name  
/return/industries/industry/sicCodes Comma separated list of SIC codes.  
/return/industries/industry/naicsCodes Comma separated list of NAICS codes.  
/return/industries/industry/profileId Profile Id of the industry.  
/return/industries/industry/lastUpdated Last updated date.  
/return/industries/industry/categories    
/return/industries/industry/categories/category Category name of the industry.  

2 Get Call Prep Sheet

2.1 Overview

This call returns a Call Preparation Sheet from the First Research API for a given Profile ID

2.2 Input Parameters

Required fields are indicated with.

Field Name Value Notes
profileId Profile ID  

2.3 Output Parameters

Field Name Value Notes
/return/industryName Industry Name  
/return/lastUpdate Last Updated Date  
/return/keyBusinessChallenges Collection of challenge elements  
/return/keyBusinessChallenges/challenge Challenge element  
/return/keyBusinessChallenges/challenge/title Challenge title  
/return/keyBusinessChallenges/challenge/description Challenge description  
/return/keyBusinessChallenges/challenge/question Challenge question  
/return/keyBusinessOpportunities Collection of opportunity elements  
/return/keyBusinessOpportunities/opportunity Opportunity element  
/return/keyBusinessOpportunities/opportunity/title Opportunity title  
/return/keyBusinessOpportunities/opportunity/description Opportunity description  
/return/keyBusinessOpportunities/opportunity/question Opportunity question  
/return/fastFacts Collection of fact elements  
/return/fastFacts/fact Fact element  
/return/executiveTalkingPoints Collection of talkingPoint elements  
/return/executiveTalkingPoints/talkingPoint TalkingPoint elements  
/return/executiveTalkingPoints/talkingPoint/role TalkingPoint Role  
/return/executiveTalkingPoints/talkingPoint/focusIssue TalkingPoint Focus Issue  
/return/executiveTalkingPoints/talkingPoint/callPrepQuestion TalkingPoint Call Prep Question  

3 Get Industry Profile

3.1 Overview

This call returns the Industry Profile information from the First Research API by SIC, NAICS or profileId.

3.2 Input Parameters

Required fields are indicated with.

Field Name Value Notes
industryCodeType Valid values are 'sic', 'naics', or 'profileId'  
industryCode The value of the corresponding code type to search on.  
chapters Collection of chapter elements.  
chapter The chapter number to retrieve. Valid chapter numbers range from 0 to 10.

3.3 Output Parameters

Field Name Value Notes
/return/errorCode Error code returned by First Research if request results in an error.  
/return/errorMessage Error message returned by First Research if request results in an error.  
/return/exactMatches Container for industryProfiles element.  
/return/exactMatches/industryProfiles Collection of industryProfile elements.  
/return/groupMatches Container for industryProfiles element.  
/return/groupMatches/industryProfiles Collection of industryProfile elements.  
/return/majorGroupMatches Container for industryProfiles element.  
/return/majorGroupMatches/industryProfiles Collection of industryProfile elements.  
/return/usIndustryMatches Container for industryProfiles element.  
/return/usIndustryMatches/industryProfiles Collection of industryProfile elements.  
/return/industryMatches Container for industryProfiles element.  
/return/industryMatches/industryProfiles Collection of industryProfile elements.  
/return/industryGroupMatches Container for industryProfiles element.  
/return/industryGroupMatches/industryProfiles Collection of industryProfile elements.  
/return/industrySubsectorMatches Container for industryProfiles element.  
/return/industrySubsectorMatches/industryProfiles Collection of industryProfile elements.  
/return/industrySectorMatches Container for industryProfiles element.  
/return/industrySectorMatches/industryProfiles Collection of industryProfile elements.  
/return/industryProfile Industry Profile data  
/return/industryProfile/errorCode Error code returned by First Research if request results in an error.  
/return/industryProfile/errorMessage Error message returned by First Research if request results in an error.  
/return/industryProfile/industryName Industry Name  
/return/industryProfile/profileID Profile ID  
/return/industryProfile/lastUpdate Last updated date.  
/return/industryProfile/categories Collection of category elements.  
/return/industryProfile/categories/category Category associated with this industry profile.  
/return/industryProfile/sicCodes Collection of sicCode elements.  
/return/industryProfile/sicCodes/sicCode SIC code associated with this industry profile.  
/return/industryProfile/naicsCodes Collection of naicsCode elements.  
/return/industryProfile/naicsCodes/naicsCode NAICS code associated with this industry profile.  
/return/industryProfile/relatedProfiles Collection of relatedProfile elements.  
/return/industryProfile/relatedProfiles/relatedProfile Related Profile data  
/return/industryProfile/relatedProfiles/relatedProfile/industryName Related Profile industry name.  
/return/industryProfile/relatedProfiles/relatedProfile/profileID Related profile ID.  
/return/industryProfile/disclaimer First Research Disclaimer text.  
/return/industryProfile/chapters Collection of chapter elements  
/return/industryProfile/chapters/chapter Chapter data.  
/return/industryProfile/chapters/chapter/name Chapter name.  
/return/industryProfile/chapters/chapter/description Chapter description.  
/return/industryProfile/chapters/chapter/paragraphs Collection of paragraph elements.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph Paragraph data.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/category Paragraph category.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/title Paragraph title.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/tableHeader Paragraph table header.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/contents Paragraph contents.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/tableFooter Paragraph table footer.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/imageURL Paragraph image URL.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/siteURL Paragraph site URL.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/bullets Collection of bullet elements.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/bullets Collection of bullet elements.  
/return/industryProfile/chapters/chapter/paragraphs/paragraph/bullets/bullet Paragraph bullet.  
/return/industryProfile/chapters/chapter/subChapters Collection of subChapter elements.  
/return/industryProfile/chapters/chapter/subChapters/subChapter Chapter element.  

4 Find Industry Profiles By Keyword

4.1 Overview

This call returns Industry Profiles from the First Research API that match the keyword sent in the request.

4.2 Input Parameters

Required fields are indicated with.

Field Name Value Notes
keyword    

4.3 Output Parameters

Field Name Value Notes
/return/industries Collection of Industry elements.  
/return/industry Industry Profile data  
/return/industryProfile/industryName Industry Name  
/return/industryProfile/profileID Profile ID  
/return/industryProfile/lastUpdated Last updated date.  
/return/industryProfile/categories Collection of category elements.  
/return/industryProfile/categories/category Category associated with this industry profile.  
/return/industryProfile/sicCodes Comma separated string. SIC codes associated with this industry profile.
/return/industryProfile/naicsCodes Comma separated string. NAICS codes associated with this industry profile.

5 Get State or Province Profile

5.1 Overview

This call returns State or Province profile data from the First Research API by profile Id.

5.2 Input Parameters

Required fields are indicated with.

Field Name Value Notes
stateOrProvinceType Valid values are 'state' or 'province' (see StateOrProvinceTypes in WSDL)  
stateOrProvinceId ID Value (the state or province to be searched) from GetAdvancedSearchLookups  

5.3 Output Parameters

Field Name Value Notes
/return/errorCode Error code returned by First Research if request results in an error.  
/return/errorMessage Error message returned by First Research if request results in an error.  
/return/stateProfile State Profile element.  
/return/stateProfile/id State or Province ID.  
/return/stateProfile/stateName State or Province Name.  
/return/stateProfile/lastUpdate Last updated date.  
/return/stateProfile/code State or Province code.  
/return/stateProfile/image State or Province image.  
/return/stateProfile/relatedProfiles Container for relatedProfile elements.  
/return/stateProfile/relatedProfiles/relatedProfile RelatedProfile element.  
/return/stateProfile/relatedProfiles/relatedProfile/industryName Industry Name element.  
/return/stateProfile/relatedProfiles/relatedProfile/profileID Industry profileID.  
/return/stateProfile/bigPicture Container for chapter element.  
/return/stateProfile/bigPicture/name Chapter name.  
/return/stateProfile/bigPicture/description Chapter description.  
/return/stateProfile/bigPicture/paragraphs Paragraphs element  
/return/stateProfile/bigPicture/subChapters Subchapters element  
/return/stateProfile/employmentData Container for anyTypes element.  
/return/stateProfile/employmentData/anyTypes Container for anyType elements.  
/return/stateProfile/employmentData/anyTypes/anyType Any valid XSD type.  
/return/stateProfile/industryUpdate Container for chapter element.  
/return/stateProfile/industryUpdate/name Chapter name.  
/return/stateProfile/industryUpdate/description Chapter description.  
/return/stateProfile/industryUpdate/paragraphs Paragraphs element  
/return/stateProfile/industryUpdate/subChapters Subchapters element  
/return/stateProfile/localRealEstateSummary Container for chapter element.  
/return/stateProfile/localRealEstateSummary/name Chapter name.  
/return/stateProfile/localRealEstateSummary/description Chapter description.  
/return/stateProfile/localRealEstateSummary/paragraphs Paragraphs element  
/return/stateProfile/localRealEstateSummary/subChapters Subchapters element  
/return/stateProfile/weblinks Container for anyTypes element.  
/return/stateProfile/weblinks/anyTypes Container for anyType elements.  
/return/stateProfile/weblinks/anyTypes/anyType Any valid XSD type.  
/return/stateProfile/chapters Collection of chapter elements  
/return/stateProfile/chapters/chapter Chapter data.  
/return/stateProfile/chapters/chapter/name Chapter name.  
/return/stateProfile/chapters/chapter/description Chapter description.  
/return/stateProfile/chapters/chapter/paragraphs Collection of paragraph elements.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph Paragraph data.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/category Paragraph category.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/title Paragraph title.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/tableHeader Paragraph table header.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/contents Paragraph contents.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/tableFooter Paragraph table footer.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/imageURL Paragraph image URL.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/siteURL Paragraph site URL.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/bullets Collection of bullet elements.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/bullets Collection of bullet elements.  
/return/stateProfile/chapters/chapter/paragraphs/paragraph/bullets/bullet Paragraph bullet.  
/return/stateProfile/chapters/chapter/subChapters Collection of subChapter elements.  
/return/stateProfile/chapters/chapter/subChapters/subChapter Chapter element.  
/return/stateProfile/disclaimer First Research Disclaimer text.