Skip to main content

Old School RuneScape Grand Exchange wrapper

Project description

# GE_wrapper
GE_wrapper is a Old School Runesacpe Grand Exchange API wrapper.

---
How to Use
---

clone the repository:

git clone https://github.com/Blankpanda/GE_wrapper.git

add this to the top of your program:

import exchange

(be sure to add items.json to a resource folder)
create an Exchange object:

item = exchange.GE(<ITEM_ID>)
(item IDS can be found in res/items.json)

the following generic properties will be retrieved from the api:
1. icon
2. icon_large
3. id
4. type
5. typeIcon
6. name
7. description
8. members
9. price

properties about marketing trends:

* **today**
1. today_trend
2. today_price
* **current**
1. current_trend
2. current_price
* **three months ago**
1. ThreeMonths_trend
2. ThreeMonths_change
* **six months ago**
1. SixMonth_trend
2. SixMonth_change

---
Example
---
item = Exchange.exchange(4151)

print(item.price) # 2.4m
print(item.name) # "Abbysal Whip"
print(item.SixMonth_trend) # "positive"
print(item.SixMonth_change) # "+9.0%"

---
Additionally you can use the ItemList module to match item IDs to names.

item_id = exchange.ItemList.get_id("Bucket of wax") # 30
item_name = exchange.ItemList.get_name(30) # "Bucket of wax"

---
TODO
---
* fix Items.py so that its able to retrieve IDS from inputing a name from names.json to make it easier to match item ids to names

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gew-0.0.2.zip (6.4 kB view details)

Uploaded Source

File details

Details for the file gew-0.0.2.zip.

File metadata

  • Download URL: gew-0.0.2.zip
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gew-0.0.2.zip
Algorithm Hash digest
SHA256 2e60dc6f4298701568f09e2c08079b192194c704ef15f4180569b81e32ed1724
MD5 fde40d13fba779802a67aaaac65c91fc
BLAKE2b-256 af77bc97801ddf58b33567840bb29e4d4cd8062b1447127b839da59fc2d3876f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page