Stipop Docs | Documentation for SDK and API

Trending Search Terms

Use the Trending Search Terms API to show search tag suggestions based on trendy searches made by users. It can be very effective to use this API with the Sticker Search API. As a default, 20 search tags are provided.

Request URL

GET
https://messenger.stipop.io/v1/search/keyword

Best Practices

  1. Use the language and country parameters (strongly recommended) to provide user locale information for best use. Stipop automatically tunes the sticker results so that they match your users' language preferences, cultures, and local trends. The default values for language and country are en and US.
  2. Use the limit parameter to have optimal sticker search tag loading. For example, set limit to '30' to show 30 search tag suggestions.
  3. Use other search related endpoints like Sticker Search, and Recent Search. You can also see the tutorial for Optimizing Sticker Search for more specific guides.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Query Parameters
Strongly RecommendedTypeDescription
langstringSpecify default language for regional search terms.
Use a 2-letter ISO 639-1 language code.
Default Value: en
countryCodestringSpecify default country for local search terms.
Use a 2-letter ISO 3166-1 country code.
Default Value: US
OptionalTypeDescription
limitintThe maximum number of search suggestion tags.
Default Value: 20 (max: 50)

Example Request

Sample Call: Trending Search Terms
1
curl --location --request GET "https://messenger.stipop.io/v1/search/keyword" --header "apikey:xxxxxxxxx"

Success Response

Success Response code 200
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "keywordList": [
      {
        "keyword": "hi"
      },
      {
        "keyword": "hello"
      },
      {
        "keyword": "thanks"
      }
    ]
  }
}

Response Format

Attributes
NameTypeDescription
keywordstringSearch suggestion tag

Error Response

ErrorCodeDescription
Description9000The API key used does not exist
server error1000Unable to receive data from the server
We’re here to help.Contact us.