/brave/search

POST /api/brave/search

Price: 20 credits

Brave web search by query. Returns organic web results with url, title, displayed url, description, date, favicon, thumbnail, sponsored flag and site deep links. Supports region, language, safe search and recency filters.

How to use it

Brave web search by query. Brave runs its own independent search index (not Google/Bing). Each result has url, title, displayed_url, description, date, favicon, thumbnail, is_sponsored and deep_links. Use count to control how many results to return; country, search_lang, safesearch and tf to filter.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string required — Search query (examples: "python fastapi"; minLength: 1)
• count integer required — Maximum number of results to return (min: 1; max: 120)
• country string — Region of the search results (default: "all"; one of: "all", "us", "ar", "au", "at", "be", "br", "ca", "cl", "cn", "de", "dk", "fi", "fr", "gr", "hk", "in", "id", "it", "jp", "kr", "my", "mx", "nl", "nz", "no", "ph", "pl", "pt", "ru", "sa", "sg", "za", "es", "se", "ch", "tw", "tr", "gb")
• search_lang string nullable — Language of the result content (ISO 639-1) (one of: "en", "az", "id", "ms", "br", "ca", "cs", "cy", "da", "de", "et", "es", "eu", "fr", "gl", "hr", "it", "sw", "lv", "lt", "hu", "nl", "nb", "pl", "pt", "ro", "sq", "sk", "sl", "sr", "fi", "sv", "vi", "tr", "el", "bg", "ru", "uk", "ka", "th", "ko", "zh", "ja")
• safesearch string — Adult content filtering level (default: "moderate"; one of: "off", "moderate", "strict")
• tf string — Restrict results to a recency window (default: "any"; one of: "any", "pd", "pw", "pm", "py")

Response

• @type string (default: "BraveSearchResult")
• url string required
• position integer nullable
• displayed_url string nullable
• description string nullable
• date string nullable
• favicon string nullable
• thumbnail string nullable
• is_sponsored boolean (default: false)
• deep_links array (default: [])
  • @type string (default: "BraveDeepLink")
  • url string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.