Scavio MCP Server

Scavio is a unified Web Search API and MCP server that gives AI agents web search, page extraction, and structured data from e-commerce, social, travel, jobs, real-estate, app-store, ad-library and company-filing sources. 585 tools across 83 platforms plus Extract, Company Enrich, map, crawl and batch, one API key.
The 22 platforms added in 0.13.0 are opt-in. Registering all 585 tools puts ~976KB of tool definitions โ roughly 90k tokens โ into every session before you type anything. So the default is the platform set 0.12.x already had, plus Extract and Company Enrich: 143 tools, 114KB. Upgrading never removes a tool you were using. Everything else is one env var away: see Choosing which tools load.
Remote MCP Server
Connect directly to Scavio's remote MCP server without any local installation:
https://mcp.scavio.dev/mcp
Two ways to authenticate:
- Sign in with OAuth, no key to copy. Claude Desktop, claude.ai and Claude Code sign in to your Scavio account through the server. In Claude Desktop or claude.ai: Settings > Connectors > Add custom connector, name it Scavio, paste the URL, then Connect and Authorize. In Claude Code:
claude mcp add --transport http scavio https://mcp.scavio.dev/mcp, then run /mcp and choose Authenticate.
- API key. Pass it in the
x-api-key header. Get your key at scavio.dev.
Run Locally (npx)
Prefer to run the server on your own machine? Use npx with no clone or build. The server runs over stdio and only needs your SCAVIO_API_KEY.
Claude Code
claude mcp add scavio -e SCAVIO_API_KEY=YOUR_SCAVIO_API_KEY -- npx -y @scavio/mcp-server
Any MCP-Compatible Client (Claude Desktop, Cursor, Windsurf, VS Code, etc.)
{
"mcpServers": {
"scavio": {
"command": "npx",
"args": ["-y", "@scavio/mcp-server"],
"env": {
"SCAVIO_API_KEY": "YOUR_SCAVIO_API_KEY"
}
}
}
}
Requires Node.js 20+. Get your API key at scavio.dev.
Install
Claude Code
Sign in with OAuth, then run /mcp inside Claude Code and choose Authenticate:
claude mcp add --transport http scavio https://mcp.scavio.dev/mcp
Or pass an API key:
claude mcp add --transport http scavio https://mcp.scavio.dev/mcp --header "x-api-key: YOUR_SCAVIO_API_KEY"
Claude Desktop
No API key needed: Settings > Connectors > Add custom connector, name it Scavio, paste https://mcp.scavio.dev/mcp, then Connect and sign in to your Scavio account. The same steps work on claude.ai.
Or run the server locally. Add to claude_desktop_config.json (~/Library/Application Support/Claude/claude_desktop_config.json on macOS, %APPDATA%\Claude\claude_desktop_config.json on Windows):
{
"mcpServers": {
"scavio": {
"command": "npx",
"args": ["-y", "@scavio/mcp-server"],
"env": {
"SCAVIO_API_KEY": "YOUR_SCAVIO_API_KEY"
}
}
}
}
Requires Node.js 20+. Restart Claude Desktop after saving.
Cursor

