IInventoryService – Steam Web API Documentation

This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.

PUBLISHERPOSTAddItem

Adds an item to a user's inventory

https://partner.steam-api.com/IInventoryService/AddItem/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
itemdefid		uint64	Yes
itempropsjson		string	Yes
itemquantity		uint32	Yes
steamid		uint64	Yes
notify		bool	Yes	Should notify the user that the item was added to their Steam Inventory.
requestid		uint64	Yes
trade_restriction		bool	Yes	If true, apply the default trade and market restriction times to this item.
is_purchase		bool	No	If set, treat requestid as a txnid and create this item as a result of user microtransaction purchase.

PUBLISHERPOSTAddPromoItem

Adds a promo item to a user's inventory

https://partner.steam-api.com/IInventoryService/AddPromoItem/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
itemdefid		uint64	Yes
itempropsjson		string	Yes
itemquantity		uint32	Yes
steamid		uint64	Yes
notify		bool	Yes	Should notify the user that the item was added to their Steam Inventory.
requestid		uint64	Yes
trade_restriction		bool	Yes	If true, apply the default trade and market restriction times to this item.
is_purchase		bool	No	If set, treat requestid as a txnid and create this item as a result of user microtransaction purchase.

UNDOCUMENTEDPOSTArchiveItemDef

https://api.steampowered.com/IInventoryService/ArchiveItemDef/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No
itemdefid		uint64	No
archive		bool	No

POSTCombineItemStacks

Combine two stacks of items

https://api.steampowered.com/IInventoryService/CombineItemStacks/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
fromitemid		uint64	Yes
destitemid		uint64	Yes
quantity		uint32	Yes
steamid		uint64	Yes

PUBLISHERPOSTConsolidate

Consolidate items of the given type within an user's inventory

https://partner.steam-api.com/IInventoryService/Consolidate/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
itemdefid		uint64	Yes
force		bool	No

PUBLISHERPOSTConsolidateAll

Consolidate all items within an user's inventory

https://partner.steam-api.com/IInventoryService/ConsolidateAll/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
force		bool	Yes

UNDOCUMENTEDPOSTConsumeItem

Consume an item

https://api.steampowered.com/IInventoryService/ConsumeItem/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No
itemid		uint64	No	Item ID to be consumed
quantity		uint32	No	Amount of the given item stack to be consumed
timestamp		string	No
steamid		uint64	No
requestid		uint64	No	Clients may provide a unique identifier for a request to perform at most once execution. When a requestid is resubmitted, it will not cause the work to be performed again; the response message will be the current state of items affected by the original successful execution.

PUBLISHERPOSTExchangeItem

Craft an item in a user's inventory

https://partner.steam-api.com/IInventoryService/ExchangeItem/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
materialsitemid		uint64	Yes
materialsquantity		uint32	Yes
outputitemdefid		uint64	Yes

PUBLISHERGETGetAddItemHistory

Gets a list of items that have been added to accounts

https://partner.steam-api.com/IInventoryService/GetAddItemHistory/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
max_results		uint32	No
start_highwater		uint64	Yes
start_timestamp		uint32	Yes

PUBLISHERGETGetInventory

Retrieves a users inventory as a big JSON blob

https://partner.steam-api.com/IInventoryService/GetInventory/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes

UNDOCUMENTEDGetItemDefMeta

Get metadata about the current item definition for this game.

https://api.steampowered.com/IInventoryService/GetItemDefMeta/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No

PUBLISHERGETGetItemDefs

Get item definitions

https://partner.steam-api.com/IInventoryService/GetItemDefs/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
modifiedsince		string	Yes
itemdefids		uint64	Yes
workshopids		uint64	Yes
cache_max_age_seconds		uint32	No	Allow stale data to be returned for the specified number of seconds.

GETGetPriceSheet

Get the Inventory Service price sheet

https://api.steampowered.com/IInventoryService/GetPriceSheet/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
ecurrency		int32	Yes
currency_code		string	Yes	Standard short code of the requested currency (preferred)

PUBLISHERGETGetQuantity

Get the total number of available items of the given type

https://partner.steam-api.com/IInventoryService/GetQuantity/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
itemdefid[0]		uint64[]	Yes
force		bool	No

PUBLISHERPOSTModifyItems

Modify an item in a user's inventory

https://partner.steam-api.com/IInventoryService/ModifyItems/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
updates		{message}	Yes
timestamp		uint32	Yes

POSTSplitItemStack

Split an item stack into two stacks

https://api.steampowered.com/IInventoryService/SplitItemStack/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
itemid		uint64	Yes
quantity		uint32	Yes
steamid		uint64	Yes