Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.3 KB

GetInventory.md

File metadata and controls

34 lines (25 loc) · 1.3 KB

Get Your Inventory

HTTP Request

GET https://api-trade.wax.io/IUser/GetInventory/v1/

Authentication

API key required.

OAuth Scopes

items, trades

Input

Parameter Type Required Description
app_id int + Internal App ID (see ITrade/GetApps)
page int Page number in response (starting with 1, defaults to 1)
per_page int Number of items per_page in response (no more than 500)
search string Additional search by item's name
sort int Standard Item Sorts
filter_in_trade boolean Removes items that are part of an active trade from the response.

Output

Parameter Type Description
total int Total number of items (filtered, if search parameter is passed)
items array-object Items list, based on pagination and search filters. Standard Item Object
sort_parameters array-object Available sort parameters
items_in_active_offers object-array List of Item IDs and matching Offer IDs that are involved in active trade offers. Keys are Item IDs and values are an array of Offer IDs.
--value int Value expected in this method
--display_name string Display name