Skip to main content
POST
/
api
/
v1
/
platform
/
scrapers
/
web
/
search
Search web
curl --request POST \
  --url https://developer.thehog.ai/api/v1/platform/scrapers/web/search \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>' \
  --data '
{
  "query": "best CRM software 2025",
  "maxResults": 10,
  "searchDepth": "basic",
  "topic": "general",
  "days": 123,
  "includeDomains": [
    "<string>"
  ],
  "excludeDomains": [
    "<string>"
  ]
}
'
{
  "data": {
    "query": "<string>",
    "results": [
      {
        "url": "<string>",
        "title": "<string>",
        "content": "<string>",
        "publishedDate": "<string>",
        "position": 123
      }
    ],
    "totalResults": 123
  },
  "meta": {
    "requestId": "<string>"
  }
}

POST /api/v1/platform/scrapers/web/search

Search the web and return ranked results.
Run a web search and return result URLs, titles, and snippets.

Example

curl -X POST https://developer.thehog.ai/api/v1/platform/scrapers/web/search \
  -H "X-Access-Key: ak_xxxxxxxxxxxxxxxx" \
  -H "X-Secret-Key: sk_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"query": "AI CRM tools", "maxResults": 10}'

Authorizations

X-Access-Key
string
header
required

The public API key from the Credentials page.

X-Secret-Key
string
header
required

The API secret shown when the credential is created.

Body

application/json
query
string
required

Search query

Example:

"best CRM software 2025"

maxResults
number
default:10
Required range: 1 <= x <= 50
searchDepth
enum<string>
default:basic
Available options:
basic,
advanced
topic
enum<string>
default:general
Available options:
general,
news
days
number

Limit results to last N days (news only)

includeDomains
string[]

Only include results from these domains

excludeDomains
string[]

Exclude results from these domains

Response

Successful response.

data
object
required
meta
object
required