OrbusVR API

From Travellers Hall Wiki
(Redirected from OrbusVR / OrbusVR API)

The Public API is a read-only resource that provides information about OrbusVR in JSON format, and can be used to create external tools to display game information.

Server Time and Player Count

Server time can be found here: http://api-reborn.orbusvr.com/servertime

A game day corresponds to 5 real-time hours. The spawn times of public events depends on the current in-game time.

Key Value Data Type Meaning (or other info)
percentThroughDay float Fraction of the day that has passed in game. Multiply by 100 to get percentage.
yearNumber int
monthOfYear int
dayOfMonth int
dayOfYear int
hour int
minutes int
seconds int
time str provides information in the format "HH:MM"
playersOnline int How many players are currently logged in

Fellowships

Fellowship information can be found here: http://api-reborn.orbusvr.com/public/fellowships/%FELLOWSHIPNAME% where %FELLOWSHIPNAME% is replaced with the name of the fellowship you want information for. An example would be this link to Thrive's fellowship stats page.

Key Data Type Meaning (or other info)
status bool whether or not the request was successful
fellowshipName str name of the fellowship requested
rosterName str[] array of string. The first name on this list is the Fellowship Leader

Characters

Character information can be found here: http://api-reborn.orbusvr.com/public/characters/%CHARACTERNAME% where %CHARACTERNAME% is replaced with the name of the character you want information for. An example would be this link to Pherosis's character stats page.

Key Value Data Type Meaning (or other info)
status bool whether or not the request was successful
characterName str
timePlayed int seconds played
levels int[] archer:Ranger, gambler:Scoundrel, orbhealer:Musketeer, swordboard:Warrior
stats obj[] will be broken down more in the next table {array of objects with two keys, name is the stat, record is either int, float, or obj[]}
fellowshipName string
equipment string[] Starts with the object ID: number before @ is itemId, number after @ is amount (for equipped potions, dragon treats, etc). Optionally followed by a JSON object converted to a string that contains item stats and other information. Each array position corresponds to one item slot.
id string character id

Equipment Item Data

Additional item data. Not all fields are required, and different item types can have different fields.

Key Value Data Type Info
isLocked boolean Shows that the item is locked. Field is missing if the item is unlocked.

Armor, Weapons, Rings

Key Value Data Type Info
itemLevel int Base level of the item
itemPlusLevel int Plus level of the item.
rarity string Item rarity (common, uncommon, rare, epic, legendary)
armor
attack
vitality
defense
strength
intellect
wisdom
luck
crit
int Stat boosts. Only present if the boost is greater than 0.
affixes string[] Weapon or armor affixes.
majordye
minordye
string Dyes. Not present if undyed.
tileset int[] Array contains IDs of rune tile items.
looksLike int Item ID of transmog item.
durability int Current durability of the item.
maxDurability int Maximum durability of the item.
loadout string[] Full loadout data. Only on weapons.

Bracers

Key Value Data Type Info
itemLevel int level of the bracer (basic = 0, silver = 1, gold = 2)
itemPlusLevel int always 0
expireTime int Time to expire (in seconds)

Dragon Pets

Key Value Data Type Info
primaryColor
secondaryColor
spotColor
int[2] Value is an array of two integers, one for each gene
size int
type string "mouse", "tiger" or "sea"
mood int
happiness int
isBonusActive boolean
bonusType int
breederName string
lastPetting int Unix timestamp of the last time the pet was pet by the owner.

Character Statistics

Key (name) Value Data Type Meaning (or other info)
fish_totalweight float The total weight fish caught, in lbs
potions_brewed int
monsters_killed int
gathers int
shard_highest_level int
shard_dungeons_completed obj[] each object has a the following fields:
  • zoneName (string)
  • shardLevel (int)
  • timeRemaining (float): time remaining in seconds
  • mutationsActive (string): all active shard affixes
raid_bosses_completed obj[] each object has a zoneName(str), bossName(str), timeToKill(float)
levels_past_30 int overlevels
bag_looted int
dragon_race_completed int
healing_potion_consumed int
number_dungeons_completed int
number_shards_completed int
battleground_wins int
battleground_captures int
battleground_kills int
bosskills_cngiant int
bosskills_shgiant int

Market Stall API

Market Stall information can be found here: http://api-reborn.orbusvr.com/public/market/stalldata is the link. The response is a JSON with the keys stall1 to stall10. The table below lists data type of each stall.

The market stall API is currently disabled.

Key (stall) Value Data Type (record) Meaning (or other info)
inventory str[] value before @ is item ID, value after @ is item count. Dragons have extra info in JSON.
prices int[] price corresponding to inventory.

Auction House API

Auction History can be found here: https://api-reborn.orbusvr.com/public/market/auctionhistory/%ITEMID% where %ITEMID% is the ID of the item you wish to look up. An example would be this link to Runemage Reagent. The response is a JSON object, with one key - the item ID. The value to that key is an object with several keys.

The auction house API is currently disabled.

Key (name) Value Data Type (record)
item_name string
total_auctions int
total_auctions_sold int
total_items_sold int

Orbus Community Resources