Learn how to use JigsawStack’s Web Search API to access high-quality search results with built-in geo search capabilities
The Web Search API provides access to high-quality search results with built-in AI overviews, comprehensive metadata, and geo-spatial search capabilities. This API makes it easy to integrate powerful search functionality into your applications while also providing location-based context for search queries.
Parameter | Type | Description |
---|---|---|
query | string | The search query (1-400 characters) |
spell_check | boolean | Enable or disable spell check (default: true) |
safe_search | string | Safe search level: “strict”, “moderate”, or “off” (default: “moderate”) |
ai_overview | boolean | Include AI-generated overview of results (default: true) |
byo_urls | array | Optional array of up to 3 URLs to include in search results |
country_code | string | ISO-3 country code to localize search results |
auto_scrape | boolean | Automatically scrape and extract content from results (default: true) |
deep_research | boolean | Enable deep research mode for comprehensive results |
deep_research_config | object | Configuration options for deep research mode |
The deep_research_config
object has the following properties:
Property | Type | Description |
---|---|---|
max_depth | number | Number of recursive search iterations (default: 3) |
max_breadth | number | Number of parallel subqueries per depth level (default: 3) |
max_output_tokens | number | Maximum tokens in generated output (default: 32000) |
target_output_tokens | number | Target number of tokens for output report |
The API automatically includes geolocation data when relevant to your search query. The geo_results
array contains location information with the following structure:
type
: Type of location (place, street, etc.)name
: Name of the locationplace_formatted
: Formatted place namecountry
: Country informationgeoloc
: GeoJSON object with coordinatesai_overview
to get concise summaries of search resultssafe_search
levels based on your application needs