HG Insights API

Overview of the HG Insights API

The HG Insights API provides comprehensive, data-driven insights into global technology markets and company landscapes. This API can be leveraged to seamlessly integrate HG’s firmographic and technographic data into platforms and internal processes.

Today, the API allows you to search our database of entities, understand our catalog of filters and products, and enrich firmographic and install data by HG ID.

Summary of Endpoints

Data Catalog API

This endpoint is to help make sure you have the correctly formatted inputs in other calls. This is an important resource that should be used to make sure parameters of other endpoints lead to successful calls.

Closely review the ReDoc/Swagger before making these calls, as some require additional inputs in the query parameters.

This catalog will generate lists for the following areas of the product:

  • Countries
  • FAI Departments
  • FAI Roles
  • Industries
  • Intent Buyers Journey
  • Intent Context Types
  • Intent Topics
  • NAICS 2012
  • Product Attributes
  • Product Categories
  • Products
  • SIC
  • Spend Categories
  • States
  • Vendors

Company Match API

This endpoint allows you to find entities in our dataset by name, country and/or URL.

Some entities can return a number of records back due to areas of deep location granularity in our data set. As a result, we allow you to return between 1 and 10 possible matches based on your input.

This endpoint will return the HG ID, Name and URL back to you for matching records. HG ID will be an important parameter in firmographic and install endpoints.

Company Search API

This endpoint allows you to find companies based on our wide variety of search criteria.

We’ll return back to you the count of companies that match your criteria, as well as an array of Name, Domain, Domain Normalized and HG ID. The array will be limited based on the value set in the request. HG ID will be an important parameter in firmographic and install endpoints.

Pay careful attention to the request body scheme to ensure a successful call. We highly recommend consulting the data catalog endpoint for help exploring options and selecting the right syntax.

Company Firmographics API

This endpoint allows the user to retrieve firmographic information about a company. Response will cover all fields available in the Platform today, including firmographics for both the target company and the GHQ.

An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.

Company Installs API

This endpoint allows the user to retrieve product install information about a company.

Filter your request by specific product datapoints relating to the id, name, vendor and category details, along with localization of the install.

An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.

Spend API

This endpoint allows the user to retrieve IT Spend Budget data about a company.

Requests can be filtered to only specific IT Spend Budget categories, or all categories can be returned in the call.

An HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID.

Functional Area Intelligence

HG Insights’ Functional Area Intelligence solution predicts where detected technologies are used on both a departmental and location-specific level within an organization. Given a product in a department, we will return top locations where a Decision Maker or Influencer is present.

An HG ID, product(s) and department(s) must be included in the parameter for this call to be successful, you may also optionally include roles to further target the returned data. The call will return data for that single HG ID.

Intent API

HG Contextual Intent is a solution designed for companies looking to leverage the power of customer buying patterns. This intent data is then contextualized with each company’s technographic profile to provide refined insights that support laser-focused company targeting.

A HG ID must be included in the parameter for this call to be successful, and the call will return data for that single HG ID. Requests can be filtered to only specific Intent topics, or all provisioned topics can be returned in the call. Available intent topics are limited to those provisioned to your organization.

API Structure + Base URL

The API is structured around REST commands with HTTPS response codes to indicate either successful calls or errors produced. Responses are all JSON objects.

When making API requests in URL, you must do so over HTTPS - calls made over HTTP will fail.

Note: Configuration for Large Data Transfer

Some endpoints, especially the ones inside our Data Catalog can return a lot of data. To reduce the data transfer and increase response time, the client should use the Content-Encoding header and specify a compression method, like gzip.

Tokens & Authentication

To access our data, you will need a token - this is a small piece of code that verifies a user or application to access an API. This token is needed for all API endpoints.

Does the token rotate?: This token will be refreshed periodically and should be used in the request header to authenticate the request.

How to Obtain a Token: This token will be supplied to you via your CSM.

Security Best Practices: Keep your API token confidential and regenerate tokens if compromised. Use HTTPS for all API requests

API Errors

Error Codes

The API uses standard HTTP status codes to indicate the success or failure of a request.

