Auction Endpoint

Auction Endpoint#

Shared#

class AuctionEndpoint(*, http, item_id, json=False, region=None)[source]#

Bases: APIClient

Auction endpoint for specified item.

async lots(limit=None, offset=None, sort=None, order=None, additional=None, region=None)[source]#

Retrieve active auction lots for item.

Parameters:

  • limit (optional) – Amount of lots to return (0-100). Defaults to 20.

  • offset (optional) – Amount of lots to skip. Defaults to 0.

  • sort (optional) – Sorting field. Defaults to time_created.

  • order (optional) – Sorting direction. Defaults to descending.

  • additional (optional) – Include additional json data. Defaults to False.

  • region (optional) – Default game server region. Defaults to ru.

Return type:

Listing[AuctionLot]

Returns:

Paginated auction lots listing.

async price_history(limit=None, offset=None, additional=None, region=None)[source]#

Retrieve item price history.

Parameters:

  • limit (optional) – Amount of prices to return (0-100). Defaults to 20.

  • offset (optional) – Amount of prices to skip. Defaults to 0.

  • additional (optional) – Include additional json data. Defaults to False.

  • region (optional) – Default game server region. Defaults to ru.

Return type:

Listing[AuctionPrice]

Returns:

Paginated price history listing.

Contents