Nexscope logo

Shopify Store Query API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector
Shopify Commerce

API overview

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.).

Try this API
Endpoint
https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run
MCP method
nexscope_shopify_store_query

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Missing or invalid API keys return an authentication error. Manage keys from .
POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run

Run an API

Request parameters documented by ecommerce.shopify-store-query.

Slugshopify-store-query
HeadersAuthorization: Bearer nk_...
Content-Type: application/json
Request bodyAPI-specific JSON object.
Response bodyDirect API response payload. No data/result wrapper is added.

Status codes

CodeDescription
200API executed successfully. Body is the direct response payload.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "keyword": "phone case",   "pageSize": 10,   "page": 1 }'
All categories/ Shopify Commerce
POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run

Run this API

Send a JSON request to execute this API and receive the direct response payload.

Open tester

Endpoint

MethodPOST
Pathhttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run
AuthBearer API key
Content-Typeapplication/json

Request body

NameTypeRequiredDescription
searchKeystringoptional
Store name or domain keyword
countrystringoptional
Country code (e.g., US, CN)
yearintegeroptional
Store creation year: 1=Last 1 year, 2=1~2 years, 3=2~3 years, 4=3+ years
Example: 1
productNumMinintegeroptional
Product count range start
Example: 1
productNumMaxintegeroptional
Product count range end
Example: 1
advertiseCountMinintegeroptional
Ad count range start
Example: 1
advertiseCountMaxintegeroptional
Ad count range end
Example: 1
monthlyVisitMinintegeroptional
Monthly visits range start
Example: 1
monthlyVisitMaxintegeroptional
Monthly visits range end
Example: 1
monthOrderMinintegeroptional
Monthly orders range start
Example: 1
monthOrderMaxintegeroptional
Monthly orders range end
Example: 1
sortByintegeroptional
Sort field: 0=Product count, 1=Category count, 2=Monthly visits, 3=FB followers, 4=Ins followers, 5=Ad count, 6=Relevance, 7=Monthly orders (default)
Example: 1
orderBystringoptional
Sort direction: desc (default) / asc
pageintegeroptional
Page number (starting from 1)
Example: 1
pageSizeintegeroptional
Results per page, max 100
Example: 1

Request example

{
  "keyword": "phone case",
  "pageSize": 10,
  "page": 1
}

Response body

Returns the documented upstream API response directly without an additional wrapper.

NameTypeRequiredDescription
totalintegeroptional
Number of results returned on this page
Example: 1
storeNumintegeroptional
Total number of matching stores (upstream store_num)
Example: 1
storesarrayoptional
Shopify store list
Example: []
columnsarrayoptional
Columns for rendering
Example: []
titlestringoptional
Title (Shopify Store Query)
sourceTypestringoptional
Source type: shopify
sourceToolstringoptional
Tool type: ehunt
typestringoptional
Render style: tableListWorkbenches
stores[].storeIdstringoptional
Store ID
Example: example-id
stores[].shopIdstringoptional
Shopify shop ID
Example: example-id
stores[].storeNamestringoptional
Store name
stores[].storeDomainstringoptional
Store domain
stores[].storeLinkstringoptional
Store link
stores[].countrystringoptional
Country
stores[].createdTimestringoptional
Creation time
stores[].productNumstringoptional
Product count
stores[].categoryNumstringoptional
Category count
stores[].categoriesstringoptional
Category list (elements contain id, name)
stores[].monthlyVisitstringoptional
Monthly visits (formatted)
stores[].monthOrderNumstringoptional
Monthly orders (formatted)
stores[].fbFollowersstringoptional
Facebook followers
stores[].insFollowersstringoptional
Instagram followers
stores[].advertiseCountstringoptional
Ad count
stores[].adLinkstringoptional
Ad library link
stores[].emailstringoptional
Contact email
stores[].facebookUrlstringoptional
Facebook page
Example: https://example.com/image.jpg
stores[].instagramUrlstringoptional
Instagram page
Example: https://example.com/image.jpg
stores[].socialLinksstringoptional
Social media links (Map)
stores[].globalRankstringoptional
Global rank
stores[].logostringoptional
Store logo URL
stores[].availableStatusstringoptional
Whether active: 1=Active
errcodeintegeroptional
Upstream status code returned by the provider.
errmsgstringoptional
Upstream status message returned by the provider.
codestringoptional
Provider-specific status code.
msgstringoptional
Provider-specific status message.
messagestringoptional
Provider-specific message.
costTokenintegeroptional
Token cost reported by the upstream provider.
costTimeintegeroptional
Execution time reported by the upstream provider.
pageintegeroptional
Current page returned by the upstream provider.
pageSizeintegeroptional
Page size returned by the upstream provider.
pageItemCountintegeroptional
Item count on the current page returned by the upstream provider.
totalPageintegeroptional
Total page count returned by the upstream provider.
dataSnapshotMonthstringoptional
Data snapshot month returned by the upstream provider.

Response example

Direct response payload. No extra wrapper is added.

{
  "total": 1,
  "storeNum": 1,
  "stores": [
    {
      "storeId": "example-id",
      "shopId": "example-id",
      "facebookUrl": "https://example.com/image.jpg",
      "instagramUrl": "https://example.com/image.jpg"
    }
  ],
  "columns": []
}

Responses

CodeDescription
200API executed successfully. Body is the direct response payload.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Related APIs

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp
POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_shopify_store_query",
    "arguments": {
      "keyword": "phone case",
      "pageSize": 10,
      "page": 1
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

Send a real request with the same contract shown in the reference.

Endpoint
https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run
MCP method
nexscope_shopify_store_query
cURL
curl -X POST \
  https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "phone case", "pageSize": 10, "page": 1 }'
Response
No response yet. Run the request to see the response here.