# HG Insights API License: HG Insights terms of service ## Servers ``` https://api.hginsights.com ``` Variables: ## Security ### authorization Type: http Scheme: bearer Bearer Format: API_KEY ## Download OpenAPI description [HG Insights API](https://data-docs.hginsights.com/_bundle/v2/openapi.yaml) ## Catalog ### List countries - [GET /data-api/v2/catalog/countries](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_countries.md): List all countries ### List FAI departments - [GET /data-api/v2/catalog/fai_departments](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_fai_departments.md): List all FAI departments ### List industries - [GET /data-api/v2/catalog/industries](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_industries.md): List all industries ### List intent buyers journey - [GET /data-api/v2/catalog/intent_buyers_journey](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_intent_buyers_journey.md): List all intent buyers journey stages ### List intent context types - [GET /data-api/v2/catalog/intent_context_types](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_intent_context_types.md): List all intent context types ### List intent topics - [GET /data-api/v2/catalog/intent_topics](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_intent_topics.md): List all intent topics ### List NAICS 2012 - [GET /data-api/v2/catalog/naics2012](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_naics2012.md): List all NAICS 2012 ### List product attributes - [GET /data-api/v2/catalog/product_attributes](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_product_attributes.md): List all product attributes ### List product categories - [GET /data-api/v2/catalog/product_categories](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_product_categories.md): List all product categories ### List products - [GET /data-api/v2/catalog/products](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_products.md): List all products ### List SIC US 1987 - [GET /data-api/v2/catalog/sicus1987](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_sicus1987.md): List all SIC US 1987 ### List spend categories - [GET /data-api/v2/catalog/spend_categories](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_spend_categories.md): List all spend categories ### List states - [GET /data-api/v2/catalog/states](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_states.md): List all states ### List vendors - [GET /data-api/v2/catalog/vendors](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_vendors.md): List vendors, optionally filtered by name ## Companies ### Enrich Companies - [POST /data-api/v2/companies/enrich](https://data-docs.hginsights.com/v2/openapi/companies/enrich_companies.md): Unified endpoint to enrich company data with firmographics, spend, and technographics. Select which data categories to include using the fields parameter. Filter technographics by categories, vendors, or products using the filters parameter. Control pagination for both tecnographics and spend data using the pagination parameter. ### Estimate credit cost for company enrichment - [POST /data-api/v2/companies/enrich/estimate](https://data-docs.hginsights.com/v2/openapi/companies/estimate_companies_enrich.md): Returns the estimated credit cost for a company enrichment request without consuming any credits or returning data. Use the same parameters as the enrich endpoint. ### Company Functional Area Intelligence - [POST /data-api/v2/companies/functional-areas](https://data-docs.hginsights.com/v2/openapi/companies/get_functional_areas.md): Returns Functional Area Intelligence (FAI) for a company. FAI predicts where detected technologies are used at both a departmental and location-specific level within an organization. Provide the company by id (hex-encoded) or domain. All filters are optional. ### Estimate credit cost for Functional Area Intelligence - [POST /data-api/v2/companies/functional-areas/estimate](https://data-docs.hginsights.com/v2/openapi/companies/estimate_functional_areas.md): Returns the estimated credit cost for a Functional Area Intelligence (FAI) request without consuming any credits or returning data. Use the same parameters as the /functional-areas endpoint. ### Company Hierarchy - [POST /data-api/v2/companies/hierarchy](https://data-docs.hginsights.com/v2/openapi/companies/company_hierarchy.md): Returns the company hierarchy as a nested tree. Use mode to control the traversal: full returns the entire tree from Group HQ, children returns the subtree rooted at the matched company, parents returns the ancestor chain from Group HQ to the matched company. ### Estimate credit cost for Company Hierarchy - [POST /data-api/v2/companies/hierarchy/estimate](https://data-docs.hginsights.com/v2/openapi/companies/estimate_company_hierarchy.md): Returns the estimated credit cost for a Company Hierarchy request without consuming any credits or returning data. Use the same parameters as the /hierarchy endpoint. ### Match Companies - [POST /data-api/v2/companies/match](https://data-docs.hginsights.com/v2/openapi/companies/match_companies.md): Batch match up to 10 companies by name, domain, and/or country. Each company in the request must include at least one of: name, domain, country. Results are returned in the same order as the input, with each entry containing the matched HG company records sorted by relevance. ### Search Companies - [POST /data-api/v2/companies/search](https://data-docs.hginsights.com/v2/openapi/companies/search_companies_v2.md): Search and filter companies. Returns a paginated list of companies matching the filter criteria. Intent topic filtering is unrestricted — all intent topics are available regardless of provisioning. ## Credits ### Get Credits Balance - [GET /data-api/v2/credits](https://data-docs.hginsights.com/v2/openapi/credits/get_credits.md): Returns credit balance, contract dates, and data entitlements for the authenticated organization. ## Intent ### Get Company Intent Signals - [POST /data-api/v2/intent/enrich](https://data-docs.hginsights.com/v2/openapi/intent/intent_enrich.md): Returns intent signals for a known company. Combines HG topic-based intent and TrustRadius buyer-intent activities. Provide the company by id (hex-encoded) or domain. All filters are optional.