schema-items.json

{
  "id": {
    "description": "Unique OSRS item ID number.",
    "type": "integer",
    "required": true,
    "nullable": false
  },
  "name": {
    "description": "The name of the item.",
    "type": "string",
    "required": true,
    "nullable": false
  },
  "last_updated": {
    "description": "The last time (UTC) the item was updated (in ISO8601 date format).",
    "type": "string",
    "required": true,
    "nullable": false,
    "regex": "^(20[0-9]{2})-([012][0-9])-([0123][0-9])$"
  },
  "incomplete": {
    "description": "If the item has incomplete wiki data.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "members": {
    "description": "If the item is a members-only.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "tradeable": {
    "description": "If the item is tradeable (between players and on the GE).",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "tradeable_on_ge": {
    "description": "If the item is tradeable (only on GE).",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "stackable": {
    "description": "If the item is stackable (in inventory).",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "stacked": {
    "description": "If the item is stacked, indicated by the stack count.",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "noted": {
    "description": "If the item is noted.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "noteable": {
    "description": "If the item is noteable.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "linked_id_item": {
    "description": "The linked ID of the actual item (if noted/placeholder).",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "linked_id_noted": {
    "description": "The linked ID of an item in noted form.",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "linked_id_placeholder": {
    "description": "The linked ID of an item in placeholder form.",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "placeholder": {
    "description": "If the item is a placeholder.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "equipable": {
    "description": "If the item is equipable (based on right-click menu entry).",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "equipable_by_player": {
    "description": "If the item is equipable in-game by a player.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "equipable_weapon": {
    "description": "If the item is an equipable weapon.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "cost": {
    "description": "The store price of an item.",
    "type": "integer",
    "required": true,
    "nullable": false
  },
  "lowalch": {
    "description": "The low alchemy value of the item (cost * 0.4).",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "highalch": {
    "description": "The high alchemy value of the item (cost * 0.6).",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "weight": {
    "description": "The weight (in kilograms) of the item.",
    "type": "float",
    "required": true,
    "nullable": true
  },
  "buy_limit": {
    "description": "The Grand Exchange buy limit of the item.",
    "type": "integer",
    "required": true,
    "nullable": true
  },
  "quest_item": {
    "description": "If the item is associated with a quest.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "release_date": {
    "description": "Date the item was released (in ISO8601 format).",
    "type": "string",
    "required": true,
    "nullable": true,
    "regex": "^(2[0-9]{3})-([012][0-9])-([0123][0-9])$"
  },
  "duplicate": {
    "description": "If the item is a duplicate.",
    "type": "boolean",
    "required": true,
    "nullable": false
  },
  "examine": {
    "description": "The examine text for the item.",
    "type": "string",
    "required": true,
    "nullable": true
  },
  "icon": {
    "description": "The item icon (in base64 encoding).",
    "type": "string",
    "required": true,
    "nullable": false
  },
  "wiki_name": {
    "description": "The OSRS Wiki name for the item.",
    "type": "string",
    "required": true,
    "nullable": true
  },
  "wiki_url": {
    "description": "The OSRS Wiki URL (possibly including anchor link).",
    "type": "string",
    "required": true,
    "nullable": true
  },
  "equipment": {
    "description": "The equipment bonuses of equipable armour/weapons.",
    "type": "dict",
    "required": true,
    "nullable": true,
    "schema": {
      "attack_stab": {
        "description": "The attack stab bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "attack_slash": {
        "description": "The attack slash bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "attack_crush": {
        "description": "The attack crush bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "attack_magic": {
        "description": "The attack magic bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "attack_ranged": {
        "description": "The attack ranged bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "defence_stab": {
        "description": "The defence stab bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "defence_slash": {
        "description": "The defence slash bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "defence_crush": {
        "description": "The defence crush bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "defence_magic": {
        "description": "The defence magic bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "defence_ranged": {
        "description": "The defence ranged bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "melee_strength": {
        "description": "The melee strength bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "ranged_strength": {
        "description": "The ranged strength bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "magic_damage": {
        "description": "The magic damage bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "prayer": {
        "description": "The prayer bonus of the item.",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "slot": {
        "description": "The equipment slot associated with the item (e.g., head).",
        "type": "string",
        "required": true,
        "nullable": false,
        "allowed": [
          "2h",
          "ammo",
          "body",
          "cape",
          "feet",
          "hands",
          "head",
          "legs",
          "neck",
          "ring",
          "shield",
          "weapon"
        ]
      },
      "requirements": {
        "description": "An object of requirements {skill: level}.",
        "type": "dict",
        "required": true,
        "nullable": true,
        "keysrules": {
          "type": "string",
          "allowed": [
            "agility",
            "attack",
            "construction",
            "cooking",
            "crafting",
            "defence",
            "farming",
            "firemaking",
            "fishing",
            "fletching",
            "herblore",
            "hitpoints",
            "hunter",
            "magic",
            "mining",
            "prayer",
            "ranged",
            "runecraft",
            "slayer",
            "smithing",
            "strength",
            "thieving",
            "woodcutting",
            "combat"
          ]
        },
        "valuesrules": {
          "type": "integer"
        }
      }
    }
  },
  "weapon": {
    "description": "The weapon bonuses including attack speed, type and stance.",
    "type": "dict",
    "required": true,
    "nullable": true,
    "schema": {
      "attack_speed": {
        "description": "The attack speed of a weapon (in game ticks).",
        "type": "integer",
        "required": true,
        "nullable": false
      },
      "weapon_type": {
        "description": "The weapon classification (e.g., axes)",
        "type": "string",
        "required": true,
        "nullable": false,
        "allowed": [
          "axe",
          "blunt",
          "bludgeon",
          "bulwark",
          "claw",
          "polearm",
          "pickaxe",
          "scythe",
          "slash_sword",
          "spear",
          "spiked",
          "stab_sword",
          "2h_sword",
          "whip",
          "bow",
          "chinchompas",
          "crossbow",
          "thrown",
          "staff",
          "bladed_staff",
          "powered_staff",
          "banner",
          "blaster",
          "gun",
          "polestaff",
          "salamander",
          "unarmed"          
        ]
      },
      "stances": {
        "description": "An array of weapon stance information.",
        "type": "list",
        "required": true,
        "nullable": false,
        "schema": {
          "type": "dict",
          "schema": {
            "combat_style": {
              "type": "string",
              "nullable": false,
              "required": true,
              "allowed": [
                "impale",
                "aim and fire",
                "reap",
                "bash",
                "long fuse",
                "pummel",
                "smash",
                "blaze",
                "flare",
                "rapid",
                "lunge",
                "stab",
                "swipe",
                "short fuse",
                "punch",
                "kick",
                "spike",
                "scorch",
                "focus",
                "deflect",
                "fend",
                "block",
                "medium fuse",
                "flick",
                "slash",
                "longrange",
                "hack",
                "accurate",
                "pound",
                "chop",
                "jab",
                "lash",
                "spell",
                "spell (defensive)"
              ]
            },
            "attack_type": {
              "type": "string",
              "nullable": true,
              "required": true,
              "allowed": [
                "spellcasting",
                "stab",
                "ranged",
                "slash",
                "crush",
                "magic",
                "defensive casting"
              ]
            },
            "attack_style": {
              "type": "string",
              "nullable": true,
              "required": true,
              "allowed": [
                "aggressive",
                "defensive",
                "magic",
                "controlled",
                "accurate"
              ]
            },
            "experience": {
              "type": "string",
              "nullable": true,
              "required": true,
              "allowed": [
                "defence",
                "ranged and defence",
                "ranged",
                "shared",
                "magic and defence",
                "magic",
                "strength",
                "attack"
              ]
            },
            "boosts": {
              "type": "string",
              "nullable": true,
              "required": true,
              "allowed": [
                "attack speed by 1 tick",
                "attack range by 2 squares",
                "accuracy and damage"
              ]
            }
          }
        }
      }
    }
  }
}