### Run an API - Example Request

Source: https://www.nexscope.ai/api-docs/data-amazon-ads-developer-proxy-amazon-ads-developer-proxy?returnTo=%2Fapi-docs%23api-data-amazon-ads-developer-proxy-amazon-ads-developer-proxy

Example curl command to POST to the developer proxy endpoint. Replace YOUR_API_KEY with your actual key before running.

```bash
curl -X POST 'https://api.nexscope.ai/amazonAds/developerProxy' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "{}",
  "contentType": "application/json",
  "method": "POST"
}'
```

--------------------------------

### curl Request Example

Source: https://www.nexscope.ai/api-docs/amazon-opportunity-search-by-metrics

Replace YOUR_API_KEY with your actual key, then run this command in your terminal. The request body includes example parameters.

```bash
curl -X POST 'https://api.nexscope.ai/amazon/opportunity/searchByMetrics' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "featureNewAvgReviewCountAtLeastLte": 500,
  "limit": 25,
  "nicheBrandCountLte": 20,
  "nicheSearchVolumeYoyChangePctAtLeastGte": 100
}'
```

--------------------------------

### curl Request Example

Source: https://www.nexscope.ai/api-docs/amazon-niche-reviews-by-keyword

Example curl command to call the getNicheReviewFromKeyword endpoint. Replace YOUR_API_KEY with your actual key before running.

```bash
curl -X POST 'https://api.nexscope.ai/jm/getNicheReviewFromKeyword' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "countryCode": "US",
  "keyword": "yoga mat",
  "pageSize": 20,
  "sortField": "unitsSoldT7",
  "sortType": "desc"
}'
```

--------------------------------

### curl request example

Source: https://www.nexscope.ai/api-docs/chuhaijiang-tiktok-shop-rankings-top-selling

Example curl command to call the top-selling endpoint. Replace YOUR_API_KEY with your actual key and adjust the JSON body as needed.

```bash
curl -X POST 'https://api.nexscope.ai/cj/sellers/rankings/top-selling' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "country": "us",
  "date": "20260824",
  "granularity": "daily",
  "page": 1,
  "pageSize": 10
}'
```

--------------------------------

### Request body for GET method

Source: https://www.nexscope.ai/api-docs/data-amazon-ads-developer-proxy-sd-ad-groups

Example request body for the API. It specifies the method as GET, content type as application/json, and an empty body.

```json
{
  "body": "{}",
  "contentType": "application/json",
  "method": "GET"
}
```

--------------------------------

### Example curl Request

Source: https://www.nexscope.ai/api-docs/amazon-market-product-detail

Replace YOUR_API_KEY with your actual key and run this command to call the product detail endpoint. The request body includes asin and marketplace parameters.

```bash
curl -X POST 'https://api.nexscope.ai/st/amazon/productDetail' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "B00FLYWNYQ",
  "marketplace": "us"
}'
```

--------------------------------

### curl request to GET /api/skill-api/v1/account/usage

Source: https://www.nexscope.ai/api-docs/account-usage

