Smart Search
Parameter |
Description |
Example |
basePath |
The base path for calling the mass API |
https://searchapi.cloudsway.net/ |
endpointPath |
A randomly generated path for calling the mass API |
|
AccessKey |
The access key for calling the mass API |
RWxxxxxxxx0Gd |
Request Method
GET
Request Path
{basePath}/search/{endpointPath}/smart
Parameter |
Description |
Example |
Authorization |
AccessKey Bearer ${AccessKey} |
Bearer RWxxxxxxxx0Gd |
pragma |
string |
no-cache: Do not enable caching |
Request Parameters
Field Name |
Type |
Required |
Description |
count |
string |
No |
The number of search results to include in the returned results |
freshness |
string |
No |
Filter search results by the following case-insensitive time values: Day, Week, Month. To get articles discovered within a specific time range, specify a date range in the format YYYY-MM-DD..YYYY-MM-DD. For example, &freshness=2019-02-01..2019-05-30. |
offset |
Short |
No |
A zero-based offset indicating the number of search results to skip before returning results. The default value is 0. Use this parameter together with the count parameter to paginate results. |
q |
string |
No |
The user's search query term. This term cannot be empty. The query term can contain Bing advanced operators. |
mkt |
string |
No |
The market from which the results originate. Usually, mkt is the country where the user issued the request. However, if the user is not in a country where Bing provides results, it may be a different country. The market must be in the form -. For example, en-US. This string is case-insensitive. |
cc |
string |
No |
A 2-character country/region code indicating the country/region from which the results originate. |
safeSearch |
string |
No |
Used to filter adult content in web pages, images, and videos. The following are the possible filter values: Off — Return content that includes adult text and images but not adult videos. Moderate — Return web pages that include adult text but not adult images or videos. Strict — Do not return adult text, images, or videos. |
setLang |
string |
No |
The language used for user interface strings. You can specify the language using a 2-letter or 4-letter code. It is recommended to use a 4-letter code. To specify a 2-letter code, set this parameter to an ISO 639-1 language code. To specify a 4-letter code, use the form -, where is an ISO 639-1 language code (neutral culture) and is an ISO 3166 country/region code (specific culture). For example, use en-US for US English. |
Return Value
Response
Field Name |
Type |
Description |
queryContext |
object |
The result of image review |
webPages |
string |
The MIME type of the OpenSearch URL template for the Custom Search JSON API. |
QueryContext
Field Name |
Type |
Description |
originalQuery |
string |
The query string specified in the request. |
webPages
Field Name |
Type |
Description |
value |
WebPage[] |
A list of web pages related to the query. |
webPage
Field Name |
Type |
Description |
name |
String |
The name of the web page. Use this name and the url to create a hyperlink that takes the user to the web page when clicked. |
snippet |
String |
A text snippet describing the content of the web page. |
url |
String |
The URL of the web page. Use this URL and the name to create a hyperlink that takes the user to the web page when clicked. |
thumbnailUrl |
String |
The URL of the image thumbnail. |
datePublished |
String |
The time when the web page was published. 2020-03-02T16:51:00.0000000Z |
dateLastCrawled |
String |
The time when the web page was last crawled. 2024-09-08T23:18:00.0000000Z |
siteName |
String |
The source of the web page |
Example
Request
curl --location --request GET 'https://searchapi.cloudsway.net/search/{endpointPath}/smart?q=cat&safeSearch=Off' \
--header 'Authorization: Bearer ${AccessKey} ' \
--header 'pragma: no-cache' \
--header 'X-Search-Location;' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)'
Return value
{
"queryContext": {
"originalQuery": "cat"
},
"webPages": {
"value": [
{
"name": "Cat - Wikipedia",
"url": "https://en.wikipedia.org/wiki/Cat",
"thumbnailUrl": "https://www.bing.com/th?id=OIP.jBq63m5ZX-icInoK4ZraVgHaEh&w=80&h=80&c=1&pid=5.1",
"displayUrl": "https://en.wikipedia.org/wiki/Cat",
"snippet": "Learn about the cat (Felis catus), a small domesticated carnivorous mammal and the only domesticated species of the family Felidae. Find out its origin, evolution, classification, anatomy, behavior, reproduction, and global distribution.",
"dateLastCrawled": "2025-05-25T23:37:00.0000000Z",
"siteName": "Wikipedia"
}
]
}
}