Documentation Index
Fetch the complete documentation index at: https://mintlify.com/firecrawl/firecrawl/llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/search
Search the web using Firecrawl’s search engine and optionally scrape the content from the search results.Authentication
Requires Bearer token authentication. Include your API key in the Authorization header:Request Body
The search query
Maximum number of results to return. Minimum: 1, Maximum: 100
Time-based search parameter for filtering results by time period
Location parameter for search results
Timeout in milliseconds
Excludes URLs from the search results that are invalid for other Firecrawl endpoints. This helps reduce errors if you are piping data from search into other Firecrawl API endpoints.
Options for scraping search results
Formats to include in the scraped output. Options:
markdown, html, rawHtml, links, screenshot, screenshot@fullPage, json, brandingResponse
Indicates whether the request was successful
Array of search results
Title from search result
Description from search result
URL of the search result
Markdown content if scraping was requested
HTML content if requested in formats
Raw HTML content if requested in formats
Links found if requested in formats
Screenshot URL if requested in formats
Warning message if any issues occurred
Examples
Basic Search
Response
Search with Content Scraping
Get the full content of search results:Error Responses
Request Timeout - Request timed out
Server Error - An unexpected error occurred on the server