halipso / php-steam-tradeoffers

Steam Trade Offers for PHP (based on node.js library by Alex7Kom)
76 stars 31 forks source link

php-steam-tradeoffers

Steam Trade Offers library for PHP (based on node.js library by Alex7Kom)

All the same functions as in Alex7Kom library

Note: By using this library you automatically agree to Steam API Terms of Use

Installation

require_once 'classes/steam.class.php'

Usage

Instantiate a steam object...

$steam = new SteamTrade();

...then setup session:

$steam->setup('sessionID', 'cookies');

This setup will automatically register and retrieve Steam API key for you.

Methods

The first param for all methods (except setup) is an associative array of options.

setup(sessionId, cookies)

As noted above, this method is used to setup a web session. It also tries to retrieve Web API key.

Options:

If failed to retrieve Web API key due to limited account, setup will throw the error.

loadMyInventory(options)

Loads your inventory for the given app and context. For example, use 440 and 2 for TF2 and 570 and 2 for Dota 2.

Options:

loadPartnerInventory(options)

Loads your partner inventory for the given app and context.

Options:

makeOffer(options)

Makes a trade offer to the partner.

Options:

itemsFromMe and itemsFromThem both are arrays of item objects that look like this:

array(
    "appid" => 440,
    "contextid" => 2,
    "amount" => 1,
    "assetid" => "1627590398"
)

If success it will return an object with tradeofferid of the newly created trade offer.

getOffers(options)

getOffer(options)

The first method loads a list of trade offers, and the second loads just a single offer.

Options:

declineOffer(options)

acceptOffer(options)

cancelOffer(options)

declineOffer or acceptOffer that was sent to you. cancelOffer that you sent.

Options:

In return you will get an object with response from Steam, but don't expect anything meaningful in it.

getOfferToken()

In return you will get the offer token of the bot, extracted from its trade offer URL.

getItems(options)

Options:

In return you will get an array of items acquired in a completed trade.