Highrise Web API Update 🎉

Builders Web API
1

Hello Highrise Builder Community!

We’re back with another exciting update for the Highrise Web API! :tada::tada::tada:

Today, we are happy to announce the addition of the Items and Grabs data to our API. This means developers and community members now have even more ways to interact with and analyze Highrise game data. With this new information, you can explore in-depth item details, such as item rarity, categories, and more! Plus, get to know all about grabs – an invaluable resource for understanding player engagement and in-game economics.

Here’s a quick overview of the newly added API resources:

1. Items Data

  • Retrieve a list of items

    GET /items?starts_after={starts_after}&ends_before={ends_before}&sort_order={sort_order}&limit={limit}&rarity={rarity}&item_name={item_name}&category={category}

    This endpoint retrieves a list of items based on the following query parameters:

    • rarity: The rarities of items to filter for, comma separated (eg: rare,epic,legendary,none or rare)
    • item_name: The name of the item to retrieve.
    • category: The category of the item to retrieve. Available categories include:
      • aura
      • bag
      • blush
      • body
      • dress
      • earrings
      • emote
      • eye
      • eyebrow
      • face_hair
      • fishing_rod
      • freckle
      • fullsuit
      • glasses
      • gloves
      • hair_back
      • hair_front
      • handbag
      • hat
      • jacket
      • lashes
      • mole
      • mouth
      • necklace
      • nose
      • pants
      • rod
      • shirt
      • shoes
      • shorts
      • skirt
      • sock
      • tattoo
      • watch
    • sort_order: Determines the order in which results are returned. Can be either asc for ascending order or desc for descending order.
    • starts_after: The ID of the item from which to start the query. This is useful for paginating results.
    • ends_before: The ID of the item to end the query before. This is also useful for paginating results.
    • limit: The maximum number of items to retrieve per request.

  • Retrieve a specific item

    GET /items/{item_id}

    Replace {item_id} with the ID of the item you want to retrieve.

2. Grabs Data

  • Retrieve a list of grabs

    GET /grabs?starts_after={starts_after}&ends_before={ends_before}&sort_order={sort_order}&limit={limit}&title={title}

    This endpoint retrieves a list of grabs based on the following query parameters:

    • title: The title of the grab to retrieve.
    • sort_order: Determines the order in which results are returned. Can be either asc for ascending order or desc for descending order.
    • starts_after: The ID of the grab from which to start the query. This is useful for paginating results.
    • ends_before: The ID of the grab to end the query before. This is also useful for paginating results.
    • limit: The maximum number of grabs to retrieve per request.

  • Retrieve a specific grab

    GET /grabs/{grab_id}

    Replace {grab_id} with the ID of the grab you want to retrieve.

Our mission remains the same: to open up new possibilities for our community to create and innovate. Whether you’re looking to build powerful Highrise bots, conduct extensive game analytics, or create Highrise-related applications, our continuously evolving API is here to assist you.

Your feedback has been instrumental in shaping our Web API. As always, if you have any suggestions, questions, or content requests, we are all ears! Drop your thoughts in the comments below.

Happy building!

6 Likes