Or add to .cursor/mcp.json in your project root or ~/.cursor/mcp.json for global:
{
"mcpServers": {
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
}
}
Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
}
}
VS Code
Create .vscode/mcp.json in your project root:
{
"servers": {
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
}
}
ChatGPT
- Go to ChatGPT > Settings > Apps & Connectors
- Click Add custom connector
- Enter the MCP server URL:
https://mcp.scavio.dev/mcp
- Configure authentication with your API key
Cline
Add to cline_mcp_settings.json (open via Cline sidebar > MCP Servers > Configure):
{
"mcpServers": {
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
}
}
Zed
Add to settings (Cmd+,):
{
"assistant": {
"mcp_servers": {
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
}
}
}
Any MCP-Compatible Client
{
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY"
}
}
Scavio exposes 585 tools. Loading all of them costs ~976KB of tools/list โ
roughly 90k tokens of context in every session before the user has said anything,
and more tools than some clients will accept at all. So the server registers a
curated subset by default and lets you pick the rest. The sizes below are
measured, not estimated: npm run toolslist reproduces them.
SCAVIO_PLATFORMS is a comma-separated allowlist of platform keys:
| Value | Registers |
|---|
(unset) or default | Every platform 0.12.x had, plus extract and company โ 143 tools, 114KB |
all | every platform โ 585 tools, ~976KB |
extract,sec,g2 | just those platforms โ 18 tools, 21KB |
default,zillow,metaads | the default set plus two more โ 149 tools, 122KB |
default,chatgpt,gemini | the default set plus ChatGPT and Gemini โ 145 tools, 117KB |
none | no platform tools, only get_usage |
Keys are matched case- and punctuation-insensitively, so meta-ads, metaads
and META_ADS are the same thing, and twitter resolves to x. An unknown key
is logged to stderr and skipped rather than failing the server.
get_usage always registers โ it is free, and it is what every install guide
tells you to call to check the server works.
Platform keys: extract, company, google, chatgpt, gemini, youtube, tiktok, instagram,
reddit, x, linkedin, threads, kuaishou, amazon, walmart, ebay,
target, homedepot, costco, heb, kroger, publix, ikea, wayfair, ashley, maisonsdumonde, decathlon, specs, lowes, samsclub, canadiantire, dollargeneral, sephora, ulta, aldi, microcenter, walgreens, cvs, wholefoods, harborfreight, petsmart, petco, iherb, chewy, menards, nordstrom, nordstromrack, bestbuy, tcgplayer, nintendo, hm, zara, asos, vinted, macys, saks, kohls, jcpenney, dicks, footlocker, fanatics, carrefour, allegro, olx, trendyol, mercadolibre, tiktok-shop, booking, airbnb,
tripadvisor, yelp, zillow, redfin, realtor, rightmove, indeed, glassdoor,
appstore, googleplay, g2, capterra, trustpilot, googleads, metaads, sec, companieshouse
Local (stdio)
{
"mcpServers": {
"scavio": {
"command": "npx",
"args": ["-y", "@scavio/mcp-server"],
"env": {
"SCAVIO_API_KEY": "YOUR_SCAVIO_API_KEY",
"SCAVIO_PLATFORMS": "extract,google,zillow,redfin"
}
}
}
}
Remote (HTTP)
The hosted server has no env var to read, so pass the allowlist per connection โ
either as a header or as a query parameter:
{
"scavio": {
"type": "http",
"url": "https://mcp.scavio.dev/mcp",
"headers": {
"x-api-key": "YOUR_SCAVIO_API_KEY",
"x-scavio-platforms": "extract,google,sec,companieshouse"
}
}
}
https://mcp.scavio.dev/mcp?platforms=all
Upgrading from 0.12.x
Nothing to do. The default set is exactly the 10 platforms 0.12.x registered,
plus Extract โ every tool you were using still loads. Those platforms keep gaining
tools (Walmart grew from 2 to 7; TikTok, YouTube, Reddit and X gained 19 in 0.20.0;
Extract gained map, crawl and batch in 0.21.0; Instagram gained 8 in 0.22.0; Google gained google_custom_search in 0.23.0; company_enrich joined the default in 0.50.0), which is why the default count is now 143.
The 22 platforms added in 0.13.0 are opt-in. Add them additively:
SCAVIO_PLATFORMS=default,zillow,redfin,sec
One breaking fix worth knowing: search_walmart previously sent
fulfillment_speed: "anytime" on every call, which the API rejects. The
parameter is now today or tomorrow with no default.
Every tool costs 1 credit per call unless its section says otherwise. Several
platforms price per endpoint (YouTube, Instagram, LinkedIn, Kuaishou) or per
request body (Extract, Threads, Walmart); get_amazon_options and get_usage
are free.
| Tool | Description |
|---|
extract_url | Read any web page and return it as clean Markdown, plain text, or raw HTML |
map_website | List a site's page URLs from its sitemaps and start page, path-filtered, with lastmod when known |
crawl_website | Crawl a site from one URL and extract every same-site page; waits up to wait_seconds and returns results, or the job id |
get_crawl_status | A crawl's status, page counts, credits used and page results, paged by cursor; can wait for completion |
cancel_crawl | Stop a running crawl; nothing more is billed, results so far stay readable |
batch_extract | Extract a list of URLs in one job, results in input order; waits up to wait_seconds |
get_batch_status | A batch's status and results, paged by cursor; can wait for completion |
cancel_batch | Stop a running batch |
Extract is tier-priced by the mode parameter, not flat: normal (the default)
and advanced (renders JavaScript) cost 1 credit, ultra (for the hardest pages)
costs 2. Start at normal and escalate only when the
content comes back empty or blocked. You are billed only on a successful
extraction โ a dead link, a bot wall or a timeout costs nothing. There is no
pagination: the whole page comes back in one call.
Map, crawl and batch (new in 0.21.0) are the multi-page operations:
- Pricing.
map_website costs 1 credit. Crawl and batch bill per
successful page at Extract's price for the tier (normal 1, advanced 1,
ultra 2); failed and skipped pages are free, and status and cancel calls are
free. Credits are taken page by page, and a job stops cleanly with
stopped_reason: "insufficient_credits" if the balance runs out.
- Plan limits (max pages per crawl / active jobs / URLs per batch): Free
10 / 1 / 10, PAYG 100 / 1 / 50, Project 500 / 2 / 100, Bootstrap 2,000 / 3 / 500,
Startup 5,000 / 5 / 1,000, Growth 10,000 / 10 / 1,000. Starting a job past the
active-job limit returns a 429 that names the running jobs.
- Behaviour. Robots.txt is always obeyed for map and crawl. A crawl stays on
the start URL's site (subdomains optional) and visits pages under the start
path first. Results are kept for 3 days; a job runs for at most 6 hours.
- Built for tool-call time limits. MCP clients usually cancel a tool call
after about 60 seconds, so a crawl is a job, not one long call.
crawl_website / batch_extract start the job and wait up to wait_seconds
(default 30, max 50): a small job comes back finished with its first page of
results; a large one returns the job id (and webhook_secret, shown only
once, if you set webhook_url). get_crawl_status / get_batch_status take
the same wait_seconds to long-poll, and cursor to page.
- Output stays small. Status calls return 10 results per call by default
(
limit up to 100) and clip each page's content to max_content_chars
(default 4,000); clipped pages carry content_clipped: true next to the full
content_length. map_website asks for 200 links when you set no limit
(the API default is 1,000). Every response that has more to read carries a
_hint naming the exact next call. Repeat a start call with the same
idempotency_key and you get the original job back instead of a second one.
| Tool | Description |
|---|
company_enrich | A company's published emails, phone numbers, social profiles and contact page, plus the owner or founder's name and title with the page that names them, from its website or a Google Maps place_id |
Platform key company, in the default set. The step after google_maps_search:
pass each local result's place_id and get the business's contact details, a
lead list from a Maps search in two calls. Provide url (the company's own
site; a social profile is a 400) or place_id (the listing is looked up first,
then its website is read).
Returns data.company (name, website, domain, emails[], phones[],
socials keyed by network, contact_page, address, place_id),
data.owner (name, title, source_url, email, email_status) or null
when no page names one. An owner is only returned when
the cited page names them; email_status is published when an address on the
site matches the owner's name, otherwise not_found.
10 credits from a url, 20 from a place_id (1 when the listing has no
readable website); a site that cannot be reached is free. Each call reads
several pages live, so it takes 10-45 seconds; a place_id call can pass 60
seconds, so raise the client's tool-call timeout if it cancels at 60.
| Tool | Description |
|---|
search_google | Web search (v2) with organic results, ads, and AI Overview; web_only + location for organic rankings as seen from a city (local rank tracking) |
google_custom_search | Google results in the Custom Search JSON API format (items[], searchInformation, queries.nextPage) for code ported from CSE |
google_ai_mode | AI Mode conversational answer with cited sources |
google_maps_search | Search Google Maps for local businesses |
google_maps_place | Place details: address, phone, hours, rating |
google_maps_reviews | Reviews for a place with pagination |
google_shopping | Product listings with price, store, and rating |
google_shopping_product | Product detail and sellers |
google_shopping_stores | More sellers for a product (pagination) |
google_flights | Flight itineraries with prices and stops |
google_hotels | Hotel search with prices and ratings |
google_hotels_detail | Hotel property details |
google_news | News results by query, topic, story, or publication |
google_trends | Interest-over-time and related queries |
google_trending | Trending searches |
| Tool | Description |
|---|
chatgpt_prompt | Ask ChatGPT a prompt: the full Markdown answer, every cited page (title, publisher, date), the web searches it ran and the products it recommended |
gemini_prompt | Ask Google Gemini a prompt: the full Markdown answer, the URLs it cites and the products it recommended |
For AI visibility and brand monitoring: ask what a buyer would ask ("best CRM for small
agencies") and see whether a brand is recommended, which competitors are, and which pages
the answer cites. Both tools return the same shape (answer.markdown, sources[],
search_queries[], shopping[]), so comparing assistants needs one parser. Every call is a
fresh answer and takes 10-40 seconds. ChatGPT costs 2 credits and Gemini 5 credits per answered
prompt; failed prompts are free.
Opt-in: add chatgpt and gemini to SCAVIO_PLATFORMS (e.g. default,chatgpt,gemini).
Docs: ChatGPT,
Gemini.
| Tool | Description |
|---|
search_youtube | Search videos, channels, and playlists |
search_youtube_shorts | Search short-form videos |
youtube_search_suggestions | Get search autocomplete suggestions |
get_youtube_video | Get full video details, chapters, and captions |
get_youtube_metadata | Deprecated alias of get_youtube_video |
get_youtube_comments | Get comments on a video with pagination |
get_youtube_comment_replies | Get replies to a specific comment |
get_youtube_transcript | Get a video transcript as plain text or SRT |
get_youtube_related | Get videos related to a video |
search_youtube_channels | Search channels by keyword |
get_youtube_channel | Get channel profile by ID, handle, or URL |
get_youtube_channel_videos | List a channel's videos |
get_youtube_channel_shorts | List a channel's Shorts |
get_youtube_channel_community | List a channel's community posts |
resolve_youtube_channel | Resolve a handle or URL to a channel ID |
get_youtube_streams | Get direct media stream URLs for a video |
get_youtube_community_post | Get one community post: text, author, likes, images, comments cursor |
get_youtube_community_post_comments | Get comments on a community post with pagination |
Credit cost varies: get_youtube_transcript costs 5, get_youtube_streams 3,
search_youtube and search_youtube_shorts 2, and every other YouTube tool 1.
get_youtube_related accepts a cursor but never returns one, so treat it as a
single page.
| Tool | Description |
|---|
search_amazon | Search product listings across 22 marketplaces (no sort option) |
get_amazon_product | Get full product details by ASIN |
get_amazon_offers | List every seller offering an ASIN, with buy-box winner |
get_amazon_options | List the supported marketplaces and their country codes (free) |
| Tool | Description |
|---|
search_walmart | Search product listings with price and delivery filters |
get_walmart_product | Get full product details by product ID |
get_walmart_reviews | Customer reviews with ratings, text, author, date and the rating breakdown |
get_walmart_category | Products within a category, same product shape as search |
get_walmart_offers | The buy-box offer for a product: price, seller, condition, buy-box flag |
get_walmart_seller | Marketplace seller storefront: name, rating, Pro Seller badge, business details |
get_walmart_seller_products | A seller's catalogue; total_count is the real size |
get_walmart_stores | Stores near a US ZIP or Canadian postal code, nearest first, with store_id, address, distance and hours |
Walmart is priced by the request body, not at a flat rate: com (US, default)
and ca cost 1 credit, com.mx costs 2. Only search_walmart and
get_walmart_category accept every domain.
Store targeting: pass delivery_zip and store_id together on search_walmart
or get_walmart_product to get one store's assortment and availability. Take the
store_id from get_walmart_stores on the same domain (walmart.com or
walmart.ca). A store-targeted call costs 2 credits, takes 10-60 seconds, and
echoes the store it used in data.location. get_walmart_product accepts
domain: "ca" only together with a store pair.
Two shapes to plan for. get_walmart_offers returns the buy-box winner only โ
Walmart server-renders just that one offer, so expect a single row even when
total_offer_count is higher. And get_walmart_seller_products is capped at
roughly the first 40 items with no page or cursor parameter; read total_count
to know you are looking at a slice. Both seller tools need the NUMERIC
seller_catalog_id from a product, search or offers response โ the GUID-form
seller_id in those same responses 404s.
| Tool | Description |
|---|
get_tiktok_profile | Get user profile (bio, follower/following counts, likes) |
get_tiktok_user_posts | List a user's videos with stats |
get_tiktok_video | Get detailed info for a single video |
get_tiktok_video_comments | Get comments on a video |
get_tiktok_comment_replies | Get replies to a specific comment |
search_tiktok_videos | Search videos by keyword |
search_tiktok_users | Search users by keyword |
get_tiktok_hashtag | Get hashtag details and stats |
get_tiktok_hashtag_videos | List videos for a hashtag |
get_tiktok_user_followers | Get a user's follower list |
get_tiktok_user_followings | Get a user's following list |
get_tiktok_trending_searches | Search terms trending now (about 90, no region filter) |
get_tiktok_trending_videos | A sample of trending videos (about 6 per call) |
get_tiktok_search_suggestions | Search autocomplete suggestions for a keyword |
get_tiktok_music | Get a sound: artist, album, duration, videos using it, chart rank |
get_tiktok_music_videos | List videos that use a sound (about 14 per page) |
search_tiktok_music | Search sounds by keyword |
get_tiktok_music_chart | Top 50 or Viral 50 sound chart (global) |
get_tiktok_user_similar | Creators similar to a user (about 30 per page) |
get_tiktok_user_playlists | List a user's playlists (series) |
get_tiktok_playlist_videos | List the videos in a playlist |
get_tiktok_user_live | Is a user live now: room status, title, viewers |
get_tiktok_user_region | The region an account is registered in, plus sec_user_id |
Every TikTok tool costs 1 credit. The trending, sound, playlist, similar-creator, live
and region tools return TikTok's own payload shape, trimmed for context: large numeric
ids can lose precision as JSON numbers, so use the string forms (id_str, sec_uid,
sec_user_id). get_tiktok_trending_videos returns about 6 videos per call whatever
count says, and get_tiktok_music_videos ignores count (about 14 per page). Search
suggestions can be empty for long-tail keywords and still bill. An unknown username is
a billed 404 on get_tiktok_user_live and an unbilled 404 on get_tiktok_user_region.
| Tool | Description |
|---|
get_instagram_profile | Get user profile (bio, follower/following/post counts) |
get_instagram_user_posts | List a user's posts with pagination |
get_instagram_user_reels | List a user's Reels with pagination |
get_instagram_user_tagged | List posts a user is tagged in |
get_instagram_user_stories | Get a user's active stories |
get_instagram_post | Get a single post by url, media_id, or shortcode |
get_instagram_post_comments | Get comments on a post |
get_instagram_comment_replies | Get replies to a specific comment |
search_instagram_users | Search users by keyword |
search_instagram_hashtags | Search hashtags by keyword |
get_instagram_user_followers | Get a user's follower list |
get_instagram_user_followings | Get a user's following list |
get_instagram_user_highlights | List a user's story highlights (id, title, cover, item count) |
get_instagram_highlight_stories | Get every story in one highlight, with media URLs |
search_instagram_reels | Search Reels by keyword with pagination |
search_instagram_music | Search audio tracks by song or artist |
get_instagram_music_posts | List the Reels that use an audio track, plus its total reel count |
search_instagram_locations | Search places by name (id, address, coordinates) |
get_instagram_user_similar | Get accounts similar to a creator |
get_instagram_post_likers | Get accounts that liked a post, plus its total like count |
Instagram is priced per endpoint: get_instagram_profile, get_instagram_user_reels,
get_instagram_user_tagged and get_instagram_music_posts cost 1 credit (reels and
tagged cost 2 the first time a username is looked up), and the other tools cost 2.
search_instagram_users and search_instagram_hashtags cost 8 when you pass a
cursor for the next page. Any request can cost up to 10 when it needs extra work;
credits_used in the response is always the exact charge.
| Tool | Description |
|---|
search_reddit | Search Reddit posts by query, relevance order, cursor pagination |
get_reddit_post | Get a single post by URL or id (no comments; see below) |
get_reddit_search_suggestions | Get search autocomplete suggestions |
get_reddit_post_comments | Get a post's top-level comments with pagination |
get_reddit_comment_replies | Get replies to a specific comment |
get_reddit_subreddit | Get subreddit metadata and subscriber count |
get_reddit_subreddit_posts | List a subreddit's post feed |
get_reddit_user | Get a redditor's profile |
get_reddit_user_posts | List a redditor's submitted posts |
get_reddit_user_comments | List a redditor's comments |
get_reddit_popular | Get the site-wide popular feed |
get_reddit_trending | Get current trending search queries |
search_reddit_comments | Search comments by keyword, with the post and subreddit each was left on |
search_reddit_subreddits | Find subreddits by keyword, with subscriber counts |
Every Reddit tool costs 1 credit. Two things to know: search_reddit takes a query
and a cursor only - there is no sort or post-type filter, results come back in
relevance order (search_reddit_comments does sort: relevance, hot, top or new) - and get_reddit_post returns a flat post object with no comments,
so call get_reddit_post_comments with the post id for those. Reddit is the slowest
platform here, typically 5-15 seconds per call.
| Tool | Description |
|---|
search_x | Search tweets and people by keyword |
get_tweet | Get full details for a single tweet |
get_tweet_comments | Get replies to a tweet (ranked or chronological) |
get_tweet_retweeters | List users who retweeted a tweet |
get_x_user | Get a user's profile by handle |
get_x_user_tweets | List a user's tweets |
get_x_user_replies | List a user's tweets and replies |
get_x_user_media | List a user's media tweets |
get_x_user_followers | List a user's followers |
get_x_user_followings | List accounts a user follows |
get_x_trending | Get trending topics for a country |
search_x_communities | Find X Communities by keyword, with member counts |
get_x_community | Get a Community's description, member count, topic and rules |
get_x_community_tweets | List a Community's posts by relevance or recency |
get_x_user_tweets, get_x_user_replies and get_x_user_media return a
next_cursor but no has_more, so page until the cursor is absent or the timeline
comes back empty.
| Tool | Description |
|---|
get_linkedin_person | Get a member's full profile, experience and education |
get_linkedin_person_about | Get a member's about/overview sections |
get_linkedin_person_posts | List a member's recent posts (up to 50) |
get_linkedin_company | Get a company's profile, locations and related companies |
get_linkedin_company_posts | List a company's recent posts (up to 50) |
search_linkedin_jobs | Search for jobs by keyword and location |
get_linkedin_job | Get full details for a job listing |
get_linkedin_post | Get full details for a single post |
get_linkedin_post_comments | Get comments on a post, 10 per page |
All take a vanity handle, slug or id, or a full LinkedIn URL. Credit cost varies:
get_linkedin_person, get_linkedin_person_about, get_linkedin_company and
get_linkedin_post cost 1; get_linkedin_person_posts,
get_linkedin_company_posts, search_linkedin_jobs and
get_linkedin_post_comments cost 10 per page; get_linkedin_job costs 30.
Member contact info, the company employee directory, per-company job listings,
people search and post search are no longer available, so those five tools were
removed. get_linkedin_company still returns a
small sample of featured employees, and search_linkedin_jobs with a company
name substitutes for per-company listings.
| Tool | Description |
|---|
search_tiktok_shop | Search TikTok Shop products by keyword (US catalog, exact prices) |
get_tiktok_shop_search_suggestions | Keyword autocomplete for a partial query, 8 regions |
get_tiktok_shop_product | Full product detail (no price; ~44% of search IDs resolve) |
get_tiktok_shop_product_reviews | Paginated product reviews, up to 200 per call |
get_tiktok_shop_categories | The global category tree (28 top-level, 240 nodes) |
get_tiktok_shop_category_products | List products under a category ID, with exact prices |
get_tiktok_shop_shop_products | List a seller's catalog, 30 per page, with exact prices |
resolve_tiktok_shop_url | Resolve a TikTok Shop URL or share link to a product/shop ID |
Two things to know: get_tiktok_shop_product does not return a price (TikTok masks it on the
product page) - exact prices come from search_tiktok_shop,
get_tiktok_shop_shop_products and get_tiktok_shop_category_products. And only about 44% of the
product IDs returned by search resolve on get_tiktok_shop_product (11 of 25 measured), because
TikTok Shop has no detail data for the rest. That miss is signalled by the HTTP 404 status, not by any
field in the response body, and it is a normal outcome rather than an error to retry - the tool
returns it as a plain result with status: "no_detail_data" so agents skip the product instead of
looping. For an id that will not resolve, get_tiktok_shop_product_reviews is often still usable:
across 8 measured ids that failed on detail, 8 of 8 returned HTTP 200 on reviews and 7 of 8 returned
at least one review.
| Tool | Description |
|---|
get_threads_profile | Profile details for a Threads user, by user_id or username |
get_threads_user_posts | A user's Threads posts, cursor-paginated |
get_threads_user_replies | A user's replies, cursor-paginated |
get_threads_post | A single post by id or threads.net URL |
get_threads_post_comments | Replies to a post, cursor-paginated |
search_threads_users | Profiles matching a name or handle - the only search Threads exposes |
Threads is priced by how you address a user, not per endpoint: 2 credits when you pass user_id, 4 credits when you pass username. Only get_threads_profile, get_threads_user_posts and get_threads_user_replies accept a username; the other three are always 2. Prefer user_id - a handle costs a second lookup.
| Tool | Description |
|---|
get_kuaishou_profile | Profile details for a Kuaishou user (10 credits) |
get_kuaishou_user_posts | A user's top posts, cursor-paginated |
get_kuaishou_user_live | A user's current live-stream status |
resolve_kuaishou_user | Turn a Kuaishou share link into a user id |
get_kuaishou_video | A single video by photo id or URL (2 credits) |
get_kuaishou_video_comments | Comments on a video, cursor-paginated |
get_kuaishou_comment_replies | Replies under a root comment |
get_kuaishou_videos_batch | Up to 20 videos in one call (40 credits) |
search_kuaishou | Mixed-result search across Kuaishou (10 credits) |
search_kuaishou_videos | Video search results (10 credits) |
search_kuaishou_users | User search results (10 credits) |
search_kuaishou_live | Live-stream search results (10 credits) |
get_kuaishou_tag_feed | Posts under a hashtag, cursor-paginated |
get_kuaishou_trending | Hot, live, shopping, brand and music leaderboards |
Kuaishou is priced per endpoint, not at a flat rate: get_kuaishou_profile and all four search tools cost 10, get_kuaishou_video 2, get_kuaishou_videos_batch 40, and every other tool 1.
| Tool | Description |
|---|
search_ebay | Search live or SOLD listings: price, condition, bids, shipping, seller feedback |
get_ebay_product | One listing in full: price, condition, images, item specifics, shipping, returns, auction state |
get_ebay_seller | Seller profile card: store name, feedback score, items sold, followers, location |
1 credit per call. get_ebay_seller is a profile card and cannot enumerate a catalogue - list a seller's inventory with search_ebay and seller set and no keyword. sold: true searches completed listings that actually sold; on that view eBay publishes no headline count, so total_results is null. per_page accepts only 60, 120 or 240.
| Tool | Description |
|---|
search_target_products | Search Target.com: prices, ratings, badges and promotions |
get_target_category | Products in a category, same shape as search plus the breadcrumb |
get_target_product | Product details by TCIN: price, images, specifications, variants, fulfillment |
get_target_reviews | Reviews with the rating breakdown, per-attribute averages and guest photos |
get_target_availability | In-store stock at every Target near a ZIP: units, in-store, pickup, curbside and ship-to-store status, distance, address, hours |
1 credit per call. get_target_product, get_target_reviews and get_target_availability are single-shot; search and category page with page + count. store_id on search, category, product and reviews sets the store for prices only; get_target_availability is the store-stock tool.
| Tool | Description |
|---|
search_home_depot | Search Home Depot: price, brand and model, ratings, per-store pickup/delivery |
get_home_depot_product | Full item detail: pricing, media, spec table, dimensions, documents, return policy |
get_home_depot_reviews | Full review bodies, rating distribution, per-attribute ratings, seller responses |
2 credits per call. Search page size is fixed at 12 and cannot be changed. Reviews return 30 per page; total_pages is the last page that exists and asking past it is a 404.
| Tool | Description |
|---|
search_costco | Search by keyword or item number: online and original price, rating, member-only and stock flags, promotions, facets |
get_costco_category | Products in a category, same filters and shape as search |
get_costco_categories | Department list, or the full subcategory tree under one department |
get_costco_product | Full detail for up to 20 items: description, features, specs, variants, purchase limits, delivery fee, promotion dates |
get_costco_prices | Online vs in-warehouse price at up to 10 warehouses: discount, final price, promotion dates, per-member limits, price code |
get_costco_availability | In-warehouse stock status for one item at up to 10 warehouses, plus pickup and same-day delivery |
get_costco_reviews | Reviews with rating distribution and recommend count; sort, star filter, up to 100 per page |
get_costco_warehouses | Warehouses near a US zip or coordinates: warehouse_id, address, hours, departments, services, gas prices |
get_costco_gas_prices | Regular, premium and diesel prices at Costco gas stations near a location or at given warehouses |
get_costco_coupons | The current member coupon book: item number, amount off, final price, scope, limits, valid dates |
get_costco_deals | Deal feeds: new, while supplies last, treasure hunt, member favorites, online only, on sale |
get_costco_clearance | Clearance and manager-markdown items at one warehouse, decoded from the shelf price ending |
get_costco_search_suggestions | Search suggestions for a partial query, plus matching warehouses |
1 credit per call, except the multi-warehouse tools: get_costco_prices makes one
lookup per two locations (online counts as one) and get_costco_availability one per
warehouse, billed 1 credit per 5 lookups, so 10 warehouses cost 2 credits.
get_costco_warehouses and get_costco_gas_prices cost 2 for country: "ca"; gas by
warehouse_ids is 1 credit per 5 warehouses (2 per warehouse on ca).
search_costco, get_costco_category and get_costco_deals take warehouse_id to add
that warehouse's in-store price, stock and price code to every result. Get the id from
get_costco_warehouses. country is us (default) or ca everywhere except
get_costco_coupons (US only); search_costco, get_costco_product and
get_costco_warehouses also accept uk, au, mx, jp, kr and tw for keyword,
sort and paging only. Price codes in get_costco_clearance are the member-community
decode (.97 clearance, .00/.88 manager markdown; .49/.79/.89 special buy on request),
not something Costco publishes, and only items Costco lists online are covered.
get_costco_coupons returns the first 50 offers of a ~200-offer book by default; pass
limit for more.
HEB
| Tool | Description |
|---|
search_heb | Search HEB grocery products: price (cents), sale status, unit price, size, UPC, stock, EBT/SNAP, aisle location |
get_heb_product | Full detail: nutrition facts, ingredients, images, similar products, coupons, EBT/SNAP, breadcrumbs |
get_heb_stores | Store locator by ZIP or city: address, hours, pharmacy, fulfillment channels, distance |
2 credits per call. HEB is a Texas-based grocery chain. Pass product_url (from
search_heb) or slug + product_id for product detail. Pass store_id (the
store_number from get_heb_stores, e.g. "441") to search_heb or
get_heb_product for that store's prices, stock, aisle location and assortment;
the store used is echoed in data.store, and product_id alone is enough with a
store_id. US only.
HEB Mexico: pass country: "mx" to search_heb and get_heb_product for
heb.com.mx. Prices are Mexican peso cents (10000 = MX$100.00) for HEB Mexico's
default store, and every row adds stock (units on hand), promotions (price
cuts, multi-buys, free gifts, with end dates), is_sponsored and the EAN barcode
in upc. Search pages are 20 rows with total_pages. get_heb_stores is US only.
Spec's
| Tool | Description |
|---|
search_specs | Search Spec's (Texas liquor): online price (cents), case price, promo and Keyclub flags, stock, SKU, UPC, slug |
get_specs_product | Every store's price and stock for one product in store_prices (about 200 stores), plus the online price and details |
get_specs_stores | Stores in a Texas region: store_id, address, phone, coordinates, hours |
5 credits per call. Pass the slug from search_specs to get_specs_product;
add store_id (from get_specs_stores, e.g. "169") to put that store's price
at the top.
Lowe's
| Tool | Description |
|---|
search_lowes | Search Lowe's at one store by keyword or category: that store's price, was-price and savings, stock quantity, pickup/delivery/parcel availability, rating; on_sale for the store's deals |
get_lowes_product | One item at one store: price, on-hand stock and lead times, stock at nearby stores, aisle and bay, specifications, UPC, dimensions |
get_lowes_stores | Stores near a ZIP: store_id, address, phone, coordinates, distance, hours, features |
get_lowes_reviews | Review bodies, 10 per page: rating, title, text, recommended, helpful votes, verified flag, photos, brand replies, star counts |
2 credits per call; get_lowes_reviews is 1. Prices and stock are per store, so
store_id and that store's own zip (both from get_lowes_stores, e.g. "0595"
and "28117") are required on search and product. Deals are search_lowes with
on_sale: true; there is no clearance tool.
Sam's Club
| Tool | Description |
|---|
search_sams_club | Search Sam's Club: price, was price, savings, unit price, Instant Savings, rating, stock, fulfillment, aisle |
get_sams_club_product | One item: online and club shelf price, Instant Savings, rating histogram, specifications, per-method stock and aisle; club_id for a specific club |
get_sams_club_clubs | Clubs near a ZIP: club_id, address, coordinates, distance, phone, hours, services |
get_sams_club_savings | Every Instant Savings item: offer amount, end date, purchase limit, channels |
get_sams_club_category | Products in a category, same fields as search; clearance is category 1150109 |
get_sams_club_reviews | Review bodies, 10 per page, with average rating and 1-5 star breakdown |
get_sams_club_clubs is 1 credit per call; every other Sam's Club tool is 2.
Search, savings and category use a nearby club chosen by
location (echoed in club); for one specific club, call get_sams_club_product
with a club_id from get_sams_club_clubs. available_quantity is capped at 8 by
the site, so 8 means 8 or more.
Canadian Tire
| Tool | Description |
|---|
search_canadian_tire | Search at one store by keyword or category: price and regular price (CAD), savings, clearance/sale/rebate badges, rating, SKU, stock at the store |
get_canadian_tire_product | One product at one store: specifications, variants with SKUs, warranty, manuals, store price, stock, pickup and ship-to-home dates |
get_canadian_tire_stores | Stores near a postal code or coordinates; with sku, each store's stock quantity and aisle for it |
get_canadian_tire_availability | Up to 50 SKUs at one store in one call: price, clearance and sale flags, price valid-until date, stock, aisle |
get_canadian_tire_clearance | Every clearance item at one store, 100 per page |
get_canadian_tire_deals | Sale, instant rebate, special buy or Triangle Rewards items at one store |
1 credit per call. store_id (from get_canadian_tire_stores, e.g. "600") is
required on search, product, availability, clearance and deals. Prices differ by
store and province (Quebec prices differ). Rating and review count only, no
review text.
Dollar General
| Tool | Description |
|---|
search_dollar_general | Search at one store: price, original price, units on hand at that store, rating, coupons and promotions, UPC |
get_dollar_general_product | One product by UPC at one store: price, units on hand, nearby stores with stock, description, images, coupons |
get_dollar_general_stores | Stores near a ZIP or coordinates (up to 25); with upc, that product's unit count at every store in one call |
get_dollar_general_deals | On-sale or clearance items priced and stocked at one store |
get_dollar_general_coupons | Current digital coupons: value, brand, minimum quantity, start and expiration dates |
1 credit per call. store_id (from get_dollar_general_stores, e.g. "14838") is
required on search, product and deals. Clearance items carry the current price
only, with no was-price. Rating and review count only, no review text.
Sephora
| Tool | Description |
|---|
search_sephora | Search sephora.com (US): price, list and sale price, rating, review count, bestseller/new/exclusive flags, category facets; zip for same-day eligibility |
get_sephora_category | Products in a category, same fields as search, with subcategories, parent category and breadcrumbs |
get_sephora_product | One product: every shade or size with price, stock, ingredients and pickup/same-day eligibility, plus a review summary with pro and con sentiment counts |
search_sephora and get_sephora_category are 1 credit per call, get_sephora_product 2.
get_sephora_product takes a result's url (faster) or
product_id (e.g. "P510799"). The review summary and sentiment counts come
with no review text.
Ulta Beauty
| Tool | Description |
|---|
search_ulta | Search Ulta Beauty: list and sale price, discount, promo text, rating, review count, badge, variant count |
get_ulta_category | Products in a category (e.g. /shop/makeup/lips/lipstick), same fields as search |
get_ulta_product | One product by URL: price, GTIN, ingredients, every shade or size variant, ship/pickup/same-day eligibility, five most recent reviews |
get_ulta_stores | One shade or size at the 10 stores nearest a ZIP: in stock or out of stock per store, hours, distance |
1 credit per call. get_ulta_stores takes a result's product_id and sku_id
plus a ZIP. Ulta publishes in stock / out of stock per store, not unit counts.
ALDI
| Tool | Description |
|---|
search_aldi | Search at one store: price and was-price, unit price, stock level, aisle location, ALDI-exclusive brand flag, dietary labels |
get_aldi_product | One product at one store: price, stock, description, ingredients, allergen warnings, images |
get_aldi_stores | Stores near a ZIP: store_id, address, coordinates, distance |
1 credit per call. Prices are per store and per service_type: instore (the
shelf price, default), pickup or delivery (online prices, often higher).
Pass store_id (from get_aldi_stores, e.g. "151248") or a zip to use the
nearest store. ALDI has no product ratings.
Micro Center
| Tool | Description |
|---|
search_micro_center | Search by keyword or category at one store: price, original price, stock count at that store, open-box count and lowest price, rebate text |
get_micro_center_product | One product: specs, UPC, reviews, the store's stock and open-box units, and an in-stock yes/no for every store |
get_micro_center_stores | Every store with its 3-digit store_id, city, state and address |
2 credits per call; get_micro_center_stores is 1. Stock is per 3-digit
store_id (e.g. "131", Dallas); without one, the web store 029 (shippable
items) is used. Counts are capped at 25+ (quantity_capped).
Walgreens
| Tool | Description |
|---|
search_walgreens | Search retail products (no pharmacy): regular, sale and unit price, promotions, coupons, rating, availability, clearance flag |
get_walgreens_product | One product: SKU, UPC, price, savings, offers, ingredients, warnings, rating, category path, images |
get_walgreens_stores | Walgreens and Duane Reade stores near a ZIP or coordinates: store number, address, phone, hours |
get_walgreens_stock | One product's live stock at up to 20 stores in one call: status, unit count, in_stock |
2 credits per call; get_walgreens_stock is 4. Prices are national, the same
at every store. Store numbers (from get_walgreens_stores, e.g. "9438") go to
get_walgreens_stock as store_ids.
CVS
| Tool | Description |
|---|
search_cvs | Search front-store products (no pharmacy): regular, sale and unit price, promotions, coupons, rating, and units in store and for pickup at one store |
get_cvs_product | One product by URL or id: price, promotion end date, UPC, ingredients, directions, warnings, every variant |
get_cvs_stock | Units at one store for up to 20 SKUs: in store, pickup, online |
1 credit per call. There is no store locator: the store number is on every
cvs.com store page (e.g. "7019"). Search stock defaults to store 7019 (New
York). Prices are the same at every store. get_cvs_product can take 10-30+
seconds.
Whole Foods Market
| Tool | Description |
|---|
search_whole_foods | Search at one store: regular, sale and Prime member price, sale dates, on-sale and local flags, category and diet facets |
get_whole_foods_category | One category at one store, same fields as search, with 6 sorts and on-sale and diet filters |
get_whole_foods_deals | Every sale item at one store, store-wide or in one category |
get_whole_foods_product | One product by ASIN, URL or slug: ingredients, nutrition facts, diets, plus that store's in-store and online prices as separate blocks |
get_whole_foods_stores | Stores near a ZIP: store_id, address, phone, distance, in-store and pickup hours |
get_whole_foods_store | One store: status, phone, Prime eligibility, opening date, address, sales flyer URL |
get_whole_foods_sales_flyer | One store's current weekly flyer: each promotion's regular, sale and Prime price as printed, dates, ASINs covered |
1 credit per call. Prices are per 5-digit store_id (from
get_whole_foods_stores); without one, store 10145 (Austin) is used. Search
sorts only by relevance, price_asc or price_desc. No ratings, reviews, UPCs
or per-store unit stock.
Harbor Freight
| Tool | Description |
|---|
search_harbor_freight | Search by keyword and/or category: price, sale price and end date, public coupon price, Inside Track member price, compare-at price, rating, facets |
get_harbor_freight_clearance | Clearance items, optionally narrowed by keyword, category or brand, same fields as search |
get_harbor_freight_product | One product by item number, id or URL: every price above, UPC, specs, warranty, manuals, variants |
get_harbor_freight_prices | Current prices for up to 50 item numbers in one call |
get_harbor_freight_stores | Stores near a ZIP, "City, ST" or coordinates: store_id, address, phone, hours |
get_harbor_freight_availability | Up to 20 items at chosen or nearest stores: stock status (in_stock, limited, out_of_stock, not_carried) and aisle |
get_harbor_freight_reviews | Reviews for one item, newest first, with average rating and total count |
1 credit per call. Prices are national. Store stock is a status from a daily
snapshot (inventory_updated_at), not a unit count.
PetSmart
| Tool | Description |
|---|
search_petsmart | Search products: price, original and sale price, rating, how many stores stock it, pickup and Autoship eligibility; store_id lists only what that store has |
get_petsmart_product | One product with every size/flavor: price, sale price and end date, Autoship first-order and recurring price, ship and pickup options |
get_petsmart_stores | The 12 stores nearest a ZIP with hours and services; pass a sku for each store's unit count |
get_petsmart_store_stock | Units at one store for up to 20 SKUs, plus a nearby store that has it |
get_petsmart_availability | Unit counts for up to 20 store and SKU pairs in one call |
get_petsmart_deals | The Sale section by pet, sale event or keyword, with the current sale events |
1 credit per call. Prices are national. The Sale section also lists points and
Autoship promotions, so on_sale marks the rows whose price is actually
reduced.
Petco
| Tool | Description |
|---|
search_petco | Search products: price, list price, Repeat Delivery (autoship) price, rating, fulfillment flags, every variation |
get_petco_category | Products in a category path, e.g. dog/dog-food/dry-dog-food, same fields as search |
get_petco_product | One product by part number or URL with every variant: cat_entry_id, UPC, prices, first-autoship price, ingredients, guaranteed analysis |
get_petco_stores | Up to 10 stores nearest a ZIP: store_id, store number, address, hours |
get_petco_store_inventory | Units on hand at one store for up to 10 products |
1 credit per call. Prices are national. get_petco_store_inventory takes
cat_entry_id values (from search or product), not part numbers, and a
store_id from get_petco_stores or a ZIP. get_petco_product and
get_petco_category can take 10-30 seconds.
iHerb
| Tool | Description |
|---|
search_iherb | Search by keyword: price, list price, discount, rating, review count, stock, badges, recent sales; brand filter |
get_iherb_product | One product: UPC, price per serving, supplement facts, expiration date, best-seller rankings, variants |
get_iherb_prices | Price, discount, stock, rating and review count for up to 50 products in one call |
get_iherb_reviews | Rating summary: average, star histogram, counts per language, top positive and top critical review |
2 credits per call. US store, USD. iHerb is online only, so there are no store
tools. get_iherb_reviews is a summary, not a full review list.
Chewy
| Tool | Description |
|---|
search_chewy | Search or browse a category: one-time, Autoship and first-Autoship price, MAP price, per-unit price, rating, stock |
get_chewy_product | One product by id or URL: every price above, review count and star distribution, GTIN, ingredients, every variant |
10 credits per call. Some broad queries go straight to a category; redirect
then names it. No store data.
Menards
| Tool | Description |
|---|
search_menards | Search one store, 40 per page: price, sale price, rebate, final price and that store's stock count; sort by price or brand, in-stock-today and price filters |
get_menards_product | One product by item id or URL: everyday and sale price, mail-in rebates (e.g. 11%), final price after rebates; store_id adds stock quantity and aisle |
get_menards_stores | Stores near a ZIP or a city and state: store_id, address, distance, services |
search_menards is 2 credits and needs a store_id from get_menards_stores.
get_menards_product is 1 credit, 2 with store_id (10-40 seconds); take the
item id from a search result or a menards.com product URL (p-60893666613.htm).
get_menards_stores is 1 credit.
Nordstrom
| Tool | Description |
|---|
search_nordstrom | Search nordstrom.com (US), 24 per page: price and price range, original price, percent off, on-sale flag, rating, review count, badges, low-inventory flag, marketplace seller, colors; sort by rating, price, newest or percent off |
get_nordstrom_product | One product by URL or style id: every color and size as a sku with UPC, price, price type and quantity available to ship, star histogram, size-fit distribution, praised and criticized features, and the reviews shown on the product page |
get_nordstrom_category | Browse a category, sale section (sale/women) or new arrivals (/browse/new), 24 per page: the same product rows as search plus the category's breadcrumbs, subcategories and filter sidebar with product counts |
get_nordstrom_brand | A brand page (/brands/astr-the-label--53360 or a product's brand_url), 24 per page: the same product rows as search plus the brand's sub-pages and filter sidebar |
get_nordstrom_stores | Full-line stores and Nordstrom Local near a ZIP or latitude/longitude (up to 100 miles), or by store number: address, phone, weekly and daily hours, coordinates, pickup and curbside flags, amenities |
get_nordstrom_availability | Per sku of one product: ship quantity, pickup quantity (chain-wide) and the stores that offer in-store pickup |
get_nordstrom_suggestions | The nordstrom.com search-box autocomplete for a partial term |
get_nordstrom_reviews | A product's full review history, up to 200 per call: sort by most helpful, most recent, highest or lowest rated; filter by stars, verified purchases, photos or text; plus the rating summary, histogram, size and width rating, praised and criticized features and the AI review summary |
5 credits per call; get_nordstrom_availability is 10 (the product page plus the
store lookup) and get_nordstrom_reviews is 10. US site only. Product,
reviews and availability take a result's url or style_id; an unknown style
id is a 404. Product reviews are the ones shown on the product page (up to
about 13) plus the total review count and star histogram;
get_nordstrom_reviews returns the rest (rating-only reviews included, without
text). It takes 20-60s, up to about 100s at 200 reviews, so lower
max_reviews if your client times out long tool calls; sort cannot be
combined with search. A sku's quantity is units
available to ship, and in_stock means it can be shipped or picked up in a
store, so a sku can read in stock with quantity 0. Availability quantities are
chain-wide: per store Nordstrom only says whether pickup is available, not how
many units. A ZIP with no store within range returns an empty list (billed).
For nordstromrack.com see Nordstrom Rack.
Nordstrom Rack
| Tool | Description |
|---|
search_nordstromrack | Search nordstromrack.com (US), 24 per page: price and price range, compare-at price, percent off, on-sale flag, clearance price range, any promotion on top (promotion_price_range, promotion_percent_off), rating, review count, badges, low-inventory flag, marketplace seller, colors; sort by rating, price, newest or percent off |
get_nordstromrack_product | One product by URL or style id: every color and size as a sku with UPC, price, price type and quantity available to ship, clearance and promotion price ranges, star histogram, size-fit distribution, praised and criticized features, and the reviews shown on the product page |
get_nordstromrack_category | Browse any /shop or /clearance listing: departments, deals, new arrivals, Clear the Rack (/clearance) and flash events (/shop/flash lists them, /shop/flash/event-7 opens one), 24 per page, with breadcrumbs, subcategories and the filter sidebar |
get_nordstromrack_brand | A brand page (/brands/adidas or a product's brand_url), 24 per page: the same product rows as search plus the filter sidebar |
get_nordstromrack_stores | Nordstrom Rack stores near a ZIP or latitude/longitude (up to 100 miles), or by store number: address, phone, weekly and daily hours, coordinates, pickup and curbside flags, amenities |
get_nordstromrack_availability | Per sku of one product: ship quantity, pickup quantity (chain-wide) and the Rack stores that offer in-store pickup |
get_nordstromrack_suggestions | The nordstromrack.com search-box autocomplete for a partial term |
get_nordstromrack_reviews | A product's Rack review history, up to 200 per call: sort by most helpful, most recent, highest or lowest rated; filter by stars, verified purchases, photos or text; plus the rating summary, histogram, size and width rating, praised and criticized features and the AI review summary |
Nordstrom Rack is its own platform key (nordstromrack), separate from
nordstrom. 5 credits per call; get_nordstromrack_availability is 10 and
get_nordstromrack_reviews is 10. US site only. Category takes Rack paths
(/shop/..., /clearance/..., /shop/flash/event-N); there is no /browse.
Brand paths have no id (/brands/adidas); the nordstrom.com --<id> form is a
404. During Clear the Rack a clearance item can carry an extra percent off on
top of its clearance price: promotion_price_range is the price after it and
promotion_percent_off the extra percent. Rack has its own review pool,
separate from nordstrom.com's, so the same style can show a different rating
and review count on each. Reviews take 15-60s, up to about 100s at 200; lower
max_reviews if your client times out long tool calls. Stores and availability
cover Rack stores only, and availability quantities are chain-wide: per store
the site only says whether pickup is available, not how many units.
Best Buy
| Tool | Description |
|---|
search_bestbuy | Search bestbuy.com (US), 18 organic products per page: SKU, model, price, regular price, savings, on-sale flag, deal badge, condition, rating, review count, seller type; filter by brand, on sale, clearance, open box or a price range; sort by best match, best selling, best discount, price, rating or newest; plus the filter sidebar with counts |
get_bestbuy_product | One product by SKU or URL: UPC, model, every open-box offer by condition (fair, good, excellent) with its price and savings against new and against the regular price, financing, the full specification table, the AI review summary, features, images and manuals |
get_bestbuy_reviews | First-party Best Buy reviews, 20 per page, sorted or filtered to one star rating, with the star histogram, recommended percent and the most mentioned pros and cons with mention counts |
get_bestbuy_category | Browse a category (abcat...) or merchandised deals page (pcmcat...) by id or URL, 18 per page, with the same filters and sorts as search |
get_bestbuy_deals | Today's Deal of the Day and the more-deals row, up to 15 products with live prices |
get_bestbuy_stores | Best Buy stores near a US ZIP, up to 15, with dated opening hours for the next 35 days |
get_bestbuy_availability | Store pickup status of one SKU at up to 8 stores (nearest a ZIP or given store ids): in_stock, limited, ship_to_store, out_of_stock, not_available_for_pickup or unknown, with the pickup date |
get_bestbuy_suggestions | The bestbuy.com search-box autocomplete, each term with its categories and SKUs |
get_bestbuy_prices | Current price, regular price, savings, deal badge and deal end for up to 15 SKUs in one call |
Platform key bestbuy. 2 credits per call; get_bestbuy_category is 3 on a
pcmcat page, get_bestbuy_deals 3, get_bestbuy_stores and
get_bestbuy_suggestions 1, and get_bestbuy_availability 2 flat for up to 8
stores. get_bestbuy_prices is 2 per call whatever the number of SKUs (up to
15). US site only. Product, reviews and availability take sku or url;
availability takes exactly one of zip or store_ids, and min_price and
max_price go together. Availability is store pickup status, not unit counts:
Best Buy publishes a quantity only when it shows "only N left" (limited), so
quantity is null for in_stock. Availability takes 5-20s. An unknown SKU is
a 404 and is not billed.
TCGplayer
| Tool | Description |
|---|
search_tcgplayer | Search TCGplayer (US, USD) cards and sealed products across every game (Pokemon, Magic: The Gathering, Yu-Gi-Oh!, One Piece, Lorcana and 60+ more), up to 50 per page: market, median and lowest price, listing count, set, rarity, card number and up to 3 featured listings; filter by game, set, rarity or cards vs sealed; sort by relevance, best selling, name or market price; plus facets with counts |
get_tcgplayer_product | One product by id or URL: images, card attributes, market / median / lowest listing price, listing and seller counts, and every SKU (condition x printing x language) with its market price and the recent sale range (lowest and highest sale price, sale count) |
get_tcgplayer_listings | Every live seller offer on a product, up to 50 per page, filtered by condition, printing, language, verified sellers or Direct, sorted by price plus shipping or price, with seller rating percent, sales band, gold star and location |
get_tcgplayer_price_history | Up to a year of sales history per SKU (month, quarter, semi_annual, annual): per bucket market price, quantity sold, transaction count and the low and high sale price |
get_tcgplayer_sales | The 5 most recent sales of a product: date, condition, printing, quantity, price and shipping |
get_tcgplayer_games | Every game (product line) on TCGplayer, 70+, with the url_name the other tools accept |
get_tcgplayer_sets | Every set of one game, newest first, with the set_id the price guide takes |
get_tcgplayer_price_guide | A whole set's price table, cards or sealed, up to 500 rows per page: market and low price per card per condition and printing |
get_tcgplayer_suggestions | The tcgplayer.com search-box autocomplete: products, sets and games |
get_tcgplayer_trending | Trending searches right now, overall or for Pokemon, Magic or Yu-Gi-Oh! |
get_tcgplayer_seller | A seller's profile by seller key, with the 365-day feedback summary and rating percent |
get_tcgplayer_seller_feedback | Individual feedback rows on a seller from the last 365 days, filterable by star rating or with a comment; buyers appear only as the site's masked nickname |
get_tcgplayer_seller_products | A seller's catalogue with their own listings of each product, filtered by keywords or game |
Platform key tcgplayer. 1 credit per call, every tool. US marketplace,
prices in USD. Product, listings, price history and sales take product_id
or a tcgplayer.com /product/<id>/ URL; an unknown id is a 404 and is not
billed. SKU sale fields on get_tcgplayer_product (lowest_sale_price,
highest_sale_price, sale_count) are recent SALE statistics, not live
listings; use get_tcgplayer_listings for offers. get_tcgplayer_sales
returns only the 5 newest sales; for sold volume use
get_tcgplayer_price_history, whose low and high sale prices are null in a
bucket with no sales. Seller tools take the 8-character seller.key from a
listing. No store locator, product reviews or buylist prices.
Nintendo eShop API: one game's regular price, sale price and sale end date in each eShop country, in that country's currency, plus catalog search, product detail, deals, new and upcoming releases and a game's DLC, across 46 countries.
| Tool | Description |
|---|
search_nintendo | Search one country's eShop catalog by keyword: nsuid, title, platform (Switch / Switch 2), release date, publisher, price, regular price, sale price, discount, sale start and end, age rating; Europe and Japan with sorts and filters (platform, on sale, publisher, type; Europe also price range, genre, players, demo), the Americas 40 tiles per page by relevance or newest |
get_nintendo_product | One product by nsuid, link or (Americas) slug: publisher, developer, genres, players, languages, file size, age rating and descriptors, description, prices with the sale window, demo, Nintendo Switch Online; Americas also editions, play modes, the game's DLC with prices and the stock signal for hardware, amiibo and merchandise |
get_nintendo_prices | The eShop price of 1 to 50 item ids in one country: price, regular price, sale price, discount, sale start and end, sales status; every market including the prices-only kr, hk, tw and il |
get_nintendo_deals | Games on sale now: Europe and Japan every discounted game in the catalog, the Americas Nintendo's featured sale pages (with each item's sale page and the list of sale pages) |
get_nintendo_releases | New releases (newest first) or upcoming games (soonest first) with prices, filtered by platform |
get_nintendo_dlc | A game's DLC, bundles and upgrade packs with prices and sale windows |
Platform key nintendo. Every tool costs 1 credit. Markets (country,
default us) and languages (language, default the market's first):
Americas us (USD), ca (CAD; English or French), mx (MXN), br (BRL;
Portuguese), ar (ARS), cl (CLP), co (COP) and pe (PEN) (Spanish); Europe in
the market's language: gb (GBP) and ie (EUR) (English), de and at (EUR;
German), ch (CHF; German, French or Italian), fr, be (French or Dutch), nl,
lu (French), it, es and pt (EUR), au (AUD), nz (NZD) and za (ZAR) (English);
pl (PLN), cz (CZK), se (SEK), no (NOK), dk (DKK), fi, sk, hu, ro, bg, gr, hr,
si, ee, lv, lt, mt and cy (EUR) have no Nintendo site of their own and read
the English European catalog with that country's own prices; jp (JPY;
Japanese). get_nintendo_prices also serves kr (KRW), hk (HKD), tw (TWD) and
il (EUR, European item ids). ph (no Philippines item ids published yet), ru
(no eShop), uk (use gb) and countries with no eShop data answer 400 before
anything is charged.
Item ids (nsuid) are per eShop region: Americas (US CA MX BR AR CL CO PE),
Europe (EU / EFTA, GB, AU, NZ, ZA, IL), Japan, Korea, and Hong Kong + Taiwan
(Taiwan uses Hong Kong ids). An id from one region is not_found in another
and there is no cross-region title mapping: look the game up with
search_nintendo or get_nintendo_product in that region, then call
get_nintendo_prices for any country of the region (up to 50 ids). Americas
search tiles carry a slug and no nsuid: read the product with the slug.
Prices are always the requested country's eShop price in its currency;
sale_start and sale_end are the eShop's own sale window. Nintendo shows
no price history or historical low: poll get_nintendo_prices to build one.
Americas deals are Nintendo's featured sale pages, not every discounted game;
Europe and Japan deals are every game on sale. Americas search sorts by
relevance or newest only and takes no filters, and the Americas releases
lists are one page; an unsupported sort or filter answers 400, never silently
dropped. No user reviews (Nintendo's stores have none; age ratings only), no
best-seller charts and no autocomplete. Failed calls are not charged; a
not-found is charged.
H&M product data API: one article's price, sale price, member price and online stock by size in each H&M market, in that market's currency, plus catalog search, category, sale and new-arrivals grids, search suggestions, stores and where an article is made, across 47 countries.
| Tool | Description |
|---|
search_hm | Search one market's catalog by keyword or article code: article code, title, price, regular price, sale price, member price, discount, prior price (EU), colours, sizes with online stock, category id; up to 72 per page, sorted by relevance, newest or price, filtered by department, store assortment, colour, size, material, fit, product type and on sale; facets and price range |
get_hm_product | One article by article code or link (2 credits, can take up to about a minute): description, composition, materials, care, fit attributes, the prices with H&M's price disclosure, every colourway with its own prices, sizes with online stock and few-left, rating and the latest reviews H&M shows (up to 10, with fit feedback) |
get_hm_stock | Online stock per size for every colour of a product, by article or product code (not store stock) |
get_hm_stores | A country's stores with address, coordinates, phone, opening hours and exceptions, departments; filtered by city, postal code or a lat / lng radius |
get_hm_category | A category grid by H&M's category id (the same ids in every market, e.g. ladies_dresses, men_jeans), with the search sorts and filters |
get_hm_deals | A department's sale grid (default women) with sale price, regular price and discount; may be empty between sales |
get_hm_new_arrivals | A department's new-arrivals grid (default women), with the search sorts and filters |
get_hm_suggestions | Search suggestions for what a shopper has typed, in the market's language |
get_hm_production | Where an article is made as H&M publishes it: production countries, suppliers and factories (name, city, workers range; no street addresses) |
Platform key hm. get_hm_product costs 2 credits, every other tool 1.
Markets (country, default us) and languages (language, default the
market's first): us (USD), ca (CAD; English or French), mx (MXN; Spanish),
gb (GBP), ie (EUR), de and at (EUR; German), ch (CHF; German, French or
Italian), fr, be (Dutch or French), nl, it, es, pt (EUR), se (SEK), fi (EUR;
Finnish or Swedish), dk (DKK), no (NOK), pl (PLN), cz (CZK), sk (EUR), hu
(HUF), ro (RON), bg (EUR), gr (EUR), rs (RSD), tr (TRY), ua (UAH), il (ILS;
Hebrew), hk and mo (HKD; Chinese or English), tw (TWD; Chinese or English),
jp (JPY), kr (KRW), in (INR), my (MYR), ph (PHP), sg (SGD), vn (VND), au
(AUD), each in its own language; and hr, cy, ee, lv, lt, lu and si on H&M's
shared English EUR store (answers say store eu). Every tool serves all 47
except get_hm_product (not mo, tw or the shared EU store countries: use
search_hm or get_hm_stock there) and get_hm_stores (not mo: H&M lists
no stores there). Countries where H&M runs a separate site (ae, eg, id, th,
br, cn) or has no online store, ru, and uk (use gb) answer 400 before
anything is charged.
Article codes are global: the same 10-digit code (7-digit product code +
3-digit colour) in every market, so one code compares a price across markets
with one call per country. price is what a non-member pays now;
member_price is H&M's member price as shown to signed-in members;
prior_price is the earlier price H&M shows next to an EU markdown. Stock is
online stock per size: H&M publishes no per-size store stock (search_hm
with store lists a store's assortment). Category ids are the same in every
market, and a category returns everything H&M files under that id, which can
be more than the site's curated page. H&M runs sales in seasons, so
get_hm_deals may return an empty grid between sales. No price history
(poll to track changes), no full review list (the 10 latest only), no
checkout or member-only cart prices, and H&M's sibling brands (COS, Weekday,
& Other Stories, Monki, ARKET) are not covered. Failed calls are not
charged; a not-found is charged.
Zara product data API: Zara prices by country (one reference's price, sale price and availability in up to 10 markets per call, each in that market's own currency), stock by size online and in physical stores, catalogue search, product detail, materials and origin, category, special-prices and new-arrivals lists, stores and search suggestions, across 102 Zara storefronts.
| Tool | Description |
|---|
search_zara | Search one market's catalogue by keyword, or look up a reference (all its colours): product id, reference, title, price, old price, discount, availability, colours; up to 96 per page, sorted by relevance or price, filtered by section, colour, size and price range; facets and price range |
get_zara_product | One product by link, product id + slug, or reference: description, prices, composition, every colour with its sizes, online availability per size, promotions and images |
get_zara_materials | Composition, care, certifications and origin (country of production as Zara states it; France shows traceability steps) |
get_zara_stock | Online availability per size of one colour (in_stock, out_of_stock, low_on_stock, coming_soon) |
get_zara_stores | Stores near a point, nearest first, with address, coordinates, phones, 7 dated days of opening hours and services |
get_zara_store_stock | Units per size of one colour in physical stores (sales floor and stockroom), by store ids or a point |
get_zara_categories | A market's category tree (id, name, section, parent, leaf, redirect id) |
get_zara_category | Every product of one category, paged and sorted over the whole list, optionally only marked-down items |
get_zara_deals | A section's SPECIAL PRICES list (woman, man, girl or boy) with old price and discount |
get_zara_new_arrivals | A section's NEW ARRIVALS list (woman, man, girl or boy) |
get_zara_prices | One reference across up to 10 markets: price, old price, discount, currency, title and availability per market, plus the markets that do not sell it |
get_zara_suggestions | Search suggestions for what a shopper has typed, in the market's language |
Platform key zara. Every request is billed what it spent (credits_used
in the answer): 2 credits per call for search_zara, get_zara_materials,
get_zara_stock, get_zara_stores, get_zara_categories and
get_zara_category; get_zara_product 2 (4 when opened by reference or
when the slug is another market's or language's, 6 for both);
get_zara_store_stock 2 with store ids, 4 with a point; get_zara_deals 4
(2 when the market has no special-prices category); get_zara_new_arrivals
4; get_zara_prices 2 per market that answered; get_zara_suggestions 2 (4
when the English fallback runs). China (cn, Zara's separate site) costs 1
credit per call instead of 2.
Markets (country, default us): the 102 Zara storefronts with an online
store of their own, each in its own currency, e.g. us (USD), ca (CAD), mx
(MXN), br (BRL), gb (GBP; the United Kingdom), the euro countries, ch (CHF),
se, dk, no, pl, cz, hu, ro, tr, ua, il, ae, sa, kw, qa, eg, ma, in, jp (JPY),
kr (KRW), cn (CNY), hk, tw, sg, my, th, id, vn, au, nz, za and the rest of
Latin America and Europe Zara sells online in; ic is the Canary Islands, xe
Abu Dhabi, Al Ain and Ras Al Khaimah, xk Kosovo. language takes Zara's own
languages for the market (205 market-languages; the first listed is Zara's
default), listed per market in the search_zara description. Every tool
serves all 102 except get_zara_stores and get_zara_store_stock (not ao
or iq: Zara lists no stores there), get_zara_new_arrivals (not dz) and
get_zara_suggestions (not ad, al, am, az, ba, dz, mk, mo, uz or xk).
Belarus, uk (use gb) and the countries Zara serves only from its worldwide
store answer 400 before anything is charged.
References are global on Zara's international site, so one reference
compares a price across markets in a single get_zara_prices call. A
colour's product id is usually the same across markets but can differ, and
China (cn) runs its own ids, so match across markets with the reference. Prices are numbers in the market's own currency, never
converted; old_price is set only on a markdown. Zara runs seasonal sales
and lists special prices between them: get_zara_deals resolves each
market's special-prices list live and answers an empty list (not an error)
where a market has none for the section; in fr, be, lu, mc and iq Zara lists
special prices without a previous price. get_zara_stock is online stock;
get_zara_store_stock is units in physical stores. Category ids are shared
across the northern-hemisphere catalogue; au, za and br run their own (get
them from get_zara_categories). No reviews (Zara shows none), no price
history (poll get_zara_prices), and Inditex's other brands (Pull&Bear,
Massimo Dutti, Bershka, Stradivarius, Oysho, Zara Home, Lefties) are not
covered. Failed calls are not charged; a not-found is charged.
ASOS product data API: ASOS prices by country and currency (one product's price, previous price, RRP, sale flag and online stock by size in each ASOS store and currency), catalogue search, product detail, reviews by store with ASOS's AI summary, categories, brands, the sale and new-in lists, and the markets table, across 235 countries and 245 country-currency combinations.
| Tool | Description |
|---|
search_asos | Search one store by keyword: product id, title, brand, price, previous price, RRP, lowest 30-day price, discount, colours; up to 200 per page, sorted by relevance, newest or price, filtered by gender, brand, colour, size, body-fit range, product type, price and sale; facets and price range |
get_asos_product | One product by id, co-ord group id or link: description, composition, care, size and fit, every size variant with price and online stock, rating with fit and quality, ASOS's AI review summary and the other colours |
get_asos_stock | Price and online stock per variant of up to 100 product ids in one call, plus the ids the store does not sell |
get_asos_reviews | Reviews of one product on one store, up to 50 per page, sorted and filtered by star rating, with fit and quality averages and ASOS's labelled AI summary |
get_asos_suggestions | Search suggestions for what a shopper has typed, in the store's language |
get_asos_category | Every product of one category or brand page, paged and sorted, with the search filters |
get_asos_categories | The store's women and men navigation tree with category ids |
get_asos_brands | The store's A-Z brand list for women or men (brand_id is a category id) |
get_asos_deals | The store's SALE category for women or men, with previous price and discount |
get_asos_new_arrivals | The store's NEW IN category for women or men |
get_asos_markets | Every country ASOS sells in with its store, language, currencies and size schema |
Platform key asos. 1 credit per call on every tool.
Markets (country, default gb; currency, default ASOS's own default for
the country): the 235 countries in ASOS's own country selector, served by 13
ASOS stores. Eleven have a site of their own in their own language: gb (GBP),
us and pr (USD), fr and mc (EUR, French; the French overseas territories in
USD), de and at (EUR, German), es and ad (EUR, Spanish), it, sm and va (EUR,
Italian), au (AUD), dk (DKK), nl (EUR), pl (PLN) and se (SEK). ASOS's
European store (33 countries, English: ie, pt, be, fi, gr, cz, hu, ro, no ...)
and its international store (170 countries, English: ca, mx, in, za, ch, nz,
ae, sa, hk, il, jp, kr, sg, tw, cn ...) serve the rest. currency takes any
currency ASOS offers the country (245 country-currency combinations, e.g. ae
AED or GBP, il ILS, GBP or USD, jp USD or GBP). Every tool serves every
combination except get_asos_suggestions on pl (ASOS's Polish store answers
no suggestions). Russia and Belarus (ASOS is not selling there), uk (use gb)
and countries ASOS does not list answer 400 before anything is charged.
Product and category ids are the same on every store (titles come back in the
store's language), so one product id compares a price across countries and
currencies with one call per country. Countries served by the same ASOS store
in the same currency share one price list, except Ireland, which has its own
euro prices on ASOS's European store (measured 2026-11-16 on all 245
country-currency combinations); which products are offered still differs by
country. price is the lowest size price when ASOS prices sizes differently
(variants carry each size's price). Prices are numbers in the requested currency, never converted:
price, previous_price (ASOS's "was"), rrp, lowest_price_30d where ASOS
shows it, is_marked_down, is_outlet, discount_percent and
discount_basis. get_asos_stock is online stock per variant (ASOS has no
physical stores) and carries variant ids, not size names: map them with
get_asos_product. Which reviews come back depends on the store: gb,
us, au and ASOS's European and international stores share one English review
pool; es, it, nl, se, dk and pl add reviews written in their own language to
that pool; fr and de show only reviews written in French or German (each
review carries its language). Reviewer names are never returned. Keyword search
serves at most 2,088 results whatever total says (max_reachable); category
lists page through everything. The search_asos brand filter takes brand
facet ids from a search answer; get_asos_brands returns category ids to pass
to get_asos_category. No outlet (ASOS's outlet categories are empty), no
promo codes (shown only to signed-in shoppers) and no price history (poll
get_asos_stock). Failed calls are not charged; a not-found is charged.
Vinted
| Tool | Description |
|---|
search_vinted | Search second-hand listings on any of 27 Vinted country sites by keywords, category, brand, condition, size, color, material and price range, sorted by relevance, newest or price: 96 items per page, pages 1-10, with price, the Vinted fee, total price, brand, size, condition, favourites, photos and the seller id |
get_vinted_product | One listing by item id or URL: description, price in the seller's currency, brand, size, condition, color, material, category path, all photos, reserved and sold state, and the seller's login, feedback count and rating |
get_vinted_seller | A member's public seller profile: feedback count and rating, positive / neutral / negative counts, listed item count, verification, response time, holiday mode, last seen |
get_vinted_seller_products | The items one member has listed, newest first, cheapest first or by relevance, up to 96 per page |
get_vinted_seller_feedback | Reviews left for a member, newest first, up to 50 per page: rating 1-5, text, date, automatic flag and the member's reply; no reviewer identity |
get_vinted_brands | Find brands by name: brand id (for search's brand_ids), listing count, luxury flag and whether Vinted authenticity-checks it |
get_vinted_suggestions | The Vinted search-box autocomplete in the site's language, up to 10 suggestions with their type |
get_vinted_filters | The options of one search filter (size, condition, color, material) with live item counts, optionally for a query and category |
get_vinted_categories | The category tree in the site's language (9 top-level, about 3,000 in all), or one category's subtree with its path |
Platform key vinted. 1 credit per call, every tool. Every tool takes an
optional country: fr (default), be, lu, es, nl, lt, de, at,
it, uk, pt, us, cz, sk, pl, se, ro, hu, dk, fi, hr,
gr, ie, ee, lv, si, au. Category, condition and filter names come
back in that site's language. Every site, uk, us and au included, can
show listings from sellers in other countries, with the price converted to the
site's currency (vinted.co.uk shows an Australian seller's 20 AUD item at
10.43 GBP); the EU sites share one cross-border pool. A product is priced in
the SELLER's own currency, which can differ from the site's.
service_fee is the Vinted fee the buyer pays on top of the price (formerly
the Buyer Protection fee). Search serves at most 10 pages of 96
(total_is_capped is true past 960 matches), and price sorts surface loosely
matching cheap listings, so pair them with a category or price range. Live
listings only: no sold-item search, shipping prices, pickup points or similar
items. Seller data is limited to public buyer-relevant fields.
Macy's
| Tool | Description |
|---|
search_macys | Search macys.com (US), 60 organic items per page: price, regular and sale price, percent off, sale end date, deal label (Black Friday Deal, Clearance, LAST ACT, Today Only), promotions, rating, review count, colors; filter by brand, color, special offer, any price range, pickup store or any facet; sort by featured, price, top rated, best sellers or newest; plus the facets with counts |
get_macys_product | One product by id or URL, or up to 10 ids in one call: price block with sale end, rating histogram, text vs total review counts, fit slider, AI review summary, colors with prices, sizes and every variant (UPC, color, size, availability, low-stock flag, ship days) |
get_macys_reviews | Macy's own reviews, up to 100 per page, newest, highest or lowest rated or with photos first, filtered by star rating or a word, with slider ratings, photos, syndication source and the brand's response |
get_macys_category | Browse a category by id or URL, 60 per page, with the same filters and sorts as search |
get_macys_brand | Browse a brand's page by its page id (a product's brand_page_id) or URL, 60 per page, with the same filters and sorts as search |
get_macys_deals | Sales & Offers, Clearance, Today Only, Last Act, Limited-Time Specials or Black Friday Deals, 60 per page, with the same filters and sorts as search |
get_macys_stores | Macy's stores near a ZIP, a point or a city + state, up to 15, with hours, curbside hours and the same-day pickup cut-off |
get_macys_store_availability | Store pickup for one product: which stores near a location can hand it over, or per variant at one store_id whether it can be picked up and whether it is in the store |
get_macys_suggestions | The macys.com search-box autocomplete, up to 7 suggested searches |
Platform key macys. 1 credit per call, every tool. US site only, prices in
USD. Search, category, brand and deals share one grid: 60 organic items per
page with total and total_pages, and totals can differ between sorts, as
they do on the site. Ad-only sponsored tiles are dropped (sponsored_dropped
counts them) unless include_sponsored; organic items that also hold a paid
slot stay, flagged is_sponsored. A keyword Macy's maps to a category returns
redirected_to_category. A batch of product_ids (up to 10) gets Macy's
summary view: no rating histogram, and a collection without its members'
variants. A collection member's id answers with the collection product
(requested_id echoes the id asked for). review_count includes ratings
without text; reviews returns written reviews only (text_review_count).
Store availability is pickup and in-store flags, never unit counts: Macy's
publishes no quantities. A store_id comes from get_macys_stores. No coupon
codes, Q&A text or price history: to track prices, poll and store your own.
Saks Fifth Avenue
| Tool | Description |
|---|
search_saks | Search saksfifthavenue.com (US), 24 grid positions per page: price, regular and sale price, percent off, badge, final-sale and clearance flags, returnable, limited inventory, promotions, review count, colors; filter by designer, color, size, any price range, on sale, new arrivals or any facet; sort by featured, best sellers, newest, price, sale first or designer A-Z; plus the facets with counts and price ranges |
get_saks_product | One product by id or URL, optionally one color + size: price block, final-sale / returnable / marketplace flags, promotions, colors and sizes with availability, every SKU with its online warehouse units, availability message and restock date, merchandising attributes, average rating and review count |
get_saks_category | Browse a category by its /c/ path or URL, 24 per page, with the same filters and sorts as search, plus breadcrumbs |
get_saks_brand | Browse a designer's page by slug (from get_saks_designers) or URL, 24 per page, with the same filters and sorts as search |
get_saks_deals | Sale, Women's Clothing Sale, Men's Sale, Women's New Arrivals or Men's New Arrivals, 24 per page, with the same filters and sorts as search |
get_saks_stores | Saks stores near a ZIP or a point within 15-300 miles, with today's hours and a pickup flag for stores that offer in-store pickup |
get_saks_store_availability | Pickup availability of one variant sku at stores near a location: availability message, in stock, limited, and units_at_store when the site shows a count |
get_saks_suggestions | The search-box suggestions: result count, designers, categories (with paths for get_saks_category), up to 5 products and popular searches |
get_saks_designers | The A-Z designer index (about 1,200 designers) with the slugs get_saks_brand takes, optionally one letter |
Platform key saks. 2 credits per call, every tool. US site only, prices in
USD. Search, category, brand and deals share one grid: 24 positions per page
with total, total_pages, start and next_start. An editorial tile can
take a grid position, so a page may carry 22-23 items: walk with start =
the previous next_start to miss nothing (page also works). A keyword the
site maps to a designer or category page returns redirected_to. Facet
values feed the filters as listed: size takes the facet label ("Medium",
not "M"). Store availability needs a VARIANT sku (a product's
variants[].sku, or a product resolved with color + size); units_at_store
is present only when the site shows a count, otherwise null. Rating and
review count only: review text is not available. No clearance list, coupon
codes, international prices or price history: to track designer sale
prices, poll and store your own.
Kohl's
| Tool | Description |
|---|
search_kohls | Search kohls.com (US), 120 products per page: price, regular and sale price, price label (sale / clearance), percent off, with-code price and its offer codes, cart-only price flag, promotions, rating, review count, badges, Sephora and pickup / ship-to-store flags, sponsored flag; filter by brand, color, size, on sale, clearance or any facet value (price buckets included); sort by featured, new arrivals, best sellers, price, highest rated or percent off; plus the facets with counts and corrected_query |
get_kohls_product | One product by id or URL, optionally at one store: price block with with-code price and offer codes, Kohl's Cash earn and redeem windows, the public offers that apply, dept, every variant with sku, UPC, color, size, availability and online units, average rating, review count and recommended percent |
get_kohls_category | Browse a catalog listing by its path or URL (the path carries its CN= filter), 120 per page, with the same filters and sorts as search, plus breadcrumbs |
get_kohls_brand | Browse one brand by name or URL, 120 per page, with the same filters and sorts as search |
get_kohls_deals | Clearance (default), Sale, items that earn Kohl's Cash now, or Sephora at Kohl's, 120 per page, with the same filters and sorts as search |
get_kohls_stores | Kohl's stores near a ZIP, a city + state or a point within 1-100 miles (default 25): store_id, address, phone, weekly hours, badges (Sephora...) and services |
get_kohls_store_availability | Pickup stock of one SKU at every store within about 50 miles of a ZIP: pickup_units (a unit count), stock_level, ship-to-store units and window, store hours |
get_kohls_suggestions | The search-box suggestions: keyword completions, or matching products with type: "products" |
get_kohls_coupons | Today's public Kohl's coupon codes: code, description, end date, Kohl's Card-only flag, terms and eligible-products URLs |
Platform key kohls. 2 credits per call, except get_kohls_stores (1
credit). US site only, prices in USD. Search, category, brand and deals share
one grid: 120 products per page with total and total_pages; up to about 8
sponsored items stay in the list, flagged is_sponsored and counted in
sponsored_count. Facet value ids feed filters as returned; price is a
facet bucket ("Price:$25 to $50"), not a free min / max. A category needs a
kohls.com catalog path or URL that carries its CN= filter. Store
availability takes a product's variants[].sku (and optionally its dept)
and returns real pickup unit counts per store. with_code_price is the
price after a public offer code, with the code. Rating and review count only:
review text is not available. No price history, international sites, account
offers or checkout: to track clearance prices, poll and store your own.
JCPenney
| Tool | Description |
|---|
search_jcpenney | Search jcpenney.com (US), 48 products per page (at most 25 pages): current, regular and after-coupon price ranges with the coupon code, price type (sale / clearance / original), percent off, deal label, rating, review count, badge, availability label, colors with SKU ids, marketplace flag and seller; filter by brand, color, size, price range, deal label or any facet value; sort by relevance, new arrivals, best sellers, rating or price; plus the facets with counts, corrected_query and redirected_to |
get_jcpenney_product | One product by id or URL, or up to 20 by product_ids: price block (regular, sale and clearance ranges, percent off, after-coupon price with its code, price window), breadcrumbs, average rating, review count, question and answer counts, and every variant with sku, UPC, color, size, status and online stock level (high / low / out) |
get_jcpenney_category | Browse a category by its /g/ path or URL (the path carries its id=cat...), 48 per page, with the same filters and sorts as search, plus breadcrumbs |
get_jcpenney_brand | Browse one brand by name or brand page URL, 48 per page, with the same filters and sorts as search |
get_jcpenney_deals | Clearance (default), Sale, Black Friday deals, Big Buy, Limited Time Special, Best Value, Gotta Have It, Closeout, Buy 1 Get 1 or any Deals & Promotions label, across all products or one department |
get_jcpenney_stores | JCPenney stores near a ZIP, a city + state or a point within 1-100 miles (default 25), paged: store_id, address, phone, weekly hours, timezone, services (salon, portrait studio, JCPenney Beauty, Curbside Pickup...), pickup directions and bookable appointments |
get_jcpenney_store_availability | Real unit counts of one SKU at the 5 nearest stores to a ZIP (or lat + lng): quantity, status, updated_at, store hours, plus stores_with_stock and total_quantity |
get_jcpenney_suggestions | The search-box suggestions: keyword completions with their search URL and department refinements where JCPenney offers them |
get_jcpenney_coupons | Today's public JCPenney coupons: code (null for in-store offers that need none), channel, headline, details, start and end dates, disclaimer and eligible-products URL |
get_jcpenney_reviews | Real review text of one product by id or URL, up to 98 per call (default 38), sorted most recent, most helpful, highest or lowest rating, or relevance, optionally one star rating: total_reviews (every language), displayed_reviews (the English reviews JCPenney lists), `m |