Skip to main content
POST
/
stock
cURL
curl --request POST \
  --url https://api.starmonitors.com/stock \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "storeName": "walmart",
  "upc": "622356633604",
  "zipcode": "10036"
}
'
{
  "success": true,
  "message": "Found 27 store(s) with stock",
  "stores": [
    {
      "zip": "07852",
      "address": "461 Rt 10 Suite A100",
      "city": "Ledgewood",
      "price": 169,
      "storeUrl": "https://www.walmart.com/store/3912",
      "backRoom": 0,
      "salesFloor": 2,
      "id": "3912",
      "state": "NJ",
      "aisles": "H40-5"
    },
    {
      "zip": "11735",
      "address": "965 Broadhollow Rd",
      "city": "Farmingdale",
      "price": 169,
      "storeUrl": "https://www.walmart.com/store/5295",
      "backRoom": 1,
      "salesFloor": 5,
      "id": "5295",
      "state": "NY",
      "aisles": "H29-9"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Stock check request parameters

storeName
string
required

Name of the store (e.g., 'walmart')

Example:

"walmart"

upc
string
required

UPC of the product

Example:

"622356633604"

zipcode
string
required

Zipcode to search near

Example:

"10036"

Response

Stock status response

success
boolean

Whether the request was successful

message
string

Status message

stores
object[]