What’s New in v2
Search Multiple Sources
Search web, images, and news at once:Response Format Changed
v1: flat list of results. v2: organized by source type:New Features
- Filter by time ranges (“past week”, “past month”)
- Target specific countries/regions
- Category Filtering: Search within GitHub repositories or research websites
- Results capped at 500 during alpha
scrapeOptions
with formats: [{"type": "markdown"}]
to get complete markdown content for each search result otherwise you will default to getting the SERP results (url, title, description). You can also use other formats like {"type": "summary"}
for condensed content.
Supported query operators
We support a variety of query operators that allow you to filter your searches better.Operator | Functionality | Examples |
---|---|---|
"" | Non-fuzzy matches a string of text | "Firecrawl" |
- | Excludes certain keywords or negates other operators | -bad , -site:firecrawl.dev |
site: | Only returns results from a specified website | site:firecrawl.dev |
inurl: | Only returns results that include a word in the URL | inurl:firecrawl |
allinurl: | Only returns results that include multiple words in the URL | allinurl:git firecrawl |
intitle: | Only returns results that include a word in the title of the page | intitle:Firecrawl |
allintitle: | Only returns results that include multiple words in the title of the page | allintitle:firecrawl playground |
related: | Only returns results that are related to a specific domain | related:firecrawl.dev |
imagesize: | Only returns images with exact dimensions | imagesize:1920x1080 |
larger: | Only returns images larger than specified dimensions | larger:1920x1080 |
Location Parameter
Use thelocation
parameter to get geo-targeted search results. Format: "string"
. Examples: "Germany"
, "San Francisco,California,United States"
.
See the complete list of supported locations for all available countries and languages.
Categories Parameter
Filter search results by specific categories using thecategories
parameter:
github
: Search within GitHub repositories, code, issues, and documentationresearch
: Search academic and research websites (arXiv, Nature, IEEE, PubMed, etc.)
Example Usage
Category Response
Each result includes acategory
field indicating its source:
Time-Based Search
Use thetbs
parameter to filter results by time periods, including custom date ranges. See the Search Feature documentation for detailed examples and supported formats.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
The search query
Maximum number of results to return
Required range:
1 <= x <= 100
Sources to search. Will determine the arrays available in the response.
Categories to filter results by
Time-based search parameter. Supports predefined time ranges (qdr:h
, qdr:d
, qdr:w
, qdr:m
, qdr:y
) and custom date ranges (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY
)
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