How do I install Nexscope?

Copy the http config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Nexscope need an API key?

No required environment variable is listed on this record.

When was Nexscope last checked?

Last checked 2026-11-10. Ecommerce data MCP: Amazon, TikTok Shop, Walmart, Temu, Ozon, Shopee, 1688, Etsy, eBay & more

Nexscope MCP server

Nexscope Ecommerce API

Connect ecommerce workflows to marketplace data, product research, and AI image and video creation through Nexscope APIs.

225 APIs · 172 Data APIs · 53 Creative APIs · 20 categories

Get an API key · Official API docs · Complete catalog · Integration guide

This repository includes documentation for every API in the official directory, request/response definitions, editable request samples, and cURL, JavaScript, and Python clients. Use it to connect marketplace research, sourcing, keyword analysis, product imagery, and video creation to your application.

Quick start

1. Get and configure your API key

Open API Access, sign in, and create or copy your user API key. Send it in the Authorization header as a bearer token.

Creative API access requires an active subscription. Trial credits do not enable Creative API key access. Review your account access and current plans before submitting generation requests.

Keep the key on your server. Do not commit it or expose it in a browser application. In Bash or Zsh, enter it without displaying it or putting its value into shell history:

printf 'Nexscope API key: '
read -r -s NEXSCOPE_API_KEY
printf '\n'
export NEXSCOPE_API_KEY

All run requests use:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

2. Make your first Data API request

This example calls Amazon Search API for phone case results. It sends a real API request when you execute it with your key.

curl --silent --show-error --fail-with-body --max-time 120 \
  -X POST 'https://api.nexscope.ai/api/skill-api/v1/skills/amazon-search/run' \
  -H "Authorization: Bearer $NEXSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"keyword":"phone case","page":1}'

Response shapes vary by API; follow its current official reference. For Amazon Product Detail, check code === 0 and read business fields from data (for example, data.products and data.total); data may be null. The Amazon Search fixture below retains the original snapshot shape and should be verified against its current reference before integration. Documented response fixture.

3. Use JavaScript, Python, or reusable cURL commands

Clone this repository and run commands from its root. The examples require Node.js 22+, Python 3.10+, or cURL 7.76+; the cURL helper also uses Python 3.10+ to look up and check the request. JavaScript and Python use only standard libraries.

git clone https://github.com/nexscope-ai/nexscope-ecommerce-api.git
cd nexscope-ecommerce-api

# Choose ONE client to submit a request:
node examples/javascript/run.mjs amazon-search payloads/amazon-search.json
# Alternatively:
python3 examples/python/run.py amazon-search payloads/amazon-search.json
# Alternatively:
bash examples/curl/run.sh amazon-search payloads/amazon-search.json

Each command above independently submits a request. To inspect the method, endpoint, and JSON without sending or using credits:

python3 examples/python/run.py amazon-search payloads/amazon-search.json --dry-run
node examples/javascript/run.mjs amazon-search payloads/amazon-search.json --dry-run

JavaScript source · Python source · cURL source

4. Call a Creative API and retrieve its result

All 53 Creative APIs in this snapshot use asynchronous tasks. This example uses Background Remover API.

Create a request with your real, publicly accessible image URL. The input image must meet the API's documented limits, including 385–8192 pixels on both dimensions and a maximum size of 20 MB.

cp payloads/background-remover.json creative-request.json
# Edit creative-request.json: replace the example.com image URL with your asset URL.
# subType: 1 = general, 2 = portrait, 3 = product, 9 = apparel, 12 = hair, 13 = face.

python3 examples/python/run.py background-remover creative-request.json > creative-task.json
cat creative-task.json

The submission returns a receipt resembling this illustrative documentation sample:

{
  "taskId": "6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2",
  "status": "PENDING",
  "message": "The task has been created. Use taskId to query the result."
}

Use the task ID returned by your own request to query the result; do not rerun the POST to check progress:

TASK_ID=$(python3 -c 'import json; print(json.load(open("creative-task.json"))["taskId"])')
python3 examples/python/run.py background-remover --task "$TASK_ID"
# Alternatively: node examples/javascript/run.mjs background-remover --task "$TASK_ID"
# Alternatively: bash examples/curl/run.sh background-remover --task "$TASK_ID"

The query endpoint is:

GET https://api.nexscope.ai/api/skill-api/v1/skills/background-remover/tasks/{taskId}
Authorization: Bearer YOUR_API_KEY

