HG Insights MCP (Preview)
HG Insights MCP server provides AI agents with unified, real-time access to high-quality B2B data, signals, and contextual intelligence to power automated workflows, enrichment, and go-to-market decision-making.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | HG Insights |
| URL | https://phoenix.hginsights.com |
| support@hginsights.com |
| Connector Metadata | |
|---|---|
| Publisher | HG Insights |
| Website | https://phoenix.hginsights.com/docs |
| Privacy policy | https://hginsights.com/privacy-page/ |
| Categories | AI;Business Intelligence |
HG Insights MCP (Phoenix) — Microsoft ecosystem
What this is
hip-phoenix implements Phoenix, the HG Insights control plane. Production: https://phoenix.hginsights.com.
For Microsoft Power Automate, Copilot, and related connectors, Phoenix exposes a seller-friendly REST facade over the same MCP-backed capabilities: one POST per tool, predictable JSON bodies, and a published OpenAPI 2.0 document aligned with Power Platform import and certification workflows.
Canonical OpenAPI URL
Live specification (source of truth for the Power Automate surface):
https://phoenix.hginsights.com/api/powerautomate/openapi.json
That document describes https://phoenix.hginsights.com with basePath: /api/powerautomate, schemes: [https], and global api_key security (Bearer-style API key as defined in the spec). Regenerate or diff certification artifacts against this URL whenever the facade changes.
REST facade vs MCP transport
| Use case | Surface |
|---|---|
| Power Automate / connector-style HTTP | POST https://phoenix.hginsights.com/api/powerautomate{path} — see operation table below |
| MCP JSON-RPC / agents | POST https://phoenix.hginsights.com/api/ai/mcp (OAuth Bearer) |
| MCP tool catalog (JSON) | GET https://phoenix.hginsights.com/api/mcp/spec |
| OAuth discovery | GET https://phoenix.hginsights.com/.well-known/oauth-authorization-server |
The REST paths mirror MCP tool names (snake_case). Request/response shapes follow the OpenAPI definitions at the URL above.
Power Automate operations (from OpenAPI)
Each row is POST /api/powerautomate + path (e.g. POST .../api/powerautomate/contact_search).
| Path | operationId |
Summary |
|---|---|---|
/company_firmographic |
CompanyFirmographic |
Get Company Firmographics |
/company_technographic |
CompanyTechnographic |
Get Company Technographics |
/company_spend |
CompanySpend |
Get Company IT Spend |
/company_intent |
CompanyIntent |
Get Company Buyer Intent Signals |
/company_operating_signals |
CompanyOperatingSignals |
Get Company Operating Signals |
/company_research |
CompanyResearch |
Get Company Research Summary |
/company_install_time_series |
CompanyInstallTimeSeries |
Get Company Install Time Series |
/company_gov_opportunities |
CompanyGovOpportunities |
Get Company Federal Opportunities |
/company_gov_relationships |
CompanyGovRelationships |
Get Company Federal Relationships |
/contact_search |
ContactSearch |
Search Contacts at a Company |
/contact_enrich |
ContactEnrich |
Enrich a Contact with Email and Phone |
/list_product_categories |
ListProductCategories |
List Product Categories |
/list_product_attributes |
ListProductAttributes |
List Product Attributes |
/list_intent_topics |
ListIntentTopics |
List Intent Topics |
/get_vendor_information |
GetVendorInformation |
Get Vendor Information |
/intent_category |
IntentCategory |
Search Companies by Intent Topic |
/search_federal_contracts |
SearchFederalContracts |
Search Federal Contracts |
/search_gov_opportunities |
SearchGovOpportunities |
Search Federal Opportunities |
/sec_filing_section |
SecFilingSection |
Get SEC Filing Section |
/sec_full_text_search |
SecFullTextSearch |
Search SEC Filings Full Text |
Connector metadata (live OpenAPI)
The published spec includes x-ms-connector-metadata entries such as Website (https://phoenix.hginsights.com/docs), Privacy policy, and Categories (AI, Business Intelligence). Keep the certified connector’s apiDefinition.swagger.json metadata in sync with this document when those values change.
Authentication
- Power Automate OpenAPI (
/api/powerautomate) — usesapi_keyin the liveopenapi.json(header/query per spec). - MCP OAuth (
/api/ai/mcp) — OAuth 2.0 scopesmcp:read,mcp:tools,offline_access; resource metadata athttps://phoenix.hginsights.com/.well-known/oauth-protected-resource.
Limitations
- Not every MCP tool in Phoenix may appear in the Power Automate facade; the authoritative list is always
openapi.jsonat the URL above. - API-key MCP at
/api/mcpremains a separate entry point from the OAuth MCP route.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Enrich a Contact with Email and Phone |
Enrich contacts with full details: email, phone, social profiles, employment history. Supports Apollo and ZoomInfo providers (auto-selected based on org configuration). USES CREDITS. Use contact_search first to find contacts (free), then enrich the best matches. Accepts contact ID (most accurate), name + company, or up to 25 contacts for bulk enrichment. Specify provider to target the same provider used in search. |
| Get Company Buyer Intent Signals |
Get a broad overview of intent signals for a specific company. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). Returns the top intent topics by score with merged HG proprietary + TrustRadius buyer intent data including: topic scores, intent levels, buyer journey stages, context dispositions for competitive intelligence (e.g., displacement signals), and TrustRadius buyer activities. Use vendor_name for competitive intelligence (e.g., "Is Prudential looking at Snowflake competitors?"). NOTE: For topic-specific queries (e.g., "Does Caterpillar show intent for Siemens Teamcenter?"), use intent_category with the topic_name instead — company_intent returns the top topics by score and may miss specific topics for companies with many active signals. |
| Get Company Federal Opportunities |
Find open federal solicitations where a specific company is the incumbent contractor or a likely bidder based on their NAICS codes and existing contract portfolio. Resolves the company via SAM.gov, then searches for matching opportunities. Requires the SAM.gov (Data.gov) integration to be configured. |
| Get Company Federal Relationships |
Show prime/subcontractor relationships for a company from federal subaward data. Reveals which companies a prospect teams with on government deals, including contract counts and total subaward values. Data sourced from USAspending.gov subaward records. Requires the SAM.gov (Data.gov) integration to be configured. |
| Get Company Firmographics |
Retrieve comprehensive business information about companies including industry, employee count, revenue, location, and technologies. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). If both are provided, hg_id takes precedence. |
| Get Company Install Time Series |
Get installation intensity time series data for a company's technology usage. Returns monthly intensity values (0-100 scale) for each product over time. Use to answer trend questions like 'How has Cisco's usage of Snowflake changed over the past 2 years?' Filter by products, vendors, or categories. Each product includes current_intensity, intensity_momentum (positive = growing), and is_active status. Products are ordered by current intensity (descending) when no filters are applied. Empty results mean no matching products were found for the specified filters. |
| Get Company IT Spend |
Retrieve IT spend data from HGInsights for a specific company. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id, e.g., "0FF69D9F596504A1FF4FF5B16FF"). If both are provided, hg_id takes precedence. Returns detailed spend amounts by category and geography, with currency formatting and category hierarchies for sales intelligence and market analysis. |
| Get Company Operating Signals |
Retrieve company operating signals by combining mentions-derived attributes (work_model, cloud_posture, esg_commitment, iot_posture, network_modernization, automation_stage) and GenAI maturity attributes (ai_trajectory, cloud_depth, genai_readiness, intent_adoption_gap). Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). |
| Get Company Research Summary |
Comprehensive company research that aggregates firmographic, technographic, IT spend, cloud spend, intent signals, contracts, and operating signals into a single interactive dashboard. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). Requires fewer API calls than querying each tool individually. |
| Get Company Technographics |
REQUIRED WORKFLOW — follow these steps before calling this tool:
Get technographic data (technology usage) for a company by domain. Returns installed technologies with productId (numeric), vendor, usage intensity, and verification dates. Use the productId values from results when calling company_fai for precise lookups. Filter by 'categories' for category-based filtering, or by 'vendorIds'/'productIds' for exact vendor/product filtering (preferred for specific vendor lookups). Large unfiltered requests may be truncated. Default limit: 50. Empty results mean no data was found for the specified filters — do NOT say the tool lacks functionality. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). If both are provided, hg_id takes precedence. |
| Get SEC Filing Section |
Extract specific sections from SEC 10-K, 10-Q, or 8-K filings. Returns cleaned text optimized for analysis. SECTION MAPPING GUIDE - For questions about: 10-K ANNUAL REPORTS:
10-Q QUARTERLY REPORTS:
8-K CURRENT EVENTS:
|
| Get Vendor Information |
Look up technology vendors from the HG Insights catalog. When vendorName is provided, performs fuzzy search and returns matched vendors with their product IDs — use these IDs with company_technographic's productIds or vendorIds parameters to check if a company uses that vendor's technologies. When vendorName is omitted, returns the full vendor catalog for discovery. TIP: To check if a company uses a specific vendor, call this tool first to get the vendor ID, then call company_technographic with the vendorIds parameter. |
| List Intent Topics |
Search or list intent topics from the official HG Insights catalog. Intent topics represent buying signals and research areas that indicate what technologies companies are actively investigating or planning to purchase. Use the 'query' parameter to fuzzy-search topics by name (recommended to avoid overwhelming results). Use 'category' to filter by topic category. IMPORTANT: When recommending intent topics, always use this tool to look up real topic IDs and names — never guess or fabricate them. |
| List Product Attributes |
Search or list product attributes from the official HG Insights catalog. Product attributes describe technology characteristics like deployment model (Cloud-Based, On-Premise), licensing (Open Source, Enterprise), and other features. Use the 'query' parameter to fuzzy-search attributes by name (recommended). IMPORTANT: When filtering by product attributes, always use this tool to look up the exact attribute name — never guess or approximate. |
| List Product Categories |
Search or list product categories from the official HG Insights catalog. Returns hierarchical category structure with IDs, names, and category trees. Use the 'query' parameter to fuzzy-search categories by name (recommended). Use 'parentId' to navigate the category hierarchy. IMPORTANT: When filtering company technographics by category, always use this tool to look up the exact category name — never guess or approximate. |
| Search Companies by Intent Topic |
Find companies showing intent for a topic, vendor, or product. Returns merged HG proprietary + TrustRadius buyer intent signals with signal strength (0-100), intent levels, buyer journey stages, and context types. Use list_intent_topics to discover available topics first. |
| Search Contacts at a Company |
Search for contacts at a company by title, seniority, and location. Supports Apollo and ZoomInfo providers (auto-selected based on org configuration). Returns basic contact info (name, title, LinkedIn). FREE - does not use credits. IMPORTANT RULES: 1) Combine ALL title variations in ONE call using arrays (e.g., personTitles: ['VP Marketing', 'CMO', 'Head of Marketing']). 2) Do NOT make separate calls for each title - use ONE search with all titles combined. 3) If a search returns 0 results, STOP - do not retry with different title variations. Report 'no matches found' to the user. 4) Maximum 2 searches per user request (initial search + optional pagination). Use contact_enrich to get email/phone for the best matches. |
| Search Federal Contracts |
Search USAspending.gov for U.S. federal contract awards. Filter by awarding agency, NAICS code, PSC code, keywords, contract value range, date range, and small business set-aside type. Returns contract details including recipient, obligation amount, and performance location. Requires the SAM.gov (Data.gov) integration to be configured. |
| Search Federal Opportunities |
Search SAM.gov for open U.S. federal solicitations (RFPs, RFQs, presolicitations, sources sought). Filter by keywords, NAICS code, PSC code, agency, set-aside type, posting date, and response deadline. Returns opportunity details including title, agency, deadline, and direct SAM.gov link. Requires the SAM.gov (Data.gov) integration to be configured. |
| Search SEC Filings Full Text |
Search within SEC filing content for specific terms or phrases. Supports boolean operators (AND, OR, NOT), wildcards (*), and exact phrase matching ("quoted"). Use to find filings mentioning specific topics, risks, or events. QUERY EXAMPLES:
COMMON USE CASES:
|
Enrich a Contact with Email and Phone
Enrich contacts with full details: email, phone, social profiles, employment history. Supports Apollo and ZoomInfo providers (auto-selected based on org configuration). USES CREDITS. Use contact_search first to find contacts (free), then enrich the best matches. Accepts contact ID (most accurate), name + company, or up to 25 contacts for bulk enrichment. Specify provider to target the same provider used in search.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
contactId
|
contactId | string |
Contact ID from contact_search results. Most accurate method. |
|
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
email
|
Contact's email address (if known) |
|||
|
companyDomain
|
companyDomain | string | ||
|
companyName
|
companyName | string |
Current employer's name |
|
|
linkedinUrl
|
linkedinUrl | uri |
LinkedIn profile URL for matching |
|
|
id
|
id | string |
Contact ID (from contact_search results) |
|
|
firstName
|
firstName | string |
Contact's first name |
|
|
lastName
|
lastName | string |
Contact's last name |
|
|
email
|
Contact's email (if known) |
|||
|
companyDomain
|
companyDomain | string |
Current employer's domain (e.g., 'salesforce.com') |
|
|
companyName
|
companyName | string |
Current employer's name |
|
|
linkedinUrl
|
linkedinUrl | uri |
LinkedIn profile URL |
|
|
revealEmail
|
revealEmail | boolean |
Whether to reveal email addresses (default: true) |
|
|
revealPhone
|
revealPhone | boolean |
Whether to reveal phone numbers (default: true) |
|
|
provider
|
provider | string |
Contact data provider to use. Use "auto" for automatic selection, "apollo" for Apollo, or "zoominfo" for ZoomInfo. |
Returns
Get Company Buyer Intent Signals
Get a broad overview of intent signals for a specific company. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). Returns the top intent topics by score with merged HG proprietary + TrustRadius buyer intent data including: topic scores, intent levels, buyer journey stages, context dispositions for competitive intelligence (e.g., displacement signals), and TrustRadius buyer activities. Use vendor_name for competitive intelligence (e.g., "Is Prudential looking at Snowflake competitors?"). NOTE: For topic-specific queries (e.g., "Does Caterpillar show intent for Siemens Teamcenter?"), use intent_category with the topic_name instead — company_intent returns the top topics by score and may miss specific topics for companies with many active signals.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters). When provided, this overrides companyDomain. Obtain from a previous company_search result. |
|
|
vendor_name
|
vendor_name | string |
Filter by vendor name for competitive intelligence (e.g., "Snowflake, Inc."). Shows displacement signals and context dispositions. |
|
|
product_name
|
product_name | string |
Filter by product name (e.g., "Salesforce Sales Cloud"). Scopes results to intent signals related to this product. |
|
|
intent_level
|
intent_level | string |
Filter by intent level. |
|
|
buyers_journey
|
buyers_journey | string |
Filter by buyer journey stage (e.g., "Researching", "Evaluating", "Purchasing"). |
|
|
context_type
|
context_type | string |
Filter by context type (e.g., "Whitespace", "Expansion", "Displacement", "Complementary"). |
|
|
source
|
source | string |
Filter by data source. Omit to include both HG and TrustRadius signals. |
|
|
start_date
|
start_date | string |
Start date in YYYY-MM-DD format. Defaults to 30 days ago. |
|
|
end_date
|
end_date | string |
End date in YYYY-MM-DD format. Defaults to today. |
|
|
signal
|
signal | string |
Filter by signal category. Activates activity search mode. Values: comparison (view Comparison, click Comparisons), pricing (view Product Pricing), research (view Product Listing, view Category), evaluation (view Review, view Reviews and Ratings). |
|
|
products
|
products | array of string |
Array of product names with AND logic — returns only companies/events matching ALL products (e.g., ["Databricks", "Snowflake Platform"]). Activates activity search mode. Distinct from product_name which filters the intent endpoint. |
|
|
employees_range
|
employees_range | string |
Employee range filter (e.g., "10,000+", "1,001-5,000", "201-500"). |
|
|
country_codes
|
country_codes | array of string |
ISO country code filter (e.g., ["US", "GB"]). |
|
|
category_name
|
category_name | string |
Filter by product category name. |
|
|
group_by
|
group_by | string |
"company" for aggregated company data, omit for raw individual events with evidence URLs. Activates activity search mode. |
|
|
limit
|
limit | integer |
Pagination limit (1-200). Used in both intent and activity search modes. |
|
|
offset
|
offset | integer |
Pagination offset (default 0). Used in both intent and activity search modes. |
Returns
Intent mode returns company/window/summary/topics/activities. Activity search mode returns companies (group_by=company) or events (raw mode) with pagination.
Get Company Federal Opportunities
Find open federal solicitations where a specific company is the incumbent contractor or a likely bidder based on their NAICS codes and existing contract portfolio. Resolves the company via SAM.gov, then searches for matching opportunities. Requires the SAM.gov (Data.gov) integration to be configured.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string |
The company domain to look up (e.g., "boozallen.com") |
|
includeIncumbentOnly
|
includeIncumbentOnly | boolean |
Only show opportunities where the company is the incumbent (default: false) |
|
|
daysUntilDeadline
|
daysUntilDeadline | number |
Filter by deadline (e.g., 90 = opportunities closing in the next 90 days) |
|
|
limit
|
limit | number |
Maximum number of opportunities to return (1-50, default: 25) |
Returns
Get Company Federal Relationships
Show prime/subcontractor relationships for a company from federal subaward data. Reveals which companies a prospect teams with on government deals, including contract counts and total subaward values. Data sourced from USAspending.gov subaward records. Requires the SAM.gov (Data.gov) integration to be configured.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string |
The company domain to look up (e.g., "palantir.com") |
|
relationshipType
|
relationshipType | string |
Type of relationships to show: "prime" (company as prime), "sub" (company as sub), or "both" (default) |
|
|
minAmount
|
minAmount | number |
Minimum subaward value to include |
|
|
fiscalYearStart
|
fiscalYearStart | number |
Start fiscal year for the search (default: current year - 5) |
|
|
limit
|
limit | number |
Maximum number of relationships per direction (1-100, default: 50) |
Returns
Get Company Firmographics
Retrieve comprehensive business information about companies including industry, employee count, revenue, location, and technologies. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). If both are provided, hg_id takes precedence.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters). When provided, this overrides companyDomain. Obtain from a previous company_search result. |
|
|
provider
|
provider | string |
Provider to use for data lookup. Use "auto" for automatic selection or specify a provider key. |
Returns
Get Company Install Time Series
Get installation intensity time series data for a company's technology usage. Returns monthly intensity values (0-100 scale) for each product over time. Use to answer trend questions like 'How has Cisco's usage of Snowflake changed over the past 2 years?' Filter by products, vendors, or categories. Each product includes current_intensity, intensity_momentum (positive = growing), and is_active status. Products are ordered by current intensity (descending) when no filters are applied. Empty results mean no matching products were found for the specified filters.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
products
|
products | array of string |
Filter to specific product names (e.g., ['Snowflake Platform', 'Databricks']). |
|
|
productIds
|
productIds | array of string |
Filter by product IDs. |
|
|
vendors
|
vendors | array of string |
Filter by vendor name. Returns all products from that vendor (e.g., ['Amazon', 'Microsoft']). |
|
|
categories
|
categories | array of string |
Filter by category name (e.g., ['Cloud Infrastructure', 'Security']). |
|
|
timeRange
|
timeRange | string |
Time range for the series. Options: last_6_months, last_12_months, last_24_months, last_36_months. Default: last_24_months. |
|
|
maxProducts
|
maxProducts | integer |
Maximum number of products to return (1-50, default 10). |
Returns
Get Company IT Spend
Retrieve IT spend data from HGInsights for a specific company. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id, e.g., "0FF69D9F596504A1FF4FF5B16FF"). If both are provided, hg_id takes precedence. Returns detailed spend amounts by category and geography, with currency formatting and category hierarchies for sales intelligence and market analysis.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters, e.g., "0FF69D9F596504A1FF4FF5B16FF"). When provided, this overrides companyDomain. Obtain from a previous company_search result. |
|
|
spendCategory
|
spendCategory | string |
Optional spend category to filter results. If not provided, returns all spend categories. Use fuzzy matching on category names (e.g., "Security", "Software", "Cloud"). |
Returns
- Body
- CompanySpendResponse
Get Company Operating Signals
Retrieve company operating signals by combining mentions-derived attributes (work_model, cloud_posture, esg_commitment, iot_posture, network_modernization, automation_stage) and GenAI maturity attributes (ai_trajectory, cloud_depth, genai_readiness, intent_adoption_gap). Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters). When provided, this overrides companyDomain. |
Returns
Get Company Research Summary
Comprehensive company research that aggregates firmographic, technographic, IT spend, cloud spend, intent signals, contracts, and operating signals into a single interactive dashboard. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). Requires fewer API calls than querying each tool individually.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | string |
The company domain to look up (e.g., "cisco.com"). Do not include protocol (http/https). At least one of companyDomain or hg_id must be provided. |
|
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters). When provided, this overrides companyDomain. At least one of companyDomain or hg_id must be provided. |
Returns
Get Company Technographics
REQUIRED WORKFLOW — follow these steps before calling this tool:
- To check a SPECIFIC vendor/product: call get_vendor_information first → pass the returned vendorIds/productIds here.
- To filter by category: call list_product_categories first → pass the exact category name here.
- For a full unfiltered tech stack: call this tool directly with no filters. Skipping step 1 or 2 causes missed results (e.g., Snowflake is under 'Database Management', not 'Data Warehousing').
Get technographic data (technology usage) for a company by domain. Returns installed technologies with productId (numeric), vendor, usage intensity, and verification dates. Use the productId values from results when calling company_fai for precise lookups. Filter by 'categories' for category-based filtering, or by 'vendorIds'/'productIds' for exact vendor/product filtering (preferred for specific vendor lookups). Large unfiltered requests may be truncated. Default limit: 50. Empty results mean no data was found for the specified filters — do NOT say the tool lacks functionality. Provide a company domain (e.g., "cisco.com") or an HG Insights company ID (hg_id). If both are provided, hg_id takes precedence.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | True | string | |
|
hg_id
|
hg_id | string |
HG Insights company ID (32 alphanumeric characters). When provided, this overrides companyDomain. Obtain from a previous company_search result. |
|
|
categories
|
categories | array of string |
Filter by technology categories (fuzzy matched). IMPORTANT: Use list_product_categories to find exact category names before filtering. Leave empty for all categories. |
|
|
productIds
|
productIds | array of integer |
Filter by exact HG Insights product IDs (passed directly to API). Get IDs from get_vendor_information or from previous company_technographic results' productId field. |
|
|
vendorIds
|
vendorIds | array of integer |
Filter by exact HG Insights vendor IDs (passed directly to API). Get IDs from get_vendor_information. Example: get_vendor_information(vendorName: 'Anthropic') returns vendorId, then pass it here. |
|
|
sort
|
sort | string |
Sort results by usage intensity (high to low) or last verified date (most recent first). |
|
|
maxResults
|
maxResults | number |
Maximum number of results to return (1-500, default 50). Use 'categories', 'productIds', or 'vendorIds' to filter for focused results instead of requesting large result sets. |
|
|
provider
|
provider | string |
Data provider to use. Use 'auto' for automatic selection or specify provider name. |
Returns
Get SEC Filing Section
Extract specific sections from SEC 10-K, 10-Q, or 8-K filings. Returns cleaned text optimized for analysis.
SECTION MAPPING GUIDE - For questions about:
10-K ANNUAL REPORTS:
- Company overview, products, markets, strategy → "1" (Business)
- Risks, challenges, uncertainties, threats → "1A" (Risk Factors)
- Financial performance discussion, trends → "7" (MD&A)
- Executive pay, stock options, bonuses → "11" (Executive Compensation)
- Board members, leadership team → "10" (Directors & Officers)
- Legal issues, lawsuits, litigation → "3" (Legal Proceedings)
- Properties, facilities, real estate → "2" (Properties)
10-Q QUARTERLY REPORTS:
- Quarterly performance analysis → "part1item2" (MD&A)
- Updated risk factors → "part2item1a" (Risk Factors)
- Quarterly financial statements → "part1item1" (Financial Statements)
8-K CURRENT EVENTS:
- CEO/CFO changes, executive departures → "5.02" (Officer Changes)
- Earnings announcements, quarterly results → "2.02" (Results of Operations)
- M&A activity, acquisitions, divestitures → "2.01" (Acquisition/Disposition)
- Cybersecurity breaches, incidents → "1.05" (Cybersecurity Incident)
- New contracts, major partnerships → "1.01" (Material Agreement)
- Contract terminations → "1.02" (Termination of Agreement)
- Bankruptcy filings → "1.03" (Bankruptcy)
- Auditor changes → "4.01" (Accountant Changes)
- Stock delisting notices → "3.01" (Delisting Notice)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyTicker
|
companyTicker | True | string | |
|
filingType
|
filingType | True | string | |
|
section
|
section | True | string | |
|
fiscalYear
|
fiscalYear | number |
Fiscal year (e.g., 2024). Defaults to most recent filing. |
|
|
fiscalQuarter
|
fiscalQuarter | number |
Fiscal quarter (1-4) for 10-Q filings |
|
|
outputFormat
|
outputFormat | string |
Output format. Text is cleaned and optimized for LLM analysis. |
Returns
Get Vendor Information
Look up technology vendors from the HG Insights catalog. When vendorName is provided, performs fuzzy search and returns matched vendors with their product IDs — use these IDs with company_technographic's productIds or vendorIds parameters to check if a company uses that vendor's technologies. When vendorName is omitted, returns the full vendor catalog for discovery. TIP: To check if a company uses a specific vendor, call this tool first to get the vendor ID, then call company_technographic with the vendorIds parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
vendorName
|
vendorName | string |
Vendor name to search for (fuzzy matched). Example: 'Anthropic', 'OpenAI', 'Salesforce'. When provided, returns matched vendors with their products. When omitted, returns all vendors. |
Returns
List Intent Topics
Search or list intent topics from the official HG Insights catalog. Intent topics represent buying signals and research areas that indicate what technologies companies are actively investigating or planning to purchase. Use the 'query' parameter to fuzzy-search topics by name (recommended to avoid overwhelming results). Use 'category' to filter by topic category. IMPORTANT: When recommending intent topics, always use this tool to look up real topic IDs and names — never guess or fabricate them.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
query
|
query | True | string |
Fuzzy search query to filter intent topics by name (e.g., 'cloud security', 'ERP'). Returns the most relevant matches sorted by relevance score. Use a broad term like 'technology' or 'security' to browse large sections of the catalog. |
|
category
|
category | string |
Filter intent topics by category (e.g., 'Technology', 'Business'). Case-insensitive. |
|
|
is_tech
|
is_tech | boolean |
Filter to only technology-related intent topics when true. |
|
|
limit
|
limit | number |
Maximum number of results to return (default 50). Set higher to retrieve more matches. |
Returns
List Product Attributes
Search or list product attributes from the official HG Insights catalog. Product attributes describe technology characteristics like deployment model (Cloud-Based, On-Premise), licensing (Open Source, Enterprise), and other features. Use the 'query' parameter to fuzzy-search attributes by name (recommended). IMPORTANT: When filtering by product attributes, always use this tool to look up the exact attribute name — never guess or approximate.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
query
|
query | string |
Fuzzy search query to filter attributes by name (e.g., 'cloud', 'open source'). Returns the most relevant matches sorted by relevance score. |
|
|
limit
|
limit | number |
Maximum number of results to return. Defaults to 50 when query is provided, or all results when no filters are used. |
Returns
List Product Categories
Search or list product categories from the official HG Insights catalog. Returns hierarchical category structure with IDs, names, and category trees. Use the 'query' parameter to fuzzy-search categories by name (recommended). Use 'parentId' to navigate the category hierarchy. IMPORTANT: When filtering company technographics by category, always use this tool to look up the exact category name — never guess or approximate.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
query
|
query | string |
Fuzzy search query to filter categories by name (e.g., 'security', 'cloud'). Returns the most relevant matches sorted by relevance score. |
|
|
parentId
|
parentId | string |
Filter to only return children of this parent category ID. Use to navigate the hierarchy. |
|
|
limit
|
limit | number |
Maximum number of results to return. Defaults to 50 when query or parentId is provided, or all results when no filters are used. |
Returns
Search Companies by Intent Topic
Find companies showing intent for a topic, vendor, or product. Returns merged HG proprietary + TrustRadius buyer intent signals with signal strength (0-100), intent levels, buyer journey stages, and context types. Use list_intent_topics to discover available topics first.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
topic_name
|
topic_name | True | string |
Topic or category to find companies showing intent for (e.g., "Siemens Teamcenter", "cloud security", "ERP"). Fuzzy-matched server-side. REQUIRED — use list_intent_topics to discover available topics. |
|
vendor_name
|
vendor_name | string |
Filter by vendor name (e.g., "Snowflake, Inc."). Scopes results to intent signals related to this vendor. |
|
|
product_name
|
product_name | string |
Filter by product name (e.g., "Salesforce Sales Cloud"). Scopes results to intent signals related to this product. |
|
|
intent_level
|
intent_level | string |
Filter by intent level. |
|
|
buyers_journey
|
buyers_journey | string |
Filter by buyer journey stage. |
|
|
context_type
|
context_type | string |
Filter by context type (e.g., "Whitespace", "Expansion", "Displacement"). |
|
|
source
|
source | string |
Filter by data source. Omit to include both HG and TrustRadius signals. |
|
|
start_date
|
start_date | string |
Start date in YYYY-MM-DD format. Defaults to 30 days ago. |
|
|
end_date
|
end_date | string |
End date in YYYY-MM-DD format. Defaults to today. |
|
|
maxResults
|
maxResults | integer |
Maximum number of companies to return (1-200, default 50). Used in intent mode. |
|
|
signal
|
signal | string |
Filter by signal category. Activates activity search mode. Values: comparison (view Comparison, click Comparisons), pricing (view Product Pricing), research (view Product Listing, view Category), evaluation (view Review, view Reviews and Ratings). |
|
|
products
|
products | array of string |
Array of product names with AND logic — returns only companies/events matching ALL products (e.g., ["Databricks", "Snowflake Platform"]). Activates activity search mode. |
|
|
employees_range
|
employees_range | string |
Employee range filter (e.g., "10,000+", "1,001-5,000", "201-500"). |
|
|
country_codes
|
country_codes | array of string |
ISO country code filter (e.g., ["US", "GB"]). |
|
|
category_name
|
category_name | string |
Filter by product category name. |
|
|
group_by
|
group_by | string |
"company" for aggregated company data, omit for raw individual events with evidence URLs. Activates activity search mode. |
|
|
limit
|
limit | integer |
Pagination limit (1-200). Overrides maxResults when provided. Used in both modes. |
|
|
offset
|
offset | integer |
Pagination offset (default 0). Used in both modes. |
Returns
Intent mode returns context/companies/pagination. Activity search mode returns companies (group_by=company) or events (raw mode) with pagination.
Search Contacts at a Company
Search for contacts at a company by title, seniority, and location. Supports Apollo and ZoomInfo providers (auto-selected based on org configuration). Returns basic contact info (name, title, LinkedIn). FREE - does not use credits. IMPORTANT RULES: 1) Combine ALL title variations in ONE call using arrays (e.g., personTitles: ['VP Marketing', 'CMO', 'Head of Marketing']). 2) Do NOT make separate calls for each title - use ONE search with all titles combined. 3) If a search returns 0 results, STOP - do not retry with different title variations. Report 'no matches found' to the user. 4) Maximum 2 searches per user request (initial search + optional pagination). Use contact_enrich to get email/phone for the best matches.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
companyDomain
|
companyDomain | string | ||
|
companyName
|
companyName | string |
Company name for fuzzy search (e.g., "Salesforce"). Use companyDomain when possible. |
|
|
personTitles
|
personTitles | array of string |
Job titles to filter by (e.g., ["VP Marketing", "Head of Marketing"]). Supports multiple titles. |
|
|
personSeniorities
|
personSeniorities | array of string |
Seniority levels: owner, founder, c_suite, partner, vp, head, director, manager, senior, entry, intern |
|
|
personLocations
|
personLocations | array of string |
Person locations (e.g., ["California, US", "New York, US"]) |
|
|
organizationLocations
|
organizationLocations | array of string |
Filter by company HQ location |
|
|
organizationNumEmployeesRanges
|
organizationNumEmployeesRanges | array of string |
Employee count ranges (e.g., ["1,10", "11,50", "51,200"]) |
|
|
contactEmailStatus
|
contactEmailStatus | array of string |
Filter by email status: verified, unverified, likely_to_engage, unavailable |
|
|
page
|
page | integer |
Page number for pagination (default: 1) |
|
|
perPage
|
perPage | integer |
Results per page (default: 25, max: 100) |
|
|
provider
|
provider | string |
Contact data provider to use. Use "auto" for automatic selection, "apollo" for Apollo, or "zoominfo" for ZoomInfo. |
Returns
Search Federal Contracts
Search USAspending.gov for U.S. federal contract awards. Filter by awarding agency, NAICS code, PSC code, keywords, contract value range, date range, and small business set-aside type. Returns contract details including recipient, obligation amount, and performance location. Requires the SAM.gov (Data.gov) integration to be configured.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
recipientName
|
recipientName | string |
Company/recipient name to search for (partial match) |
|
|
recipientUei
|
recipientUei | string |
Exact Unique Entity Identifier (UEI) of the recipient |
|
|
awardingAgency
|
awardingAgency | string |
Awarding agency name, e.g., "Department of Defense" |
|
|
naicsCode
|
naicsCode | string |
NAICS code to filter by, e.g., "541512" for Computer Systems Design |
|
|
pscCode
|
pscCode | string |
Product/Service Code to filter by, e.g., "D310" for IT services |
|
|
keywords
|
keywords | string |
Keywords to search in contract descriptions |
|
|
minAmount
|
minAmount | number |
Minimum contract obligation amount in USD |
|
|
maxAmount
|
maxAmount | number |
Maximum contract obligation amount in USD |
|
|
startDateAfter
|
startDateAfter | string |
Only contracts starting after this date (ISO format, e.g., "2024-01-01") |
|
|
startDateBefore
|
startDateBefore | string |
Only contracts starting before this date (ISO format) |
|
|
setAsideType
|
setAsideType | string |
Small business set-aside type code (e.g., "SBA" for Small Business) |
|
|
limit
|
limit | number |
Maximum number of results to return (1-100, default: 50) |
|
|
offset
|
offset | number |
Number of results to skip for pagination (default: 0) |
|
|
sortBy
|
sortBy | string |
Sort results by "amount" or "date" (default: "amount") |
|
|
sortOrder
|
sortOrder | string |
Sort order: "asc" or "desc" (default: "desc") |
Returns
Search Federal Opportunities
Search SAM.gov for open U.S. federal solicitations (RFPs, RFQs, presolicitations, sources sought). Filter by keywords, NAICS code, PSC code, agency, set-aside type, posting date, and response deadline. Returns opportunity details including title, agency, deadline, and direct SAM.gov link. Requires the SAM.gov (Data.gov) integration to be configured.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
keywords
|
keywords | string |
Keywords to search in opportunity titles |
|
|
naicsCode
|
naicsCode | string |
NAICS code to filter by, e.g., "541512" for Computer Systems Design |
|
|
pscCode
|
pscCode | string |
Product/Service classification code |
|
|
agency
|
agency | string |
Awarding agency name |
|
|
setAsideType
|
setAsideType | string |
Small business set-aside type |
|
|
postedAfter
|
postedAfter | string |
Only opportunities posted after this date (ISO format, e.g., "2025-01-01") |
|
|
postedBefore
|
postedBefore | string |
Only opportunities posted before this date (ISO format) |
|
|
responseDeadlineAfter
|
responseDeadlineAfter | string |
Only opportunities with response deadline after this date (ISO format) |
|
|
responseDeadlineBefore
|
responseDeadlineBefore | string |
Only opportunities with response deadline before this date (ISO format) |
|
|
opportunityType
|
opportunityType | string |
Type of opportunity to search for |
|
|
activeOnly
|
activeOnly | boolean |
Only show active/open opportunities (default: true) |
|
|
limit
|
limit | number |
Maximum number of results to return (1-100, default: 25) |
|
|
offset
|
offset | number |
Number of results to skip for pagination (default: 0) |
Returns
Search SEC Filings Full Text
Search within SEC filing content for specific terms or phrases. Supports boolean operators (AND, OR, NOT), wildcards (*), and exact phrase matching ("quoted"). Use to find filings mentioning specific topics, risks, or events.
QUERY EXAMPLES:
- "material weakness" - Find exact phrase
- cybersecurity AND breach - Both terms required
- layoff* - Wildcard matching (layoff, layoffs, etc.)
- "going concern" OR "substantial doubt" - Either phrase
- acquisition NOT merger - Exclude term
COMMON USE CASES:
- Risk monitoring: "material weakness", "going concern"
- Cyber incidents: "cybersecurity incident", "data breach"
- M&A activity: acquisition, merger, "change of control"
- Restructuring: layoff*, "workforce reduction", restructuring
- Leadership changes: "chief executive", "board of directors"
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
query
|
query | True | string | |
|
filingTypes
|
filingTypes | array of string |
Limit to specific form types (e.g., ["10-K", "8-K"]) |
|
|
tickers
|
tickers | array of string |
Limit to specific company tickers |
|
|
startDate
|
startDate | string |
Start date (YYYY-MM-DD). Defaults to 30 days ago. |
|
|
endDate
|
endDate | string |
End date (YYYY-MM-DD). Defaults to today. |
|
|
limit
|
limit | number |
Maximum results (max 100) |
Returns
Definitions
ListProductCategoriesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | number |
Number of product categories returned |
|
totalAvailable
|
totalAvailable | number |
Total number of categories in the catalog (before filtering) |
|
categories
|
categories | array of object |
List of product category information |
|
id
|
categories.id | string |
Unique category identifier |
|
name
|
categories.name | string |
Category name |
|
parentId
|
categories.parentId | string |
Parent category identifier, omitted for root categories |
|
nameTree
|
categories.nameTree | array of string |
Hierarchical category path from root to this category |
GetVendorInformationResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | number |
Total number of vendors returned |
|
vendors
|
vendors | array of object |
List of vendor information |
|
id
|
vendors.id | number |
Unique vendor identifier (use with company_technographic vendorIds parameter) |
|
name
|
vendors.name | string |
Vendor name |
|
matchScore
|
vendors.matchScore | number |
Match confidence (0-1). 1.0 = exact match, 0.9 = substring/near-exact, <0.9 = fuzzy. Only present in vendorName search results. |
|
products
|
vendors.products | array of object |
Products offered by this vendor (only included when vendorName search is used) |
|
id
|
vendors.products.id | number |
Product ID (use with company_technographic productIds parameter) |
|
name
|
vendors.products.name | string |
Product name |
|
categoryId
|
vendors.products.categoryId | string |
Product category ID |
ListProductAttributesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | number |
Number of product attributes returned |
|
totalAvailable
|
totalAvailable | number |
Total number of attributes in the catalog (before filtering) |
|
attributes
|
attributes | array of object |
List of product attribute information |
|
id
|
attributes.id | string |
Unique attribute identifier |
|
name
|
attributes.name | string |
Attribute name |
|
description
|
attributes.description | string |
Description of what this attribute means |
ListIntentTopicsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | number |
Number of intent topics returned |
|
totalAvailable
|
totalAvailable | number |
Total number of intent topics matching the query |
|
topics
|
topics | array of object |
List of intent topic information |
|
id
|
topics.id | string |
Unique intent topic identifier |
|
name
|
topics.name | string |
Intent topic name |
|
category
|
topics.category | string |
Topic category |
|
is_tech_related
|
topics.is_tech_related | boolean |
Whether this is a technology-related topic |
|
signal_count
|
topics.signal_count | number |
Number of signals observed for this topic |
CompanyFirmographicResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
domain
|
domain | string |
The company domain that was queried |
|
name
|
name | string |
The company name |
|
industry
|
industry | string |
Company industry/sector |
|
employeeCount
|
employeeCount | string |
Number of employees (range or exact number) |
|
revenue
|
revenue | string |
Annual revenue (if available) |
|
city
|
location.city | string |
City |
|
state
|
location.state | string |
State/province |
|
country
|
location.country | string |
Country |
|
postalCode
|
location.postalCode | string |
Postal/zip code |
|
continent
|
location.continent | string |
Continent |
|
subcontinent
|
location.subcontinent | string |
Subcontinent |
|
geopolitical
|
location.geopolitical | string |
Geopolitical region |
|
description
|
description | string |
Company description |
|
website
|
website | string |
Company website URL |
|
foundedYear
|
foundedYear | number |
Year the company was founded |
|
companyType
|
companyType | string |
Company type (public, private, etc.) |
|
linkedin
|
socialMedia.linkedin | string |
LinkedIn company page URL |
|
twitter
|
socialMedia.twitter | string |
Twitter/X company profile URL |
|
facebook
|
socialMedia.facebook | string |
Facebook company page URL |
|
technologies
|
technologies | array of string |
Technologies used by the company |
|
code
|
industryCodes.naics.code | string |
NAICS code |
|
name
|
industryCodes.naics.name | string |
NAICS name |
|
codes
|
industryCodes.sic.codes | array of string |
SIC codes |
|
names
|
industryCodes.sic.names | array of string |
SIC names |
|
fortune500
|
rankings.fortune500 | number |
Fortune 500 ranking (null if not ranked) |
|
forbes2000
|
rankings.forbes2000 | number |
Forbes 2000 ranking (null if not ranked) |
|
itSpend
|
itSpend | number |
IT spending information |
|
companyLevel
|
companyLevel | string |
Company level/organizational structure |
|
customerData
|
customerData | object |
Customer-specific data enriched from Snowflake (only present when Snowflake enrichment is configured) |
|
provider
|
metadata.provider | string |
Which provider returned this data |
|
confidence
|
metadata.confidence | number |
Confidence score of the data (0-1) |
|
lastUpdated
|
metadata.lastUpdated | string |
When this data was last updated |
CompanyTechnographicResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyId
|
companyId | string |
Unique company identifier |
|
companyDomain
|
companyDomain | string |
The company domain that was queried |
|
products
|
products | array of object |
List of technologies/products used by the company |
|
productId
|
products.productId | integer |
Unique product identifier |
|
productName
|
products.productName | string |
Name of the technology product |
|
vendorName
|
products.vendorName | string |
Name of the technology vendor |
|
productAttributes
|
products.productAttributes | array of string |
Product attributes/categories |
|
productLocations
|
products.productLocations | number |
Number of product locations |
|
categoryId
|
products.categoryId | string |
Category identifier |
|
categoryName
|
products.categoryName | string |
Technology category name |
|
categoryNameTree
|
products.categoryNameTree | array of string |
Category hierarchy |
|
firstVerifiedDate
|
products.firstVerifiedDate | string |
Date when technology was first verified |
|
lastVerifiedDate
|
products.lastVerifiedDate | string |
Date when technology usage was last verified |
|
intensity
|
products.intensity | number |
Usage intensity level |
|
productDescription
|
products.productDescription | string |
Description of the product |
|
countryCode
|
products.countryCode | string |
Country code |
|
installDate
|
products.installDate | string |
Installation date |
|
totalCount
|
totalCount | number |
Total number of technologies found |
|
categories
|
categories | array of object |
Categories of technologies found |
|
items
|
categories | object | |
|
lastUpdated
|
lastUpdated | string |
When the data was last updated |
|
truncatedFrom
|
_truncation.truncatedFrom | number |
Original number of products before truncation |
|
returnedCount
|
_truncation.returnedCount | number |
Number of products returned after truncation |
|
note
|
_truncation.note | string |
Guidance for retrieving more targeted results |
CompanySpendResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyId
|
companyId | string |
The HGInsights company identifier |
|
companyDomain
|
companyDomain | string |
The company domain that was queried |
|
totalSpend
|
totalSpend | string |
Total IT spend formatted as currency (e.g., '$1,234,567') |
|
totalSpendAmount
|
totalSpendAmount | number |
Total IT spend as a numeric value |
|
spendByCategory
|
spendByCategory | array of object |
Breakdown of spend by category |
|
categoryId
|
spendByCategory.categoryId | string |
Category identifier |
|
categoryName
|
spendByCategory.categoryName | string |
Category display name |
|
categoryTree
|
spendByCategory.categoryTree | array of string |
Hierarchical category path |
|
totalSpend
|
spendByCategory.totalSpend | string |
Category spend formatted as currency |
|
totalSpendAmount
|
spendByCategory.totalSpendAmount | number |
Category spend as numeric value |
|
spendByCountry
|
spendByCategory.spendByCountry | array of object |
Geographic breakdown of spend |
|
countryCode
|
spendByCategory.spendByCountry.countryCode | string |
ISO country code |
|
countryName
|
spendByCategory.spendByCountry.countryName | string |
Country name |
|
region
|
spendByCategory.spendByCountry.region | string |
Geographic region |
|
spend
|
spendByCategory.spendByCountry.spend | string |
Spend formatted as currency |
|
spendAmount
|
spendByCategory.spendByCountry.spendAmount | number |
Spend as numeric value |
|
categoriesFound
|
categoriesFound | number |
Number of spend categories found |
|
countriesFound
|
countriesFound | number |
Number of countries with spend data |
CompanyResearchResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyName
|
header.companyName | string | |
|
domain
|
header.domain | string | |
|
industry
|
header.industry | string | |
|
employeeCount
|
header.employeeCount | string | |
|
revenue
|
header.revenue | string | |
|
location
|
header.location | object | |
|
website
|
header.website | string | |
|
foundedYear
|
header.foundedYear | number | |
|
companyType
|
header.companyType | string | |
|
itSpend
|
keyMetrics.itSpend | number | |
|
fortune500Rank
|
keyMetrics.fortune500Rank | number | |
|
forbes2000Rank
|
keyMetrics.forbes2000Rank | number | |
|
topTechCategories
|
keyMetrics.topTechCategories | array of string | |
|
firmographic
|
firmographic | object |
Firmographic data |
|
technographic
|
technographic | object |
Technographic data (top 20 products) |
|
spend
|
spend | object |
IT spend data (top 15 categories) |
|
cloudSpend
|
cloudSpend | object |
Cloud spend data (top 10 vendors) |
|
intent
|
intent | object |
Intent signals (top 20) |
|
contracts
|
contracts | object |
Contract data |
|
operatingSignals
|
operatingSignals | object |
Operating signals |
CompanyOperatingSignalsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
company_name
|
company_name | string |
Company name from HG Insights v2 |
|
company_domain
|
company_domain | string |
Company domain queried |
|
organization_id
|
organization_id | string |
HG organization identifier |
|
data_available
|
mentions.data_available | boolean |
Whether mentions-derived attributes were found |
|
no_data_reason
|
mentions.no_data_reason | string |
Reason when mentions data is unavailable |
|
stage
|
mentions.work_model.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.work_model.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.work_model.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.work_model.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
stage
|
mentions.cloud_posture.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.cloud_posture.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.cloud_posture.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.cloud_posture.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
stage
|
mentions.esg_commitment.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.esg_commitment.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.esg_commitment.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.esg_commitment.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
stage
|
mentions.iot_posture.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.iot_posture.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.iot_posture.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.iot_posture.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
stage
|
mentions.network_modernization.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.network_modernization.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.network_modernization.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.network_modernization.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
stage
|
mentions.automation_stage.stage | string |
Derived categorical stage label |
|
intensity
|
mentions.automation_stage.intensity | number |
Sum of all contributing signal intensities |
|
last_verified_at
|
mentions.automation_stage.last_verified_at | string |
Most recent verification date |
|
signals
|
mentions.automation_stage.signals | object |
Breakdown of individual mention intensities by product or keyword |
|
data_available
|
genai_maturity.data_available | boolean |
Whether GenAI maturity data was found |
|
no_data_reason
|
genai_maturity.no_data_reason | string |
Reason when GenAI maturity data is unavailable |
|
stage
|
genai_maturity.ai_trajectory.stage | string |
AI trajectory stage classification |
|
intensity
|
genai_maturity.ai_trajectory.intensity | number |
Intensity score (0-100) |
|
ai_maturity_score
|
genai_maturity.ai_trajectory.signals.ai_maturity_score | number | |
|
ai_maturity_6m_delta
|
genai_maturity.ai_trajectory.signals.ai_maturity_6m_delta | number | |
|
stage
|
genai_maturity.cloud_depth.stage | string |
Cloud depth stage classification |
|
intensity
|
genai_maturity.cloud_depth.intensity | number |
Intensity score (0-100) |
|
gcp_intensity
|
genai_maturity.cloud_depth.signals.gcp_intensity | number | |
|
aws_intensity
|
genai_maturity.cloud_depth.signals.aws_intensity | number | |
|
azure_intensity
|
genai_maturity.cloud_depth.signals.azure_intensity | number | |
|
stage
|
genai_maturity.genai_readiness.stage | string |
GenAI readiness stage classification |
|
intensity
|
genai_maturity.genai_readiness.intensity | number |
Intensity score (0-100) |
|
genai_intent_score
|
genai_maturity.genai_readiness.signals.genai_intent_score | number | |
|
ai_product_use
|
genai_maturity.genai_readiness.signals.ai_product_use | boolean | |
|
data_maturity_score
|
genai_maturity.genai_readiness.signals.data_maturity_score | number | |
|
stage
|
genai_maturity.intent_adoption_gap.stage | string |
Intent-adoption gap stage classification |
|
intensity
|
genai_maturity.intent_adoption_gap.intensity | number |
Intensity score (0-100) |
|
genai_intent_score
|
genai_maturity.intent_adoption_gap.signals.genai_intent_score | number | |
|
ai_product_use
|
genai_maturity.intent_adoption_gap.signals.ai_product_use | boolean | |
|
ai_maturity_score
|
genai_maturity.intent_adoption_gap.signals.ai_maturity_score | number |
CompanyInstallTimeSeriesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
organization_id
|
organization.organization_id | string |
Resolved organization ID |
|
organization_name
|
organization.organization_name | string |
Organization display name |
|
match_confidence
|
organization.match_confidence | number |
Confidence of domain match (0.0-1.0) |
|
start_date
|
time_range.start_date | string |
Start date (YYYY-MM format) |
|
end_date
|
time_range.end_date | string |
End date (YYYY-MM format) |
|
granularity
|
time_range.granularity | string | |
|
products
|
products | array of object |
Products with their time series data |
|
product_id
|
products.product_id | string | |
|
product_name
|
products.product_name | string | |
|
vendor_name
|
products.vendor_name | string | |
|
category
|
products.category | string | |
|
is_active
|
products.is_active | boolean |
Whether the product was verified within the last 90 days |
|
current_intensity
|
products.current_intensity | number |
Current intensity (0-100 scale) |
|
intensity_momentum
|
products.intensity_momentum | number |
Momentum float — positive means growing, negative means declining |
|
data_points
|
products.data_points | array of object | |
|
date
|
products.data_points.date | string |
YYYY-MM format |
|
intensity
|
products.data_points.intensity | number |
Intensity for that month, null if no data |
|
credits_consumed
|
credits_consumed | number |
Credits consumed (3 per product returned) |
CompanyIntentResponse
Intent mode returns company/window/summary/topics/activities. Activity search mode returns companies (group_by=company) or events (raw mode) with pagination.
| Name | Path | Type | Description |
|---|---|---|---|
|
company_id
|
company.company_id | string | |
|
company_name
|
company.company_name | string | |
|
domain
|
company.domain | string | |
|
start
|
window.start | string | |
|
end
|
window.end | string | |
|
total_active_topics
|
summary.total_active_topics | number | |
|
high_intent_topics
|
summary.high_intent_topics | number | |
|
top_context_types
|
summary.top_context_types | object |
Context type counts |
|
sources
|
summary.sources | object |
Signal counts by source |
|
latest_signal_date
|
summary.latest_signal_date | string | |
|
topics
|
topics | array of object |
Per-topic intent details (intent mode) |
|
topic_id
|
topics.topic_id | string | |
|
topic_name
|
topics.topic_name | string | |
|
score
|
topics.score | number |
Intent score (0-100) |
|
intent_level
|
topics.intent_level | string | |
|
buyers_journey
|
topics.buyers_journey | string | |
|
context_types
|
topics.context_types | array of string | |
|
context_dispositions
|
topics.context_dispositions | array of string | |
|
vendor_names
|
topics.vendor_names | array of string | |
|
product_names
|
topics.product_names | array of string | |
|
trend
|
topics.trend | number | |
|
last_seen_at
|
topics.last_seen_at | string | |
|
source
|
topics.source | string | |
|
activities
|
activities | array of object |
TrustRadius buyer activities (intent mode) |
|
activity_type
|
activities.activity_type | string | |
|
activity_label
|
activities.activity_label | string | |
|
products
|
activities.products | array of string | |
|
vendors
|
activities.vendors | array of string | |
|
activity_date
|
activities.activity_date | string | |
|
daily_views
|
activities.daily_views | number | |
|
intent_signal_url
|
activities.intent_signal_url | string | |
|
companies
|
companies | array of object |
Companies matching the activity search query (returned when group_by='company') |
|
company_id
|
companies.company_id | string | |
|
company_name
|
companies.company_name | string | |
|
domain
|
companies.domain | string | |
|
employees_range
|
companies.employees_range | string | |
|
event_count
|
companies.event_count | number | |
|
total_views
|
companies.total_views | number | |
|
last_activity_date
|
companies.last_activity_date | string | |
|
products_compared
|
companies.products_compared | array of string | |
|
vendors
|
companies.vendors | array of string | |
|
signals
|
companies.signals | array of string | |
|
activity_labels
|
companies.activity_labels | array of string | |
|
events
|
events | array of object |
Individual activity events with evidence URLs (returned when group_by is omitted) |
|
activity_date
|
events.activity_date | string | |
|
activity_type
|
events.activity_type | string | |
|
activity_label
|
events.activity_label | string | |
|
signal
|
events.signal | string | |
|
daily_views
|
events.daily_views | number | |
|
product_names
|
events.product_names | array of string | |
|
vendor_names
|
events.vendor_names | array of string | |
|
category_name_trees
|
events.category_name_trees | array of string | |
|
intent_signal_url
|
events.intent_signal_url | string | |
|
company_id
|
events.company_id | string | |
|
company_name
|
events.company_name | string | |
|
domain
|
events.domain | string | |
|
total
|
pagination.total | number | |
|
limit
|
pagination.limit | number | |
|
offset
|
pagination.offset | number | |
|
has_more
|
pagination.has_more | boolean |
IntentCategoryResponse
Intent mode returns context/companies/pagination. Activity search mode returns companies (group_by=company) or events (raw mode) with pagination.
| Name | Path | Type | Description |
|---|---|---|---|
|
start
|
context.date_range.start | string | |
|
end
|
context.date_range.end | string | |
|
source
|
context.source | string |
Data sources queried |
|
topic_id
|
context.topic_resolved.topic_id | string | |
|
topic_name
|
context.topic_resolved.topic_name | string | |
|
generated_at
|
context.generated_at | string | |
|
companies
|
companies | array of object |
Intent mode: companies with signal strength. Activity search mode (group_by=company): companies with event counts. |
|
company_id
|
companies.company_id | string | |
|
company_name
|
companies.company_name | string | |
|
domain
|
companies.domain | string | |
|
signal_strength
|
companies.signal_strength | number |
Intent signal strength 0-100 (intent mode) |
|
intent_level
|
companies.intent_level | string |
High, Medium, or Low (intent mode) |
|
buyers_journey
|
companies.buyers_journey | string | |
|
context_types
|
companies.context_types | array of string | |
|
topics_matched
|
companies.topics_matched | array of string | |
|
last_seen_at
|
companies.last_seen_at | string | |
|
source
|
companies.source | string | |
|
employees_range
|
companies.employees_range | string |
Activity search mode |
|
event_count
|
companies.event_count | number |
Activity search mode |
|
total_views
|
companies.total_views | number |
Activity search mode |
|
last_activity_date
|
companies.last_activity_date | string |
Activity search mode |
|
products_compared
|
companies.products_compared | array of string |
Activity search mode |
|
vendors
|
companies.vendors | array of string |
Activity search mode |
|
signals
|
companies.signals | array of string |
Activity search mode |
|
events
|
events | array of object |
Individual activity events with evidence URLs (returned when group_by is omitted) |
|
activity_date
|
events.activity_date | string | |
|
activity_type
|
events.activity_type | string | |
|
activity_label
|
events.activity_label | string | |
|
signal
|
events.signal | string | |
|
daily_views
|
events.daily_views | number | |
|
product_names
|
events.product_names | array of string | |
|
vendor_names
|
events.vendor_names | array of string | |
|
category_name_trees
|
events.category_name_trees | array of string | |
|
intent_signal_url
|
events.intent_signal_url | string | |
|
company_id
|
events.company_id | string | |
|
company_name
|
events.company_name | string | |
|
domain
|
events.domain | string | |
|
total
|
pagination.total | number | |
|
limit
|
pagination.limit | number | |
|
offset
|
pagination.offset | number | |
|
has_more
|
pagination.has_more | boolean |
ContactSearchResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
contacts
|
contacts | array of object |
List of contacts found |
|
id
|
contacts.id | string |
Contact ID (use for enrichment with the same provider) |
|
firstName
|
contacts.firstName | string |
First name |
|
lastName
|
contacts.lastName | string |
Last name |
|
name
|
contacts.name | string |
Full name |
|
title
|
contacts.title | string |
Job title |
|
seniority
|
contacts.seniority | string |
Seniority level |
|
linkedinUrl
|
contacts.linkedinUrl | string |
LinkedIn profile URL |
|
id
|
contacts.organization.id | string |
Organization ID |
|
name
|
contacts.organization.name | string |
Company name |
|
domain
|
contacts.organization.domain | string |
Company domain |
|
industry
|
contacts.organization.industry | string |
Industry |
|
employeeCount
|
contacts.organization.employeeCount | number |
Employee count |
|
location
|
contacts.organization.location | string |
Company location |
|
city
|
contacts.city | string |
City |
|
state
|
contacts.state | string |
State/Region |
|
country
|
contacts.country | string |
Country |
|
page
|
pagination.page | number |
Current page number |
|
perPage
|
pagination.perPage | number |
Results per page |
|
totalResults
|
pagination.totalResults | number |
Total number of matching contacts |
|
hasMore
|
pagination.hasMore | boolean |
Whether more results are available |
|
searchCriteria
|
metadata.searchCriteria | object |
The search criteria used |
|
tip
|
metadata.tip | string |
Usage tip |
|
provider
|
metadata.provider | string |
Contact data provider used (e.g., apollo, zoominfo) |
|
usedProvider
|
metadata.usedProvider | string |
Which provider fulfilled this request |
|
availableProviders
|
metadata.availableProviders | array of string |
Providers configured for the organization |
|
warnings
|
metadata.warnings | array of string |
Warnings about ignored parameters |
ContactEnrichResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
contact.id | string |
Contact ID |
|
firstName
|
contact.firstName | string |
First name |
|
lastName
|
contact.lastName | string |
Last name |
|
name
|
contact.name | string |
Full name |
|
title
|
contact.title | string |
Job title |
|
seniority
|
contact.seniority | string |
Seniority level |
|
email
|
contact.email | string |
Email address (if revealed) |
|
emailStatus
|
contact.emailStatus | string |
Email verification status |
|
personalEmails
|
contact.personalEmails | array of string |
Personal email addresses |
|
phone
|
contact.phone | string |
Primary phone number |
|
mobilePhone
|
contact.mobilePhone | string |
Mobile phone number |
|
corporatePhone
|
contact.corporatePhone | string |
Corporate phone number |
|
linkedinUrl
|
contact.linkedinUrl | string |
LinkedIn profile URL |
|
twitterUrl
|
contact.twitterUrl | string |
Twitter/X profile URL |
|
facebookUrl
|
contact.facebookUrl | string |
Facebook profile URL |
|
githubUrl
|
contact.githubUrl | string |
GitHub profile URL |
|
id
|
contact.organization.id | string |
Organization ID |
|
name
|
contact.organization.name | string |
Company name |
|
domain
|
contact.organization.domain | string |
Company domain |
|
industry
|
contact.organization.industry | string |
Industry |
|
employeeCount
|
contact.organization.employeeCount | number |
Employee count |
|
revenue
|
contact.organization.revenue | number |
Annual revenue |
|
location
|
contact.organization.location | string |
Company location |
|
linkedinUrl
|
contact.organization.linkedinUrl | string |
Company LinkedIn URL |
|
website
|
contact.organization.website | string |
Company website |
|
employmentHistory
|
contact.employmentHistory | array of object |
Employment history |
|
organizationName
|
contact.employmentHistory.organizationName | string | |
|
title
|
contact.employmentHistory.title | string | |
|
startDate
|
contact.employmentHistory.startDate | string | |
|
endDate
|
contact.employmentHistory.endDate | string | |
|
isCurrent
|
contact.employmentHistory.isCurrent | boolean | |
|
city
|
contact.city | string |
City |
|
state
|
contact.state | string |
State/Region |
|
country
|
contact.country | string |
Country |
|
contacts
|
contacts | array of object |
Enriched contacts (bulk enrichment) |
|
id
|
contacts.id | string |
Contact ID |
|
firstName
|
contacts.firstName | string |
First name |
|
lastName
|
contacts.lastName | string |
Last name |
|
name
|
contacts.name | string |
Full name |
|
title
|
contacts.title | string |
Job title |
|
seniority
|
contacts.seniority | string |
Seniority level |
|
email
|
contacts.email | string |
Email address (if revealed) |
|
emailStatus
|
contacts.emailStatus | string |
Email verification status |
|
personalEmails
|
contacts.personalEmails | array of string |
Personal email addresses |
|
phone
|
contacts.phone | string |
Primary phone number |
|
mobilePhone
|
contacts.mobilePhone | string |
Mobile phone number |
|
corporatePhone
|
contacts.corporatePhone | string |
Corporate phone number |
|
linkedinUrl
|
contacts.linkedinUrl | string |
LinkedIn profile URL |
|
twitterUrl
|
contacts.twitterUrl | string |
Twitter/X profile URL |
|
facebookUrl
|
contacts.facebookUrl | string |
Facebook profile URL |
|
githubUrl
|
contacts.githubUrl | string |
GitHub profile URL |
|
id
|
contacts.organization.id | string |
Organization ID |
|
name
|
contacts.organization.name | string |
Company name |
|
domain
|
contacts.organization.domain | string |
Company domain |
|
industry
|
contacts.organization.industry | string |
Industry |
|
employeeCount
|
contacts.organization.employeeCount | number |
Employee count |
|
revenue
|
contacts.organization.revenue | number |
Annual revenue |
|
location
|
contacts.organization.location | string |
Company location |
|
linkedinUrl
|
contacts.organization.linkedinUrl | string |
Company LinkedIn URL |
|
website
|
contacts.organization.website | string |
Company website |
|
employmentHistory
|
contacts.employmentHistory | array of object |
Employment history |
|
organizationName
|
contacts.employmentHistory.organizationName | string | |
|
title
|
contacts.employmentHistory.title | string | |
|
startDate
|
contacts.employmentHistory.startDate | string | |
|
endDate
|
contacts.employmentHistory.endDate | string | |
|
isCurrent
|
contacts.employmentHistory.isCurrent | boolean | |
|
city
|
contacts.city | string |
City |
|
state
|
contacts.state | string |
State/Region |
|
country
|
contacts.country | string |
Country |
|
creditsUsed
|
metadata.creditsUsed | number |
Number of credits consumed |
|
matchConfidence
|
metadata.matchConfidence | string |
Match confidence level |
|
enrichedAt
|
metadata.enrichedAt | string |
ISO timestamp of enrichment |
|
noMatchReason
|
metadata.noMatchReason | string |
Reason when no matching contact was found |
|
enrichmentType
|
metadata.enrichmentType | string |
Type of enrichment performed |
|
provider
|
metadata.provider | string |
Contact data provider used (e.g., apollo, zoominfo) |
|
usedProvider
|
metadata.usedProvider | string |
Which provider fulfilled this request |
|
availableProviders
|
metadata.availableProviders | array of string |
Providers configured for the organization |
SecFilingSectionResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyName
|
companyName | string |
Full company name from the filing |
|
ticker
|
ticker | string |
Stock ticker symbol |
|
cik
|
cik | string |
SEC Central Index Key |
|
filingType
|
filingType | string |
Type of SEC filing |
|
filingDate
|
filingDate | string |
Date the filing was submitted to SEC |
|
periodOfReport
|
periodOfReport | string |
Period covered by the filing |
|
section
|
section | string |
Section code that was extracted |
|
sectionLabel
|
sectionLabel | string |
Human-readable section name |
|
content
|
content | string |
Extracted section content |
|
contentFormat
|
contentFormat | string |
Format of the content |
|
filingUrl
|
filingUrl | string |
URL to the original SEC filing |
|
wordCount
|
wordCount | number |
Word count of the extracted content |
|
accessionNumber
|
metadata.accessionNumber | string |
SEC accession number for the filing |
|
fiscalYear
|
metadata.fiscalYear | number |
Fiscal year of the filing |
|
fiscalQuarter
|
metadata.fiscalQuarter | number |
Fiscal quarter (for 10-Q filings) |
SecFullTextSearchResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | number |
Total number of matching filings |
|
query
|
query | string |
The search query that was executed |
|
filings
|
filings | array of object |
Array of matching filings |
|
accessionNumber
|
filings.accessionNumber | string |
SEC accession number |
|
formType
|
filings.formType | string |
Type of SEC filing (10-K, 10-Q, 8-K, etc.) |
|
filedAt
|
filings.filedAt | string |
Filing date |
|
companyName
|
filings.companyName | string |
Company name |
|
ticker
|
filings.ticker | string |
Stock ticker symbol |
|
cik
|
filings.cik | string |
SEC Central Index Key |
|
filingUrl
|
filings.filingUrl | string |
URL to the SEC filing |
|
description
|
filings.description | string |
Filing description |
|
filingTypes
|
searchParams.filingTypes | array of string | |
|
tickers
|
searchParams.tickers | array of string | |
|
startDate
|
searchParams.startDate | string | |
|
endDate
|
searchParams.endDate | string | |
|
limit
|
searchParams.limit | number |
SearchFederalContractsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | number |
Total matching contracts |
|
contracts
|
contracts | array of object |
List of federal contract awards matching the search criteria |
|
awardId
|
contracts.awardId | string | |
|
recipientName
|
contracts.recipientName | string | |
|
recipientUei
|
contracts.recipientUei | string | |
|
awardingAgency
|
contracts.awardingAgency | string | |
|
awardingSubAgency
|
contracts.awardingSubAgency | string | |
|
totalObligation
|
contracts.totalObligation | number | |
|
totalObligationFormatted
|
contracts.totalObligationFormatted | string | |
|
startDate
|
contracts.startDate | string | |
|
endDate
|
contracts.endDate | string | |
|
contractType
|
contracts.contractType | string | |
|
naicsCode
|
contracts.naicsCode | string | |
|
naicsDescription
|
contracts.naicsDescription | string | |
|
pscCode
|
contracts.pscCode | string | |
|
pscDescription
|
contracts.pscDescription | string | |
|
setAsideType
|
contracts.setAsideType | string | |
|
city
|
contracts.placeOfPerformance.city | string | |
|
state
|
contracts.placeOfPerformance.state | string | |
|
country
|
contracts.placeOfPerformance.country | string | |
|
description
|
contracts.description | string | |
|
hasMore
|
hasMore | boolean |
Whether more results are available |
SearchGovOpportunitiesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | number |
Total matching opportunities |
|
opportunities
|
opportunities | array of object |
List of federal opportunities/solicitations matching the search criteria |
|
opportunityId
|
opportunities.opportunityId | string | |
|
title
|
opportunities.title | string | |
|
solicitationNumber
|
opportunities.solicitationNumber | string | |
|
agency
|
opportunities.agency | string | |
|
subAgency
|
opportunities.subAgency | string | |
|
postedDate
|
opportunities.postedDate | string | |
|
responseDeadline
|
opportunities.responseDeadline | string | |
|
daysUntilDeadline
|
opportunities.daysUntilDeadline | number | |
|
type
|
opportunities.type | string | |
|
setAsideType
|
opportunities.setAsideType | string | |
|
naicsCode
|
opportunities.naicsCode | string | |
|
classificationCode
|
opportunities.classificationCode | string | |
|
city
|
opportunities.placeOfPerformance.city | string | |
|
state
|
opportunities.placeOfPerformance.state | string | |
|
country
|
opportunities.placeOfPerformance.country | string | |
|
description
|
opportunities.description | string | |
|
link
|
opportunities.link | string | |
|
hasMore
|
hasMore | boolean |
Whether more results are available |
CompanyGovOpportunitiesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyName
|
companyName | string |
Resolved company name from SAM.gov |
|
companyDomain
|
companyDomain | string |
The company domain that was looked up |
|
uei
|
samEntity.uei | string | |
|
cageCode
|
samEntity.cageCode | string | |
|
legalBusinessName
|
samEntity.legalBusinessName | string | |
|
opportunities
|
opportunities | array of object |
Matching federal opportunities with incumbent status |
|
opportunityId
|
opportunities.opportunityId | string | |
|
title
|
opportunities.title | string | |
|
agency
|
opportunities.agency | string | |
|
responseDeadline
|
opportunities.responseDeadline | string | |
|
daysUntilDeadline
|
opportunities.daysUntilDeadline | number | |
|
incumbentStatus
|
opportunities.incumbentStatus | string | |
|
matchReason
|
opportunities.matchReason | string | |
|
link
|
opportunities.link | string | |
|
totalOpportunities
|
totalOpportunities | number |
Total number of matching opportunities |
CompanyGovRelationshipsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
companyName
|
companyName | string |
Resolved company name from SAM.gov |
|
companyDomain
|
companyDomain | string |
The company domain that was looked up |
|
uei
|
samEntity.uei | string | |
|
cageCode
|
samEntity.cageCode | string | |
|
legalBusinessName
|
samEntity.legalBusinessName | string | |
|
totalValue
|
asSubcontractor.totalValue | number | |
|
totalValueFormatted
|
asSubcontractor.totalValueFormatted | string | |
|
primeContractors
|
asSubcontractor.primeContractors | array of object | |
|
partnerName
|
asSubcontractor.primeContractors.partnerName | string | |
|
contractCount
|
asSubcontractor.primeContractors.contractCount | number | |
|
totalValue
|
asSubcontractor.primeContractors.totalValue | number | |
|
totalValueFormatted
|
asSubcontractor.primeContractors.totalValueFormatted | string | |
|
agencies
|
asSubcontractor.primeContractors.agencies | array of string | |
|
totalValue
|
asPrimeContractor.totalValue | number | |
|
totalValueFormatted
|
asPrimeContractor.totalValueFormatted | string | |
|
subcontractors
|
asPrimeContractor.subcontractors | array of object | |
|
partnerName
|
asPrimeContractor.subcontractors.partnerName | string | |
|
contractCount
|
asPrimeContractor.subcontractors.contractCount | number | |
|
totalValue
|
asPrimeContractor.subcontractors.totalValue | number | |
|
totalValueFormatted
|
asPrimeContractor.subcontractors.totalValueFormatted | string | |
|
agencies
|
asPrimeContractor.subcontractors.agencies | array of string |