Sticker Pack Info

The Sticker Pack Info API contains all the sticker images and package information you need to display a sticker pack page. It is important that sticker artist’s name is displayed on this page to prevent any copyright issues. Use this API when a user clicks on a sticker pack from a trending/new sticker pack list to show sticker pack page.

Request URL

GET

https://messenger.stipop.io/v1/package/:packageId

Best Practices

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.
Use attributes from a successful response like the pack name and aritst name to build a sticker pack page with full components.

Parameters

Request Headers
Required	Type	Description
apikey	string	Stipop API Key for your app. Visit developer dashboard for new API Key.

Request Path Parameters
Required	Type	Description
packId	string	The [packId] of a sticker pack, NOT stickerId. Example: 6363, 5636, 5859

Request Query Parameters
Required	Type	Description
userId	string	Unique 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.

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/package/5636?userId=xxx" --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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
      "package": {
        "packageId": 118,                      
        "artistName": "MightyCat",            
        "packageName": "Stuart",                
        "packageImg": "https://img....png",   
        "packageAnimated": "N",                
        "packageCategory": "Animation/Cartoon", 
        "packageKeywords": "Stuart,Sticker",    
        "isNew": "N",                           
        "language": "English",                  
        "isDownload": "Y",                            
        "isWish": "N",					
        "stickers": [                          
            {
                "stickerId": 790,              
                "packageId": 118,               
                "stickerImg": "https://img...._5_2.png" 
            },
            {
                "stickerId": 791,
                "packageId": 118,
                "stickerImg": "https://img....._6_1.png"
            }
            ......
        ]
    }
  }
}

Response Format

Attributes
Name	Type	Description
packageId	int	Sticker package ID
packageName	string	Sticker package name
packageImg	string	Main image of sticker package
packageCategory	string	Sticker package category
packageKeywords	string	Sticker package keyword
packageAnimated	string	Is sticker animated (Y/N)
isNew	string	Is sticker new (Y/N)
artistName	string	Name of the artist
language	string	Main language of sticker package
isDownload	string	Is sticker downloaded by the user (Y/N)
isWish	string	Is sticker in wish list (Y/N)
stickers	string	List of stickers within the sticker package
stickerId	int	Sticker ID
stickerImg	string	Sticker image url

Error Response

Error	Code	Description
non exist apikey	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

Sticker StoreTRENDING STICKER PACKS

Sticker StoreDOWNLOAD/PURCHASE STICKER