Skip to content

Full Text Search API

Public Information

parameter Description Example
basePath The base path for calling the mass api https://searchapi.cloudsway.net/
endpointPath A random path generated by calling the mass api
AccessKey Access key for calling mass API RWxxxxxxxx0Gd

Full text search

Request method

GET

Request path

{basePath}/search/{endpointPath}/full

Request headers

parameter Description Example
Authorization AccessKey
Bearer ${AccessKey}		 Bearer RWxxxxxxxx0Gd
pragma string no-cache does not enable caching

Request params

Field Name Type Required? Description
count string No Number of search results included in the return 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 The offset from zero, indicating the number of search results to skip before returning results. The default value is 0. Use this parameter with the count parameter to paginate the results.
q string Yes The user's search query. This string cannot be empty. The query can contain advanced operators.
mkt string No The market from which the results come. Usually, mkt is the country where the user made the request. However, it could be a different country if the user is not in a country where delivers results. The market must be in the \-\ format. For example, en-US. The string is case-insensitive.
cc string No A two - character country code indicating the country from which the result originated.
safeSearch string No Used to filter adult content in web pages, images, and videos. The following are the possible filter values:
Off - Returns content that includes adult text and images but not adult videos.
Moderate - Returns web pages that include adult text but not adult images or videos.
Strict - Does not return adult text, images, or videos.
setLang string No The language for User Interface strings. You can use a 2 - letter or 4 - letter code to specify the language. A 4 - letter code is recommended. 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 (specific culture) code. For example, use en - US for US English.
textDecorations Boolean No A boolean value that determines whether the display string in the result should contain decoration markers (such as hit highlighting characters). If true, the string may contain markers. The default value is false.
contentType string No Enumeration value, HTML, MARKDOWN, affects the format of the full text content returned

Return value

Response

Field Name Type Description
queryContext object Picture review results
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 hyperlinke that users can click to go to the web page.
snippet String A text snippet that describes the content of a web page.
url String The URL of the web page. Use this URL and name to create a hyperlinke that the user can click to go to the web page.
content String Full text content of the web page.

Example

Request 

curl --location --request GET 'https://searchapi.cloudsway.net/search/{endpointPath}/full?q=apple&safeSearch=Off' \
--header 'Authorization: Bearer  ${AccessKey}  ' \
--header 'pragma: no-cache' \
--header 'X-Search-Location;' \

Return value 

{
  "queryContext": {
    "originalQuery": "apple"
  },
  "webPages": {
    "value": [
      {
        "name": "Apple",
        "url": "https://www.apple.com/",
        "datePublished": "2007-03-16T03:00:00.0000000",
        "displayUrl": "https://www.apple.com/",
        "snippet": "Additional terms from Apple or Apple ’s trade-in partners may apply. Card is subject to credit approval, available only for qualifying applicants in the United States, and issued by Goldman Sachs Bank USA, Salt Lake City Branch. Apple Payments Services LLC, a subsidiary of Apple Inc., is a service provider of Goldman Sachs Bank USA for Apple Card and Savings accounts. Apple",
        "siteName": "Apple",
        "content": "Apple Watch Series 10 Thinstant classic. Learn more Buy\n\nApple Trade In Get extra credit toward a new iPhone when you trade in.1 Now\nthrough 6.18 Get your estimate\n\nCollege Students Mac and iPad. Major. In any field.Learn more\n\niPad Air Now supercharged by the M3 chip. Learn more Buy\n\nBuilt for Apple Intelligence.\n\nAirPods Pro 2Now with a Hearing Aid feature.2 Learn more Buy\n\nApple Card Get up to 3% Daily Cash back with every purchase. Learn more Apply\nnow Apply now\n\n",
        "logo": "https://www.apple.com/favicon.ico"
      }
    ]
  }
}