Repository navigation
Expand file tree
/
Copy pathbrave.json
More file actions
178 lines (178 loc) · 7.33 KB
/
Copy pathbrave.json
File metadata and controls
178 lines (178 loc) · 7.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
{
"engine": "brave",
"params": {
"q": {
"required": true,
"description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Brave search (e.g., `coffee`, or `site:` and other search operators). The `intitle:`, `intext:`, `inurl:`, and `inanchor:` operators (and `allintitle:` and the like) aren't supported: use `inpage:` to search in the titles and the bodies of pages, or `inbody:` to search in their bodies. `site:` can't be followed by a dot, even inside a word: use `site:gov` instead of `site:.gov`, and `website: .net` instead of `website:.net`.",
"group": "search_query"
},
"location": {
"type": "location",
"description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. It is recommended to specify location at the city level in order to simulate a real user's search. Without location, lat, and lon, the results are localized to a city in the United States that can change from one search to the next. Parameter can't be used with lat or lon parameters.",
"group": "geographic_location"
},
"lat": {
"type": "number",
"description": "Parameter defines a GPS latitude for the search origin. Parameter is required when using lon parameter. Parameter can't be used with location parameter.",
"group": "geographic_location"
},
"lon": {
"type": "number",
"description": "Parameter defines a GPS longitude for the search origin. Parameter is required when using lat parameter. Parameter can't be used with location parameter.",
"group": "geographic_location"
},
"country": {
"type": "select",
"options": [
"all",
"ar",
"au",
"at",
"be",
"br",
"ca",
"cl",
"cn",
"dk",
"fi",
"fr",
"de",
"gr",
"hk",
"in",
"id",
"it",
"jp",
"kr",
"my",
"mx",
"nl",
"nz",
"no",
"pl",
"pt",
"ph",
"ru",
"sa",
"sg",
"za",
"es",
"se",
"ch",
"tw",
"tr",
"gb",
"us"
],
"description": "Parameter defines the country to use for the Brave search. It's a two-letter country code (e.g., `us` (default) for the United States, `gb` for the United Kingdom, or `fr` for France), or `all` for all regions. Head to the Brave countries page for a full list of supported countries.",
"group": "localization"
},
"language": {
"type": "select",
"options": [
"az",
"bg",
"br",
"ca",
"cs",
"cy",
"da",
"de",
"el",
"en",
"es",
"et",
"eu",
"fi",
"fr",
"gl",
"hr",
"hu",
"id",
"it",
"ja",
"ka",
"ko",
"lt",
"lv",
"ms",
"nb",
"nl",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sq",
"sr",
"sv",
"sw",
"th",
"tr",
"uk",
"vi",
"zh"
],
"description": "Parameter defines the language to use for the Brave search: the language of the dates and labels, and the default language of the results. It's a two-letter language code (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Brave languages page for a full list of supported languages.",
"group": "localization"
},
"safe_search": {
"type": "select",
"options": [
"off",
"moderate",
"strict"
],
"description": "Parameter defines the level of filtering for adult content. It defaults to `moderate`, like on Brave. Available options: `off` - Off `moderate` - Moderate `strict` - Strict",
"group": "advanced_filters"
},
"tf": {
"description": "Parameter defines the time period of the results, like Brave's time filter. It can be one of the options below, or a date range in the format of **YYYY-MM-DDtoYYYY-MM-DD** (e.g., `2025-01-01to2025-03-31`). Available options: `pd` - Past day `pw` - Past week `pm` - Past month `py` - Past year",
"group": "advanced_filters"
},
"spellcheck": {
"type": "checkbox",
"description": "Parameter defines whether Brave corrects the spelling of the query. It defaults to `1`, like on Brave. Available options: `0` - Autocorrection off `1` - Autocorrection on",
"group": "advanced_filters"
},
"offset": {
"type": "number",
"description": "Parameter defines the page of results to return. (e.g., `0` (default) is the first page of results, `1` is the 2nd page of results, etc.). It can be up to `5`, the last page Brave offers. Brave returns up to 20 results per page.",
"group": "pagination"
}
},
"common_params": {
"engine": {
"required": true,
"description": "Set parameter to `brave` to use the Brave API engine.",
"group": "serpapi_parameters"
},
"no_cache": {
"type": "checkbox",
"description": "Parameter will force SerpApi to fetch the Brave results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no\\_cache and async parameters should not be used together.",
"group": "serpapi_parameters"
},
"async": {
"description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no\\_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.",
"group": "serpapi_parameters"
},
"zero_trace": {
"description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
"group": "serpapi_parameters"
},
"api_key": {
"required": true,
"description": "Parameter defines the SerpApi private key to use.",
"group": "serpapi_parameters"
},
"output": {
"description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a Markdown-formatted version optimized for LLMs and AI agents.",
"group": "serpapi_parameters"
},
"json_restrictor": {
"description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.",
"group": "serpapi_parameters"
}
}
}