CodeDescriptionNotes
200OK
401UnauthorizedProbably a missing token or an invalid token
404Not foundThe requested resource was not found
422Unprocessable EntityMost likely the request body is invalid because of missing or invalid parameters validated by the Open API Spec

Error messages

The error messages follow always the same pattern for syntax errors:

{
  "errors": [
    {
      "title": "Invalid request",
      "detail": "The request is invalid",
      "source": {
        "pointer": "/data/attributes/first-name"
      }
    }
  ]
}
Download OpenAPI description
Languages
Servers
https://api.hginsights.com/

Geography

Operations

Industry

Operations

Technographic

Operations

Intent

Operations

FAI

Operations

Companies

Operations

Spend

Operations

Catalog

Operations

Company

Operations

Search & Filter Companies

Request

Retrieve a list of companies and their corresponding details.

Bodyapplication/jsonrequired

Search for companies

fieldsArray of strings or null(SelectedCompanySearchFields)required

List of fields to be selected.

Default ["company_id","company_name","domain_name","domain_name_normalized"]
Enum"company_id""company_name""domain_name""domain_name_normalized"
Example: ["company_id","company_name","domain_name","domain_name_normalized"]
filtersobject(CompanyFilters)required

Filters object

Example: {"company_identifiers":{"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}},"corporate_hierarchy":{"is_domestic_parent":true,"is_global_headquarters":true},"firmographics":{"country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"max":700000000000,"min":600000000000}},"installs":{"product_attributes":{"ids":[222],"inclusion_method":"ANY_PRESENT"},"product_categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"inclusion_method":"ANY_PRESENT"},"products":[{"ids":[814],"inclusion_method":"ANY_PRESENT"}],"vendors":[{"ids":[316],"inclusion_method":"ANY_PRESENT"}]},"intent":{"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}},"spend":[{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}}]}
filters.​company_identifiersobject(CompanyIdentifierFilters)

Filters based around company identifiers.

Example: {"company_ids":{"ids":["1698C53EBC888758570396E0334965C1"],"inclusion_method":"ANY_PRESENT"}}
filters.​corporate_hierarchyobject(CompanyCorporateHierarchyFilters)

Filters based on a company's corporate hierarchy classification.

Example: {"is_domestic_parent":true,"is_global_headquarters":true}
filters.​firmographicsobject(CompanyFirmographicFilters)

Firmographic based filters for companies.

Example: {"country_codes":[{"ids":["US"],"inclusion_method":"ANY_PRESENT"}],"employees":{"max":2500000,"min":1500000},"industries":[{"ids":[16],"inclusion_method":"ANY_PRESENT"}],"region_names":{"ids":["AMER"],"inclusion_method":"ANY_PRESENT"},"revenue":{"max":700000000000,"min":600000000000}}
filters.​installsobject(CompanyInstallFilters)

Filters based around the install records detected at a company.

Example: {"product_attributes":{"ids":[222],"inclusion_method":"ANY_PRESENT"},"product_categories":{"ids":["319D067B229178F03BCFA1DA4AC4DEDE"],"inclusion_method":"ANY_PRESENT"},"products":[{"ids":[814],"inclusion_method":"ANY_PRESENT"}],"vendors":[{"ids":[316],"inclusion_method":"ANY_PRESENT"}]}
filters.​intentobject(CompanyFiltersIntent)

Filters based around intent signals. Intent signals are signals that indicate a company is showing interest in a particular topic.

Example: {"signal_score":"MEDIUM","topics":{"ids":["19861D3AC60455102792F87A33AF533F"],"inclusion_method":"ANY_PRESENT"}}
filters.​spendArray of objects(SpendFilter)non-empty

Filter results based on spend filters

Example: [{"categories":{"ids":["3B36D42E7F8E60BE58BA4356B6AF40C"],"inclusion_method":"ANY_PRESENT"},"range":{"min":2000000000}}]
limitinteger(Limit)<= 1000

The number of records to return in the request.

Default 10
offsetinteger(Offset)>= 0

Used for paginating records.

Default 0
sortsArray of objects(CompanyFieldSorts)

List of Sort objects