PENDING or RUNNING: the task is not complete. Query the same task later; a 5-second starting interval is an application recommendation, not an API rate-limit guarantee.
SUCCESS: inspect the returned payload for generated outputs and the actual credits charged.
FAILED or TIMEOUT: stop polling and inspect the error. A new submission is a separate request.

The included clients perform one submission or one status check per command. They do not automatically resubmit or poll indefinitely. See asynchronous integration details.

5. Switch to any API in the catalog

Open its documentation below, copy payloads/<slug>.json into your own request file, and replace illustrative inputs. Pass the slug and your file to the same client:

cp payloads/seedance-2-5-video-generation.json request.json
# Edit request.json with your real reference image and desired prompt.
python3 examples/python/run.py seedance-2-5-video-generation request.json

Parameter names, media requirements, conditional fields, and response shapes vary by API. The clients reject reserved example-domain asset URLs; you must also review sample product IDs, search terms, and other values for your intended use.

Errors and response handling

HTTP status	What to do
200	Follow the current response contract; when `code` is present, only `0` indicates business success or acceptance. For asynchronous work, also inspect the documented task status.
400	Check required fields, types, allowed values, conditional inputs, and media constraints.
401	Check the bearer header and API key.
403	Check account permissions, API access, and subscription requirements.
429	Respect `Retry-After` when present and back off.
5xx	Inspect the service error. Before resubmitting a generation request, check whether a task was created.

The helpers surface non-2xx responses and print the returned JSON. They do not currently reject nonzero platform code values; application code must perform that check when the endpoint uses the platform envelope. The Python and JavaScript helpers also exit with an error for FAILED or TIMEOUT task states; cURL reports HTTP status only. Do not blindly retry POST requests: the documentation does not establish an idempotency guarantee.

Repository contents

Path	Contents
docs/data/	172 Data API references
docs/creative/	53 Creative API references
catalog/apis.json	Complete inventory, categories, links, endpoints, and definition formats
schemas/	225 request and 225 response definitions
payloads/	225 published request samples
examples/responses/	225 published response fixtures
examples/	cURL, JavaScript, and Python clients for every catalog entry
docs/calling-apis.md	Authentication, tasks, media, and MCP guidance

Complete API catalog

All 225 APIs listed in the official directory are included. Each entry links to its parameters, request/response definitions, sample payload, and official documentation.

Data APIs — 172

Amazon Marketplace Intelligence (26)

API	Purpose
Amazon ASIN Traffic Summary API	Use Nexscope (Search Intelligence Framework) data to analyze ASIN traffic source composition and exposure distribution, covering current period/previous period/newly entered/exited period comparisons.
Amazon Broad Product Search API	Use Nexscope data to search and filter Amazon products, supporting multi-dimensional criteria including price, monthly sales, BSR ranking, gross margin, ratings, fulfillment method, badges, seller origin, and more across multiple Amazon marketplaces.
Amazon Category Lookup API	Browse Amazon category nodes or search category metadata by name.
Amazon Competitor Lookup API	Use Nexscope data to find and analyze competitors on Amazon, covering 12 marketplaces, with product metrics including sales, BSR, pricing, ratings, and growth trends.
Amazon Market Product Detail API	Query Amazon product detail and historical trends by ASIN using Nexscope data, covering 14 marketplaces.
Amazon Market Product Search API	Multi-dimensional Amazon product search and filtering based on Nexscope data, covering 14 marketplaces, with support for historical monthly snapshot lookback.
Amazon Market Research API	Use Nexscope market list capability to filter Amazon niche markets by category dimensions, supporting market size, competition, top concentration, seller structure, new product share, price/rating/margin ranges, and many other criteria for discovering viable markets and evaluating product selection directions.

Walmart Marketplace Intelligence (5)

API	Purpose
Walmart Category Market API	Walmart Category Market public data API.
Walmart Keyword Research API	Walmart Keyword Research public data API.
Walmart Product Analysis API	Walmart Product Analysis public data API.
Walmart Product Detail API	Query Walmart product details via Nexscope, including pricing history and sales trends.
Walmart Search API	Search and browse Walmart product listings by keyword, category, price range, and other conditions.

Keyword & Search Demand (15)

