Stipop Docs | Documentation for SDK and API

Sticker Search

The Sticker Search API let's users search for stickers with search tags. The search tags can be in any form, including emotion, situation, character, and more. The search results automatically adjust to your app category/subcategory and user locale information (language and country). This is so that your users get the perfect sticker results they need.

We recommend you follow the Best Practices listed below for best use of the APIs. After integrating the API, you can visit Stipop Dashboard to view sticker related analytics and configure sticker filter if you'd like to customize sticker listings for your app and service.

Request URL

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

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. When a user sends sticker on any chat interface, you should Register Sticker Send. This is strongly recommended so that Stipop can analyze sticker send data to show most opt sticker pack list in the future.
  3. Use other search related endpoints like Trending Search Terms, and Recent Search. You can also see the tutorial for Optimizing Sticker Search for more specific guides.
  4. For the userId parameter, please don't use identical userId for multiple users. This is thoroughly monitored and in case of any misuse, the API key can be blocked from usage. The userId can be in any string format.
  5. Use the limit and pageNumber parameters to control optimal sticker loading. For example, set limit to '30' and use pageNumber 1,2,3... to show 30 sticker packs per page.
  6. You can add dimension (d) to sticker image url to optimize image size for specific UIs. For example, d=100x100 or d=300x300 (in pixels). The recommended default size is 300px and maximum is 700px.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Query Parameters
RequiredTypeDescription
qstringSearch tag term or phrase. Supports 40+ languages.
Example: Hello, Excited, Merry Christmas
userIdstringUnique value for every user to distinguish unique users.
The userId can be in any string format.
Important: Using same userId for multiple users is not allowed.
Strongly RecommendedTypeDescription
langstringSpecify default language for regional stickers.
Use a 2-letter ISO 639-1 language code.
Default Value: en
countryCodestringSpecify default country for local stickers.
Use a 2-letter ISO 3166-1 country code.
Default Value: US
OptionalTypeDescription
limitintThe maximum number of stickers per page.
Use pageNumber accordingly for optimized sticker view.
Default Value: 20 (max: 50)
pageNumberintSpecify pageNumber to show limit number of stickers per page.

Example Request

Sample Call: Sticker Search
1
curl --location --request GET "https://messenger.stipop.io/v1/search?userId=9937&q=cute&lang=en&pageNumber=1&limit=10" --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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
      "stickerList": [
        {
          "stickerId": 51229,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50899,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50898,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        ................
      ],
      "pageMap": {
        "pageNumber": 1,
        "onePageCountRow": 10,
        "totalCount": 80,
        "pageCount": 8,
        "groupCount": 1,
        "groupNumber": 0,
        "pageGroupCount": 10,
        "startPage": 1,
        "endPage": 8,
        "startRow": 0,
        "endRow": 10,
        "modNum": 10,
        "listStartNumber": 80
      }
    }
}

Response Format

Attributes
NameTypeDescription
stickerIdstringSticker ID
keywordstringSearch tag
packageNameintSticker package name
stickerImgstringSticker image url

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.