v1

latestOpenAPI 3.0.02026-07-224452146.0 KB

Search and optionally scrape search results

post/search

Request body

querystring required

The search query

limitinteger

Maximum number of results to return (per source type when using multiple sources)

includeDomainsstring[]

Restricts search results to the specified domains. Domains should be hostnames only, without protocol or path. Cannot be used with excludeDomains.

excludeDomainsstring[]

Excludes search results from the specified domains. Domains should be hostnames only, without protocol or path. Cannot be used with includeDomains.

tbsstring

Time-based search parameter. Supports predefined time ranges (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y), custom date ranges (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY), and sort by date (sbd:1). Values can be combined, e.g. sbd:1,qdr:w.

locationstring

Location parameter for search results (e.g. San Francisco,California,United States). For best results, set both this and the country parameter.

countrystring

ISO country code for geo-targeting search results (e.g. US). For best results, set both this and the location parameter.

timeoutinteger

Timeout in milliseconds

ignoreInvalidURLsboolean

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.

highlightsboolean

Generate query-relevant highlights for search results. Set to false to return provider descriptions or snippets without highlighting.

enterprisestring[]

Enterprise search options for Zero Data Retention (ZDR). Use ["zdr"] for end-to-end ZDR (10 credits / 10 results) or ["anon"] for anonymized ZDR (2 credits / 10 results). Must be enabled for your team.

Example request

{
  "scrapeOptions": {
    "actions": [
      {
        "selector": "#my-element"
      }
    ],
    "location": {
      "languages": [
        "en-US"
      ]
    },
    "threatProtection": {
      "riskScoreThreshold": 75
    }
  },
  "threatProtection": {
    "riskScoreThreshold": 75
  }
}

Response

Successful response

successboolean

warningstring nullable

Warning message if any issues occurred

idstring

The ID of the search job

creditsUsedinteger

The number of credits used for the search