Brave Search

Brave News Search API

Response Objects

# NewsSearchApiResponse

Top level response model for successful News Search API requests. The API can also respond back with an error response based on invalid subscription keys and rate limit events.

Field	Type	Required	Description
type	"news"	true	The type of search API result. The value is always `news`.
query	Query	true	News search query string.
results	list [ NewsResult ]	true	The list of news results for the given query.

# Query

A model representing information gathered around the requested query.

Field	Type	Required	Description
original	string	true	The original query that was requested.
altered	string	false	The altered query by the spellchecker. This is the query that is used to search if any.
cleaned	string	false	The cleaned normalized query by the spellchecker. This is the query that is used to search if any.
spellcheck_off	bool	false	Whether the spellchecker is enabled or disabled.
show_strict_warning	bool	false	The value is `true` if the lack of results is due to a `strict` safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.

# NewsResult

A model representing a news result for the requested query.

Field	Type	Required	Description
type	news_result	true	The type of news search API result. The value is always `news_result`.
url	string	true	The source URL of the news article.
title	string	true	The title of the news article.
description	string	false	The description for the news article.
age	string	false	A human readable representation of the page age.
page_age	string	false	The page age found from the source web page.
page_fetched	string	false	The ISO date time when the page was last fetched. The format is `YYYY-MM-DDTHH:MM:SSZ`.
breaking	bool	false	Whether the result includes breaking news.
thumbnail	Thumbnail	false	The thumbnail for the news article.
meta_url	MetaUrl	false	Aggregated information on the URL associated with the news search result.
extra_snippets	list [ string ]	false	A list of extra alternate snippets for the news search result.

# Thumbnail

Aggregated details representing the news thumbnail.

Field	Type	Required	Description
src	string	true	The served URL of the thumbnail associated with the news article.
original	string	false	The original URL of the thumbnail associated with the news article.

# MetaUrl

Aggregated information about a URL.

Field	Type	Required	Description
scheme	string	false	The protocol scheme extracted from the URL.
netloc	string	false	The network location part extracted from the URL.
hostname	string	false	The lowercased domain name extracted from the URL.
favicon	string	false	The favicon used for the URL.
path	string	false	The hierarchical path of the URL useful as a display string.