Support stickers for story [#18] Added StorySticker and stickers param for upload_to_story methods

Author: adw0rd

instagrapi/extractors.py

@@ -242,6 +242,7 @@ def extract_story_v1(data):
     ]
     story["locations"] = []
     story["hashtags"] = []
+    story["stickers"] = []
     story["links"] = []
     for cta in story.get("story_cta", []):
         for link in cta.get("links", []):

instagrapi/mixins/photo.py

@@ -14,7 +14,7 @@
                                    PhotoConfigureStoryError, PhotoNotUpload)
 from instagrapi.extractors import extract_media_v1
 from instagrapi.types import (Location, Media, Story, StoryHashtag, StoryLink,
-                              StoryLocation, StoryMention, Usertag)
+                              StoryLocation, StoryMention, StorySticker, Usertag)
 from instagrapi.utils import dumps
 
 try:
@@ -266,6 +266,7 @@ def photo_upload_to_story(
         locations: List[StoryLocation] = [],
         links: List[StoryLink] = [],
         hashtags: List[StoryHashtag] = [],
+        stickers: List[StorySticker] = [],
     ) -> Story:
         """
         Upload photo as a story and configure it
@@ -286,6 +287,8 @@ def photo_upload_to_story(
             URLs for Swipe Up
         hashtags: List[StoryHashtag], optional
             List of hashtags to be tagged on this upload, default is empty list.
+        stickers: List[StorySticker], optional
+            List of stickers to be tagged on this upload, default is empty list.
 
         Returns
         -------
@@ -306,6 +309,7 @@ def photo_upload_to_story(
                 locations,
                 links,
                 hashtags,
+                stickers,
             ):
                 media = self.last_json.get("media")
                 self.expose()
@@ -314,6 +318,7 @@ def photo_upload_to_story(
                     mentions=mentions,
                     hashtags=hashtags,
                     locations=locations,
+                    stickers=stickers,
                     **extract_media_v1(media).dict()
                 )
         raise PhotoConfigureStoryError(
@@ -330,6 +335,7 @@ def photo_configure_to_story(
         locations: List[StoryLocation] = [],
         links: List[StoryLink] = [],
         hashtags: List[StoryHashtag] = [],
+        stickers: List[StorySticker] = [],
     ) -> Dict:
         """
         Post configure photo