Sends a GET request with a bearer API key and optional query parameters for startTime, endTime, pageNum, and pageSize. The time values are UTC epoch milliseconds; the example uses 2026-04-28T20:26:40.000Z → 1777408000000 and 2026-05-28T20:26:40.000Z → 1780000000000.

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.nexscope.ai/api/skill-api/v1/account/usage?startTime=1777408000000&endTime=1780000000000&pageNum=1&pageSize=20"
```

--------------------------------

### Example curl Request

Source: https://www.nexscope.ai/api-docs/data-amazon-ads-developer-proxy-sd-targets-extended

Replace YOUR_API_KEY with your actual key and run this command to call the endpoint. The request body uses a JSON payload with method GET.

```bash
curl -X POST 'https://api.nexscope.ai/amazonAds/sd/targets/extended' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "{}",
  "contentType": "application/json",
  "method": "GET"
}'
```

--------------------------------

### Example curl Request

Source: https://www.nexscope.ai/api-docs/ozon-shop-search

Replace YOUR_API_KEY with your actual key and run this command to search Ozon shops. The request body includes an id and pagination parameters.

```bash
curl -X POST 'https://api.nexscope.ai/sr/ozon/shopSearch' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 1362816,
  "page": {
    "orders": [
      {
        "direction": "DESC",
        "field": "sales"
      }
    ],
    "page": 1,
    "pageSize": 20
  }
}'
```

--------------------------------

### Request body example for POST /amazonAds/reporting/reports/by-reportId

Source: https://www.nexscope.ai/api-docs/data-amazon-ads-developer-proxy-reporting-reports-report-id

JSON request body for the API. The body field contains a JSON string with reportTypeId set to 'spCampaigns'. The contentType is 'application/vnd.createasyncreportrequest.v3+json' and method is 'GET'.

```json
{
  "body": "{\"reportTypeId\":\"spCampaigns\"}",
  "contentType": "application/vnd.createasyncreportrequest.v3+json",
  "method": "GET"
}
```

--------------------------------

### Example curl request to /kd/shop/detail

Source: https://www.nexscope.ai/api-docs/tiktok-shop-analytics?returnTo=%2Fapi-docs%23api-tiktok-shop-analytics

Replace YOUR_API_KEY with your actual key, then run this command in your terminal. The request body includes currency, dateRange, region, and shopId.

```bash
curl -X POST 'https://api.nexscope.ai/kd/shop/detail' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "dateRange": "last7Day",
  "region": "US",
  "shopId": "7495514739648989419"
}'
```

--------------------------------

### Amazon Search API Request Example

Source: https://www.nexscope.ai/api-docs/amazon-search?returnTo=%2Fapi-docs%23api-featured-amazon-search

JSON payload for the Amazon Search API. Includes amazonDomain, keyword, and page parameters. The keyword should be in the target site language, and page starts from 1 with approximately 20 entries per page.

```json
{
  "amazonDomain": "amazon.com",
  "keyword": "wireless earbuds",
  "page": 1
}
```

--------------------------------

### Example curl request to POST /kp/productSeries

Source: https://www.nexscope.ai/api-docs/amazon-product-price-series?returnTo=%2Fapi-docs%23api-amazon-product-price-series

Example curl command to call the product series endpoint. Replace YOUR_API_KEY with a valid key. The request body includes ASIN, days, domain, and optional flags.

```bash
curl -X POST 'https://api.nexscope.ai/kp/productSeries' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "B0DFRJ7WSX",
  "days": 90,
  "domain": "1",
  "showBsrMain": 1,
  "showPrice": 1,
  "showSellerCount": 1
}'
```

--------------------------------

### Response example for GET /api/skill-api/v1/account/usage

Source: https://www.nexscope.ai/api-docs/account-usage

Shows the complete ResponseData envelope returned by the API. The cost field is processing time in milliseconds, not charged credits. The response includes a list of call records with details such as path, method, callResult, chargeStatus, and chargedCredit.

```json
{
  "code": 0,
  "msg": null,
  "data": {
    "scope": "API_KEY_CALLS",
    "observedAt": "1780000000000",
    "startTime": "1777408000000",
    "endTime": "1780000000000",
    "grossChargedCredit": "8",
    "calls": {
      "records": [
        {
          "id": "1",
          "createTime": "1779999999000",
          "apiKeyId": "2",
          "path": "/api/skill-api/v1/skills/example/run",
          "method": "POST",
          "callResult": "SUCCESS",
          "chargeStatus": "CHARGED",
          "chargedCredit": "8",
          "requestId": "example-request",
          "correlationRequestId": "example-diagnostic-id",
          "latencyMs": 120
        }
      ],
      "total": "1",
      "size": "20",
      "current": "1",
      "pages": "1"
    }
  },
  "ts": "1780000000000",
  "time": "2026-05-28 20:26:40",
  "cost": "13",
  "traceId": null
}
```

--------------------------------

### curl request to create a product description

Source: https://www.nexscope.ai/api-docs/product-description-generator

Run this command in your terminal after replacing YOUR_API_KEY. It sends a POST request to the /ai/productDescriptionGenerator endpoint with operation=create and a prompt for a wireless speaker.

```bash
curl -X POST 'https://api.nexscope.ai/ai/productDescriptionGenerator' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "imageUrls": [],
  "model": "GEM_3_FLASH",
  "operation": "create",
  "prompt": "Write a product description for a wireless speaker.",
  "thinkingLevel": "minimal"
}'
```

--------------------------------

### Request JSON for TikTok Video Reviews API

Source: https://www.nexscope.ai/api-docs/chuhaijiang-tiktok-video-reviews?returnTo=%2Fapi-docs%23api-chuhaijiang-tiktok-video-reviews&view=api

Example request body for the POST endpoint. Required fields are 'country' (lowercase country code) and 'id' (video ID as string). Optional fields 'page' (starting from 1) and 'pageSize' (max 10) are included.

```json
{
  "country": "us",
  "id": "6788833646091504902",
  "page": 1,
  "pageSize": 3
}
```

--------------------------------

### Request JSON for TikTok Video Detail API

Source: https://www.nexscope.ai/api-docs/chuhaijiang-tiktok-video-detail?returnTo=%2Fapi-docs%23api-chuhaijiang-tiktok-video-detail&view=api

Example request body for the TikTok Video Detail API. The 'country' parameter is a lowercase site code, 'id' is the video ID as a string, and 'include' is optional, set to 'core' to get standardized core performance fields.

```json
{
  "country": "us",
  "id": "6788833646091504902",
  "include": "core"
}
```

--------------------------------

### curl request example

Source: https://www.nexscope.ai/api-docs/tiktok-shop-product-detail?returnTo=%2Fapi-docs%23api-tiktok-shop-product-detail&view=api

Example curl command to call the product detail endpoint. Replace YOUR_API_KEY with your actual key. The request body includes productInput and region.

```bash
curl -X POST 'https://api.nexscope.ai/tiktok/shop/product/detail' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "productInput": "1729937400435937604",
  "region": "US"
}'
```

--------------------------------

### Example curl Request

Source: https://www.nexscope.ai/api-docs/ozon-keyword-back-search?returnTo=%2Fapi-docs%23api-ozon-keyword-back-search

POST request to the keywordBackSearch endpoint. Replace YOUR_API_KEY with your actual key. The request body includes pagination and skuIds.

```bash
curl -X POST 'https://api.nexscope.ai/sr/ozon/keywordBackSearch' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "hasVariant": 0,
  "page": {
    "orders": [
      {
        "direction": "DESC",
        "field": "searchVolume"
      }
    ],
    "page": 1,
    "pageSize": 5
  },
  "skuIds": [
    4380710124
  ]
}'
```

--------------------------------

### cURL request to get account credits

Source: https://www.nexscope.ai/api-docs/account-credits

Use this cURL command to call the Account Credits endpoint. Replace YOUR_API_KEY with a GENERAL user API key. The startTime and endTime parameters are optional UTC epoch milliseconds; the example uses 2026-04-28T20:26:40.000Z → 1777408000000 and 2026-05-28T20:26:40.000Z → 1780000000000.

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.nexscope.ai/api/skill-api/v1/account/credits?startTime=1777408000000&endTime=1780000000000"
```

