Submit search
Run a search across supported web and social sources. The default response returns an operation to poll; add sync=true only when you want to wait briefly for an immediate result.
POST
/
api
/
v1
/
search
Submit search
curl --request POST \
--url https://developer.thehog.ai/api/v1/search \
--header 'Content-Type: application/json' \
--header 'X-Access-Key: <api-key>' \
--header 'X-Secret-Key: <api-key>' \
--data '
{
"type": "web_search",
"query": "AI startup funding 2026",
"match_any": [
"AI startup",
"machine learning funding"
],
"match_all": [
"Series A",
"2026"
],
"exclude": [
"crypto",
"blockchain"
],
"max_results": 10,
"site": "techcrunch.com",
"include_domains": [
"<string>"
],
"exclude_domains": [
"<string>"
],
"sort_by": "relevance",
"match_mode": "exact",
"date_filter": "<string>",
"hashtag": "productanalytics",
"subreddit": "startups"
}
'const options = {
method: 'POST',
headers: {
'X-Access-Key': '<api-key>',
'X-Secret-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'web_search',
query: 'AI startup funding 2026',
match_any: ['AI startup', 'machine learning funding'],
match_all: ['Series A', '2026'],
exclude: ['crypto', 'blockchain'],
max_results: 10,
site: 'techcrunch.com',
include_domains: ['<string>'],
exclude_domains: ['<string>'],
sort_by: 'relevance',
match_mode: 'exact',
date_filter: '<string>',
hashtag: 'productanalytics',
subreddit: 'startups'
})
};
fetch('https://developer.thehog.ai/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://developer.thehog.ai/api/v1/search"
payload = {
"type": "web_search",
"query": "AI startup funding 2026",
"match_any": ["AI startup", "machine learning funding"],
"match_all": ["Series A", "2026"],
"exclude": ["crypto", "blockchain"],
"max_results": 10,
"site": "techcrunch.com",
"include_domains": ["<string>"],
"exclude_domains": ["<string>"],
"sort_by": "relevance",
"match_mode": "exact",
"date_filter": "<string>",
"hashtag": "productanalytics",
"subreddit": "startups"
}
headers = {
"X-Access-Key": "<api-key>",
"X-Secret-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"status": "queued",
"type": "web_search",
"query": "<string>",
"created_at": "<string>",
"poll_url": "<string>",
"results": [
{
"url": "<string>",
"title": "<string>",
"content": "<string>",
"published_at": "<string>",
"author_name": "<string>",
"author_headline": "<string>",
"id": "<string>",
"platform_video_id": "<string>",
"post_url": "<string>",
"author_username": "<string>"
}
],
"total_results": 123,
"error": {
"message": "<string>",
"retryable": true
},
"completed_at": "<string>"
}{
"id": "<string>",
"status": "queued",
"poll_url": "<string>",
"meta": {
"request_id": "<string>"
}
}{
"statusCode": 400,
"error": "Bad Request",
"message": "Validation failed",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b",
"errors": [
{
"property": "body.query",
"message": "query must be a string",
"constraints": {
"isString": "query must be a string"
}
}
]
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication is required.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}{
"statusCode": 402,
"error": "Payment Required",
"message": "Insufficient credits.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}{
"statusCode": 422,
"error": "Unprocessable Entity",
"message": "Validation failed",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b",
"errors": [
{
"property": "body.query",
"message": "query must be a string",
"constraints": {
"isString": "query must be a string"
}
}
]
}{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}POST /api/v1/search
Submit a search across web, LinkedIn, X, Reddit, or TikTok. Returns 202.Submit a search query across one or more platforms. Returns
202 Accepted with a poll URL.
For Reddit post search, set type to reddit_search. Use sort_by: "relevance" for Reddit’s relevance ranking or sort_by: "recent" for Reddit’s newest-post ranking.
Example
curl -X POST https://developer.thehog.ai/api/v1/search \
-H "X-Access-Key: ak_xxxxxxxxxxxxxxxx" \
-H "X-Secret-Key: sk_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"type": "web_search", "query": "AI CRM tools", "max_results": 10}'
Authorizations
Headers
Query Parameters
Body
application/json
Response
Search completed immediately.
⌘I
Submit search
curl --request POST \
--url https://developer.thehog.ai/api/v1/search \
--header 'Content-Type: application/json' \
--header 'X-Access-Key: <api-key>' \
--header 'X-Secret-Key: <api-key>' \
--data '
{
"type": "web_search",
"query": "AI startup funding 2026",
"match_any": [
"AI startup",
"machine learning funding"
],
"match_all": [
"Series A",
"2026"
],
"exclude": [
"crypto",
"blockchain"
],
"max_results": 10,
"site": "techcrunch.com",
"include_domains": [
"<string>"
],
"exclude_domains": [
"<string>"
],
"sort_by": "relevance",
"match_mode": "exact",
"date_filter": "<string>",
"hashtag": "productanalytics",
"subreddit": "startups"
}
'const options = {
method: 'POST',
headers: {
'X-Access-Key': '<api-key>',
'X-Secret-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'web_search',
query: 'AI startup funding 2026',
match_any: ['AI startup', 'machine learning funding'],
match_all: ['Series A', '2026'],
exclude: ['crypto', 'blockchain'],
max_results: 10,
site: 'techcrunch.com',
include_domains: ['<string>'],
exclude_domains: ['<string>'],
sort_by: 'relevance',
match_mode: 'exact',
date_filter: '<string>',
hashtag: 'productanalytics',
subreddit: 'startups'
})
};
fetch('https://developer.thehog.ai/api/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://developer.thehog.ai/api/v1/search"
payload = {
"type": "web_search",
"query": "AI startup funding 2026",
"match_any": ["AI startup", "machine learning funding"],
"match_all": ["Series A", "2026"],
"exclude": ["crypto", "blockchain"],
"max_results": 10,
"site": "techcrunch.com",
"include_domains": ["<string>"],
"exclude_domains": ["<string>"],
"sort_by": "relevance",
"match_mode": "exact",
"date_filter": "<string>",
"hashtag": "productanalytics",
"subreddit": "startups"
}
headers = {
"X-Access-Key": "<api-key>",
"X-Secret-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"status": "queued",
"type": "web_search",
"query": "<string>",
"created_at": "<string>",
"poll_url": "<string>",
"results": [
{
"url": "<string>",
"title": "<string>",
"content": "<string>",
"published_at": "<string>",
"author_name": "<string>",
"author_headline": "<string>",
"id": "<string>",
"platform_video_id": "<string>",
"post_url": "<string>",
"author_username": "<string>"
}
],
"total_results": 123,
"error": {
"message": "<string>",
"retryable": true
},
"completed_at": "<string>"
}{
"id": "<string>",
"status": "queued",
"poll_url": "<string>",
"meta": {
"request_id": "<string>"
}
}{
"statusCode": 400,
"error": "Bad Request",
"message": "Validation failed",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b",
"errors": [
{
"property": "body.query",
"message": "query must be a string",
"constraints": {
"isString": "query must be a string"
}
}
]
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication is required.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}{
"statusCode": 402,
"error": "Payment Required",
"message": "Insufficient credits.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}{
"statusCode": 422,
"error": "Unprocessable Entity",
"message": "Validation failed",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b",
"errors": [
{
"property": "body.query",
"message": "query must be a string",
"constraints": {
"isString": "query must be a string"
}
}
]
}{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred.",
"path": "/api/v1/search",
"timestamp": "2026-05-21T09:08:10.000Z",
"requestId": "506af9b3-01a9-43be-9eb4-8458fe3e4f5b"
}