Path of Exile website client
Switch branches/tags
Nothing to show
Clone or download
Latest commit c546a50 Sep 21, 2018

README.md

Respoe

Path of Exile website client. Useful for automating tasks on the Path of Exile website or forum (bots or just gathering data).

It makes requests and then parses the response to fetch all the needed data. The library is separated in three packages:

  • Client: Related to all account features.
  • Forum: Related to all forum data.
  • Trade: Related to trading websites
  • Util: Related to util methods for developing tools.

Usage

First get the package:

go get github.com/raggaer/respoe/...

You can then use this as a library for developing tools related to the Path of Exile website, forum or the trade site. You can automate the reading of forums, creating or replying threads or even automating private messaging (just like poe.trade bot does)

Features

Below is a list of the features that are already completed:

Client

GoDoc

  • Login
  • Logout
  • Change password
  • Retrieve inbox by page
  • Send private messages
  • Retrieve special offer list
  • Retrieve account profile
  • Retrieve account character list
  • Retrieve account character items
  • Retrieve active leagues

Forum

GoDoc

  • Forum list
  • Retrieve specific forum pagination information (first, current and last page)
  • Retrieve all threads from a forum (with status, views, author, creation date and replies)
  • Retrieve all posts from a thread (content, author, creation date, items)
  • Work with forum items (sockets)
  • Reply to a thread

Trade

GoDoc

  • Retrieve currency exchange offers

Ladder

GoDoc

  • Retrieve entries from a league ladder

Util

GoDoc

  • Retrieve pagination from any valid page
  • Retrieve hash value from any valid form
  • Retrieve hash value from any reply thread form
  • Retrieve errors from a submitted form

Testing

All methods are testable. To run the tests you need to set some environment variables:

  • RESPOE_EMAIL: Your Path of Exile account email (used for login).
  • RESPOE_PASSWORD: Your Path of Exile account password (used for login).
  • RESPOE_NEW_PASSWORD: New password for your account (used for change password).
  • RESPOE_RECIPIENT: Recipient for sending private messages (used for private message sending).

This variables are only needed if you want to run the tests. These are not needed for regular usage

Example of usage

Currently I developed this library mainly to parse Path Of Exile forums to be able to create a mobile-friendly forum. With the trading package I created Currency status to view currency prices compared to chaos

License

Respoe is licensed under the MIT license.