API	Purpose
Amazon ASIN Keywords API	Use Nexscope data to reverse-lookup traffic keywords for any Amazon ASIN, including organic ranking, ad ranking, search volume, traffic share, organic/paid scores, ABA TOP3 click concentration, click conversion rate, year-over-year search volume changes, and weekly/monthly time windows.
Amazon Keyword Expansion API	Nexscope keyword expansion tool that expands a seed keyword into a list of related keywords with search volume, trends, PPC bids, ranking difficulty, and other metrics, covering 10 Amazon marketplaces including US, UK, DE, JP, etc.
Amazon Keyword Intelligence API	Query and analyze Amazon ABA (Brand Analytics) search term data, covering 15 marketplaces with nearly 3 years of weekly data.
Amazon Keyword Overview API	Nexscope overview analysis of Amazon keyword market competition.
Amazon Keyword Search History API	Nexscope keyword historical search volume query, returning Amazon keyword exact search volume trends in 7-day periods, covering 10 marketplaces including US, UK, DE, JP, etc.
Amazon Keyword Share Of Voice API	Nexscope keyword Share of Voice analysis, returning brand visibility share across the first 3 pages of Amazon search results (organic/ad/combined), 30-day exact search volume, median PPC bid, and TOP3 ASIN click and conversion data, covering 10 marketplaces.
Amazon Keyword Summary API	Break down all competitor ASIN traffic sources under a given keyword -- organic search, SP ads, SB brand ads, SBV video ads, SP recommendations, AC/ER/TR recommendation slots, with support for ASIN filtering, custom date ranges, and new traffic keyword filters.

TikTok / Social Commerce (54)

API	Purpose
Nexscope TikTok Product Search API	Nexscope TikTok Product Search with public market data.
Nexscope TikTok Product Detail API	Nexscope TikTok Product Detail with public market data.
Nexscope TikTok Shop Detail API	Nexscope TikTok Shop Detail with public market data.
Nexscope TikTok Creator Detail API	Nexscope TikTok Creator Detail with public market data.
Nexscope TikTok Product Related Creators API	Nexscope TikTok Product Related Creators with public market data.
Nexscope TikTok Product Related Lives API	Nexscope TikTok Product Related Lives with public market data.
Nexscope TikTok Product Reviews API	Nexscope TikTok Product Reviews with public market data.
Nexscope TikTok Product Related Videos API	Nexscope TikTok Product Related Videos with public market data.
Nexscope TikTok Shop Related Creators API	Nexscope TikTok Shop Related Creators with public market data.
Nexscope TikTok Shop Related Products API

Temu Marketplace Intelligence (11)

API	Purpose
Nexscope Temu Site List API	List Temu site records.
Nexscope Temu Category Research API	Category Research using Nexscope Temu data.
Nexscope Temu Keyword Research API	Keyword Research using Nexscope Temu data.
Nexscope Temu Product Search API	Product Search using Nexscope Temu data.
Nexscope Temu Product Detail API	Product Detail using Nexscope Temu data.
Nexscope Temu Shop Search API	Shop Search using Nexscope Temu data.
Nexscope Temu Image Search API	Image Search using Nexscope Temu data.
Nexscope Temu Category List API	List Temu category records.
Temu Category Search API	Search synced Temu category data in the local database by keyword to find category Chinese names, English names, and category IDs for use in product/store filtering.
Temu Product Source Query API	Filter Temu products by multiple dimensions (keyword/product ID/store ID, front/backend categories, price, rating, reviews, total/weekly/daily sales, listing date, fully-managed/semi-managed, semi-managed regions, tags, etc.).

1688 Sourcing (4)

API	Purpose
1688 Product Detail API	1688 Product Detail public data API.
1688 Product Billboard API	Query 1688 product bestseller billboard data for sourcing discovery and wholesale product research.
1688 Product Search API	Search and analyze products on the Chinese 1688 wholesale platform (Alibaba domestic B2B market) for sourcing, supplier discovery, and product selection.
1688 Search By Image API	Perform image-based product search on the 1688 platform. Use an image URL to find visually similar supplier products, returning title, price, minimum order quantity, monthly sales, repurchase rate, trade score, and seller identity.

Shopify Commerce (2)

API	Purpose
Shopify Product Query API	Filter Shopify standalone store products by multiple dimensions (keyword/URL, price, weekly sales, listing date, Facebook ads, competitiveness, supplier availability, shipping country, etc.).
Shopify Store Query API	Filter Shopify standalone stores by multiple dimensions (store name/domain, country, years since creation, product count, ad count, monthly visits, monthly orders, social media followers, etc.).

Etsy Marketplace (4)

API	Purpose
Etsy Product Detail API	Etsy Product Detail public data API.
Etsy Category Search API	Search Etsy category data by name, ID, or parent IDs to find category identifiers for product/store filtering.
Etsy Product Query API	Query Etsy products with multi-dimensional filters (keyword/URL, price, sales, favorites, reviews, listing date, category, handmade/vintage types, Pick/Bestseller/Raving tags).
Etsy Store Query API	Search Etsy stores using keyword, category, country, status, performance, and date filters.

