SteamEx v0.2.0-alpha SteamEx.IEconService View Source

Additional Steam Economy methods that provide access to Steam Trading.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

For more info on how to use the Steamworks Web API please see the Web API Overview.

Link to this section Summary

Link to this section Functions

Link to this function cancel_trade_offer(access_key, params \\ %{}, headers \\ %{}) View Source

Cancel a trade offer we sent

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
tradeofferiduint64

See other: https://partner.steamgames.com/doc/webapi/IEconService#CancelTradeOffer

Link to this function decline_trade_offer(access_key, params \\ %{}, headers \\ %{}) View Source

Decline a trade offer someone sent to us

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
tradeofferiduint64

See other: https://partner.steamgames.com/doc/webapi/IEconService#DeclineTradeOffer

Link to this function get_trade_history(access_key, params \\ %{}, headers \\ %{}) View Source

Gets a history of trades

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
max_tradesuint32The number of trades to return information for
start_after_timeuint32The time of the last trade shown on the previous page of results, or the time of the first trade if navigating back
start_after_tradeiduint64The tradeid shown on the previous page of results, or the ID of the first trade if navigating back
navigating_backboolThe user wants the previous page of results, so return the previous max_trades trades before the start time and ID
get_descriptionsboolIf set, the item display data for the items included in the returned trades will also be returned

| language | string | ✔ | The language to use when loading item display data | include_failed | bool | ✔ | | | include_total | bool | ✔ | If set, the total number of trades the account has participated in will be included in the response|

See other: https://partner.steamgames.com/doc/webapi/IEconService#GetTradeHistory

Link to this function get_trade_offers(access_key, params \\ %{}, headers \\ %{}) View Source

Get a list of sent or received trade offers

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
get_sent_offersboolRequest the list of sent offers.
get_received_offersboolRequest the list of received offers.
get_descriptionsboolIf set, the item display data for the items included in the returned trade offers will also be returned.
languagestringThe language to use when loading item display data.
active_onlyboolIndicates we should only return offers which are still active, or offers that have changed in state since the time_historical_cutoff
historical_onlyboolIndicates we should only return offers which are not active.

| time_historical_cutoff | uint32 | ✔ | When active_only is set, offers updated since this time will also be returned

See other: https://partner.steamgames.com/doc/webapi/IEconService#GetTradeOffers

Link to this function get_trade_offers_summary(access_key, params \\ %{}, headers \\ %{}) View Source

Get counts of pending and new trade offers

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
time_last_visituint32The time the user last visited. If not passed, will use the time the user last visited the trade offer page.

See other: https://partner.steamgames.com/doc/webapi/IEconService#GetTradeOffersSummary