API

Every retailed.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Goat

prices

goat.prices Get GOAT product prices Risk: read

await corsair.retailed.api.goat.prices({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`country`	`string`	No	—

Output: object[]

Output full type

{
  sizeOption: {
    value: number,
    presentation: string
  },
  stockStatus: string,
  boxCondition: string,
  shoeCondition: string,
  lowestPriceCents: {
    currency: string
  },
  lastSoldPriceCents: {
    amount?: number,
    currency: string,
    amountUsdCents?: number
  },
  instantShipLowestPriceCents: {
    currency: string
  }
}[]

Products

search

products.search Search products Risk: read

await corsair.retailed.api.products.search({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`sku`	`string`	No	—
`page`	`number`	No	—
`sort`	`string`	No	—

Output

Name	Type	Required	Description
`docs`	`object[]`	Yes	—
`totalDocs`	`number`	Yes	—
`limit`	`number`	Yes	—
`totalPages`	`number`	Yes	—
`page`	`number`	Yes	—
`hasPrevPage`	`boolean`	Yes	—
`hasNextPage`	`boolean`	Yes	—
`prevPage`	`number`	No	—
`nextPage`	`number`	No	—

docs full type

{
  id: string,
  productId: string,
  name: string,
  url?: string,
  domain?: string,
  price?: number | null
}[]

Stockx

product

stockx.product Get StockX product details Risk: read

await corsair.retailed.api.stockx.product({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`country`	`string`	No	—
`language`	`string`	No	—
`currency`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`productId`	`string`	Yes	—
`name`	`string`	Yes	—
`url`	`string`	No	—
`domain`	`string`	No	—
`price`	`number`	No	—

search

stockx.search Search StockX products Risk: read

await corsair.retailed.api.stockx.search({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  productId: string,
  name: string,
  url?: string,
  domain?: string,
  price?: number | null
}[]

trends

stockx.trends Get StockX trends Risk: read

await corsair.retailed.api.stockx.trends({});

Input

Name	Type	Required	Description
`query`	`string`	No	—
`sort_by`	`featured \| most_active \| release_date`	No	—
`country`	`string`	No	—

Output: object[]

Output full type

{
  id: string,
  productId: string,
  name: string,
  url?: string,
  domain?: string,
  price?: number | null
}[]

Usage

get

usage.get Get API usage information Risk: read

await corsair.retailed.api.usage.get({});

Input: empty object Output

Name	Type	Required	Description
`plan`	`string`	Yes	—
`remaining`	`string`	Yes	—

Overview

Plugins

Goat

prices

Products

search

Stockx

product

search

trends

Usage

get

​Goat

​prices

​Products

​search

​Stockx

​product

​search

​trends

​Usage

​get

Goat

prices

Products

search

Stockx

product

search

trends

Usage

get