README.md

BackpackTF-API

This is an unoffical api wrapper for the Backpack.tf API in python. You can do a lot with this API keep reading for more information

Getting Started

To get started using this api follow the instructions below.

You need to register for an API key and create an app to use all the fucntions of this api at BackpackTF

Installing

pip install BackpackTF

Quick Start Guide

Here's a quick bit of code to get an item's price

from BackpackTF import Currency

api = Currency(apikey="xxxxxxxxxxxxxxxxx")

price = api.item_price(item="Tour of Duty Ticket", quality="Unique", craftable=1, tradable=1, priceindex=0)

print(price)

Detailed Documentation

The Account Class

init

Attributes	Description
client_id	from your backpack.tf app here
client_secret	from your backpack.tf app here
api_key	your api key from here

create_listing - creates a listing / classified on backpack.tf

Attributes	Description
intent	0 (Buy) or 1 (Sell)
id	if intent is 1, the current id of the id you want to list
item_name	if intent is 0, the item's name you want to buy
quality	if intent is 0, either the number or the text
craftable	if intent is 0, 0 or 1
offers	set to 0 for only accepting friend requests
buyout	set to 0 to allow negotiation
promoted	set to 1 to promote it, must be premium
details	the listing comment, max 200 characters
priceindex	complicated, most of the time is 0. More info

returns 0 or 1 for success or failure.

search_classifieds - searches for classifieds

Attributes	Description
intent	either sell, buy, or both
page_size	the results / page 0 < page_size <= 30
page	the page number you want to view
fold	if set 0 disables listing folding
item_name	the name of the item you want to search for
steamid	the steam id of the user who you want to check their listings
tradable	0/1
craftable	0/1
australium	0/1
wear_tier	1-5 for tier of skin wear, use MiscUtils().wear_Tier_String_To_Int()
texture_name	required to search by wear_tier, the name of the skin / texture to search by
quality	the integer of the quality to search by use MiscUtils().qualityStringToInt() to get it
paint	the paint's ID to search by
particle	particle ID effect
killstreak_tier	1-3, use MiscUtils().killstreaker_Tier_String_To_Int()
sheen	0-7, use MiscUtils().sheen_String_To_Int()
killstreaker	the id of the killstreaker

returns a dictionary. Here's an example json

extract_trade_url - extracts the trade url with token from a listing

Attributes	Description
listingJSON	This is the json object of a classified listing on backpack.tf. You can get this using the method above.
proxy	This is an optional field, provide a dictionary that fits the python requests module requirements. See here

returns the trade url as a string.

The Currency Class

init

Attributes	Description
apikey	your api key from here

get_currencies - gets currency values

Attributes	Description
None	None

returns a dictonary. Here's an example json.

price_history - gets the price history for a given item

Attributes	Description
item	the name of the item you want to search for
quality	the integer of the quality to search by use MiscUtils().qualityStringToInt("Unique") to get it
craftable	0/1
tradable	0/1
priceindex	complicated, most of the time is 0. More info

returns an array of dictionaries. Here's an example.

item_price - gets the current price for a given item

Attributes	Description
item	the name of the item you want to search for
quality	the integer of the quality to search by use MiscUtils().qualityStringToInt("Unique") to get it
craftable	0/1
tradable	0/1
priceindex	complicated, most of the time is 0. More info

returns a single dictionary of current value. Here's an example.

get_all_prices - gets all prices

Attributes	Description
raw	shows a value_low field
since	will only show items that has had price changes since the unix epoch.

returns a kind of weird json file. Here's an example, and here's the structure.

The MiscUtils Class

init

Attributes	Description
None	None

quality_string_to_int

Attributes	Description
string	The string of the quality. Ex: "Unique"

particle_string_to_int

Attributes	Description
string	The string of the particle effect.

rarity_string_to_int

Attributes	Description
string	The string of the rarity.

origin_string_to_int

Attributes	Description
string	The string of the origin.

wear_tier_string_to_int

Attributes	Description
string	The string of the wear_tier.

killstreaker_string_to_int

Attributes	Description
string	The string of the killstreaker.

strange_parts_string_to_int

Attributes	Description
string	The string of the strange part.

steam_id_to_account_id

Attributes	Description
string	The string of the steam_id.

returns an int of the account id.

Built With

• Python 3.7 - The web framework used

Authors

• David Teather - Initial work - davidteather

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details