跳转至

文档中心

基础网页搜索

基础网页搜索

公共信息

参数	描述	示例
basePath	调用mass api的基础路径	https://searchapi.cloudsway.net/
endpointPath	调用mass api的生成的一段随机路径
AccessKey	调用mass api的accessKey	RWxxxxxxxx0Gd

请求方法

GET

请求路径

{basePath}/search/{endpointPath}/base

参数	描述	示例
Authorization	AccessKey Bearer ${AccessKey}	Bearer RWxxxxxxxx0Gd
pragma	string	no-cache 不开启缓存

请求params

字段名	类型	是否必填	描述
count	string	否	返回结果中包含的搜索结果数量
freshness	string	否	按以下不区分大小写的时间值筛选搜索结果：Day、Week、Month。要获取在特定时间范围内发现的文章，请指定格式为YYYY-MM-DD..YYYY-MM-DD的日期范围。例如，&freshness=2019-02-01..2019-05-30。
offset	Short	否	从零开始的偏移量，指示在返回结果之前要跳过的搜索结果数量。默认值为0。使用此参数与count参数一起分页显示结果。
q	string	否	用户的搜索查询词。该词不能为空。查询词可以包含Bing高级操作符。
mkt	string	否	结果来源的市场。通常，mkt是用户发出请求的国家。然而，如果用户不在Bing提供结果的国家，则可能是不同的国家。市场必须采用<语言>-<国家/地区>的形式。例如，en-US。该字符串不区分大小写。
cc	string	否	一个 2 个字符的国家/地区代码，表示结果来源的国家/地区。
safeSearch	string	否	用于过滤网页、图片和视频中的成人内容。以下是可能的过滤值： Off — 返回包含成人文本和图片但不包含成人视频的内容。 Moderate — 返回包含成人文本的网页，但不包含成人图片或视频。 Strict — 不返回成人文本、图片或视频。
setLang	string	否	用于用户界面字符串的语言。您可以使用2个字母或4个字母的代码来指定语言。推荐使用4个字母的代码。要指定2字母代码，请将此参数设置为ISO 639-1语言代码。要指定4字母代码，请使用-的形式，其中为ISO 639-1语言代码（中性文化），为ISO 3166国家/地区（特定文化）代码。例如，使用en-US表示美国英语。
textDecorations	Boolean	否	一个布尔值，用于确定结果中的显示字符串是否应包含装饰标记（例如命中高亮字符）。如果为true，字符串可能包含标记。默认值为false。

返回值

Response

字段名	类型	描述
queryContext	object	图片审核结果
webPages	string	Custom Search JSON API 的 OpenSearch 网址模板的 MIME 类型。

QueryContext

字段名	类型	描述
originalQuery	string	请求中指定的查询字符串。

webPages

字段名	类型	描述
value	WebPage[]	与查询相关的网页列表。

webPage

字段名	类型	描述
name	String	网页的名称。使用此名称和url创建一个超链接，用户点击时会转到网页。
snippet	String	描述网页内容的文本片段。
url	String	网页的URL。使用此URL和name创建一个超链接，用户点击时会转到网页。
thumbnailUrl	String	图像缩略图的URL。
datePublished	String	网页发布的时间。2020-03-02T16:51:00.0000000Z
dateLastCrawled	String	最后一次抓取网页的时间。2024-09-08T23:18:00.0000000Z
siteName	String	网页来源
## 示例

请求

curl --location --request GET 'https://searchapi.cloudsway.net/search/{endpointPath}/base?q=trump&safeSearch=Off' \
--header 'Authorization: Bearer  ${AccessKey}  ' \
--header 'pragma: no-cache' \
--header 'X-Search-Location;' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)'

返回值

{
  "queryContext": {
    "originalQuery": "trump"
  },
  "webPages": {
    "value": [
      {
        "name": "Donald Trump - Wikipedia",
        "url": "https://en.wikipedia.org/wiki/Donald_Trump",
        "datePublished": "2008-10-09T07:36:33.0000000",
        "displayUrl": "https://en.wikipedia.org/wiki/Donald_Trump",
        "snippet": "Donald John Trump was born on June 14, 1946, at Jamaica Hospital in the New York City borough of Queens, the fourth child of Fred Trump and Mary Anne MacLeod Trump .[1] He is of German and Scottish descent.[2] He grew up with his older siblings, Maryanne, Fred Jr., and Elizabeth, and his younger brother, Robert, in a mansion in the Jamaica."
      }
    ]
  }
}