Status payload

The body of POST /api/v1/status, schema vw.status/1. Send it every 5 to 10 seconds while the client runs. Fields you do not know stay out; the dashboard shows what it gets.

Field	Type	Description
`schema`	`"vw.status/1"`	Payload schema and version
`module`required	`string`	Name and version of the sending module, for example voidwatch-feed/0.3.0up to 40 characters
`online`required	`boolean`	The character is logged in
`character`required	`Character`
`character.name`required	`string`	Character nameup to 30 characters
`character.vocation`	`string`	Vocation, for example Elite Knightup to 30 characters
`character.level`required	`integer`	≥ 1, ≤ 5000
`character.exp`required	`integer`	Total experience points≥ 0
`pos`required	`Position`
`pos.x`required	`integer`	Map x≥ 0, ≤ 65535
`pos.y`required	`integer`	Map y≥ 0, ≤ 65535
`pos.z`required	`integer`	Floor, 0 to 15; 7 is ground level≥ 0, ≤ 15
`cap`	`integer`	Free capacity, in oz≥ 0
`stamina`	`integer`	Stamina, in minutes≥ 0, ≤ 2520
`expPerHour`	`integer`	Exp per hour as the client measures it≥ 0
`route`	`string`	The loaded cavebot routeup to 80 characters
`routeOn`	`boolean`	The cavebot is running
`label`	`string`	The route label the bot is atup to 40 characters
`routes`	`string[]`	Every route the bot can loadup to 100 items
`supplies`	`Counted[]`	up to 30 items
`supplies[].name`required	`string`	Item or creature name, as the game writes itup to 60 characters
`supplies[].have`required	`integer`	How many the character has now≥ 0
`supplies[].want`required	`integer`	How many the bot keeps in stock, or the task goal≥ 0
`tasks`	`Counted[]`	up to 10 items
`tasks[].name`required	`string`	Item or creature name, as the game writes itup to 60 characters
`tasks[].have`required	`integer`	How many the character has now≥ 0
`tasks[].want`required	`integer`	How many the bot keeps in stock, or the task goal≥ 0
`loot`	`LootItem[]`	up to 200 items
`loot[].name`required	`string`	Item nameup to 60 characters
`loot[].count`required	`integer`	Looted since the session started≥ 0
`loot[].sell`	`integer`	NPC price per item, if the module knows it. The server fills it in otherwise≥ 0
`lootHours`	`number`	Hours since the loot counter started≥ 0
`skulls`	`Skull[]`	Skulled players in viewup to 20 items
`skulls[].name`required	`string`	Player nameup to 30 characters
`skulls[].skull`required	`"white" \| "red" \| "black" \| "yellow" \| "green" \| "orange"`	Skull colour
`blessed`	`boolean`	Only on servers with blessings
`redemptionLeft`	`integer`	Only on servers with redemption≥ 0

Example

{
  "schema": "vw.status/1",
  "module": "voidwatch-feed/0.3.0",
  "online": true,
  "character": {
    "name": "Franz Kafka",
    "vocation": "Royal Paladin",
    "level": 589,
    "exp": 3380000000
  },
  "pos": {
    "x": 32376,
    "y": 31779,
    "z": 7
  },
  "cap": 8568,
  "stamina": 2502,
  "expPerHour": 14998739,
  "route": "[afk] fu.exodar HH",
  "routeOn": true,
  "label": "hunt",
  "routes": [
    "[afk] fu.exodar HH",
    "UD & HH Left"
  ],
  "supplies": [
    {
      "name": "great spirit potion",
      "have": 3498,
      "want": 4000
    }
  ],
  "tasks": [
    {
      "name": "hellhound",
      "have": 578,
      "want": 1000
    }
  ],
  "loot": [
    {
      "name": "fire sword",
      "count": 192
    }
  ],
  "lootHours": 2.4,
  "skulls": []
}

Versions

The schema name carries the version. A new field keeps the version; a changed or removed field gets a new one, and the old version keeps working for at least six months.