Sign in
Stock Lots V2

Get stock lots

Changed on

Get stock lots with filters

Retrieves stock lots with optional filtering by listing, game item, location, variant, and quality tier. Supports pagination and returns enriched lot information including variant attributes, location details, and owner information.

Requirements:

  • 20.1: GET /api/v2/stock-lots endpoint
  • 20.2: Accept listing_id filter parameter
  • 20.3: Accept game_item_id filter parameter
  • 20.4: Accept location_id filter parameter
  • 20.5: Accept listed filter parameter
  • 20.6: Accept variant_id filter parameter
  • 20.7: Accept quality_tier_min and quality_tier_max filter parameters
  • 20.8: Return array of stock lots with variant information
  • 20.9: Include location and owner details in response
  • 20.10: Support pagination with page and page_size parameters
  • 20.11: Return total count for pagination
  • 20.12: Include crafted_by information if applicable
get/stock-lots

Request

  • Base URL: /api/v2 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/stock-lots
  • Auth: loggedin (a scheme the document does not define)

Query parameters

listing_idstring

Filter by listing UUID

game_item_idstring

Filter by game item UUID

location_idstring

Filter by location UUID

listedboolean

Filter by listed status

variant_idstring

Filter by variant UUID

quality_tier_minnumber double

Minimum quality tier (1-5)

quality_tier_maxnumber double

Maximum quality tier (1-5)

spectrum_idstring
pagenumber double

Page number for pagination (default: 1)

page_sizenumber double

Number of results per page (default: 20, max: 100)

Response

Stock lots with pagination metadata

totalnumber double required

Total number of lots matching filters

pagenumber double required

Current page number

page_sizenumber double required

Number of results per page

Changes

  • 6e90239467a7Revision changes
    • ○

      added the new optional query request parameter spectrum_id

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

  • dd8a4a0b5c0dRevision changes
    • ○

      added the required property // to the response with the status