Get Started - Learn How To Make Your Bot!

Guides

Code Snippets

Get methods

Post methods

Web API

Useful links

List of all currently Free Items

List of Emotes

Highrise Bot SDK Changelog

Added on version 23.3.0

get_grab(self, grab_id: str) -> GetPublicGrabResponse:

Fetch a single grab given its grab_id.

Args: grab_id: The unique identifier for a grab.

    Returns:
        **`GetPublicGrabResponse`**: The public data of the grab.

⚙️ Use cases

Here’s an example where we take the last grab available and get the info from it printed in the console:

async def on_chat(self, user: User, message: str) -> None:
        if message.lower().startswith("/lastgrab"):
            last_grab = await self.webapi.get_grabs(limit=1, sort_order="desc")
            last_grab_id = last_grab.grabs[0].grab_id
            response = await self.webapi.get_grab(last_grab_id)
            print (response)

Response:

GetPublicGrabResponse(
    grab=Grab(
        grab_id='64aed7344ec12803273c5bfb',
        title='Rebel Winter',
        description='',
        background_color=(201, 195, 161),
        banner_img_url='',
        starts_at=DateTime(2023, 7, 18, 17, 0, 0, tzinfo=Timezone('+00:00')),
        expires_at=DateTime(2023, 8, 17, 17, 0, 0, tzinfo=Timezone('+00:00')),
        rewards=[
            Reward(
                category=<LegacyRewardCategory.OUTFIT: 'outfit'>,
                amount=1,
                reward_id='64b6d78db97b55a7119dc764',
                item_id='eye-n_julyartistloungegrab2023theceliaeyes',
                account_bound=False,
                metadata=None
            ),
            Reward(
                category=<LegacyRewardCategory.OUTFIT: 'outfit'>,
                amount=1,
                reward_id='64b6d78db97b55a7119dc765',
                item_id='mouth-n_julyartistloungegrab2023theceliamouth',
                account_bound=False,
                metadata=None
            ),
            # ... (other rewards)
        ],
        primary_img_url='<https://cdn.highrisegame.com/releases/2023/6/gachas//julyartistslounge2023_grab_primaryimage.webp>',
        secondary_img_url='<https://cdn-production.joinhighrise.com/images/gacha/2023/7-RebelWinter/secondaryImageUrl_1896a3612e0.png>',
        costs=[
            Reward(
                category=<LegacyRewardCategory.GEMS: 'gems'>,
                amount=200,
                reward_id='64b073feefb3d2770af14bbd',
                item_id=None,
                account_bound=False,
                metadata=None
            )
        ],
        kompu_rewards=[
            Reward(
                category=<LegacyRewardCategory.OUTFIT: 'outfit'>,
                amount=1,
                reward_id='64b6d78db97b55a7119dc772',
                item_id='hair_front-n_julyartistloungegrab2023thecelialongwavyhair',
                account_bound=False,
                metadata=None
            )
        ],
        is_tradable=True,
        limited_time_kompu=None,
        progress_reward=None
    )
)