Stipop Docs | Documentation for SDK and API

Search Stickers

The Sticker Search API for camera stickers lets users search for stickers using emotional and situational search tags. It's handy to have the search UI near where users send or use stickers like on the button UI section of a video call interface. You can also have the search within the sticker store so users can search for specific stickers that they want to download. Each search result will have in default 100 sticker results at maximum.

Request URL

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

Best Practices

  1. Add sticker search using the sticker search API where users can search for stickers.
  2. It's best to use the Search Suggestions API and Recent Search API along with the sticker search API for best user experience.
  3. Add a message to show when there are no search results.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Query Parameters
RequiredTypeDescription
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.
searchTextstringSearch tag

Example Request

Sample call to camera sticker search
1
curl --location --request GET "https://camera.stipop.io/v1/search?userId=9937&searchText=cute"  --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

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "stickerList": [
      {
        "stickerId": 51229,
        "keyword": "cute",
        "stickerImg": "https://img....0_3.png"
      },
      {
        "stickerId": 50899,
        "keyword": "cute",
        "stickerImg": "https://img....er-4.png"
      },

Response Format

Attributes
NameTypeDescription
stickerIdstringUnique value for a single sticker
keywordstringSticker tag
stickerImgstringSticker image url

Error Response

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