Skip to content

Collective2 General API (v4)

📖 For full documentation, see the Collective2 API Documentation.

Download OpenAPI description
Languages
Servers
https://api4-general.collective2.com

APIGateway

Schemas

Schemas

StrategyBasicDetailsDTO

Idinteger(int64)

Same value as StrategyId

StrategyIdinteger(int64)

The C2 SystemID

IsAliveboolean

TRUE if the Strategy is alive

IsPrivateboolean or null

TRUE if the Strategy is a test or private strategy

StrategyNamestring or null

The Strategy Name

StartDatestring or null(date-time)

UTC Date of when the Strategy was created

SecurityTypesEnabledobject or null

List of all SecurityTypes enabled for trading in the strategy

MonthlyCostnumber or null(double)

Cost of Strategy lease per month

StrategyOwnerIdinteger or null(int64)

The Strategy Owner's PersonId

WhiteLabelSiteIdinteger or null(int64)

The Strategy Owner's White Label Site Id

{ "Id": 0, "StrategyId": 0, "IsAlive": true, "IsPrivate": true, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": { "property1": true, "property2": true }, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "WhiteLabelSiteId": 0 }

StrategyDetailsDTO

StrategyIdinteger(int64)

The C2 strategyID

StrategyNamestring or null

The Strategy Name

IsAliveboolean

TRUE if the Strategy is alive

StartDatestring or null(date-time)

UTC Date of when the Strategy was created

PrimarySecurityTypesstring or null

Primary asset class traded e.g. Stocks, Options, Forex, Futures

SecurityTypesEnabledobject or null

List of all SecurityTypes enabled for trading in the strategy

MonthlyCostnumber or null(double)

Cost of Strategy lease per month

StrategyOwnerIdinteger or null(int64)

The Strategy Owner's PersonId

StrategyOwnerNamestring or null

The Strategy Owner's name

SuggestedCapitalinteger or null(int32)

The suggested capital to invest in the Strategy

LastModifiedstring or null(date-time)

UTC Date of when the Strategy was last modified

Scoreinteger or null(int32)

The C2 score

IsTradeOwnSystemboolean or null

TRUE if Strategy owner Trades his Own Strategy

WhiteLabelSiteIdinteger or null(int64)

The WhiteLabel SiteId, if any

IsPrivateboolean or null

TRUE if Strategy is private

AUMinteger or null(int32)

The total USD assets under management

AUM_NumberOfAccountsinteger or null(int32)

The number of accounts used in the AUM calculation

Returnnumber or null(double)

The total Strategy return

ReturnLabelstring or null

The total Strategy return label which explains the Return calculation

Equitynumber or null(double)

The current open profits (or open losses) in the positions the strategy is currently holding

Cashnumber or null(double)

The current strategy cash

StartingCashnumber or null(double)

The starting strategy cash

ProfitFactornumber or null(double)

The win/loss ratio

CashDividendsnumber or null(double)

The strategy's total cash dividends

BuyingPowernumber or null(double)

The strategy's remaining Buying Power

MarginUsednumber or null(double)

The amount of collateral the strategy needs to put up to hold the positions it holds. For futures, this is specified per contract by the exchange; for stocks it's the standard margin formula

AgeInDaysinteger or null(int32)

Number of days the Strategy traded

ModelAccountValuenumber or null(double)

The current strategy account value

NumTradesinteger or null(int32)

The number of executed signals

NumWinnersinteger or null(int32)

The number of winning signals

NumLosersinteger or null(int32)

The number of losing signals

PercentWinTradesnumber or null(double)

% of winning trades

SumDollarWinnersnumber or null(double)

Total USD of winning trades

SumDollarLosersnumber or null(double)

Total USD of losing trades

NumMonthsinteger or null(int32)

The total number of months for the strategy

WinMonthsInUIinteger or null(int32)

The number of profitable months as shown on the C2 UI

WinMonthsnumber or null(double)

The number of profitable months

WinMonthsRationumber or null(double)

The ratio of winning months

MaxDrawdownnumber or null(double)

The % of maximum peak-to-valley historical drawdown

MaxDrawdownDaysnumber or null(double)

The number of days of the maximum peak-to-valley historical drawdown

MaxDrawdownStartDatestring or null

The maximum drawdown start date YYYYMMDD

MaxDrawdownEndDatestring or null

The maximum drawdown end date YYYYMMDD

AvgWinDollarsnumber or null(double)

The average Strategy winning trade in dollars

AvgLossDollarsnumber or null(double)

The average Strategy losing trade in dollars

AvgTradeDurationnumber or null(double)

The average number of trading days that a position is held

CorrelationSP500number or null(double)

The Correlation to the S&P 500 during strategy life

SP500Returnnumber or null(double)

The cumulative % return of the SP500 during strategy life

ReturnVsSP500number or null(double)

The % return of the strategy - Return of SP500 % (cumulative)

AvgLeveragenumber or null(double)

The average leverage used by the Strategy

MaxLeveragenumber or null(double)

The max leverage used by the Strategy

CorrelationToSP500number or null(double)

The strategy correlation to the SP500

Alphanumber or null(double)

The Alpha ratio

Betanumber or null(double)

The Beta ratio

Treynornumber or null(double)

The Treynor ratio

Sortinonumber or null(double)

The Sortino ratio

Sharpenumber or null(double)

The Sharpe ratio tells us whether a portfolio's returns are due to smart investment decisions or a result of excess risk

Calmarnumber or null(double)

The Calmar ratio

{ "StrategyId": 0, "StrategyName": "string", "IsAlive": true, "StartDate": "2019-08-24T14:15:22Z", "PrimarySecurityTypes": "string", "SecurityTypesEnabled": { "property1": true, "property2": true }, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "StrategyOwnerName": "string", "SuggestedCapital": 0, "LastModified": "2019-08-24T14:15:22Z", "Score": 0, "IsTradeOwnSystem": true, "WhiteLabelSiteId": 0, "IsPrivate": true, "AUM": 0, "AUM_NumberOfAccounts": 0, "Return": 0.1, "ReturnLabel": "string", "Equity": 0.1, "Cash": 0.1, "StartingCash": 0.1, "ProfitFactor": 0.1, "CashDividends": 0.1, "BuyingPower": 0.1, "MarginUsed": 0.1, "AgeInDays": 0, "ModelAccountValue": 0.1, "NumTrades": 0, "NumWinners": 0, "NumLosers": 0, "PercentWinTrades": 0.1, "SumDollarWinners": 0.1, "SumDollarLosers": 0.1, "NumMonths": 0, "WinMonthsInUI": 0, "WinMonths": 0.1, "WinMonthsRatio": 0.1, "MaxDrawdown": 0.1, "MaxDrawdownDays": 0.1, "MaxDrawdownStartDate": "string", "MaxDrawdownEndDate": "string", "AvgWinDollars": 0.1, "AvgLossDollars": 0.1, "AvgTradeDuration": 0.1, "CorrelationSP500": 0.1, "SP500Return": 0.1, "ReturnVsSP500": 0.1, "AvgLeverage": 0.1, "MaxLeverage": 0.1, "CorrelationToSP500": 0.1, "Alpha": 0.1, "Beta": 0.1, "Treynor": 0.1, "Sortino": 0.1, "Sharpe": 0.1, "Calmar": 0.1 }

StrategyHistoricalEquityDTO

StrategyIdinteger(int64)

The C2 strategyID

StrategyNamestring or null

The Strategy Name

StartDatestring or null(date-time)

UTC Date of when the Strategy was created

SecurityTypesEnabledobject or null

List of all SecurityTypes enabled for trading in the strategy

MonthlyCostnumber or null(double)

Cost of Strategy lease per month

StrategyOwnerIdinteger or null(int64)

The Strategy Owner's PersonId

MonthlyResultsArray of objects or null(StrategyMonthlyResultsDTO)

Monthly and Yearly stats for the strategy

{ "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": { "property1": true, "property2": true }, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "MonthlyResults": [ { "Month": 0, "MonthName": "string", "Year": 0, "Return": 0.1, "IsAnnual": true } ] }

GetAutotradedStrategies

Request

Request the Autotraded strategies of the person. Paginated endpoint.

Query
PersonIdinteger or null(int64)required

PersonId

Accountstring

The Autotrade account (optional)

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetAutotradedStrategies?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AutotradedStrategyDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "Account": "string", "ScalingPercentage": 0.1, "StrategyId": 0, "StrategyName": "string", "BrokerId": 0, "BrokerName": "string", "StartDate": "2019-08-24T14:15:22Z", "LastModified": "2019-08-24T14:15:22Z" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAutotraders

Request

A list of Autotraders. Paginated endpoint.

Query
StrategyIdinteger or null(int64)

(Optional) StrategyId filter

BrokerIdinteger or null(int32)

(optional) The Autotrade BrokerId

WhiteLabelSiteIdinteger or null(int64)

(optional) The White Label Site Id

curl -i -X GET \
  https://api4-general.collective2.com/Autotrade/GetAutotraders

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AutotradedStrategyDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "Account": "string", "ScalingPercentage": 0.1, "StrategyId": 0, "StrategyName": "string", "BrokerId": 0, "BrokerName": "string", "StartDate": "2019-08-24T14:15:22Z", "LastModified": "2019-08-24T14:15:22Z" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAutotradeSettings

Request

The Autotrade Settings. Non-paginated endpoint.

Query
PersonIdinteger or null(int64)required

PersonId

Accountstring

(Optional) Account

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetAutotradeSettings?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AutotradeSettingsDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "Country": "string", "State": "string", "Language": "string", "SiteDomain": "string", "BrokerId": 0, "Connection": "string", "IntroducingBrokerId": 0, "IntroducingBroker": "string", "StrategyId": 0, "StrategyName": "string", "Account": "string", "AccountType": 0, "BrokerUserID": "string", "Currency": "string", "SalesRepId": 0, "SalesRep": "string", "IsTradeLeader": true, "IsManualDiscardedPosition": true, "IgnoreManualOrders": true, "IsConfirmationNeeded": true, "IsSyncEnabled": true, "WillSyncToOpenStocksUSA": true, "WillSyncToOpenStocksEurope": true, "WillSyncToOpenOptionsUSA": true, "WillSyncToOpenOptionsEurope": true, "WillSyncToOpenFuturesUSA": true, "WillSyncToOpenFuturesEurope": true, "WillSyncToOpenFuturesAsia": true, "WillSyncToOpenForex": true, "LastSyncStocksUSA": "2019-08-24T14:15:22Z", "LastSyncStocksEurope": "2019-08-24T14:15:22Z", "LastSyncOptionsUSA": "2019-08-24T14:15:22Z", "LastSyncOptionsEurope": "2019-08-24T14:15:22Z", "LastSyncFuturesUSA": "2019-08-24T14:15:22Z", "LastSyncFuturesEurope": "2019-08-24T14:15:22Z", "LastSyncFuturesAsia": "2019-08-24T14:15:22Z", "LastSyncForex": "2019-08-24T14:15:22Z", "IsBrokerEnabled": true, "IsAutotradeDisabled": true, "IsAutotradeDisabledReason": "string", "SyncDisabledReason": "string", "FirstBrokerActivationDate": "2019-08-24T14:15:22Z", "NetLiquidationValue": 0.1, "NetLiquidationValueDate": "2019-08-24T14:15:22Z", "VirtualLimitOrdersEnabled": true, "ScalingPercentage": 0.1, "SettingsLastUpdateUTC": "2019-08-24T14:15:22Z", "Approved": true, "ClosingOrdersOnly": true, "EnabledFutures": true, "FuturesLong": true, "FuturesShort": true, "MinFutures": 0, "MaxFutures": 0, "EnabledForex": true, "ForexEnabledLong": true, "ForexEnabledShort": true, "ForexLotSize": 0, "MinForex": 0, "MaxForex": 0, "EnabledStocks": true, "StocksLong": true, "StocksShort": true, "MaxStocksDollars": 0, "TradeStocksAsCFD": true, "EnabledOptions": true, "OptionsLong": true, "OptionsShort": true, "MinOptions": 0, "MaxOptions": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SetAutotradeSettings

Request

Enable or disable Autotrade or Autosync in the specified account.

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

BrokerIdinteger or null(int32)

The C2 PersonID

IsAutotradeEnabledboolean or null

Set to TRUE if you want to enable the account for Autotrade. The StartAutotrade endpoint will automatically enable this setting. It may be disabled if your account is delinked by the broker, or if we detect rare unexpected activity in your account such as a margin call, pattern day trader, account becomes restricted by the broker, etc.

IsAutoSyncEnabledboolean or null

Set to TRUE if you want to enable or disable AutoSync for the account. AutoSync automatically gets disabled whenever an external (i.e. non-C2) order is executed in the account.

curl -i -X PUT \
  https://api4-general.collective2.com/Autotrade/SetAutotradeSettings \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of booleans or null

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetDashBoard

Request

Request the Person's Autotraded strategies and a performance summary. Non-paginated endpoint.

Query
PersonIdinteger or null(int64)required

PersonId

Accountstringrequired

The brokerage Account

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetDashBoard?PersonId=0&Account=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(DashBoardItemDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "PersonId": 0, "BrokerName": "string", "Account": "string", "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "TodayReturn": 0.1, "TotalReturn": 0.1 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SearchAccounts

Request

Request a list of Autotrade and Papertrade accounts. Partial matches will be returned. Paginated endpoint. Only visible to the account owner or White-label site owner

Query
Accountstring

The Autotrade account (optional)

PersonIdinteger or null(int64)

PersonId (optional)

BrokerIdinteger or null(int32)

The Autotrade BrokerId (optional)

FirstNamestring

The FirstName (optional). Not case-sensitive

LastNamestring

The FirstName (optional). Not case-sensitive

Emailstring

The Email (optional)

WhiteLabelSiteIdinteger or null(int64)

The White Label site Id (optional)

CountryCodestring

The person's country code. Not case-sensitive (optional)

IPAddressstring

The person's last known IP address (optional)

Phonestring

The Phone number (optional)

curl -i -X GET \
  https://api4-general.collective2.com/Autotrade/SearchAccounts

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AccountDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "Account": "string", "BrokerName": "string", "BrokerId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "Language": "string", "WhiteLabelSiteId": 0, "GeoSite": "string", "CountryCode": "string", "DivisionCode": "string", "AuthenticatedDate": "2019-08-24T14:15:22Z" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAutotradeActiveOrders

Request

Request the Working orders of the Account. Non-paginated endpoint.

Query
Accountstringrequired

The Brokerage Account

PersonIdinteger or null(int64)required

The PersonId owning the account

StrategyIdinteger or null(int64)

(Optional) StrategyId filter

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetAutotradeActiveOrders?Account=string&PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(OrderStatusDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "OrderId": "string", "StrategyId": 0, "StrategyName": "string", "SignalId": 0, "AvgPx": 0.1, "OrderType": "1", "Side": "1", "OpenClose": "O", "OrderQuantity": 0.1, "Limit": 0.1, "Stop": 0.1, "TIF": "0", "ProfitTarget": 0.1, "StopLoss": 0.1, "DoNotCreateOCAGroup": true, "CancelReplaceSignalId": 0, "ParentSignalId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z", "DoNotSyncToOpen": true, "C2Symbol": {}, "ExchangeSymbol": {}, "RejectMessage": "string", "BrokerId": 0, "OrderStatus": "string", "FilledQuantity": 0.1, "AvgFillPrice": 0.1, "PostedDate": "2019-08-24T14:15:22Z", "SignalType": 0, "Info": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAutotradeHistoricalOrders

Request

Request the historical orders of the Account. Paginated endpoint.

Query
Accountstringrequired

Brokerage Account filter

PersonIdinteger or null(int64)required

The PersonId owning the account

BrokerIdinteger or null(int32)

BrokerId (Optional)

StrategyIdinteger or null(int64)

StrategyId (Optional)

OrderStatusstring

'A' = PendingNew, '0' = Working, '1' = Partially filled, '2' = Filled, '4' = Canceled, '5' = Replaced, '6' = Pending Cancel, '8' = Rejected, 'C' = Expired, 'E' = Pending Replace (Optional)

StartDatestring or null(date-time)

StartDate (Optional)

EndDatestring or null(date-time)

EndDate (Optional)

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetAutotradeHistoricalOrders?Account=string&PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(OrderStatusDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "OrderId": "string", "StrategyId": 0, "StrategyName": "string", "SignalId": 0, "AvgPx": 0.1, "OrderType": "1", "Side": "1", "OpenClose": "O", "OrderQuantity": 0.1, "Limit": 0.1, "Stop": 0.1, "TIF": "0", "ProfitTarget": 0.1, "StopLoss": 0.1, "DoNotCreateOCAGroup": true, "CancelReplaceSignalId": 0, "ParentSignalId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z", "DoNotSyncToOpen": true, "C2Symbol": {}, "ExchangeSymbol": {}, "RejectMessage": "string", "BrokerId": 0, "OrderStatus": "string", "FilledQuantity": 0.1, "AvgFillPrice": 0.1, "PostedDate": "2019-08-24T14:15:22Z", "SignalType": 0, "Info": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAutoTradeOpenPositions

Request

Request the open positions of the Account. Non-paginated endpoint.

Query
Accountstringrequired

Brokerage Account filter

StrategyIdinteger or null(int64)

(Optional) StrategyId filter

curl -i -X GET \
  'https://api4-general.collective2.com/Autotrade/GetAutoTradeOpenPositions?Account=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(PositionDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "Quantity": 0.1, "AvgPx": 0.1, "C2Symbol": {}, "ExchangeSymbol": {}, "StrategyName": "string", "Currency": "string", "OpenedDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

NewAutotradeOrder

Request

Send a new closing order to the specified account. Only Stop and Limit OrderTypes are supported. Non-paginated endpoint.

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

Orderobject(OrderDTO)
curl -i -X POST \
  https://api4-general.collective2.com/Autotrade/NewAutotradeOrder \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

CancelAutotradeOrder

Request

Cancel an order in the specified account. Auto Stop-Loss orders are not currently supported. Non-paginated endpoint.

Query
Accountstringrequired

The Autotrade account

PersonIdinteger or null(int64)required

The C2 PersonID

OrderIdstringrequired

The OrderID to be cancelled

curl -i -X DELETE \
  'https://api4-general.collective2.com/Autotrade/CancelAutotradeOrder?Account=string&PersonId=0&OrderId=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

ReplaceAutotradeOrder

Request

Cancel/Replace an open closing order in the specified account. Only strategy and manual exit orders are currently supported.

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

OrderIdstring or null

The OrderID to be replaced

Pricenumber or null(double)

The new Order price

curl -i -X PUT \
  https://api4-general.collective2.com/Autotrade/ReplaceAutotradeOrder \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetBrokers

Request

Get a list of Autotrade brokers. Non-Paginated endpoint.

Query
IncludeDisabledboolean or null

Include the disabled brokers. Default is FALSE. (optional)

curl -i -X GET \
  https://api4-general.collective2.com/Autotrade/GetBrokers

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(BrokerDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "Name": "string", "IsEnabled": true, "ConnectionName": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

StartAutotrade

Request

Start or modify an Autotrade setup. Non-paginated endpoint.

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

BrokerIdinteger or null(int32)

The BrokerId

StrategyIdinteger or null(int64)

The StrategyId

ScalingPercentageinteger(int64)

The Autotrade Scaling factor. e.g. Enter 105 for 105%

FuturesEnabledboolean

(optional) TRUE to enable the Futures asset class when autotrading this strategy. Default is FALSE

Default false
MaxFuturesinteger or null(int32)

(optional) Set a maximum number of contracts to hold in a position for this strategy

ForexEnabledboolean

(optional) TRUE to enable autotrading Forex for this strategy. Default is FALSE

Default false
MaxForexinteger or null(int32)

(optional) Set a maximum number of units (each unit on C2 is 1000 currency units) to hold in a position for this strategy

StocksEnabledboolean

(optional) TRUE to enable autotrading Stocks for this strategy. Default is FALSE

Default false
MaxStocksDollarsinteger or null(int32)

(optional) Set a maximum number of dollars to hold in a position for this strategy (no decimals)

OptionsEnabledboolean

(optional) TRUE to enable autotrading Options for this strategy. Default is FALSE

Default false
ShortOptionsEnabledboolean

(optional) TRUE to enable the shorting of Options when autotrading this strategy. Default is FALSE

Default false
MaxOptionsinteger or null(int32)

(optional) Set a maximum number of contracts to hold in a position for this strategy

DoNotJoinCurrentSystemPositionsboolean or null

(optional) TRUE to prevent joining currently open positions in the strategy. Only applies to new Autotrade setups: this setting must not be set when modifing an existing Autotrade setup.

AutoStopLossinteger or null(int64)

(optional) Dollar value of the automated stop loss which will rest in addition to the strategy stop loss orders

AccountUserNamestring or null

(optional) The Brokerage account username. Only needed for specific Brokers, please enquire with support at help@collective2.com

AccountPasswordstring or null

(optional) The Brokerage account password. Only needed for specific Brokers, please enquire with support at help@collective2.com

curl -i -X POST \
  https://api4-general.collective2.com/Autotrade/StartAutotrade \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
boolean
Response
application/json
true

StopAutotrade

Request

Stop a autotrade setup. Non-paginated endpoint.

Query
Accountstringrequired

The Autotrade account

PersonIdinteger or null(int64)required

The C2 PersonID

StrategyIdinteger or null(int64)required

The StrategyId

BrokerIdinteger or null(int32)

The BrokerId

LeavePositionsOpenboolean

TRUE to leave positions open in the autotraded account. Default is FALSE

TerminateStrategySubscriptionboolean

TRUE to stop the Strategy subscription. Default is FALSE

curl -i -X DELETE \
  'https://api4-general.collective2.com/Autotrade/StopAutotrade?Account=string&PersonId=0&StrategyId=0'

Responses

OK

Bodyapplication/json
boolean
Response
application/json
true

GetSimResults

Request

Return SIM trading results for all subscribers who are using “free sims.”. Non-Paginated endpoint.

Query
PersonIdinteger or null(int64)

PersonId (optional)

WhiteLabelSiteIdinteger or null(int64)

The WhiteLabel SiteId (optional)

ActiveOnlyboolean

Set to FALSE to get the full history of all Simulation results (optional). Default is TRUE

MaxAccountDaysinteger or null(int32)

The maximum account number of days to include (optional). Maximum default value is 365 days

MinLoginDaysinteger or null(int32)

The minimum number of days since the user logged in (optional)

curl -i -X GET \
  https://api4-general.collective2.com/Autotrade/GetSimResults

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SimResultDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "PersonId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "Account": "string", "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "StartEquity": 0, "EndEquity": 0, "TotalReturn": 0.1, "TotalDelta": 0.1, "ScalingFactor": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

ResetPaperTrade

Request

Reset the specified PaperTrade account.

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

curl -i -X PUT \
  https://api4-general.collective2.com/Autotrade/ResetPaperTrade \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of booleans or null

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SyncPositionsToOpen

Request

Reset the Autosync PositionsToOpen flags for all enabled asset classes in the specified account/strategy. Account will sync-to-open positions once for the strategy, then resume normal operation (i.e. sync open orders and the closing of positions).

Bodyapplication/jsonrequired
Accountstring or null

The Autotrade account

PersonIdinteger or null(int64)

The C2 PersonID

BrokerIdinteger or null(int32)

The C2 PersonID

StrategyIdsArray of integers or null(int64)

A list of Strategy IDs

curl -i -X POST \
  https://api4-general.collective2.com/Autotrade/SyncPositionsToOpen \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SyncPositionsToOpenDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "Success": true, "Reason": "string", "ReasonCode": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

Hello

Request

Test endpoint that can be used to test your API Key, RateLimits, Headers, etc

Bodyapplication/jsonrequired
Namestring or null

Your name (or any string)

curl -i -X POST \
  https://api4-general.collective2.com/General/Hello \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of strings or null

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ "string" ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetProfile

Request

Request details of a Person. Public profiles are visible to all. Private profile information will only be visible to the account owner. Non-paginated endpoint.

Query
PersonIdinteger or null(int64)

The C2 PersonId. If omitted, the requester's information will be returned.

curl -i -X GET \
  https://api4-general.collective2.com/General/GetProfile

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(PersonDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "Alias": "string", "FirstName": "string", "LastName": "string", "Email": "string", "Phone": "string", "IsPhoneVerified": true, "Language": "string", "WhiteLabelSiteId": 0, "CountryCode": "string", "DivisionCode": "string", "Created": "2019-08-24T14:15:22Z", "LastLoggedIn": "2019-08-24T14:15:22Z", "LastIP": "string", "IsEmailValidated": true, "IsAlive": true, "ApprovedAccounts": [], "IsManager": true, "IsInvestor": true, "GeoSite": "string", "IsGeoSiteAdmin": true, "SupportCompanyName": "string", "SupportSiteURL": "string", "SupportEmail": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SearchProfiles

Request

Search profiles using any field combination. Partial matches will be returned. Paginated endpoint. Only Admins, Geo and White-Label Admins can access this endpoint. If you're a GeoSite admin, you will see all your GeoSite members including your WhiteLabel members. If you're a WhiteLabel admin, you will see your WhiteLabel members, but not other GeoSite members. If you're neither, you will get a 403 error.

Query
PersonIdinteger or null(int64)

The C2 PersonId (optional)

FirstNamestring

The FirstName. Not case-sensitive (optional)

LastNamestring

The FirstName. Not case-sensitive (optional)

Emailstring

The Email. Not case-sensitive (optional)

WhiteLabelSiteIdinteger or null(int64)

The White Label site Id (optional)

CountryCodestring

The person's country code. Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2

DivisionCodestring

The person's subdivision (e.g. provinces or states). Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2

IPAddressstring

The person's last known IP address (optional)

Phonestring

The verified Phone number (optional)

IsAliveboolean or null

The Person's Status (optional)

IsEmailValidatedboolean or null

The Person's email validation status (optional)

curl -i -X GET \
  https://api4-general.collective2.com/General/SearchProfiles

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(PersonDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "Alias": "string", "FirstName": "string", "LastName": "string", "Email": "string", "Phone": "string", "IsPhoneVerified": true, "Language": "string", "WhiteLabelSiteId": 0, "CountryCode": "string", "DivisionCode": "string", "Created": "2019-08-24T14:15:22Z", "LastLoggedIn": "2019-08-24T14:15:22Z", "LastIP": "string", "IsEmailValidated": true, "IsAlive": true, "ApprovedAccounts": [], "IsManager": true, "IsInvestor": true, "GeoSite": "string", "IsGeoSiteAdmin": true, "SupportCompanyName": "string", "SupportSiteURL": "string", "SupportEmail": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

UpdateProfile

Request

Update an existing C2 profile. Not available. Please contact us if you need this endpoint.

Bodyapplication/jsonrequired
PersonIdinteger or null(int64)

The C2 PersonId

curl -i -X PUT \
  https://api4-general.collective2.com/General/UpdateProfile \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AddPersonResponseDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "PersonId": 0, "CSRF": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetInvestorPlanSubscriptions

Request

Request details of a Person's strategy subscriptions. Paginated endpoint

Query
PersonIdinteger or null(int64)required

The C2 PersonId

ActiveOnlyboolean

Set to FALSE to get all transactions (optional). Default is TRUE

curl -i -X GET \
  'https://api4-general.collective2.com/General/GetInvestorPlanSubscriptions?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SubscriptionDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "LicenseType": "string", "LicenseTypeId": 0, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "IsRecurring": true, "Cost": 0.1 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetManagerPlanSubscriptions

Request

Request details of a Person's strategy manager subscriptions. Paginated endpoint

Query
PersonIdinteger or null(int64)required

The C2 PersonId

ActiveOnlyboolean

Set to FALSE to get all transactions (optional). Default is TRUE

curl -i -X GET \
  'https://api4-general.collective2.com/General/GetManagerPlanSubscriptions?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SubscriptionDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "LicenseType": "string", "LicenseTypeId": 0, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "IsRecurring": true, "Cost": 0.1 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetSubscribedStrategies

Request

Request the subscribed strategies of the person. Paginated endpoint.

Query
PersonIdinteger or null(int64)required

PersonId

ActiveOnlyboolean

Set to FALSE to get all transactions (optional). Default is TRUE

curl -i -X GET \
  'https://api4-general.collective2.com/General/GetSubscribedStrategies?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SubcribedStrategyDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "StrategyId": 0, "StrategyName": "string", "IsSimulation": true, "IsPaperTrade": true, "IsAlive": true, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "MonthlyCost": 0.1 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetAccessKey

Request

Get the requester's APIKey Role and expiration

curl -i -X GET \
  https://api4-general.collective2.com/General/GetAccessKey

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(AccessKeyDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "AccessKey": "string", "PersonId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "WhiteLabelSiteId": 0, "Role": "string", "Message": "string", "CreateDate": "2019-08-24T14:15:22Z", "DeleteDate": "2019-08-24T14:15:22Z", "Comment": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyDetails

Request

Request the strategy statistics. Non-paginated endpoint.

Query
StrategyIdinteger or null(int64)required

The Strategy ID

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyDetails?StrategyId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyDetailsDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "IsAlive": true, "StartDate": "2019-08-24T14:15:22Z", "PrimarySecurityTypes": "string", "SecurityTypesEnabled": {}, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "StrategyOwnerName": "string", "SuggestedCapital": 0, "LastModified": "2019-08-24T14:15:22Z", "Score": 0, "IsTradeOwnSystem": true, "WhiteLabelSiteId": 0, "IsPrivate": true, "AUM": 0, "AUM_NumberOfAccounts": 0, "Return": 0.1, "ReturnLabel": "string", "Equity": 0.1, "Cash": 0.1, "StartingCash": 0.1, "ProfitFactor": 0.1, "CashDividends": 0.1, "BuyingPower": 0.1, "MarginUsed": 0.1, "AgeInDays": 0, "ModelAccountValue": 0.1, "NumTrades": 0, "NumWinners": 0, "NumLosers": 0, "PercentWinTrades": 0.1, "SumDollarWinners": 0.1, "SumDollarLosers": 0.1, "NumMonths": 0, "WinMonthsInUI": 0, "WinMonths": 0.1, "WinMonthsRatio": 0.1, "MaxDrawdown": 0.1, "MaxDrawdownDays": 0.1, "MaxDrawdownStartDate": "string", "MaxDrawdownEndDate": "string", "AvgWinDollars": 0.1, "AvgLossDollars": 0.1, "AvgTradeDuration": 0.1, "CorrelationSP500": 0.1, "SP500Return": 0.1, "ReturnVsSP500": 0.1, "AvgLeverage": 0.1, "MaxLeverage": 0.1, "CorrelationToSP500": 0.1, "Alpha": 0.1, "Beta": 0.1, "Treynor": 0.1, "Sortino": 0.1, "Sharpe": 0.1, "Calmar": 0.1 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SearchStrategies

Request

Request a list of strategies available to the user. Paginated endpoint.

Query
SecurityTypestring

(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'

CreatedBeforeDatestring

(optional) Filter used to search old stategies. The date must be in ISO 8601 Date Format.

StrategyNamestring

Search strategies on name (optional). Partial matches will be returned. Wildcards % and _ are supported

StrategyOwnerPersonIdinteger or null(int64)

The C2 PersonId (optional)

WhiteLabelSiteIdinteger or null(int64)

The White Label site Id (optional)

curl -i -X GET \
  https://api4-general.collective2.com/Strategies/SearchStrategies

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyBasicDetailsDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "StrategyId": 0, "IsAlive": true, "IsPrivate": true, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": {}, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "WhiteLabelSiteId": 0 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetLeaderBoard

Request

Request the curated public leaderboard of strategies. Non-Paginated endpoint.

Query
SecurityTypestring

(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'

curl -i -X GET \
  https://api4-general.collective2.com/Strategies/GetLeaderBoard

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyBasicDetailsDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "StrategyId": 0, "IsAlive": true, "IsPrivate": true, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": {}, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "WhiteLabelSiteId": 0 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetSubscribers

Request

Request the list of subscribers of a strategy and their subscrition history. Paginated endpoint.

Query
StrategyIdinteger or null(int64)required

The C2 StrategyId

ActiveOnlyboolean or null

Set to True to include only currently active subscribers. Default is False

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetSubscribers?StrategyId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategySubscriberDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "StrategyId": 0, "StrategyName": "string", "PersonId": 0, "SubscriptionId": 0, "SubscriberId": 0, "IsStrategyOwner": true, "Alias": "string", "FirstName": "string", "LastName": "string", "Email": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "BasePrice": 0.1, "Markup": 0.1, "Cost": 0.1, "LastTransactionDate": "2019-08-24T14:15:22Z", "LastTransactionAmount": 0.1, "IsResale": 0.1, "WhiteLabelSiteId": 0, "GeoSiteId": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetSubscriptionRevenue

Request

Request the subscriber revenue of a strategy. Paginated endpoint. You must provide at least one parameter other than Start/End date.

Query
StrategyIdinteger or null(int64)

The C2 StrategyId (Optional)

StartDatestring

StartDate (Optional)

EndDatestring

EndDate (Optional)

StrategyOwnerPersonIdinteger or null(int64)

The Strategy Owner's PersonId (Optional)

SubscriberPersonIdinteger or null(int64)

The Subscriber's PersonId (Optional)

WhiteLabelSiteIdinteger or null(int64)

The White Label Site Id (Optional)

curl -i -X GET \
  https://api4-general.collective2.com/Strategies/GetSubscriptionRevenue

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategySubscriberDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "StrategyId": 0, "StrategyName": "string", "PersonId": 0, "SubscriptionId": 0, "SubscriberId": 0, "IsStrategyOwner": true, "Alias": "string", "FirstName": "string", "LastName": "string", "Email": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "BasePrice": 0.1, "Markup": 0.1, "Cost": 0.1, "LastTransactionDate": "2019-08-24T14:15:22Z", "LastTransactionAmount": 0.1, "IsResale": 0.1, "WhiteLabelSiteId": 0, "GeoSiteId": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

NewStrategyOrder

Request

Send a new order for the strategy. Non-paginated endpoint.

Bodyapplication/jsonrequired
Orderobject(OrderDTO)
curl -i -X POST \
  https://api4-general.collective2.com/Strategies/NewStrategyOrder \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

CancelStrategyOrder

Request

Cancel a order. Non-paginated endpoint.

Query
StrategyIdinteger or null(int64)required

The Strategy ID

SignalIdinteger or null(int64)required

The Signal ID to be cancelled

curl -i -X DELETE \
  'https://api4-general.collective2.com/Strategies/CancelStrategyOrder?StrategyId=0&SignalId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

ReplaceStrategyOrder

Request

Send a cancel/replace a order for the strategy. Non-paginated endpoint.

Bodyapplication/jsonrequired
Orderobject(OrderDTO)
curl -i -X PUT \
  https://api4-general.collective2.com/Strategies/ReplaceStrategyOrder \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SignalIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyActiveOrders

Request

Request the open orders for the strategies. Non-paginated endpoint.

Query
StrategyIdsArray of integers(int64)required

A list of Strategy IDs

SecurityTypestring

(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'

OrderTypestring

(optional) OrderType filter. e.g. '1' = Market, '2' = Limit, '3' = Stop

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyActiveOrders?StrategyIds=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(OrderStatusDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "OrderId": "string", "StrategyId": 0, "StrategyName": "string", "SignalId": 0, "AvgPx": 0.1, "OrderType": "1", "Side": "1", "OpenClose": "O", "OrderQuantity": 0.1, "Limit": 0.1, "Stop": 0.1, "TIF": "0", "ProfitTarget": 0.1, "StopLoss": 0.1, "DoNotCreateOCAGroup": true, "CancelReplaceSignalId": 0, "ParentSignalId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z", "DoNotSyncToOpen": true, "C2Symbol": {}, "ExchangeSymbol": {}, "RejectMessage": "string", "BrokerId": 0, "OrderStatus": "string", "FilledQuantity": 0.1, "AvgFillPrice": 0.1, "PostedDate": "2019-08-24T14:15:22Z", "SignalType": 0, "Info": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyOpenPositions

Request

Request the open positions for the strategy. Non-paginated endpoint.

Query
StrategyIdsArray of integers(int64)required

A list of Strategy IDs

SecurityTypestring

(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyOpenPositions?StrategyIds=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(PositionDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "Quantity": 0.1, "AvgPx": 0.1, "C2Symbol": {}, "ExchangeSymbol": {}, "StrategyName": "string", "Currency": "string", "OpenedDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyHistoricalOrders

Request

Returns the historical orders of the strategy. Paginated endpoint.

Query
StrategyIdinteger or null(int64)

StrategyId (optional: StrategyId or SignalId must be present)

SignalIdinteger or null(int64)

SignalId (optional: StrategyId or SignalId must be present)

OrderStatusstring

Optional. Available values: '2' = Filled, '4' = Canceled, 'C' = Expired

StartDatestring

UTC StartDate (Optional)

EndDatestring

UTC EndDate (Optional)

curl -i -X GET \
  https://api4-general.collective2.com/Strategies/GetStrategyHistoricalOrders

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(OrderStatusDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "OrderId": "string", "StrategyId": 0, "StrategyName": "string", "SignalId": 0, "AvgPx": 0.1, "OrderType": "1", "Side": "1", "OpenClose": "O", "OrderQuantity": 0.1, "Limit": 0.1, "Stop": 0.1, "TIF": "0", "ProfitTarget": 0.1, "StopLoss": 0.1, "DoNotCreateOCAGroup": true, "CancelReplaceSignalId": 0, "ParentSignalId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z", "DoNotSyncToOpen": true, "C2Symbol": {}, "ExchangeSymbol": {}, "RejectMessage": "string", "BrokerId": 0, "OrderStatus": "string", "FilledQuantity": 0.1, "AvgFillPrice": 0.1, "PostedDate": "2019-08-24T14:15:22Z", "SignalType": 0, "Info": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

AddStrategy

Request

Create a new, empty, publicly visible strategy. Non-paginated endpoint.

Bodyapplication/jsonrequired
StrategyNamestring or null

The desired strategy name

StartingCapitalinteger or null(int64)

(Optional) The starting capital. Must be set when Account is not specified, ignored when Account is specified

curl -i -X POST \
  https://api4-general.collective2.com/Strategies/AddStrategy \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

UpdateStrategy

Request

Modify a strategy. Not available yet. Please contact us if you ened this endpoint. Non-paginated endpoint.

Bodyapplication/jsonrequired
StrategyIdinteger or null(int64)

The C2 StrategyId

curl -i -X PUT \
  https://api4-general.collective2.com/Strategies/UpdateStrategy \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyIdDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyHistoricalEquity

Request

Returns monthly returns for the strategy. Non-paginated endpoint.

Query
StrategyIdinteger or null(int64)required

The Strategy ID to get data for

CommissionPlanstringrequired

(Optional) The commission plan to use. The default C2 web site CommissionPlan is used if none is specified. Available values: 0 = Default, 1 = C2Europe, 3 = IB, 4 = Tradovate, 5 = StoneX

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyHistoricalEquity?StrategyId=0&CommissionPlan=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyHistoricalEquityDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": {}, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "MonthlyResults": [] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyHistoricalDailyEquity

Request

Returns daily returns for the strategy. Non-paginated endpoint.

Query
StrategyIdinteger or null(int64)required

The Strategy ID to get data for

CommissionPlanstringrequired

(Optional) The commission plan to use. The default C2 web site CommissionPlan is used if none is specified. Available values: 0 = Default, 1 = C2Europe, 3 = IB, 4 = Tradovate, 5 = StoneX

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyHistoricalDailyEquity?StrategyId=0&CommissionPlan=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(StrategyHistoricalEquityDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": {}, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "MonthlyResults": [] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetStrategyHistoricalClosedTrades

Request

Returns the historical closed trades of the strategy. The difference between an order and a trade is trades group orders on 'tradeid', much like you would see on our web site. Non-paginated endpoint.

Query
CommissionPlanstringrequired

(Optional) The commission plan to use. The default web site CommissionPlan is used if none is specified. Available values: 0 = Default, 1 = C2Europe, 3 = IB, 4 = Tradovate, 5 = StoneX

StrategyIdinteger or null(int64)

The StrategyId

PersonIdinteger or null(int64)

(optional) The PersonId who will view the information. Available to WhiteLabel and GeoSite admins only. Default is the requester's PersonId

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetStrategyHistoricalClosedTrades?CommissionPlan=string'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(HistoricalTradeDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "TradeId": 0, "StrategyId": 0, "OpenDate": "2019-08-24T14:15:22Z", "CloseDate": "2019-08-24T14:15:22Z", "AvgOpenFillPrice": 0.1, "AvgCloseFillPrice": 0.1, "OpenedQuantity": 0.1, "ClosedQuantity": 0.1, "OpenSide": "1", "CloseSide": "1", "ProfitLoss": 0.1, "Commission": 0.1, "MaxDrawdown": 0.1, "MaxDrawdown_DateCalculated": "2019-08-24T14:15:22Z", "MaxDrawdown_WorstPrice": 0.1, "MaxDrawdown_WorstPriceDate": "2019-08-24T14:15:22Z", "MaxDrawdown_StrategyEquity": 0.1, "MaxDrawdown_EntryPrice": 0.1, "MaxDrawdown_OpenQuantity": 0.1, "C2Symbol": {}, "ExchangeSymbol": {} } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SetDesiredPositions

Request

The list of positions that must exist in the strategy. All C2 positions not in this list will be closed with market orders. Non-paginated endpoint.

Bodyapplication/jsonrequired
StrategyIdinteger or null(int64)

The C2 StrategyId

PositionsArray of objects or null(PositionBase)

The list of positions that must exist in the strategy. Quantity must be non-zero. To close a position, simply omit it from the Positions array. Sending an empty Positions array will close all positions.

curl -i -X POST \
  https://api4-general.collective2.com/Strategies/SetDesiredPositions \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(DesiredPositionResponseDTO)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "NewSignals": [], "CanceledSignals": [] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

SetDesiredPositionsV2

Request

The list of positions that must exist in the strategy. All C2 positions not in this list will be closed with market orders. Non-paginated endpoint.

Bodyapplication/jsonrequired
StrategyIdinteger or null(int64)

The C2 StrategyId

PositionsArray of objects or null(PositionBase)

The list of positions that must exist in the strategy. Quantity must be non-zero. To close a position, simply omit it from the Positions array. Sending an empty Positions array will close all positions.

curl -i -X POST \
  https://api4-general.collective2.com/v2/Strategies/SetDesiredPositions \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(DesiredPositionResponseDTOV2)

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "NewSignals": [], "CanceledSignals": [], "RejectedSignals": [] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetWatchLists

Request

Request all watchlists available to the user. Paginated endpoint.

Query
PersonIdinteger or null(int64)required

The C2 PersonId

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetWatchLists?PersonId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(WatchListDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "PersonId": 0, "CreatedDate": "2019-08-24T14:15:22Z", "ListName": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetWatchListMembers

Request

Request a list of strategies in the watchlist. Paginated endpoint.

Query
PersonIdinteger or null(int64)required

The C2 PersonId

WatchListIdinteger or null(int64)required

The WatchList Id

curl -i -X GET \
  'https://api4-general.collective2.com/Strategies/GetWatchListMembers?PersonId=0&WatchListId=0'

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(WatchListMemberDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "AddedDate": "2019-08-24T14:15:22Z", "StrategyId": 0, "PersonId": 0 } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

ManageWatchList

Request

Edit watchlists and their members. Non-paginated endpoint.

Bodyapplication/jsonrequired
PersonIdinteger or null(int64)

The C2 PersonId

WatchListIdinteger or null(int64)

The WatchList Id. Required except when ModificationAction=ADD and ModificationSource=LIST

ModificationSourcestring or null

The Type of list to modify. Valid values are 'LIST' (for the whole watchlist), 'MEMBER' (for the list items)

ModificationActionstring or null

The change to make. Valid values are: ADD, DELETE

StrategyIdinteger or null(int64)

The Strategy Id. Only required when ModificationSource=MEMBER

WatchListNamestring or null

The name of the watchlist. Only required when ModificationAction=ADD and ModificationSource=LIST

curl -i -X POST \
  https://api4-general.collective2.com/Strategies/ManageWatchList \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
ResultsArray of booleans or null

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

ManageWatchList

Request

Edit watchlists and their members. Non-paginated endpoint.

Query
PersonIdinteger or null(int64)required

The C2 PersonId

ModificationSourcestringrequired

The Type of list to modify. Valid values are 'LIST' (for the whole watchlist), 'MEMBER' (for the list items)

ModificationActionstringrequired

The change to make. Valid values are: ADD, DELETE

WatchListIdinteger or null(int64)

The WatchList Id. Required except when ModificationAction=ADD and ModificationSource=LIST

StrategyIdinteger or null(int64)

The Strategy Id. Only required when ModificationSource=MEMBER

WatchListNamestring

The name of the watchlist. Only required when ModificationAction=ADD and ModificationSource=LIST

curl -i -X DELETE \
  'https://api4-general.collective2.com/Strategies/ManageWatchList?PersonId=0&ModificationSource=string&ModificationAction=string'

Responses

OK

Bodyapplication/json
ResultsArray of booleans or null

Result array

ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }

GetSupportedSymbols

Request

Request a list of supported Futures and Forex symbols. All US stocks > $5 and all US equity options are supported by default so they will not be sent in the response. We will include a few non-standard stock symbols that require special C2 symbology. Paginated and cached endpoint.

curl -i -X GET \
  https://api4-general.collective2.com/Strategies/GetSupportedSymbols

Responses

OK

Bodyapplication/json
ResultsArray of objects or null(SupportedSymbolDTO)

Result array

Paginationobject(PaginationProperties)
ResponseStatusobject(ResponseStatus)
Response
application/json
{ "Results": [ { "Id": 0, "Currency": "string", "Description": "string", "PointValue": 0.1, "TickSize": 0.1, "DecimalPrecision": 0, "C2Symbol": {}, "ExchangeSymbol": {}, "MarginRequirements": {} } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ {} ] } }