Strategy detail

Description

Query details of a currently available strategy by ValueScan strategy ID, including strategy info, trading symbols, performance metrics, risk analysis, and version information.

Endpoint

• Method: GET
• Path: /open/v1/strategy/detail

Credits

• Cost: 1

Request parameters

Parameters are passed via Query String and must participate in signing according to the GET request rules in the authentication documentation.

Field	Type	Required	Description
strategyId	long	Yes	ValueScan strategy ID; obtainable from the id field in the strategy list endpoint
language	string	No	Response content language; supports zh-CN, zh-TW, en-US, vi-VN, ja-JP, ko-KR; default zh-CN; returns 70005 when content for the requested language is temporarily unavailable; returns 40002 for unsupported values

Request example

curl --location 'https://api.valuescan.ai/api/open/v1/strategy/detail?strategyId=1001&language=zh-CN' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx'

Response fields

Field	Type	Description
strategy	object	Basic strategy info, including id, name, description, riskLabel, marketType, performance and signal status
summary	object	Strategy summary, including trading symbols, leverage, running days, return metrics, and NAV trend
version	object	Current version details
calculatedMetrics	object	Platform-calculated metrics, including source, pointCount, totalReturn, maxDrawdown
analytics	object	Analysis results generated from strategy NAV data
performanceSegments	object	Performance metrics by phase, including backtest and live phase data
riskScope	object	Risk scope, including trading symbols, max leverage, backtest window, historical max drawdown, cost model, and fee basis
simulation	object	Strategy run overview, including run status, start time, and latest confirmed NAV
symbols	array	Strategy trading symbol binding info

Main fields of version:

Field	Type	Description
id	long	Current version record ID
version	string	Strategy version number
marketType	string	Market type
navKind	string	NAV type
feeBasis	string	Fee basis
maxLeverage	number	Maximum leverage
avgLeverage	number	Average leverage
failureModes	string	Failure scenario description
remark	string	Remarks
changelog	array/object	Version change log
ruleSpec	string	Strategy rule description
costModel	object	Cost model
selfStats	object	Strategy statistics
selfMetrics	object	Strategy metrics

Fields in each item of symbols:

Field	Type	Description
symbol	string	Strategy trading pair symbol
vsTokenId	long	ValueScan token ID
vsTokenSymbol	string	ValueScan token symbol
vsTokenName	string	ValueScan token name
vsTokenIcon	string	ValueScan token icon
exchange	string	Exchange
marketType	string	Market type
productType	string	Product type
exchangeSymbol	string	Exchange trading pair symbol
settleCoin	string	Settlement currency
contractSize	number	Contract size; may be null

Success response example

{
  "code": 200,
  "message": "success",
  "data": {
    "strategy": {
      "id": 1001,
      "name": "BTC Trend Strategy",
      "description": "Trend-following strategy for BTC perpetual futures.",
      "riskLabel": "medium",
      "marketType": "perpetual"
    },
    "summary": {
      "id": 1001,
      "tokens": [{"vsTokenId": 1, "symbol": "BTC", "name": "Bitcoin"}],
      "maxLeverage": 3,
      "backtestCagr": 0.25
    },
    "version": {
      "id": 2001,
      "version": "1.0.0",
      "marketType": "perpetual",
      "navKind": "backtest",
      "maxLeverage": 3
    },
    "calculatedMetrics": {
      "source": "valuescan_recalculated",
      "pointCount": 365,
      "totalReturn": 0.31,
      "maxDrawdown": 0.12
    },
    "analytics": {},
    "performanceSegments": {},
    "riskScope": {},
    "simulation": {},
    "symbols": []
  },
  "requestId": "xxx-xxx-xxx"
}

Error codes

Code	Description
40001	Missing strategyId
40002	Invalid strategyId parameter
50001	The requested endpoint does not exist or is currently unavailable
60001	Rate limit exceeded
70001	Insufficient OpenAPI credits
70002	OpenAPI access for the current user has been disabled
70004	Strategy does not exist or is currently unavailable
70005	Strategy content for the requested language is temporarily unavailable