@vlourme/stockx-api
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

StockX API

An unofficial StockX API wrapper for Node.js and Browser. Based on this free StockX API.

Product IDs and variant IDs are same UUIDs used by StockX.

Installation

npm install @vlourme/stockx-api

Usage

import { StockXAPI, StockXLocation } from "@vlourme/stockx-api";

const api = new StockXAPI(StockXLocation.US);

Getting a product by its ID

const product = await api.getProduct("e46adad2-21e2-48b5-86ca-9f9ebdc01322");
console.log(product);

Searching for products

const products = await api.searchProducts("Jordan 1");
console.log(products);

Getting the market data for a product

const marketData = await api.getMarketData(
  "e46adad2-21e2-48b5-86ca-9f9ebdc01322" // productId
);
console.log(marketData);

Getting the market data for a variant of a product

const variantMarketData = await api.getVariantMarketData(
  "aa7e8a4d-720f-4fe9-a0a9-f2b47b04bea7", // productId
  "8e2265bc-a210-494c-ba35-9e5d71e47b51" // variantId
);
console.log(variantMarketData);

Counting products

const count = await api.countProducts();
console.log(count);

Checking if the API is healthy

const isHealthy = await api.isHealthy();
console.log(isHealthy);

Package Sidebar

Install

npm i @vlourme/stockx-api

Weekly Downloads

218

Version

1.0.2

License

MIT

Unpacked Size

15.9 kB

Total Files

12

Last publish

Collaborators

  • vlourme