{ "openapi": "3.0.1", "info": { "title": "Five Below Stock Checker & API: In-Store Inventory & Pokemon", "description": "Five Below stock checker and inventory API: exact units of any product at every Five Below store near a ZIP code or city, plus the online warehouse stock, with store address, hours and distance. Search by keyword, product link or SKU. Scheduled runs = restock alerts.", "version": "0.1", "x-build-id": "j0NijTe7yEROapZjQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~five-below-stock-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-five-below-stock-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/s_actors~five-below-stock-checker/runs": { "post": { "operationId": "runs-sync-s_actors-five-below-stock-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/s_actors~five-below-stock-checker/run-sync": { "post": { "operationId": "run-sync-s_actors-five-below-stock-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "📋 What to do", "enum": [ "search", "products" ], "type": "string", "description": "Search: keywords, every product found with its units at the stores near your locations. Check products: exact products by link or SKU (best for a back-in-stock watchlist).", "default": "search" }, "keywords": { "title": "🔎 Keywords", "type": "array", "description": "Search mode: what to search on Five Below, one per line (e.g. \"pokemon\", \"squishmallows\", \"pokemon cards\", \"stanley cup\"). Every style of a product (e.g. each Squishmallow character) is its own SKU and row.", "items": { "type": "string" } }, "products": { "title": "🏷️ Product links or SKUs", "type": "array", "description": "Check products mode: fivebelow.com product links or 7-digit SKUs (the item number on the product page), one per line. A link with ?variant= checks that one style, a link without it every style.", "items": { "type": "string" } }, "locations": { "title": "📍 ZIP codes or cities", "type": "array", "description": "Where to check, one per line: a US ZIP code (10001), a city with its state (\"Chicago, IL\") or \"latitude, longitude\". The nearest stores within \"Radius\" are checked (up to \"Stores per location\").", "items": { "type": "string" } }, "storeNumbers": { "title": "🏬 Store numbers", "type": "array", "description": "Exact Five Below stores to check, one per line: the store number (e.g. 8117 = Times Square NYC; it is in the \"storeNumber\" column of any run).", "items": { "type": "string" } }, "radiusMiles": { "title": "📏 Radius (miles)", "minimum": 1, "maximum": 200, "type": "integer", "description": "How far from each location to look for stores.", "default": 25 }, "maxStoresPerLocation": { "title": "🔢 Stores per location", "minimum": 1, "maximum": 50, "type": "integer", "description": "For each ZIP code or city: how many of the nearest stores to check (up to 50).", "default": 10 }, "maxProductsPerSearch": { "title": "🔢 Max products per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Search mode: how many products to take from each keyword, in Five Below's order (a product with several styles gives one SKU per style).", "default": 30 }, "onlyInStock": { "title": "✅ Only in stock", "type": "boolean", "description": "Return only rows where the store has the product now.", "default": false }, "minUnits": { "title": "📦 Minimum units", "minimum": 0, "type": "integer", "description": "Return only stores with at least this many units (e.g. 3 to skip \"last one on the shelf\"). Empty = any." }, "maxPrice": { "title": "💲 Maximum price", "minimum": 0, "type": "integer", "description": "Return only products at or below this price in USD. Empty = any price." }, "onlyChanges": { "title": "🔔 Only report changes", "type": "boolean", "description": "For scheduled runs. The first run saves units and prices; later runs return only what changed: back in stock at a store, restocked (units went up: a delivery), sold out, price changes, and new products or stores in your searches (e.g. a new Pokemon release). Each row also carries the restocks this monitor has seen and the usual restock weekday. You pay only for the changes returned.", "default": false }, "monitorName": { "title": "🏷️ Monitor name", "type": "string", "description": "Separate monitors keep separate memory. Use a different name for each scheduled task.", "default": "default" }, "maxConcurrency": { "title": "⚡ Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many stock requests run at the same time.", "default": 4 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }