SEARCH API · REFERENCE

Search API Reference

Interactive API testing and complete reference documentation.

Interactive API Testing

Test the Search API directly from this page with live examples. Replace the demo key with your actual API key for real results.

POSThttps://www.search.venym.io/api/v1/search

Search the Web in Real-Time

Execute real-time web searches with automatic content extraction and enrichment

Request Builder

API Key

Using demo key. Replace with your actual API key.

Parameters

queryRequired

The search query to execute. Supports natural language and search operators.

max_results

Maximum number of search results to return (1-50).

auto_scrape_top

Number of top results to automatically scrape (0-10).

include_contactsEnable include_contacts

Extract contact information from scraped content.

include_socialEnable include_social

Extract social media links from scraped content.

country

Target country for search results (ISO 3166-1 alpha-2).

language

Preferred language for search results (ISO 639-1).

time_range

Filter results by publication time.

result_type

Type of search results to prioritize.

Code Examples

import requests

response = requests.post(
    "https://www.search.venym.io/api/v1/search",
    headers={"Authorization": "Bearer " + "demo_sk_search_12345"},
    json={
  "query": "latest AI developments 2025",
  "max_results": 10,
  "auto_scrape_top": 3,
  "include_contacts": false,
  "include_social": false,
  "country": "US",
  "language": "en",
  "time_range": "month",
  "result_type": "web"
}
)

data = response.json()
print(data)

API Response

Click Test API to see the response

01 · Response Schema

Response Schema

Search Response Fields

Field	Type	Description
`search_results`	array	Array of search result objects with title, URL, snippet, and metadata. Example: `[{title: "...", link: "...", snippet: "...", domain: "...", published_date: "..."}]`
`scraped_content`	array	Array of scraped content from auto_scrape_top results (if enabled). Example: `[{url: "...", content: "...", contacts: [...], social: [...]}]`
`total_results`	integer	Total number of search results found. Example: `1247`
`search_time`	float	Time taken to execute the search in seconds. Example: `0.34`
`credits_used`	integer	Number of API credits consumed. Example: `15`
`remaining_credits`	integer	Remaining API credits in your account. Example: `9985`
`request_id`	string	Unique identifier for this request. Example: `"req_1234567890abcdef"`

02 · Features

Key Features

Real-Time Search

• Live web search results
• Fresh content indexing
• Multiple search engines
• Instant result delivery

Auto-Scraping

• Automatic content extraction
• Clean text processing
• Contact information
• Social media links

Smart Filtering

• Geographic targeting
• Language preferences
• Time-based filtering
• Content type selection

03 · Error Codes

Error Codes

200 OK

Request successful, results returned

400 Bad Request

Invalid query or parameters

401 Unauthorized

Invalid or missing API key

429 Too Many Requests

Rate limit exceeded

04 · Use Cases

Common Use Cases

News Monitoring

Track breaking news and industry updates

{
  "query": "AI breakthrough news",
  "result_type": "news",
  "time_range": "24h",
  "max_results": 20
}

Lead Generation

Find potential customers and contacts

{
  "query": "SaaS startup founders email",
  "auto_scrape_top": 5,
  "include_contacts": true,
  "include_social": true
}

Market Research

Research competitors and market trends

{
  "query": "enterprise software market 2025",
  "auto_scrape_top": 10,
  "time_range": "month",
  "max_results": 30
}

Content Discovery

Find relevant content and resources

{
  "query": "machine learning tutorials 2025",
  "result_type": "web",
  "language": "en",
  "max_results": 15
}

Search Guide Scrape API Reference

import requests response = requests.post( "https://www.search.venym.io/api/v1/search", headers={"Authorization": "Bearer " + "demo_sk_search_12345"}, json={ "query": "latest AI developments 2025", "max_results": 10, "auto_scrape_top": 3, "include_contacts": false, "include_social": false, "country": "US", "language": "en", "time_range": "month", "result_type": "web" } ) data = response.json() print(data)