Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.thehog.ai/llms.txt

Use this file to discover all available pages before exploring further.

Before committing to a company search, you can call this endpoint to get a worst-case credit estimate for the same request body. The estimate assumes every row in the result page has a distinct domain and that all external provider lookups are required for each. Because the estimate is conservative by design, your actual charge after running the real search will typically be lower. This call is free — no credits are deducted.

​
Request

POST https://api.thehog.ai/api/companies/search/estimate

​
Authentication

HeaderRequiredDescription
AuthorizationYesBearer <your-api-key>
X-Project-IdNoOptional project context.

​
Body Parameters

This endpoint accepts the same request body as POST /api/companies/search. All parameters are optional.
​
query
string
Free-text search on company name and domain.
​
industry
string
Filter by industry.
​
employee_count_min
number
Minimum employee count.
​
employee_count_max
number
Maximum employee count.
​
domain
string
Filter by company domain.
​
location
string
Filter by country or city.
​
founding_year_min
number
Minimum founding year. Range: 1800–2100.
​
founding_year_max
number
Maximum founding year. Range: 1800–2100.
​
revenue_min
number
Minimum annual revenue in USD.
​
revenue_max
number
Maximum annual revenue in USD.
​
tech_stack
string[]
Required technologies. Example: ["Salesforce", "HubSpot"].
​
keyword_category
string
Keyword category filter.
​
hiring
boolean
Filter by hiring signal.
​
funding
boolean
Filter by recent funding signal.
​
growth
string
Growth band. One of: "low", "medium", "high".
​
limit
number
default:"20"
Page size used in the estimate calculation. Minimum 1, maximum 100.
​
offset
number
default:"0"
Pagination offset used in the estimate calculation.
​
projectId
string
Project context override.

​
Response

The response is wrapped in a data / meta envelope.
​
data
object
The estimate result.
​
meta
object
Request metadata.
The estimate reflects the worst case: all rows have distinct domains and every external provider is called. Actual charges after running the search depend on how many unique domains required live provider lookups versus data served from cache.

​
Example

curl -X POST https://api.thehog.ai/api/companies/search/estimate \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "industry": "Software",
    "employee_count_min": 50,
    "employee_count_max": 500,
    "tech_stack": ["Salesforce"],
    "hiring": true,
    "limit": 20
  }'