Nexscope
Back to API directory

API Guide

Use Nexscope data and AI tools in your own app.

An API lets your own app ask Nexscope for product data, keyword research, or AI content. Your developer can connect it once, so you do not have to copy results by hand.

Want your AI assistant to use Nexscope? Open the MCP Guide →

Step 1

Choose what you want to do

For example: find Amazon products or read customer reviews. Choose a tool, then check which product, keyword, or marketplace it needs.

Find a tool →

Example: Amazon Search API. You can choose a different tool for your task.

Step 2

Get an API key

This is your app's access key to Nexscope. Sign in to create one, then store it in your app's private settings. Treat it like a password.

Step 3

Try one task

Ask your developer to connect the tool and try it with your inputs. Start with one small task and check its credit cost before running it.

For developers: request example

Replace YOUR_API_KEY and the sample inputs. Keep the key on your server, outside browser code and public repositories.

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/api/skill-api/v1/skills/amazon-search/run' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "phone case",
  "page": 1
}'
Step 4

Check the result

Check that the result matches the product, keyword, or content you asked for. For image and video tasks, check the existing task before starting it again.

See the example tool's details →

For developers: reading the response

Results use JSON. Check both the HTTP status and the API’s business status; HTTP 200 alone does not mean the task succeeded. For image and video tasks, use the returned task ID to retrieve the final result.

For run and task-result requests, send X-Nexscope-Http-Status: semantic to receive HTTP error statuses while keeping the same JSON envelope. Existing v1 calls without this header retain their current status behavior. Check code in both modes; asynchronous acceptance is not completion.

The cost field is elapsed milliseconds, not charged credits. Data API execution costs at least 10 credits, including the Amazon Product Research directory.

Download OpenAPI 3.1 specification →
{
  "code": 0,
  "cost": "-1",
  "data": {
    "columns": [],
    "costToken": 1,
    "keyword": "phone case",
    "products": [
      {
        "asin": "B072MQ5BRX",
        "asinUrl": "https://www.amazon.com/dp/B072MQ5BRX",
        "availableDate": "2026-01-01",
        "extractedOldPrice": 1,
        "extractedPrice": 1,
        "extractedPriceUnit": 1,
        "imageUrl": "https://example.com/image.jpg",
        "keyword": "phone case",
        "monthlySalesUnits": 1,
        "oldPrice": 1,
        "position": 1,
        "price": 1,
        "rating": 1,
        "ratings": 1,
        "snapEbtEligible": false,
        "sponsored": false
      }
    ],
    "total": 1
  },
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": null,
  "ts": "0"
}

Something not working?

Check your API key, required inputs, and available credits. If you need your developer's help, share the tool name and error message—not your key.

For developers: error codes

CodeMeaning
200HTTP request completed. Check JSON code: only 0 indicates business success or acceptance; inspect data.status for asynchronous completion.
401API key is missing, invalid, or cannot be matched to a user.
403The account is authenticated but does not have access to the requested API or resource.
429The request was rate limited. Back off before retrying.
5xxThe API service or an upstream dependency failed.

What does it cost?

Costs depend on the tool and task. Check pricing before you run it.

View pricing →

For developers: balance and usage APIs

API Quickstart Guide use cases

Send a first request

A developer follows the guide to create an API key and send a first server-side request. The request and response examples show how to inspect the returned JSON before building an integration.

Prepare an app integration

An app team reads the published schemas and authentication instructions before implementing a connection. The team uses the guide to identify the required request fields and a suitable API reference.

Share an integration checklist

A technical lead shares the guide with developers joining an integration project. The team can follow the same authentication and response checks while choosing the individual APIs for its workflow.

API Quickstart Guide FAQ

How do I start using the Nexscope API?

Create an API key, choose an API from the directory, and send the documented request from your server. The guide provides authentication instructions and JSON examples for reviewing the result. Open the individual API reference for its required inputs, response fields and current credit cost before integrating it into your app.

Where can I find request and response examples?

The API integration and Parameters & response sections of each API reference contain the published examples and schemas. Use the guide to understand the shared authentication and response checks, then read the reference for your chosen operation. The guide examples are illustrative and do not represent a live result from your account.

Can I connect Nexscope through an MCP client?

Nexscope also provides an MCP guide for connecting compatible AI clients. Follow its setup instructions and consult the selected tool reference for the accepted inputs. Individual APIs can have different capabilities and credit costs, so review their documentation before making calls. Keep your API credentials private when sharing an integration example.

View plans and credits

Related APIs