Item API Model Changes

New Property: replica

The replica property has been added in order to denote Replica uniques. It's value will always be true if it is present.

New Property: stackSizeText

This property will be present on items that have 5-digit stack sizes (ie. > 9999). It contains a rounded, textual representation of the stack size for display purposes (ex. 10K to denote the value 10000). The original stackSize and maxStackSize properties will still be present for programmatic use.

Example (Heist coin stack):

{
    ...
    "stackSize": 12522,
    "maxStackSize": 50000,
    "stackSizeText": "12.5K",
    ...
}

"Inject" Property Display Mode

We have changed our internal formatting library to libfmt which has required a large update to text in the game and subsequently the website. Instead of seeing %0 in properties that use the "Inject" displayMode (exposed as the value 3) you'll now see values such as {0}, {1} etc.

Alternate Quality Gems

These gems have different typeLine properties than the normal gems. The possible prefixes are:

  • Anomalous
  • Divergent
  • Phantasmal

New Extended Categories

New item types means new values for the category and subcategories properties found in the Public Stash API. These are:

  • New subcategory under "accessories": "trinket" (new equipable item type)
  • New subcategory under "currency": "heistobjective" (currency items that sell for Rogue's Marker coins)
  • New category: "heistequipment" (used for NPC-equipable items)
    • New subcategory: "heistweapon"
    • New subcategory: "heisttool"
    • New subcategory: "heistutility"
    • New subcategory: "heistreward"
  • New category: "heistmission"
    • New subcategory: "contract"
    • New subcategory: "blueprint"

Contracts and Blueprints

Contracts and Blueprints are two new item types that look very similar to maps (even using the same explicit mods where appropriate). They don't require any new tech on the website in order to display.

Example Blueprint JSON

Spoiler

Please note that this example is for demonstration purposes only.

{
    "verified": true,
    "w": 1,
    "h": 1,
    "icon": "https://web.poecdn.com/image/Art/2DItems/Currency/Heist/BlueprintNotApproved5.png?v=3&w=1&h=1&scale=1",
    "league": "Heist",
    "name": "Rift Orders",
    "typeLine": "Blueprint: Prohibited Library",
    "identified": true,
    "ilvl": 70,
    "properties": [
        {
            "name": "Heist Target",
            "values": [
                [
                    "Replicas and Experimented Items",
                    0
                ]
            ],
            "displayMode": 0
        },
        {
            "name": "Area Level",
            "values": [
                [
                    "70",
                    0
                ]
            ],
            "displayMode": 0,
            "type": 34
        },
        {
            "name": "Wings Revealed",
            "values": [
                [
                    "1/3",
                    0
                ]
            ],
            "displayMode": 0,
            "type": 35
        },
        {
            "name": "Escape Routes Revealed",
            "values": [
                [
                    "1/6",
                    0
                ]
            ],
            "displayMode": 0,
            "type": 36
        },
        {
            "name": "Secret Reward Rooms Revealed",
            "values": [
                [
                    "0/6",
                    0
                ]
            ],
            "displayMode": 0,
            "type": 37
        },
        {
            "name": "Requires {1} (Level {0})",
            "values": [
                [
                    "1",
                    0
                ],
                [
                    "Lockpicking",
                    0
                ]
            ],
            "displayMode": 3,
            "type": 38
        },
        {
            "name": "Requires {1} (Level {0})",
            "values": [
                [
                    "2",
                    0
                ],
                [
                    "Perception",
                    0
                ]
            ],
            "displayMode": 3,
            "type": 40
        },
        {
            "name": "Requires {1} (Level {0})",
            "values": [
                [
                    "2",
                    0
                ],
                [
                    "Engineering",
                    0
                ]
            ],
            "displayMode": 3,
            "type": 46
        },
        {
            "name": "Item Quantity",
            "values": [
                [
                    "+48%",
                    1
                ]
            ],
            "displayMode": 0,
            "type": 2
        },
        {
            "name": "Item Rarity",
            "values": [
                [
                    "+28%",
                    1
                ]
            ],
            "displayMode": 0,
            "type": 3
        },
        {
            "name": "Maximum Alive Reinforcements",
            "values": [
                [
                    "+23%",
                    1
                ]
            ],
            "displayMode": 0,
            "type": 4
        }
    ],
    "requirements": [
        {
            "name": "Level",
            "values": [
                [
                    "54",
                    0
                ]
            ],
            "displayMode": 0
        }
    ],
    "explicitMods": [
        "19% increased Monster Movement Speed",
        "21% increased Monster Attack Speed",
        "23% increased Monster Cast Speed",
        "Monsters deal 58% extra Physical Damage as Fire",
        "3% reduced raising of Alert Level",
        "3% increased time before Lockdown",
        "21% reduced Time for Characters to complete objectives",
        "Players gain 30% reduced Flask Charges"
    ],
    "descrText": "Use Intelligence to Reveal additional Wings and Rooms by talking to certain NPCs in the Rogue Harbour. Give this Blueprint to Adiyah to embark on the Grand Heist.",
    "frameType": 2
}

Example Blueprint Ctrl+C Text

Spoiler

Please note that this example is for demonstration purposes only.

Rarity: Rare
Rift Orders
Blueprint: Prohibited Library
--------
Heist Target: Replicas and Experimented Items
Area Level: 70
Wings Revealed: 1/3
Escape Routes Revealed: 1/6
Secret Reward Rooms Revealed: 0/6
Requires Lockpicking (Level 1)
Requires Perception (Level 2)
Requires Engineering (Level 2)
Item Quantity: +48% (augmented)
Item Rarity: +28% (augmented)
Maximum Alive Reinforcements: +23% (augmented)
--------
Requirements:
Level: 54
--------
Item Level: 70
--------
19% increased Monster Movement Speed
21% increased Monster Attack Speed
23% increased Monster Cast Speed
Monsters deal 58% extra Physical Damage as Fire
3% reduced raising of Alert Level
3% increased time before Lockdown
21% reduced Time for Characters to complete objectives
Players gain 30% reduced Flask Charges
--------
Use Intelligence to Reveal additional Wings and Rooms by talking to certain NPCs in the Rogue Harbour. Give this Blueprint to Adiyah to embark on the Grand Heist.

Heist NPC Equipment

In Heist you can equip your team with special items in order to boost their performance.

Example Heist NPC Equipment JSON

Spoiler

Please note that this example is for demonstration purposes only.

{
    "verified": true,
    "w": 2,
    "h": 2,
    "icon": "https://web.poecdn.com/image/Art/2DItems/Currency/Heist/SilkweaveSole.png?v=3&w=2&h=2&scale=1",
    "league": "Heist",
    "name": "Empyrean Contraption",
    "typeLine": "Silkweave Sole",
    "identified": true,
    "ilvl": 68,
    "properties": [
        {
            "name": "This item can be equipped by:\n{0}",
            "values": [
                [
                    "Tullina, the Catburglar",
                    0
                ]
            ],
            "displayMode": 3
        }
    ],
    "requirements": [
        {
            "name": "Level {0} in {1}",
            "values": [
                [
                    "5",
                    0
                ],
                [
                    "Agility",
                    0
                ]
            ],
            "displayMode": 3,
            "type": 44
        }
    ],
    "implicitMods": [
        "14% increased Agility speed"
    ],
    "explicitMods": [
        "6% reduced Hiring Fee for Agility Jobs",
        "14% increased Job speed",
        "14% increased Agility speed"
    ],
    "descrText": "Can only be equipped to Heist members.",
    "frameType": 2
}

Example Heist NPC Equipment Ctrl+C Text

Spoiler

Please note that this example is for demonstration purposes only.

Rarity: Rare
Empyrean Contraption
Silkweave Sole
--------
This item can be equipped by:
Tullina, the Catburglar
--------
Requirements:
Level 5 in Agility
--------
Item Level: 70
--------
14% increased Agility speed (implicit)
--------
6% reduced Hiring Fee for Agility Jobs
14% increased Job speed
14% increased Agility speed
--------
Can only be equipped to Heist members.

Item Image URL Changes

Alternate Quality Gems

Gems that have "alternate quality" have a spectral=1 query param in image URLs.

Heist Map Series

Maps in Heist will use the "mn":9 property in their image URL data.

If there are any other questions, feel free to ask at roryv@grindinggear.com

Posted by 
on
Grinding Gear Games

Report Forum Post

Report Account:

Report Type

Additional Info