# 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) ## 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, w - [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. - [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, technographics, and contracts. Select which data categories to include using the `fields` parameter. Filter technographics by categor - [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. - [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. - [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 (`format: tree`, default) or a flat list (`format: list`). Use `mode` to control the traversal: `full` returns the entire tree from Group HQ, `children` - [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 compa - [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. ** ## Contacts - [POST /data-api/v2/contacts/enrich](https://data-docs.hginsights.com/v2/openapi/contacts/enrich_contacts_v2.md): Enrich contacts with PII fields (email, phone) by ID. A maximum of 20 IDs may be enriched per request. - [POST /data-api/v2/contacts/enrich/estimate](https://data-docs.hginsights.com/v2/openapi/contacts/estimate_contacts_enrich.md): Returns the estimated credit cost for a contact enrichment request without consuming any credits or returning data. Use the same parameters as the enrich endpoint. - [POST /data-api/v2/contacts/search](https://data-docs.hginsights.com/v2/openapi/contacts/search_contacts_v2.md): Search and filter contacts. Returns a flat list of matching contacts. ## Intent - [POST /data-api/v2/intent/enrich/estimate](https://data-docs.hginsights.com/v2/openapi/intent/intent_enrich_estimate.md): Returns a credits estimate for an intent enrich request without consuming credits. Provides a breakdown by topics and activities. - [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. ## Contracts - [POST /data-api/v2/contracts/search](https://data-docs.hginsights.com/v2/openapi/contracts/search_contracts.md): Search and filter contracts. Returns a paginated list of contracts matching the filter criteria. - [POST /data-api/v2/contracts/search/estimate](https://data-docs.hginsights.com/v2/openapi/contracts/estimate_contract_search.md): Returns the estimated credit cost for a contract search request without consuming any credits or returning data. Use the same filter parameters as the `/search` endpoint. ## Products - [POST /data-api/v2/products/attributes/search](https://data-docs.hginsights.com/v2/openapi/products/v2_search_product_attributes.md): Search the HG product attribute catalog with filtering and pagination. - [POST /data-api/v2/products/search](https://data-docs.hginsights.com/v2/openapi/products/v2_search_products.md): Search the HG product catalog with multi-field filters. Returns paginated results with product, vendor, and category details. Does not consume credits. - [POST /data-api/v2/products/categories/search](https://data-docs.hginsights.com/v2/openapi/products/v2_search_product_categories.md): Search the HG product category catalog with filtering and pagination. - [POST /data-api/v2/products/vendors/search](https://data-docs.hginsights.com/v2/openapi/products/v2_search_vendors.md): Search vendor catalog with filtering, relevance scoring, and optional product listing. When a text filter (vendor_name, description) is present and no explicit sort is given, results are ranked by rel ## Catalog - [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 - [GET /data-api/v2/catalog/naics2012](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_naics2012.md): List all NAICS 2012 - [GET /data-api/v2/catalog/vendors](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_vendors.md): List vendors, optionally filtered by name - [GET /data-api/v2/catalog/job_functions](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_job_functions.md): List all job functions - [GET /data-api/v2/catalog/sicus1987](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_sicus1987.md): List all SIC US 1987 - [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 - [GET /data-api/v2/catalog/product_categories](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_product_categories.md): List all product categories - [GET /data-api/v2/catalog/states](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_states.md): List all states - [GET /data-api/v2/catalog/industries](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_industries.md): List all industries - [GET /data-api/v2/catalog/fai_departments](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_fai_departments.md): List all FAI departments - [GET /data-api/v2/catalog/spend_categories](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_spend_categories.md): List all spend categories - [GET /data-api/v2/catalog/countries](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_countries.md): List all countries - [GET /data-api/v2/catalog/product_attributes](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_product_attributes.md): List all product attributes - [GET /data-api/v2/catalog/intent_topics](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_intent_topics.md): List all intent topics - [GET /data-api/v2/catalog/products](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_products.md): List all products - [GET /data-api/v2/catalog/job_seniorities](https://data-docs.hginsights.com/v2/openapi/catalog/v2_list_job_seniorities.md): List all job seniorities ## Industries - [GET /data-api/v2/industries/search](https://data-docs.hginsights.com/v2/openapi/industries/v2_search_industries.md): Search the industry taxonomy crosswalk across HG industry (23 buckets), NAICS 2012 (~2,200 codes), and SIC 1987 (~1,500 codes). Supports free-text search, exact code lookup, taxonomy scoping, colloqui ## Credits - [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. ## Time Series - [POST /data-api/v2/technographics/time-series](https://data-docs.hginsights.com/v2/openapi/time-series/technographics_time_series.md): Returns monthly intensity time series per product for a single company. Dense arrays with null-filled gaps, ready for charting. ## Mentions - [POST /data-api/v2/companies/mentions/time-series](https://data-docs.hginsights.com/v2/openapi/mentions/v2_mentions_time_series.md): Single-company mentions time series. ## Scoring - [GET /data-api/v2/scoring/models](https://data-docs.hginsights.com/v2/openapi/scoring/list_scoring_models_v2.md): The live AI scoring models available to your organization. Draft models are not returned. Use a returned `model_id` with `POST /v2/companies/score`. It is stable across re-publish; `model_version_id` - [POST /data-api/v2/companies/score](https://data-docs.hginsights.com/v2/openapi/scoring/score_companies_v2.md): Scores up to 25 companies against up to 6 of your organization's live AI scoring models. Identify companies by `ids` or `domains`, exactly as `companies/enrich` does. Returns one row per company per m