@@ -352,6 +358,8 @@ def photo_configure_to_story(
             URLs for Swipe Up
         hashtags: List[StoryHashtag], optional
             List of hashtags to be tagged on this upload, default is empty list.
+        stickers: List[StorySticker], optional
+            List of stickers to be tagged on this upload, default is empty list.
 
         Returns
         -------
@@ -391,6 +399,7 @@ def photo_configure_to_story(
             links = [link.dict() for link in links]
             data["story_cta"] = dumps([{"links": links}])
         tap_models = []
+        static_models = []
         if mentions:
             reel_mentions = [
                 {
@@ -444,7 +453,24 @@ def photo_configure_to_story(
                     "tap_state_str_id": "location_sticker_vibrant"
                 }
                 tap_models.append(item)
+        if stickers:
+            for sticker in stickers:
+                str_id = sticker.id  # "gif_Igjf05J559JWuef4N5"
+                static_models.append({
+                    "x": sticker.x,
+                    "y": sticker.y,
+                    "z": sticker.z,
+                    "width": sticker.width,
+                    "height": sticker.height,
+                    "rotation": sticker.rotation,
+                    "str_id": str_id,
+                    "sticker_type": sticker.type,
+                })
+                story_sticker_ids.append(str_id)
+                if sticker.type == "gif":
+                    data["has_animated_sticker"] = "1"
         data["tap_models"] = dumps(tap_models)
+        data["static_models"] = dumps(static_models)
         data["story_sticker_ids"] = dumps(story_sticker_ids)
         return self.private_request(
             "media/configure_to_story/", self.with_default_data(data)

instagrapi/mixins/video.py

@@ -13,7 +13,7 @@
                                    VideoNotUpload)
 from instagrapi.extractors import extract_media_v1
 from instagrapi.types import (Location, Media, Story, StoryHashtag, StoryLink,
-                              StoryLocation, StoryMention, Usertag)
+                              StoryLocation, StoryMention, StorySticker, Usertag)
 from instagrapi.utils import dumps
 
 
@@ -320,6 +320,7 @@ def video_upload_to_story(
         locations: List[StoryLocation] = [],
         links: List[StoryLink] = [],
         hashtags: List[StoryHashtag] = [],
+        stickers: List[StorySticker] = [],
     ) -> Story:
         """
         Upload video as a story and configure it
@@ -340,6 +341,8 @@ def video_upload_to_story(
             URLs for Swipe Up
         hashtags: List[StoryHashtag], optional
             List of hashtags to be tagged on this upload, default is empty list.
+        stickers: List[StorySticker], optional
+            List of stickers to be tagged on this upload, default is empty list.
 
         Returns
         -------
@@ -367,6 +370,7 @@ def video_upload_to_story(
                     locations,
                     links,
                     hashtags,
+                    stickers,
                 )
             except Exception as e:
                 if "Transcode not finished yet" in str(e):
@@ -385,6 +389,7 @@ def video_upload_to_story(
                     mentions=mentions,
                     hashtags=hashtags,
                     locations=locations,
+                    stickers=stickers,
                     **extract_media_v1(media).dict()
                 )
         raise VideoConfigureStoryError(
@@ -403,6 +408,7 @@ def video_configure_to_story(
         locations: List[StoryLocation] = [],
         links: List[StoryLink] = [],
         hashtags: List[StoryHashtag] = [],
+        stickers: List[StorySticker] = [],
     ) -> Dict:
         """
         Story Configure for Photo
@@ -429,6 +435,8 @@ def video_configure_to_story(
             URLs for Swipe Up
         hashtags: List[StoryHashtag], optional
             List of hashtags to be tagged on this upload, default is empty list.
+        stickers: List[StorySticker], optional
+            List of stickers to be tagged on this upload, default is empty list.
 
         Returns
         -------
@@ -483,6 +491,7 @@ def video_configure_to_story(
             links = [link.dict() for link in links]
             data["story_cta"] = dumps([{"links": links}])
         tap_models = []
+        static_models = []
         if mentions:
             reel_mentions = []
             text_metadata = []
@@ -550,7 +559,24 @@ def video_configure_to_story(
                     "tap_state_str_id": "location_sticker_vibrant"
                 }
                 tap_models.append(item)
+        if stickers:
+            for sticker in stickers:
+                str_id = sticker.id  # "gif_Igjf05J559JWuef4N5"
+                static_models.append({
+                    "x": sticker.x,
+                    "y": sticker.y,
+                    "z": sticker.z,
+                    "width": sticker.width,
+                    "height": sticker.height,
+                    "rotation": sticker.rotation,
+                    "str_id": str_id,
+                    "sticker_type": sticker.type,
+                })
+                story_sticker_ids.append(str_id)
+                if sticker.type == "gif":
+                    data["has_animated_sticker"] = "1"
         data["tap_models"] = dumps(tap_models)
+        data["static_models"] = dumps(static_models)
         data["story_sticker_ids"] = dumps(story_sticker_ids)
         return self.private_request(
             "media/configure_to_story/?video=1", self.with_default_data(data)

instagrapi/types.py

@@ -159,6 +159,17 @@ class StoryLocation(BaseModel):
     height: Optional[float]
 
 
+class StorySticker(BaseModel):
+    id: str
+    type: Optional[str] = 'gif'
+    x: float
+    y: float
+    z: Optional[int] = 1000005
+    width: float
+    height: float
+    rotation: Optional[float] = 0.0
+
+
 class StoryBuild(BaseModel):
     mentions: List[StoryMention]
     path: FilePath
@@ -183,6 +194,7 @@ class Story(BaseModel):
     links: List[StoryLink]
     hashtags: List[StoryHashtag]
     locations: List[StoryLocation]
+    stickers: List[StorySticker]
 
 
 class DirectMessage(BaseModel):

setup.py

@@ -29,7 +29,7 @@
 
 setup(
     name='instagrapi',
-    version='1.4.3',
+    version='1.4.4',
     author='Mikhail Andreev',
     author_email='[email protected]',
     license='MIT',

tests.py

@@ -23,6 +23,7 @@
     StoryLocation,
     StoryMention,
     StoryHashtag,
+    StorySticker,
     User,
     UserShort,
     Usertag
@@ -1127,6 +1128,16 @@ def test_upload_photo_story(self):
                 )
             )
         ]
+        stickers = [
+            StorySticker(
+                id="Igjf05J559JWuef4N5",
+                type="gif",
+                x=0.5,
+                y=0.5,
+                width=0.4,
+                height=0.08
+            )
+        ]
         try:
             story = self.api.photo_upload_to_story(
                 path,
@@ -1135,6 +1146,7 @@ def test_upload_photo_story(self):
                 links=links,
                 hashtags=hashtags,
                 locations=locations,
+                stickers=stickers
             )
             self.assertIsInstance(story, Story)
             self.assertTrue(story)