This guide will help you migrate from SneakersAPI v2 to v3. As the v2 support only StockX, we will focus on the changes to the StockX endpoints.

Searching for products

Endpoints

  • Old endpoint: /api/v2/products/
  • New endpoint: /api/v3/stockx/products/

Parameters

Modified parameters:

  • search is now query
  • url_key is now slugs
  • under_price is now max_price
  • sort accepts rank and release_date (instead of date)

Removed parameters:

  • trending
  • category

Object: Product

OldNewNote
idid
slugslugThis is now the same StockX URL key.
titletitle
brandbrand
descriptiondescription
colortraits.*.valueMust be matched with a trait of Colorway
skusku
imageimage
avg_priceavg_price
min_pricemin_price
max_pricemax_price
currency-Removed, all prices are in USD
release_datetraits.*.valueMust be matched with a trait of Release Date
retail_pricetraits.*.valueMust be matched with a trait of Retail Price
weekly_rankrank
weekly_ordersweekly_orders
linklink
variantsvariantsStructure changed, see Variants section below

Object: Variant

OldNewNote
sizesize
pricelowest_askRenamed to better reflect the price meaning
-size_typeNew field, typically “us m” for US Men’s
-total_asksNew field showing number of asks available
-idNew unique identifier for the variant
-product_idNew field referencing parent product
-updated_atNew timestamp of last price update

Getting product details

Endpoints

  • Old endpoint: /api/v2/products/{id}
  • New endpoint: /api/v3/stockx/products/{id}

Path parameters

  • id is the same as the id parameter in the search endpoint.

Query parameters

There are no query parameters in the v2 endpoint, however, we added display[*] parameters allowing you to control what data you want to receive. Requesting less data will make the response faster.

  • display[traits]: Include traits in the response.
  • display[variants]: Include variants in the response.
  • display[sizes]: Include sizes conversions in the response.
  • display[identifiers]: Include identifiers (barcodes) in the response.
  • display[asks]: Include asks in the response.
  • display[goat]: Include GOAT product in the response (if found).
  • display[stadium_goods]: Include Stadium Goods product in the response (if found).
  • display[kickscrew]: Include Kickscrew product in the response (if found).

Response

The response is using the same object as the search endpoint above.