Skip to content

List Strategies

List the Strategy RMS strategies owned by the supplied API key, newest first.

Endpoint URL

http
Local Host   :  POST http://127.0.0.1:5000/api/v1/strategy/list
Ngrok Domain :  POST https://<your-ngrok-domain>.ngrok-free.app/api/v1/strategy/list
Custom Domain:  POST https://<your-custom-domain>/api/v1/strategy/list

Sample API Request

json
{
  "apikey": "<your_app_apikey>",
  "status": "running",
  "q": "NIFTY"
}

Sample cURL Request

bash
curl -X POST http://127.0.0.1:5000/api/v1/strategy/list \
  -H 'Content-Type: application/json' \
  -d '{
  "apikey": "<your_app_apikey>",
  "status": "running",
  "q": "NIFTY"
}'

Sample API Response

json
{
  "status": "success",
  "data": [
    {
      "id": 7,
      "name": "NIFTY Short Straddle",
      "strategy_kind": "batch",
      "strategy_type": "intraday",
      "product": "NRML",
      "pricetype": "MARKET",
      "overall_sl_mtm": -5000.0,
      "overall_target_mtm": 8000.0,
      "live_enabled": false,
      "status": "running",
      "current_run_id": 42,
      "created_at": "2026-08-30T03:50:11.402118+00:00",
      "last_finalized_run": {
        "id": 41,
        "pnl_realized": 1250.0,
        "stopped_at": "2026-08-29T09:40:11.482913+00:00"
      }
    }
  ]
}

Request Body

ParameterDescriptionMandatory/OptionalDefault Value
apikeyYour Tradeboard API keyMandatory-
statusFilter: stopped, running, paused, or erroredOptionalnull
qCase-insensitive strategy-name substring, at most 100 charactersOptionalnull

Send null or omit status and q for no filter. An unsupported status or an undeclared request field returns HTTP 400.

Response Fields

FieldTypeDescription
statusstringsuccess or error
dataarrayOwned strategy configurations, newest first

Strategy Object Fields

FieldTypeDescription
idintegerUse as strategy_id on the other Strategy RMS endpoints
namestringStrategy name, unique for the owning user
strategy_kindstringbatch or signal
directionstringboth, long_only, or short_only; used by signal strategies
universe_tabstringweekly_monthly, monthly_only, stocks_fno, or mcx. The instrument universe the strategy was built from; it decides which segments its legs may use, and cash is offered on stocks_fno only
strategy_typestringintraday or positional
productstringConfigured product intent: CNC, NRML, or MIS
pricetypestringMARKET
overall_sl_mtmnumber or nullOverall MTM stop loss in rupees
overall_target_mtmnumber or nullOverall MTM target in rupees
live_enabledbooleanWhether a live batch start is allowed
webhook_lockedbooleanWhether public webhook delivery is blocked by the kill switch
statusstringstopped, running, paused, or errored
current_run_idinteger or nullCurrent run id, when one exists
created_at, updated_atstringISO 8601 UTC timestamps
last_finalized_runobject or nullMost recently finalised run: {id, pnl_realized, stopped_at}. For a stopped strategy, this is the durable final P&L; unrealised P&L is zero and must not be read from an earlier checkpoint

Notes

  • This list omits leg configuration. Call Strategy Status to read a strategy's legs and current run.
  • The product is an intent. The engine translates it for the venue; Order History reports the product actually sent.
  • The response never contains a webhook token. Only its digest is stored.
  • Only strategies owned by the API key are returned.
  • A checkpoint is a live mark only. Once a run stops, use last_finalized_run.pnl_realized as the final total rather than a pre-close checkpoint.

Back to: Strategy RMS API