Default [{"direction":"ASC","field":"company_name"}]
Example: [{"direction":"DESC","field":"company_name"}]
curl -i -X POST \
  https://api.hginsights.com/data-api/v1/company/search \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      "company_id",
      "company_name",
      "domain_name",
      "domain_name_normalized"
    ],
    "filters": {
      "company_identifiers": {
        "company_ids": {
          "ids": [
            "1698C53EBC888758570396E0334965C1"
          ],
          "inclusion_method": "ANY_PRESENT"
        }
      },
      "corporate_hierarchy": {
        "is_domestic_parent": true,
        "is_global_headquarters": true
      },
      "firmographics": {
        "country_codes": [
          {
            "ids": [
              "US"
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ],
        "employees": {
          "max": 2500000,
          "min": 1500000
        },
        "industries": [
          {
            "ids": [
              16
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ],
        "region_names": {
          "ids": [
            "AMER"
          ],
          "inclusion_method": "ANY_PRESENT"
        },
        "revenue": {
          "max": 700000000000,
          "min": 600000000000
        }
      },
      "installs": {
        "product_attributes": {
          "ids": [
            222
          ],
          "inclusion_method": "ANY_PRESENT"
        },
        "product_categories": {
          "ids": [
            "319D067B229178F03BCFA1DA4AC4DEDE"
          ],
          "inclusion_method": "ANY_PRESENT"
        },
        "products": [
          {
            "ids": [
              814
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ],
        "vendors": [
          {
            "ids": [
              316
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ]
      },
      "intent": {
        "signal_score": "MEDIUM",
        "topics": {
          "ids": [
            "19861D3AC60455102792F87A33AF533F"
          ],
          "inclusion_method": "ANY_PRESENT"
        }
      },
      "spend": [
        {
          "categories": {
            "ids": [
              "3B36D42E7F8E60BE58BA4356B6AF40C"
            ],
            "inclusion_method": "ANY_PRESENT"
          },
          "range": {
            "min": 2000000000
          }
        }
      ]
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "company_name"
      }
    ]
  }'

Responses

Search Companies Response

Bodyapplication/json
countinteger

The total number of companies that match the search criteria.

dataArray of objects(CompanyObjectIdentifiers)
Response
application/json
{ "count": 0, "data": [ {} ] }

Spend

Request

Returns spend data about the specified company.

It's also possible to specify what fields from the API should be returned. By default, only some fields are returned.

Bodyapplication/jsonrequired

Company Spend Request

fieldsArray of strings(CompanySpendsSelectFields)

A list of data points to be returned in the API response.

Default ["company_id","spend","category_id","country_code"]
Items Enum"company_id""spend""category_id""category_name""category_description""country_code""country_name"
filtersobject(CompanySpendFilters)required
Example: {"category_ids":["03B36D42E7F8E60BE58BA4356B6AF40C","3B7D551F81A8A448041BF23C85E3D21B"],"company_id":"1698C53EBC888758570396E0334965C1"}
filters.​category_idsArray of Id (string) or Id (integer)(Id)
Example: ["03B36D42E7F8E60BE58BA4356B6AF40C","3B7D551F81A8A448041BF23C85E3D21B"]
filters.​company_idId (string) or Id (integer)(Id)required

A unique hexadecimal identifier for the desired field.

Example: "1698C53EBC888758570396E0334965C1"
One of:

A unique hexadecimal identifier for the desired field.

string(Id)

A unique hexadecimal identifier for the desired field.

limitinteger(Limit)<= 1000

The number of records to return in the request.

Default 10
offsetinteger(Offset)>= 0

Used for paginating records.

Default 0
sortsArray of objects(CompanySpendSorts)
Example: [{"direction":"DESC","field":"spend"}]
curl -i -X POST \
  https://api.hginsights.com/data-api/v1/company/spend \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      "company_id",
      "spend",
      "category_id",
      "country_code"
    ],
    "filters": {
      "category_ids": [
        "03B36D42E7F8E60BE58BA4356B6AF40C",
        "3B7D551F81A8A448041BF23C85E3D21B"
      ],
      "company_id": "1698C53EBC888758570396E0334965C1"
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "spend"
      }
    ]
  }'

Responses

Company Spend Response

Bodyapplication/json
countinteger
dataArray of objects(SpendObject)
Response
application/json
{ "count": 0, "data": [ {} ] }