Skip to main content

GET Strategies

Get live strategies for one account NT8​

Lists live NinjaScript strategies for one NinjaTrader account, including their current positions and state.

Endpoint​

GET /v1/api/accounts/{account}/strategies

Headers​

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

Path parameters​

NameTypeRequiredDescription
accountstringRequiredName of account in NT8

Query parameters​

NameTypeRequiredDescription
includeTerminalbooleanOptionalInclude terminal strategies. Defaults to false.

Code examples​

import requests

token = 'my-secret-token'

url = "https://app.crosstrade.io/v1/api/accounts/Sim101/strategies"
headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
}

try:
response = requests.get(url, headers=headers)
print(f"Response Code: {response.status_code}, Response Text: {response.text}")
except Exception as e:
print(f"An error occurred: {e}")

Response​

{
"strategies": [
{
"id": "334081921",
"account": "Sim101",
"strategyName": "ExampleStrategy",
"displayName": "ExampleStrategy",
"position": "Long",
"quantity": 1,
"averagePrice": 5804.75,
"unrealizedPnl": 0.0,
"className": "ExampleStrategy",
"fullName": "NinjaTrader.NinjaScript.Strategies.ExampleStrategy",
"assembly": "ExampleAssembly",
"hostMode": "account",
"isChartHosted": false,
"isHeadless": true,
"isAccountStrategyOnBars": false,
"isEnabled": true,
"isTerminal": false,
"state": "Realtime",
"instrumentName": "ES 12-26",
"accountDetail": {
"name": "Sim101",
"displayName": "Sim101",
"connection": "Simulation"
},
"instrument": {
"fullName": "ES 12-26",
"masterInstrument": "ES",
"instrumentType": "Future",
"exchange": "Globex",
"tickSize": 0.25,
"pointValue": 50
},
"barsPeriod": {
"type": "Minute",
"value": 5,
"value2": 1,
"baseType": "Minute",
"baseValue": 1,
"marketDataType": "Last"
},
"tradingHoursName": null,
"positionDetail": {
"marketPosition": "Long",
"quantity": 1,
"averagePrice": 5804.75,
"unrealizedPnl": 0,
"currency": 0,
"points": 0,
"percent": 0
},
"lifecycle": {
"state": "Realtime",
"isTerminal": false,
"isEnabled": true,
"calculate": "OnBarClose",
"startBehavior": "WaitUntilFlat",
"entriesPerDirection": 1,
"entryHandling": "AllEntries"
},
"runtime": {
"currentBar": 100,
"barsRequiredToTrade": 20,
"currentBars": [
100
],
"ordersCount": 1,
"activeOrderCount": 0
},
"chart": {
"hasChartControl": false,
"hasChartBars": false,
"hasChartPanel": false,
"chartControlType": null,
"chartBarsType": null,
"chartPanelType": null
},
"instruments": [
{
"fullName": "ES 12-26",
"masterInstrument": "ES",
"instrumentType": "Future",
"exchange": "Globex",
"tickSize": 0.25,
"pointValue": 50
}
],
"barsPeriods": [
{
"type": "Minute",
"value": 5,
"value2": 1,
"baseType": "Minute",
"baseValue": 1,
"marketDataType": "Last"
}
],
"parameters": {}
}
],
"count": 1,
"success": true
}

Success field types​

Fields below strategies[] describe each strategy. Parameter names are strategy-defined, not fixed API fields.

FieldTypeDescription
successbooleantrue on success.
countintegerStrategy count.
strategiesarray of objectsMay be empty.
strategies[].id, strategies[].account, strategies[].strategyName, strategies[].displayName, strategies[].className, strategies[].fullName, strategies[].assemblystringStrategy identity and runtime type.
strategies[].position, strategies[].hostMode, strategies[].state, strategies[].instrumentNamestringPosition side, host, lifecycle state and instrument.
strategies[].quantityintegerPosition size.
strategies[].averagePrice, strategies[].unrealizedPnlfloatEntry price and P/L.
strategies[].isTerminal, strategies[].isEnabled, strategies[].isChartHosted, strategies[].isHeadless, strategies[].isAccountStrategyOnBarsbooleanRuntime flags.
strategies[].tradingHoursNamenull in capturesNon-null variant not captured.
strategies[].accountDetailobjectname, displayName, connection: string.
strategies[].instrument, strategies[].instruments[]objectfullName, masterInstrument, instrumentType, exchange: string; tickSize, pointValue: float.
strategies[].instruments, strategies[].barsPeriodsarray of objectsInstrument and period collections.
strategies[].barsPeriod, strategies[].barsPeriods[]objecttype, baseType, marketDataType: string; value, value2, baseValue: integer.
strategies[].positionDetailobjectmarketPosition: string; quantity: integer; averagePrice, unrealizedPnl, currency, points, percent: float.
strategies[].lifecycleobjectstate, calculate, startBehavior, entryHandling: string; isTerminal, isEnabled: boolean; entriesPerDirection: integer.
strategies[].runtimeobjectcurrentBar, barsRequiredToTrade, ordersCount, activeOrderCount: integer; currentBars: array of integers.
strategies[].chartobjecthasChartControl, hasChartBars, hasChartPanel: boolean; chartControlType, chartBarsType, chartPanelType: null in captures.
strategies[].parametersobjectStrategy-defined keys; captured values include string, integer, float and boolean.

Platform nuances​

The hostMode and isChartHosted response fields distinguish chart-hosted strategies from account-hosted strategies.

WebSocket API​

This request can also be made over the WebSocket API. The account path parameter is passed inside args.

{
"action": "rpc",
"id": "my-request-id",
"api": "ListStrategies",
"args": {
"account": "Sim101",
"includeTerminal": false
}
}