Home / API & Docs
// DEVELOPERS PREVIEW · EARLY ACCESS · PRO

The MarketScope API.

Run analyses, pull scores and verdicts, and stream Market Watch changes into your own tools. This is a design preview; endpoints may change before release.

Quick start

Authenticate with a bearer token from your workspace settings, then create an analysis.

# Create an analysis (preview)
curl -X POST https://api.marketscope.example/v1/analyses \
  -H "Authorization: Bearer $MS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product": "wireless earbuds",
    "market": "US",
    "sources": ["google_shopping", "google_search"]
  }'

Response

{
  "id": "ana_8f2k1x",
  "status": "completed",
  "credits_used": 3,
  "scores": {
    "demand": 81, "competition": 64,
    "saturation": 52, "opportunity": 74
  },
  "verdict": "BUY",
  "confidence": "high",
  "advisor": { "summary": "Strong demand; gap in the $30–40 band…" }
}

Example response with illustrative data. api.marketscope.example is a placeholder host.

Endpoints

POST/v1/analysesRun a new analysis
GET/v1/analyses/{id}Get scores & verdict
GET/v1/analyses/{id}/competitorsCompetitor table
GET/v1/markets/{id}/historyTerminal time series
POST/v1/watchlistAdd to Market Watch
GET/v1/walletCredit balance & usage

Webhooks

Receive watch.score_changed and watch.verdict_changed events.

Rate limits

Per-key limits will be published with the release.

Credits

API calls that run analyses use the same credits as the app.

Early access

Ask to join the API preview group.