backpack_tf

Backpack.tf is a website for the in-game economies of Team Fortress 2 and Dota 2. This gem is a wrapper for the backpack.tf API. The goal is to capture the results and turn them into Ruby objects for use in your application.

If you are interested in contributing, please see any open issues and let me know.

$ gem install backpack_tf

gem 'backpack_tf'

Register an API key, pass it in to the client.

#
# create a new Client object
#
bp = BackpackTF::Client.new(<your_api_key>)

#
# fetch some data
#
prices = bp.fetch(:prices)
price_history = bp.fetch(:price_history, { item: item_name_or_defindex })
market_prices = bp.fetch(:market_prices)
currencies = bp.fetch(:currencies)
special_items = bp.fetch(:special_items)
users = bp.fetch(:users, { steamids: [array,of,64,bit,steam,ids] })
listings = bp.fetch(:user_listings, { steamid: 64_bit_steam_id })

#
# assign fetched data to the corresponding module
#
BackpackTF::Price.response = prices
BackpackTF::PriceHistory.response = price_history
BackpackTF::MarketPrices.response = market_prices
BackpackTF::Currency.response = currencies
BackpackTF::SpecialItem.response = special_items
BackpackTF::User.response = users
BackpackTF::UserListing.response = listings

Link to all official documentation.

• Get pricing data for all priced items

Information on any particular item, (ie: 'Eviction Notice'), is captured in an instance of BackpackTF::Price::Item. Furthermore, there may be several prices for the same item. For example, an Eviction Notice with the Unique quality has a different price than an Eviction Notice with the Strange quality.

Each price is an instance of BackpackTF::Price::ItemPrice, and is stored in the @prices hash of that item.

• BackpackTF::Price module
  • @items hash of BackpackTF::Price::Response.
    • BackpackTF::Price::Item object (ie: 'Beast From Below')
    • BackpackTF::Price::Item object (ie: 'Taunt: Rock, Paper Scissors')
    • BackpackTF::Price::Item object (ie: 'Eviction Notice')
      • @prices hash of a BackpackTF::Price::Item object
        • BackpackTF::Price::ItemPrice object (ie: price of a Unique item)
        • BackpackTF::Price::ItemPrice object (ie: price of a Vintage item)
        • BackpackTF::Price::ItemPrice object (ie: price of a Strange item)

• Get price history for an item

You must pass in the item name or its defindex number as value on the name key when accessing this interface. IE:

• client.fetch(:price_history, item: 829) or
• client.fetch(:price_history, item: 'War Pig')

If you pass in a string as the item, then it must match the item_name property (not the name property) as per its definition in the schema. For more information, see the TF2 Wiki page on item schema.

You can optionally pass the client quality, tradable, craftable or priceindex keys. See the

• Get Steam Community Market price information

• Get internal currency data

There are currently 4 currencies available through the API. Each one is an instance of BackpackTF::Currency and is held in the @currencies hash of the BackpackTF::Currency::Response class.

• Get internal backpack.tf item placeholders

This is for items that only exist on backpack.tf. They are not real game items, but you will see them returned in a call to IGetSpecialItems.

• Get profile info for a list of 64-bit Steam IDs.
• Does not require an API key

Get some basic information for a list of backpack.tf users. It's basically the info that you'd see on their profile page. You can request several users at once by sending an array.

• Get classified listings for a given user

Request all classified listings for one user. You must pass in the 64-bit steamid.