Nexscope

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

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

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)

Walmart Marketplace Intelligence (5)

Keyword & Search Demand (15)

TikTok / Social Commerce (54)

Temu Marketplace Intelligence (11)

1688 Sourcing (4)

Shopify Commerce (2)

Etsy Marketplace (4)

Ozon Marketplace (10)

eBay Marketplace (1)

Shopee Marketplace (2)

Search & Trend Intelligence (3)

AI Content Generation (1)

Patent & IP Risk (23)

Product & Market Research (2)

Amazon Advertising (8)

Patent Intelligence (1)

Creative APIs — 53

Image Generation Models (7)

Video Generation Models (12)

Multimodal AI (34)

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.