--------------------------------

### Request JSON for Google Trends by Keywords

Source: https://www.nexscope.ai/api-docs/google-trends-by-keywords

Example request body for the POST /googleTrend/getTrendByKeys endpoint. The keyword must be in the target country/region language and max 100 characters; region is optional with values like US, GB, JP; dayRangeStart and dayRangeEnd use YYYY-MM-DD format starting in 2004.

```json
{
  "dayRangeEnd": "2025-01-01",
  "dayRangeStart": "2024-01-01",
  "keyword": "wireless charger",
  "region": "US"
}
```

--------------------------------

### Example curl Request

Source: https://www.nexscope.ai/api-docs/ai-hand-repair

Replace YOUR_API_KEY with your actual key, then run this command in your terminal to improve hand appearance in generated model or lifestyle images.

```bash
curl -X POST 'https://api.nexscope.ai/ai/handRepair' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "imageUrl": "https://example.com/model-reference.jpg",
  "maskUrl": "https://example.com/mask.png",
  "outputNum": 1,
  "personType": 2
}'
```

--------------------------------

### JSON payload example

Source: https://www.nexscope.ai/api-docs/seo-keyword-metrics?view=api

Example request body for the keyword metrics API, specifying keywords, language, and market.

```json
{ "keywords": [ "nexscope" ], "language": "en", "market": "US" }
```