SwiftSearch Parameters

Complete parameter reference for the SwiftSearch API

Parameter Validation

All parameters are validated before processing. Invalid parameters will return a 400 error with details about what needs to be corrected.

Request Parameters

SwiftSearch Request Parameters

Parameter	Type	Required	Description
`query`	string	Required	The search query to execute. Supports natural language queries, keywords, and search operators. Example:`"Bitcoin price analysis" OR "crypto market trends"`
`max_results`	integer	Optional	Maximum number of search results to return. Higher values consume more credits. Example:`10`
`auto_scrape_top`	integer	Optional	Number of top results to automatically scrape for content extraction. Example:`3`
`include_contacts`	boolean	Optional	Extract contact information (emails, phone numbers) from scraped content. Example:`true`
`include_social`	boolean	Optional	Extract social media links and handles from scraped content. Example:`false`
`country`	string	Optional	Target country for search results using ISO 3166-1 alpha-2 codes. Example:`"US", "GB", "DE"`
`language`	string	Optional	Preferred language for search results using ISO 639-1 codes. Example:`"en", "es", "fr"`
`time_range`	string	Optional	Filter results by publication time. Example:`"24h", "week", "month", "year"`
`safe_search`	string	Optional	Filter explicit content from search results. Example:`"strict", "moderate", "off"`
`result_type`	string	Optional	Type of search results to prioritize. Example:`"web", "news", "images", "videos"`

Credit Consumption

Base search:

1 credit

Per result returned:

0.1 credits

Per page scraped:

2 credits

Contact extraction:

+0.5 credits

Social extraction:

+0.3 credits

Supported Countries

US - United States

GB - United Kingdom

DE - Germany

FR - France

ES - Spain

IT - Italy

CA - Canada

AU - Australia

JP - Japan

IN - India

BR - Brazil

MX - Mexico

And 50+ more countries supported

Response Format

SwiftSearch Response Fields

Field	Type	Description
`search_results`	array	Array of search result objects containing title, URL, snippet, and metadata. Example:`[{title: '...', link: '...', snippet: '...'}, ...]`
`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 (may exceed max_results). Example:`1247`
`search_time`	float	Time taken to execute the search query in seconds. Example:`0.34`
`credits_used`	integer	Number of API credits consumed by this request. Example:`15`
`remaining_credits`	integer	Number of API credits remaining in your account. Example:`9985`
`request_id`	string	Unique identifier for this API request (useful for support). Example:`"req_1234567890abcdef"`

Example Requests

Minimal Request

The simplest possible request with just a search query:

Minimal SwiftSearch Request

curl -X POST https://www.searchhive.dev/api/v1/swiftsearch \
  -H "Authorization": "Bearer: sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "latest AI developments"
  }'

Advanced Request

Using all available parameters for maximum functionality:

Advanced SwiftSearch Request

curl -X POST https://www.searchhive.dev/api/v1/swiftsearch \
  -H "Authorization": "Bearer: sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "enterprise SaaS startups 2025",
    "max_results": 20,
    "auto_scrape_top": 5,
    "include_contacts": true,
    "include_social": true,
    "country": "US",
    "language": "en",
    "time_range": "month",
    "safe_search": "moderate",
    "result_type": "web"
  }'

Parameter Tips & Best Practices

Optimization Tips

Query Optimization:

Use specific keywords and phrases. Avoid overly broad queries.

Result Limits:

Start with max_results=10, increase only if needed to save credits.

Scraping Strategy:

Set auto_scrape_top=3-5 for the most valuable content extraction.

Regional Targeting:

Use country parameter for location-specific results.

Common Mistakes

Empty Queries:

Always provide a non-empty query string.

Credit Waste:

Don't set max_results too high for exploratory searches.

Invalid Countries:

Use ISO 3166-1 alpha-2 codes (e.g., "US", not "USA").

Contact Extraction:

Only enable when needed - it increases processing time and costs.