Ozon Marketplace (10)

API	Purpose
Ozon Brand Products API	Nexscope Ozon Russia brand drill-down product list. Returns all products under an Ozon brand display name (Russian/Latin) with complete metrics: sales, revenue, price, rating, stock, turnover, lost revenue, supporting multi-dimensional numeric filters, sorting, and currency conversion. Use for brand benchmarking, competitor analysis, brand product structure research, SKU-level bestseller analysis.
Ozon Category Products API	Nexscope Ozon Russia category drill-down product list by Russian category path. Returns all products in a category with complete metrics: sales, revenue, price, rating, stock, turnover, lost revenue, supporting multi-dimensional numeric filters, sorting, and currency conversion. Use for category bestseller mining, blue-ocean insight discovery, category ranking analysis, brand landscape observation.
Ozon Category Search API	Nexscope Ozon category product search: fetches the product list for a given Ozon category ID, returning category-level aggregates (total sales, total revenue, average price, average rating, seasonality) and per-product sales, price, rating, review count, brand, seller, and fulfillment method. Use for category selection analysis, category bestseller mining, category capacity and price band analysis, seasonality assessment.
Ozon Product Detail API	Nexscope Ozon Russia SKU full detail query for one product ID per call, returning price, discount, Ozon Card price, rating, review count, stock, sales, revenue, revenue potential/lost revenue, listing date, images, and the complete product card.
Ozon Product Detail Search API	Nexscope Ozon product detail query: fetches the complete detail of a single Ozon product by SKU, returning title, price (RUB), rating, review count, QA count, total and daily average sales within the stats window, revenue, stock, category ranking, daily sales trend, brand, seller, fulfillment method (FBO/FBS/OZON), weight, and listing time/days/months. Use for single product deep analysis, competitor product teardown, Ozon product selection assessment, listing diagnosis, sales trend and category ranking tracking.

eBay Marketplace (1)

API	Purpose
eBay Search API	Search and browse product listings across multiple eBay international sites.

Shopee Marketplace (2)

API	Purpose
Shopee Product Detail API	Shopee Product Detail public data API.
Shopee Product Search API	YouYing Shopee product selection tool supporting product query and filtering across all Shopee marketplaces, covering Malaysia, Taiwan (China), Indonesia, Thailand, Philippines, Singapore, Vietnam, Brazil, Mexico, Chile, and Colombia.

Search & Trend Intelligence (3)

API	Purpose
Google AI Mode Search API	AI Overview (AI Mode) scraping via Google Search. Returns AI-summarized key points for a single keyword, ideal for deep research, technical Q&A, long-tail product selection, and cross-border consumer preference analysis using the latest web information. Single-round only; follow-ups require the agent to summarize context and issue a new request. Triggered by: Google AI, AI Overview, AI Mode, Google AI search, AI search, deep research, consumer preference analysis, web summary, long-tail product research, cross-border market insights.
Google Trends By Time API	Query and analyze Google Trends real-time hot topics and trending searches for a specified time range and country/region. Triggered by: Google Trends, hot topics, real-time trending, popular trends, current hot searches, recent trending, viral topics, trending searches, trend discovery, market trends, what's popular, trending now, breakout topics.
Web Search API	Web search, online retrieval, real-time information query, search engine search, Reddit and other community platform discussions, external site posts and trending topics.

AI Content Generation (1)

API	Purpose
Product Description Generator API	Create or query asynchronous product-description generation tasks.

Patent & IP Risk (23)

API	Purpose
Google Patent Search API	Google Patent Search public data API.
Product TRO Detection API	Assess product imagery for TRO, trademark, patent, and copyright infringement risk.
Patent Abstract Image Data API	Retrieves patent abstract images (drawings) from the Nexscope (Nexscope) patent database by patent ID or publication number.
Patent Cited By API	Retrieve patents that cite one or more Nexscope patents.
Patent Claims API	Retrieves patent claims data from Nexscope (Nexscope).
Patent Claims Translation API	Retrieves translated patent claims from the Nexscope (Nexscope) patent database.
Patent Core Bibliography API	Retrieve core bibliographic records for one or more patents.
Patent Description Data API	Retrieve patent description (specification) data from the Nexscope patent database by patent ID or publication number.
Patent Description Data Translation API	Retrieve translated patent description (specification) text from Nexscope.
Patent Detailed Bibliography API

Product & Market Research (2)

API	Purpose
Mercado Market Intelligence API	Mercado Market Intelligence public data API.
Mercado Product Selection API	Run one of 24 documented Mercado Libre product, category, trend, seller, review, rate, or usage tools.

