Stipop Docs | Documentation for SDK and API

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

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.
Use the limit parameter to have optimal sticker search tag loading. For example, set limit to '30' to show 30 search tag suggestions.
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
Required	Type	Description
apikey	string	Stipop API Key for your app. Visit developer dashboard for new API Key.

Request Query Parameters
Strongly Recommended	Type	Description
lang	string	Specify default language for regional search terms. Use a 2-letter ISO 639-1 language code. Default Value: en
countryCode	string	Specify default country for local search terms. Use a 2-letter ISO 3166-1 country code. Default Value: US
Optional	Type	Description
limit	int	The maximum number of search suggestion tags. Default Value: 20 (max: 50)

Example Request

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

Success Response

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
Name	Type	Description
keyword	string	Search suggestion tag

Error Response

Error	Code	Description
Description	9000	The API key used does not exist
server error	1000	Unable to receive data from the server

Was this page helpful?

We’re here to help. Contact us.

Back

SearchSTICKER SEARCH

SearchRECENT SEARCH