Classifieds Search Search the backpack.tf Classifieds programmatically.

Classifieds Search /api/classifieds/search/v1

Search the backpack.tf Classifieds programmatically.

This API has no cooldown.

No limits are imposed, but abuse will not be tolerated. Review the Terms of Use here. Classifieds filters passed to this API are not part of the stability promise and may change at any time.

Documentation
Input
  • key - Your backpack.tf API key.
  • item_names - If set, adds a "name" property to each item object.
  • intent - Filter listings by intent. Default: dual. Valid options: sell, buy, dual.
  • page_size - Modify the page size used to paginate. Must be >= 1 and <= 30. Use the "page" parameter to paginate. Default: 10.
  • fold - If set to 0, disables listing folding.
  • item - Item name to search for.
  • steamid - Only show listings created by the user whose Steam ID is passed.
  • additional listing filters supported by backpack.tf - Any listing filter supported by backpack.tf will work with this API. Tinker with the dialog at backpack.tf/classifieds to discover the filters you would like to use.
Output
  • message - If the status code is not 2xx, this contains the reason for failure.
  • total - Amount of listings matched by the query.
  • skip - How many listings were skipped for this "page".
  • page_size - How many listings are shown on this "page".
  • buy/sell - Listings by intent.
    • total - Amount of listings matched by the query for this intent.
    • listings - Listings returned (array). May be empty if no listings match the query.
      • listing element
        • id - The listing's internal id. Guaranteed to be unique.
        • steamid - Steam ID of the user who created this listing.
        • item - WebAPI-style item object. A "name" property will be available containing the formatted item name if item_names (input) is 1.
        • appid - Which game this listing belongs to.
        • currencies - Which currencies the user is looking for. Uses backpack.tf internal currency names (e.g. metal).
        • offers - Whether the user accepts trade offers or only adds for this listing.
        • buyout - Whether the user allows negotiation.
        • details - User entered listing comment. This is not html-escaped.
        • created - Unix timestamp, at which the listing was created.
        • bump - Unix timestamp, at which the listing was last bumped. If the listing has never been bumped, this will be equal to created.
        • intent - Either 0 (Buy) or 1 (Sell).
        • automatic - Set if the user will automatically accept a matching offer.
        • count - If the listing would be folded, refers to how many items this listing stacks.
    • fold - Whether any folded listings were present in this selection.
Example Output
Input http://backpack.tf/api/classifieds/search/v1?item_names=1&item=Scattergun&quality=11&key=xxxxxxxxxxxxxxxxxxxxxx
item_names=1&item=Scattergun&quality=11&key=xxxxxxxxxxxxxxxxxxxxxx
Output
{
    "total": 1,
    "skip": 0,
    "page_size": 10,
    "buy": {
        "total": 0,
        "listings": [],
        "fold": false
    },
    "sell": {
        "total": 1,
        "listings": [
            {
                "id": "440_5552834084",
                "steamid": "76561198070299574",
                "item": {
                    "id": 5552834084,
                    "original_id": 4825777653,
                    "defindex": 200,
                    "level": 1,
                    "quality": 11,
                    "inventory": 3221225492,
                    "quantity": 1,
                    "origin": 8,
                    "style": 0,
                    "attributes": [
                        {
                            "defindex": 214,
                            "value": 0,
                            "float_value": 0
                        },
                        {
                            "defindex": 724,
                            "value": 1058776547,
                            "float_value": 0.60799998044968
                        },
                        {
                            "defindex": 796,
                            "value": "10 0 -11"
                        }
                    ],
                    "name": "Strange Scattergun"
                },
                "appid": 440,
                "currencies": {
                    "metal": 7
                },
                "offers": 0,
                "buyout": 1,
                "details": "",
                "created": 1488391040,
                "bump": 1489332614,
                "intent": 1,
                "count": 3
            }
        ],
        "fold": true
    }
}