# RuneLite HTTP API
HTTPS://api.runelite.net/runelite-1.5.41.1
Open source RuneScape client
**Version** 1.5.41.1
Table Of Contents
[toc]
# APIs
## /account/callback
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| error |
query |
no |
|
- |
string |
| code |
query |
yes |
|
- |
string |
| state |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
## /account/login
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| uuid |
query |
yes |
|
- |
string (uuid) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | OAuthResponse|
## /account/logout
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /account/session-check
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /cache/
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[Cache]|
## /cache/item/{itemId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | ItemDefinition|
## /cache/item/{itemId}/image
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
| quantity |
query |
no |
|
- |
integer (int32) |
| border |
query |
no |
|
- |
integer (int32) |
| shadowColor |
query |
no |
|
- |
integer (int32) |
#### Response
__Content-Type:__ image/png
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
## /cache/npc/{npcId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| npcId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | NpcDefinition|
## /cache/object/{objectId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| objectId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | ObjectDefinition|
## /cache/{cacheId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| cacheId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[CacheIndex]|
## /cache/{cacheId}/{indexId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| cacheId |
path |
yes |
|
- |
integer (int32) |
| indexId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[CacheArchive]|
## /cache/{cacheId}/{indexId}/{archiveId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| cacheId |
path |
yes |
|
- |
integer (int32) |
| indexId |
path |
yes |
|
- |
integer (int32) |
| archiveId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | CacheArchive|
## /cache/{cacheId}/{indexId}/{archiveId}/data
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| cacheId |
path |
yes |
|
- |
integer (int32) |
| indexId |
path |
yes |
|
- |
integer (int32) |
| archiveId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
## /chat/duels
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Duels|
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| wins |
query |
yes |
|
- |
integer (int32) |
| losses |
query |
yes |
|
- |
integer (int32) |
| winningStreak |
query |
yes |
|
- |
integer (int32) |
| losingStreak |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/gc
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| gc |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/kc
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| boss |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| boss |
query |
yes |
|
- |
string |
| kc |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/layout
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| body |
body |
no |
|
- |
Array[]
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/pb
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| boss |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| boss |
query |
yes |
|
- |
string |
| pb |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/qp
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| qp |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /chat/task
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Task|
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| name |
query |
yes |
|
- |
string |
| task |
query |
yes |
|
- |
string |
| amount |
query |
yes |
|
- |
integer (int32) |
| initialAmount |
query |
yes |
|
- |
integer (int32) |
| location |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /config
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Configuration|
## /config/{key}
### PUT
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| key |
path |
yes |
(**Pattern**: `.+`) |
- |
string |
| body |
body |
no |
|
- |
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
### DELETE
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| key |
path |
yes |
(**Pattern**: `.+`) |
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /examine/item/{id}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
| body |
body |
no |
|
- |
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /examine/npc/{id}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
| body |
body |
no |
|
- |
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /examine/object/{id}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | |
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
path |
yes |
|
- |
integer (int32) |
| body |
body |
no |
|
- |
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /feed
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | FeedResult|
## /ge
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| limit |
query |
no |
|
- |
integer (int32) |
| offset |
query |
no |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[GrandExchangeTrade]|
### POST
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
### DELETE
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /hiscore/{endpoint}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| endpoint |
path |
yes |
|
- |
string |
| username |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | HiscoreResult|
## /hiscore/{endpoint}/{skillName}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| endpoint |
path |
yes |
|
- |
string |
| skillName |
path |
yes |
|
- |
string |
| username |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | SingleHiscoreSkillResult|
## /item/price
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| id |
query |
yes |
|
- |
Array[integer] (multi) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[ItemPrice]|
## /item/prices
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[ItemPrice]|
## /item/search
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| query |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | SearchResult|
## /item/{itemId}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Item|
## /item/{itemId}/icon
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
#### Response
__Content-Type:__ image/gif
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
## /item/{itemId}/icon/large
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
#### Response
__Content-Type:__ image/gif
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
## /item/{itemId}/price
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
path |
yes |
|
- |
integer (int32) |
| time |
query |
no |
|
- |
integer (int64) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | ItemPrice|
## /loottracker
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| count |
query |
no |
|
- |
integer (int32) |
| start |
query |
no |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[LootRecord]|
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| body |
body |
no |
|
- |
Array[LootRecord]
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
### DELETE
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| eventId |
query |
no |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /osb/ge
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| itemId |
query |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | GrandExchangeEntry|
## /sprite
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| spriteId |
query |
yes |
|
- |
integer (int32) |
| frameId |
query |
no |
|
- |
integer (int32) |
#### Response
__Content-Type:__ image/png
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[]|
## /worlds
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | WorldResult|
## /xp/get
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| username |
query |
yes |
|
- |
string |
| time |
query |
no |
|
- |
integer (int64) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | XpData|
## /xp/update
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| username |
query |
yes |
|
- |
string |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /xtea
### GET
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[XteaKey]|
### POST
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| body |
body |
no |
|
- |
XteaRequest
|
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /xtea/{region}
### GET
#### Request
##### Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| region |
path |
yes |
|
- |
integer (int32) |
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | XteaKey|
# Definitions
## Cache
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| revision |
integer (int32)
|
optional |
- |
|
| date |
integer (int64)
|
optional |
- |
|
## CacheArchive
| name |
type |
required |
description |
example |
| archiveId |
integer (int32)
|
optional |
- |
|
| nameHash |
integer (int32)
|
optional |
- |
|
| revision |
integer (int32)
|
optional |
- |
|
## CacheIndex
| name |
type |
required |
description |
example |
| indexId |
integer (int32)
|
optional |
- |
|
| revision |
integer (int32)
|
optional |
- |
|
## ConfigEntry
| name |
type |
required |
description |
example |
| key |
string
|
optional |
- |
|
| value |
string
|
optional |
- |
|
## Configuration
| name |
type |
required |
description |
example |
| config |
array[ConfigEntry]
|
optional |
- |
|
## Duels
| name |
type |
required |
description |
example |
| wins |
integer (int32)
|
optional |
- |
|
| losses |
integer (int32)
|
optional |
- |
|
| winningStreak |
integer (int32)
|
optional |
- |
|
| losingStreak |
integer (int32)
|
optional |
- |
|
## FeedItem
| name |
type |
required |
description |
example |
| type |
string
|
optional |
- |
|
| avatar |
string
|
optional |
- |
|
| title |
string
|
optional |
- |
|
| content |
string
|
optional |
- |
|
| url |
string
|
optional |
- |
|
| timestamp |
integer (int64)
|
optional |
- |
|
## FeedResult
| name |
type |
required |
description |
example |
| items |
array[FeedItem]
|
optional |
- |
|
## GameItem
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| qty |
integer (int32)
|
optional |
- |
|
## GrandExchangeEntry
| name |
type |
required |
description |
example |
| item_id |
integer (int32)
|
optional |
- |
|
| buy_average |
integer (int32)
|
optional |
- |
|
| sell_average |
integer (int32)
|
optional |
- |
|
| overall_average |
integer (int32)
|
optional |
- |
|
| last_update |
integer (int64)
|
optional |
- |
|
## GrandExchangeTrade
| name |
type |
required |
description |
example |
| buy |
boolean
|
optional |
- |
|
| itemId |
integer (int32)
|
optional |
- |
|
| quantity |
integer (int32)
|
optional |
- |
|
| price |
integer (int32)
|
optional |
- |
|
| time |
integer (int64)
|
optional |
- |
|
## HiscoreResult
| name |
type |
required |
description |
example |
| player |
string
|
optional |
- |
|
| overall |
Skill
|
optional |
- |
|
| attack |
Skill
|
optional |
- |
|
| defence |
Skill
|
optional |
- |
|
| strength |
Skill
|
optional |
- |
|
| hitpoints |
Skill
|
optional |
- |
|
| ranged |
Skill
|
optional |
- |
|
| prayer |
Skill
|
optional |
- |
|
| magic |
Skill
|
optional |
- |
|
| cooking |
Skill
|
optional |
- |
|
| woodcutting |
Skill
|
optional |
- |
|
| fletching |
Skill
|
optional |
- |
|
| fishing |
Skill
|
optional |
- |
|
| firemaking |
Skill
|
optional |
- |
|
| crafting |
Skill
|
optional |
- |
|
| smithing |
Skill
|
optional |
- |
|
| mining |
Skill
|
optional |
- |
|
| herblore |
Skill
|
optional |
- |
|
| agility |
Skill
|
optional |
- |
|
| thieving |
Skill
|
optional |
- |
|
| slayer |
Skill
|
optional |
- |
|
| farming |
Skill
|
optional |
- |
|
| runecraft |
Skill
|
optional |
- |
|
| hunter |
Skill
|
optional |
- |
|
| construction |
Skill
|
optional |
- |
|
| leaguePoints |
Skill
|
optional |
- |
|
| bountyHunterHunter |
Skill
|
optional |
- |
|
| bountyHunterRogue |
Skill
|
optional |
- |
|
| clueScrollAll |
Skill
|
optional |
- |
|
| clueScrollBeginner |
Skill
|
optional |
- |
|
| clueScrollEasy |
Skill
|
optional |
- |
|
| clueScrollMedium |
Skill
|
optional |
- |
|
| clueScrollHard |
Skill
|
optional |
- |
|
| clueScrollElite |
Skill
|
optional |
- |
|
| clueScrollMaster |
Skill
|
optional |
- |
|
| lastManStanding |
Skill
|
optional |
- |
|
## Item
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| description |
string
|
optional |
- |
|
| type |
string
|
optional |
- |
|
## ItemDefinition
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| resizeX |
integer (int32)
|
optional |
- |
|
| resizeY |
integer (int32)
|
optional |
- |
|
| resizeZ |
integer (int32)
|
optional |
- |
|
| xan2d |
integer (int32)
|
optional |
- |
|
| yan2d |
integer (int32)
|
optional |
- |
|
| zan2d |
integer (int32)
|
optional |
- |
|
| cost |
integer (int32)
|
optional |
- |
|
| isTradeable |
boolean
|
optional |
- |
|
| stackable |
integer (int32)
|
optional |
- |
|
| inventoryModel |
integer (int32)
|
optional |
- |
|
| members |
boolean
|
optional |
- |
|
| colorFind |
array[integer]
|
optional |
- |
|
| colorReplace |
array[integer]
|
optional |
- |
|
| textureFind |
array[integer]
|
optional |
- |
|
| textureReplace |
array[integer]
|
optional |
- |
|
| zoom2d |
integer (int32)
|
optional |
- |
|
| xOffset2d |
integer (int32)
|
optional |
- |
|
| yOffset2d |
integer (int32)
|
optional |
- |
|
| ambient |
integer (int32)
|
optional |
- |
|
| contrast |
integer (int32)
|
optional |
- |
|
| countCo |
array[integer]
|
optional |
- |
|
| countObj |
array[integer]
|
optional |
- |
|
| options |
array[string]
|
optional |
- |
|
| interfaceOptions |
array[string]
|
optional |
- |
|
| maleModel0 |
integer (int32)
|
optional |
- |
|
| maleModel1 |
integer (int32)
|
optional |
- |
|
| maleModel2 |
integer (int32)
|
optional |
- |
|
| maleOffset |
integer (int32)
|
optional |
- |
|
| maleHeadModel |
integer (int32)
|
optional |
- |
|
| maleHeadModel2 |
integer (int32)
|
optional |
- |
|
| femaleModel0 |
integer (int32)
|
optional |
- |
|
| femaleModel1 |
integer (int32)
|
optional |
- |
|
| femaleModel2 |
integer (int32)
|
optional |
- |
|
| femaleOffset |
integer (int32)
|
optional |
- |
|
| femaleHeadModel |
integer (int32)
|
optional |
- |
|
| femaleHeadModel2 |
integer (int32)
|
optional |
- |
|
| notedID |
integer (int32)
|
optional |
- |
|
| notedTemplate |
integer (int32)
|
optional |
- |
|
| team |
integer (int32)
|
optional |
- |
|
| shiftClickDropIndex |
integer (int32)
|
optional |
- |
|
| boughtId |
integer (int32)
|
optional |
- |
|
| boughtTemplateId |
integer (int32)
|
optional |
- |
|
| placeholderId |
integer (int32)
|
optional |
- |
|
| placeholderTemplateId |
integer (int32)
|
optional |
- |
|
| params |
object
|
optional |
- |
|
| tradeable |
boolean
|
optional |
- |
|
| xoffset2d |
integer (int32)
|
optional |
- |
|
| yoffset2d |
integer (int32)
|
optional |
- |
|
## ItemPrice
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| price |
integer (int32)
|
optional |
- |
|
| time |
integer (int64)
|
optional |
- |
|
## LootRecord
| name |
type |
required |
description |
example |
| eventId |
string
|
optional |
- |
|
| type |
string
|
optional |
- |
|
| drops |
array[GameItem]
|
optional |
- |
|
| time |
integer (int64)
|
optional |
- |
|
## NpcDefinition
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| size |
integer (int32)
|
optional |
- |
|
| models |
array[integer]
|
optional |
- |
|
| chatheadModels |
array[integer]
|
optional |
- |
|
| standingAnimation |
integer (int32)
|
optional |
- |
|
| rotateLeftAnimation |
integer (int32)
|
optional |
- |
|
| rotateRightAnimation |
integer (int32)
|
optional |
- |
|
| walkingAnimation |
integer (int32)
|
optional |
- |
|
| rotate180Animation |
integer (int32)
|
optional |
- |
|
| rotate90RightAnimation |
integer (int32)
|
optional |
- |
|
| rotate90LeftAnimation |
integer (int32)
|
optional |
- |
|
| recolorToFind |
array[integer]
|
optional |
- |
|
| recolorToReplace |
array[integer]
|
optional |
- |
|
| retextureToFind |
array[integer]
|
optional |
- |
|
| retextureToReplace |
array[integer]
|
optional |
- |
|
| actions |
array[string]
|
optional |
- |
|
| isMinimapVisible |
boolean
|
optional |
- |
|
| combatLevel |
integer (int32)
|
optional |
- |
|
| widthScale |
integer (int32)
|
optional |
- |
|
| heightScale |
integer (int32)
|
optional |
- |
|
| hasRenderPriority |
boolean
|
optional |
- |
|
| ambient |
integer (int32)
|
optional |
- |
|
| contrast |
integer (int32)
|
optional |
- |
|
| headIcon |
integer (int32)
|
optional |
- |
|
| rotationSpeed |
integer (int32)
|
optional |
- |
|
| configs |
array[integer]
|
optional |
- |
|
| varbitId |
integer (int32)
|
optional |
- |
|
| varpIndex |
integer (int32)
|
optional |
- |
|
| isInteractable |
boolean
|
optional |
- |
|
| rotationFlag |
boolean
|
optional |
- |
|
| isPet |
boolean
|
optional |
- |
|
| params |
object
|
optional |
- |
|
| minimapVisible |
boolean
|
optional |
- |
|
| interactable |
boolean
|
optional |
- |
|
| pet |
boolean
|
optional |
- |
|
## OAuthResponse
| name |
type |
required |
description |
example |
| oauthUrl |
string
|
optional |
- |
|
| uid |
string (uuid)
|
optional |
- |
|
## ObjectDefinition
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| retextureToFind |
array[integer]
|
optional |
- |
|
| decorDisplacement |
integer (int32)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| objectModels |
array[integer]
|
optional |
- |
|
| objectTypes |
array[integer]
|
optional |
- |
|
| recolorToFind |
array[integer]
|
optional |
- |
|
| mapAreaId |
integer (int32)
|
optional |
- |
|
| textureToReplace |
array[integer]
|
optional |
- |
|
| sizeX |
integer (int32)
|
optional |
- |
|
| sizeY |
integer (int32)
|
optional |
- |
|
| anInt2083 |
integer (int32)
|
optional |
- |
|
| anIntArray2084 |
array[integer]
|
optional |
- |
|
| offsetX |
integer (int32)
|
optional |
- |
|
| mergeNormals |
boolean
|
optional |
- |
|
| wallOrDoor |
integer (int32)
|
optional |
- |
|
| animationID |
integer (int32)
|
optional |
- |
|
| varbitID |
integer (int32)
|
optional |
- |
|
| ambient |
integer (int32)
|
optional |
- |
|
| contrast |
integer (int32)
|
optional |
- |
|
| actions |
array[string]
|
optional |
- |
|
| interactType |
integer (int32)
|
optional |
- |
|
| mapSceneID |
integer (int32)
|
optional |
- |
|
| recolorToReplace |
array[integer]
|
optional |
- |
|
| shadow |
boolean
|
optional |
- |
|
| modelSizeX |
integer (int32)
|
optional |
- |
|
| modelSizeHeight |
integer (int32)
|
optional |
- |
|
| modelSizeY |
integer (int32)
|
optional |
- |
|
| objectID |
integer (int32)
|
optional |
- |
|
| offsetHeight |
integer (int32)
|
optional |
- |
|
| offsetY |
integer (int32)
|
optional |
- |
|
| obstructsGround |
boolean
|
optional |
- |
|
| contouredGround |
integer (int32)
|
optional |
- |
|
| supportsItems |
integer (int32)
|
optional |
- |
|
| configChangeDest |
array[integer]
|
optional |
- |
|
| varpID |
integer (int32)
|
optional |
- |
|
| ambientSoundId |
integer (int32)
|
optional |
- |
|
| anInt2112 |
integer (int32)
|
optional |
- |
|
| anInt2113 |
integer (int32)
|
optional |
- |
|
| blocksProjectile |
boolean
|
optional |
- |
|
| params |
object
|
optional |
- |
|
| rotated |
boolean
|
optional |
- |
|
| abool2111 |
boolean
|
optional |
- |
|
| hollow |
boolean
|
optional |
- |
|
## SearchResult
| name |
type |
required |
description |
example |
| items |
array[Item]
|
optional |
- |
|
## SingleHiscoreSkillResult
| name |
type |
required |
description |
example |
| player |
string
|
optional |
- |
|
| skillName |
string
|
optional |
- |
|
| skill |
Skill
|
optional |
- |
|
## Skill
| name |
type |
required |
description |
example |
| rank |
integer (int32)
|
optional |
- |
|
| level |
integer (int32)
|
optional |
- |
|
| experience |
integer (int64)
|
optional |
- |
|
## Task
| name |
type |
required |
description |
example |
| task |
string
|
optional |
- |
|
| amount |
integer (int32)
|
optional |
- |
|
| initialAmount |
integer (int32)
|
optional |
- |
|
| location |
string
|
optional |
- |
|
## World
| name |
type |
required |
description |
example |
| id |
integer (int32)
|
optional |
- |
|
| types |
array[string]
|
optional |
- |
|
| address |
string
|
optional |
- |
|
| activity |
string
|
optional |
- |
|
| location |
integer (int32)
|
optional |
- |
|
| players |
integer (int32)
|
optional |
- |
|
## WorldResult
| name |
type |
required |
description |
example |
| worlds |
array[World]
|
optional |
- |
|
## XpData
| name |
type |
required |
description |
example |
| time |
integer (int64)
|
optional |
- |
|
| attack_xp |
integer (int32)
|
optional |
- |
|
| defence_xp |
integer (int32)
|
optional |
- |
|
| strength_xp |
integer (int32)
|
optional |
- |
|
| hitpoints_xp |
integer (int32)
|
optional |
- |
|
| ranged_xp |
integer (int32)
|
optional |
- |
|
| prayer_xp |
integer (int32)
|
optional |
- |
|
| magic_xp |
integer (int32)
|
optional |
- |
|
| cooking_xp |
integer (int32)
|
optional |
- |
|
| woodcutting_xp |
integer (int32)
|
optional |
- |
|
| fletching_xp |
integer (int32)
|
optional |
- |
|
| fishing_xp |
integer (int32)
|
optional |
- |
|
| firemaking_xp |
integer (int32)
|
optional |
- |
|
| crafting_xp |
integer (int32)
|
optional |
- |
|
| smithing_xp |
integer (int32)
|
optional |
- |
|
| mining_xp |
integer (int32)
|
optional |
- |
|
| herblore_xp |
integer (int32)
|
optional |
- |
|
| agility_xp |
integer (int32)
|
optional |
- |
|
| thieving_xp |
integer (int32)
|
optional |
- |
|
| slayer_xp |
integer (int32)
|
optional |
- |
|
| farming_xp |
integer (int32)
|
optional |
- |
|
| runecraft_xp |
integer (int32)
|
optional |
- |
|
| hunter_xp |
integer (int32)
|
optional |
- |
|
| construction_xp |
integer (int32)
|
optional |
- |
|
| overall_rank |
integer (int32)
|
optional |
- |
|
| attack_rank |
integer (int32)
|
optional |
- |
|
| defence_rank |
integer (int32)
|
optional |
- |
|
| strength_rank |
integer (int32)
|
optional |
- |
|
| hitpoints_rank |
integer (int32)
|
optional |
- |
|
| ranged_rank |
integer (int32)
|
optional |
- |
|
| prayer_rank |
integer (int32)
|
optional |
- |
|
| magic_rank |
integer (int32)
|
optional |
- |
|
| cooking_rank |
integer (int32)
|
optional |
- |
|
| woodcutting_rank |
integer (int32)
|
optional |
- |
|
| fletching_rank |
integer (int32)
|
optional |
- |
|
| fishing_rank |
integer (int32)
|
optional |
- |
|
| firemaking_rank |
integer (int32)
|
optional |
- |
|
| crafting_rank |
integer (int32)
|
optional |
- |
|
| smithing_rank |
integer (int32)
|
optional |
- |
|
| mining_rank |
integer (int32)
|
optional |
- |
|
| herblore_rank |
integer (int32)
|
optional |
- |
|
| agility_rank |
integer (int32)
|
optional |
- |
|
| thieving_rank |
integer (int32)
|
optional |
- |
|
| slayer_rank |
integer (int32)
|
optional |
- |
|
| farming_rank |
integer (int32)
|
optional |
- |
|
| runecraft_rank |
integer (int32)
|
optional |
- |
|
| hunter_rank |
integer (int32)
|
optional |
- |
|
| construction_rank |
integer (int32)
|
optional |
- |
|
## XteaKey
| name |
type |
required |
description |
example |
| region |
integer (int32)
|
optional |
- |
|
| keys |
array[integer]
|
optional |
- |
|
## XteaRequest
| name |
type |
required |
description |
example |
| revision |
integer (int32)
|
optional |
- |
|
| keys |
array[XteaKey]
|
optional |
- |
|