Amazon Advertising (8)

API	Purpose
Amazon Ads SP Audience Report API	Amazon Ads SP Audience Report using an owned Amazon Ads connection.
Amazon Ads SP Search Impression Share Report API	Amazon Ads SP Search Impression Share Report using an owned Amazon Ads connection.
Amazon Ads SP Insights Report Status API	Amazon Ads SP Insights Report Status using an owned Amazon Ads connection.
Amazon Ads SP Insights Report Download API	Amazon Ads SP Insights Report Download using an owned Amazon Ads connection.
Amazon Ads Manager API	Run a catalogued Amazon Ads entity operation.
Amazon Ads API Access	Authorize Amazon Ads and inspect owned connections and profiles.
Amazon Ads Reporting API	Create, poll, and download governed Amazon Ads reports.
Amazon Advertising API	Run a catalogued Amazon Ads entity operation.

Patent Intelligence (1)

API	Purpose
Patent Search API	Search patent publications with an Analytics query expression.

Creative APIs — 53

Image Generation Models (7)

API	Purpose
Nano Banana Image Generation	Generate ecommerce images with the BANANA model.
Nano Banana Pro Image Generation	Generate ecommerce images with the BANANA_PRO model.
Nano Banana 2 Image Generation	Generate ecommerce images with the BANANA_2 model.
Nano Banana 2 Lite Image Generation	Generate ecommerce images with the BANANA_2_LITE model.
Wan 2.7 Image Generation	Generate ecommerce images with the WAN2_7 model.
Seedream 5 Pro Image Generation	Generate ecommerce images with the SEEDREAM5_PRO model.
GPT Image 2 Generation	Generate ecommerce images with the GPT_2_IMAGE model.

Video Generation Models (12)

API	Purpose
Seedance 2.0 Video Generation	Generate ecommerce videos with the seedance-2-0 model.
Seedance 2.0 Fast Video Generation	Generate ecommerce videos with the seedance-2-0-fast model.
Seedance 2.0 Mini Video Generation	Generate ecommerce videos with the seedance-2-0-mini model.
Seedance 2.5 Video Generation	Generate ecommerce videos with the seedance-2-5 model.
Kling 2.6 Video Generation	Generate ecommerce videos with the kling-v2-6 model.
Kling 3 Omni Video Generation	Generate ecommerce videos with the kling-v3-omni model.
Wan 2.6 Video Generation	Generate ecommerce videos with the wan-2-6 model.
Hailuo 2.3 Video Generation	Generate ecommerce videos with the hailuo-2-3 model.
Happy Horse 2 Video Generation	Generate ecommerce videos with the happyhorse-v2 model.
Wan 3 Video Generation	Generate ecommerce videos with the wan3 model.

Multimodal AI (34)

API	Purpose
AI Model Swap API	Swap an ecommerce product image onto a target model.
AI Model Swap API 2.0	Swap a product image onto a fixed model reference.
AI Model Scene & Background Replacement API	Place a model image into a new scene.
AI Clothes Changer API for Tops & Bottoms	Generate try-on images for separate upper and lower garments.
AI Suit Virtual Try-On API	Generate try-on images for one-piece outfits.
Virtual Try-On API	Place a product naturally onto a person or model image.
Product Replacement API	Replace a product region in an ecommerce image.
Product Scene Variations API	Create scene variations from an image.
AI Background Generator API	Generate an ecommerce scene image from a prompt.
Similar Image Variations API	Create similar image variations.
Background Remover API

Source, coverage, and validation

Snapshot: 2026-09-10, from the official API directory and its public definition service. Counts refer to documented API entries, not every supporting HTTP route. The complete 225-entry inventory is included; live documentation can change after this snapshot.

Some definitions use field descriptors rather than standard JSON Schema. Each format is labeled in the catalog. Published request and response samples are illustrative fixtures, not evidence of successful live calls. No authenticated or billable API requests were executed to prepare this repository. See source notes for the precise validation scope.

Run the offline consistency checks:

python3 scripts/validate_catalog.py
python3 -m unittest discover -s tests -v
node --check examples/javascript/run.mjs
bash -n examples/curl/run.sh

Contributing and license

For a documentation correction, include the API slug and relevant official documentation link. Never include API keys, account data, or private request logs.

Example code, validation scripts, tests, and workflow configuration are provided under the MIT terms in LICENSE. API documentation, catalog content, definitions, and sample data remain copyright Nexscope; no separate open-content license is granted here. API service use remains subject to Nexscope's applicable terms and account access requirements.