📖 For full documentation, see the Collective2 API Documentation.
A stable code identifying this plan (for example atplan_level1_monthly). Use this value when referring to the plan programmatically
This plan will start to apply starting with this minimum number of AutoTraded strategies
The maximum position scaling percentage allowed under this plan (100 = 100%)
{ "Id": 0, "PlanCode": "string", "Name": "string", "BillingPeriod": "string", "MinStrategies": 0, "MaxStrategies": 0, "PriceUSD": 0.1, "MaxScalingPercent": 0, "DaysPerTerm": 0 }
The AutoTrading plans billed monthly, ordered from smallest to largest
The AutoTrading plans billed annually, ordered from smallest to largest
{ "WhiteLabelSiteId": 0, "MonthlyPlans": [ { "Id": 0, "PlanCode": "string", "Name": "string", "BillingPeriod": "string", "MinStrategies": 0, "MaxStrategies": 0, "PriceUSD": 0.1, "MaxScalingPercent": 0, "DaysPerTerm": 0 } ], "AnnualPlans": [ { "Id": 0, "PlanCode": "string", "Name": "string", "BillingPeriod": "string", "MinStrategies": 0, "MaxStrategies": 0, "PriceUSD": 0.1, "MaxScalingPercent": 0, "DaysPerTerm": 0 } ], "FeePolicy": { "BillingModel": "string", "CustomerPaysAutotradeFee": true, "AutotradePaidBySiteOwner": true, "AutotradeNoCharge": true, "SiteGeoFlavor": "string", "MembershipIncludesAutotradingLicense": true, "HideInvestorAutotradePlans": true, "SiteSettingsConflict": true, "SiteOwnerUsagePricing": { "Unit": "string", "TieredBy": "string", "Note": "string", "Tiers": [ … ] } } }
TRUE if Autotrade will ignore manual orders (it normally would disable AutoSync when a manual order fill is detected)
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if client Autotrade settings have recently changed or client clicked on the ReSync button
TRUE if the account is enabled broker-side. You can determine if the account is currently Autotrading from a combination of fields: "IsBrokerEnabled" = True AND "IsAutotradeDisabled" = False AND "Approved" = True.
The first date when the account was activated by the broker
Last known account net liquidation value. Not available at all brokers
UTC date of last known account net liquidation value
TRUE if limit orders are held on the server due to strict broker margin constraints that result in rejected orders
The most recent UTC date the Autotrade settings were updated by the client
TRUE if broker has approved the account for Autotrade. Note that declined accounts do not appear in this endpoint; use "GetPendingAccounts" to see accounts the broker has declined.
The broker authorization status of the account: "Approved" or "Pending". Declined accounts do not appear in this endpoint; use "GetPendingAccounts" to see accounts the broker has declined. May be absent on interfaces that do not evaluate authorization state (mirrors "Approved").
Maximum currency value when scaling stock orders for Autotrade
{ "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, "BrokerAuthorizationStatus": "string", "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 }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradedStrategies?PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetAutotraders{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradeSettings?PersonId=0'{ "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, "BrokerAuthorizationStatus": "string", "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetDashBoard?PersonId=0&Account=string'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradeActiveOrders?Account=string&PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradeHistoricalOrders?Account=string&PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutoTradeOpenPositions?Account=string'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradeSyncStatusReport?PersonId=0&Account=string'{ "Results": [ { "Id": 0, "ReportType": 0, "PersonId": 0, "Account": "string", "StrategyId": 0, "SignalId": 0, "StrategyName": "string", "BrokerName": "string", "AccountQuantity": 0.1, "StrategyQuantity": 0.1, "ScaledQuantity": 0.1, "SignalType": 0, "InSync": true, "NotInSyncReason": "string", "C2Symbol": { … }, "ExchangeSymbol": { … }, "AutotradeSettings": { … } } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetBrokers{ "Results": [ { "Id": 0, "Name": "string", "IsEnabled": true, "ConnectionName": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/SearchAutotradedAccounts{ "Results": [ { "Id": 0, "PersonId": 0, "Account": "string", "BrokerId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "StrategyId": 0, "StrategyName": "string", "IsSyncEnabled": true, "IsAutotrading": true, "IsAutotradeDisabled": true, "IsAutotradeDisabledReason": "string", "SyncDisabledReason": "string", "SettingsLastUpdateUTC": "2019-08-24T14:15:22Z" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetAutotradeStats{ "Results": [ { "Id": 0, "DateUtc": "2019-08-24T14:15:22Z", "Account": "string", "PersonId": 0, "BrokerId": 0, "IB": 0, "SalesRep": 0, "WhiteLabelSiteId": 0, "GeoSiteId": "string", "NetLiquidationValue": 0.1, "LastBrokerNetLiquidationUpdateUtc": "2019-08-24T14:15:22Z", "FirstBrokerActivationDateUTC": "2019-08-24T14:15:22Z", "AutotradedStocksStrategies": 0, "AutotradedFuturesStrategies": 0, "AutotradedOptionsStrategies": 0, "AutotradedForexStrategies": 0, "AutotradedCryptoStrategies": 0, "UniqueAutotradedStrategies": 0, "BrokertransmitStocksStrategies": 0, "BrokertransmitFuturesStrategies": 0, "BrokertransmitOptionsStrategies": 0, "BrokertransmitForexStrategies": 0, "BrokertransmitCryptoStrategies": 0, "UniqueBrokertransmitStrategies": 0, "PlatformtransmitStocksStrategies": 0, "PlatformtransmitFuturesStrategies": 0, "PlatformtransmitOptionsStrategies": 0, "PlatformtransmitForexStrategies": 0, "PlatformtransmitCryptoStrategies": 0, "UniquePlatformtransmitStrategies": 0, "IsSyncEnabled": true, "IsManualConfirmationEnabled": true, "IsDisabled": true, "Currency": "string", "Email": "string", "FirstName": "string", "LastName": "string", "IsBrokerEnabled": true } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetPendingAccounts{ "Results": [ { "Id": 0, "Status": "string", "DeclinedUTC": "2019-08-24T14:15:22Z", "UtcDate": "2019-08-24T14:15:22Z", "Account": "string", "PersonId": 0, "BrokerName": "string", "BrokerId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "Country": "string", "State": "string", "Language": "string", "WhiteLabelSiteId": 0, "GeoSiteId": "string", "SiteDomain": "string", "Connection": "string", "IntroducingBrokerId": 0, "IntroducingBroker": "string", "StrategyId": 0, "StrategyName": "string", "SalesRepId": 0, "SalesRep": "string", "IsTradeLeader": true, "FirstBrokerActivationDate": "2019-08-24T14:15:22Z", "NetLiquidationValue": 0.1, "NetLiquidationValueDate": "2019-08-24T14:15:22Z", "EnabledFutures": true, "EnabledForex": true, "EnabledStocks": true, "EnabledOptions": true } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetSimResults{ "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.1, "EndEquity": 0, "TotalReturn": 0.1, "TotalDelta": 0.1, "ScalingFactor": 0.1, "SubscriptionId": 0, "IsResultReady": true } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/SearchAccounts{ "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": [ { … } ] } }
Poll one AutoTrade approval request created by WhiteLabelStartAutotrade. Status is one of PendingCustomer (your customer has not finished the approval), Processing (approved; we are switching trading on), PendingBroker (approved; broker-side enablement pending, typically 5-10 business days), Completed (trading is on), Failed, Expired, or Superseded (a newer WhiteLabelStartAutotrade or a StopAutotrade replaced it). ApprovalUrl is present only while the request is PendingCustomer. This poll is the source of truth; the completion webhook is a courtesy signal. Non-Paginated endpoint.
curl -i -X GET \
'https://api4-wl.collective2.com/Autotrade/GetAutotradeApprovalStatus?RequestId=string'{ "Results": [ { "RequestId": "string", "Status": "string", "ApprovalUrl": "string", "CreatedUtc": "2019-08-24T14:15:22Z", "ExpiresUtc": "2019-08-24T14:15:22Z", "CompletedUtc": "2019-08-24T14:15:22Z", "PersonId": 0, "StrategyId": 0, "SupersededByRequestId": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X PUT \
https://api4-wl.collective2.com/Autotrade/ResetPaperTrade \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Return the AutoTrading license plans available on your White Label site, together with the site's fee policy: who pays the AutoTrade fee (the end customer, the site owner, or nobody) and, when the site owner is billed for usage, the published pricing tiers. The site is the one your API key belongs to; C2 admin keys may pass WhiteLabelSiteId to view any site. Non-Paginated endpoint.
curl -i -X GET \
https://api4-wl.collective2.com/Autotrade/GetAutotradePlans{ "Results": [ { "WhiteLabelSiteId": 0, "MonthlyPlans": [ … ], "AnnualPlans": [ … ], "FeePolicy": { … } } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Start simulated subscriptions for a customer on your White Label site. A simulated subscription lets the customer follow a strategy's aggregate performance without trading real money and without access to its open positions or live signals. You can request 1 to 8 strategies in one call; strategies that cannot be started are returned in the Skipped list with a reason rather than failing the whole request. The site is always the one your API key belongs to, and the customer must belong to that site. Non-Paginated endpoint.
The PersonId of the customer to start simulated subscriptions for. The customer must belong to your White Label site
curl -i -X POST \
https://api4-wl.collective2.com/Autotrade/StartSim \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "PersonId": 0, "Created": [ … ], "Skipped": [ … ] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Stop a customer's simulated subscription to a strategy on your White Label site. Only simulated subscriptions can be stopped through this endpoint; real subscriptions are refused. The site is always the one your API key belongs to, and the customer must belong to that site. Non-Paginated endpoint.
curl -i -X DELETE \
'https://api4-wl.collective2.com/Autotrade/StopSim?PersonId=0&StrategyId=0'{ "Results": [ { "PersonId": 0, "StrategyId": 0, "StoppedSubscriptionId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Create a customer approval request for AutoTrading on the authenticated White Label site. This call does not activate trading. Give ApprovalUrl to the customer to open in their own browser; C2 requires customer presence, verify identity enrollment when needed, and electronic agreements before activation. ApprovalUrl must open as a top-level page, not an iframe. Poll GetAutotradeApprovalStatus. Repeated requests may return an existing approval; changed settings are not applied while approval is processing or AutoTrading is already on. To change an active setup, stop it and request a new customer approval. Never submit AccountUserName or AccountPassword: these fields are rejected on the White Label lane. Legacy StartAutotrade is unavailable to White Label callers. Non-paginated endpoint.
curl -i -X POST \
https://api4-wl.collective2.com/Autotrade/WhiteLabelStartAutotrade \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "RequestId": "string", "Status": "string", "ApprovalUrl": "string", "StatusUrl": "string", "ExpiresUtc": "2019-08-24T14:15:22Z", "IsEnrollmentRequired": true, "IsAlreadyRunning": true, "PersonId": 0, "StrategyId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Request that AutoTrading stop, subject to the caller's permissions. PlatformTransmit does not support this operation. The stop is accepted immediately and applied asynchronously when the AutoTrade server processes the account; show stop requested until the stopped state is observed. Repeated stops are safe. To change an active White Label setup, stop it and use WhiteLabelStartAutotrade for fresh customer approval. On the White Label API there is no customer approval step: open positions are always left untouched, pending approvals are retired, and the customer is notified. Non-paginated endpoint.
curl -i -X DELETE \
'https://api4-wl.collective2.com/Autotrade/StopAutotrade?Account=string&PersonId=0&BrokerId=0&StrategyId=0'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.
curl -i -X PUT \
https://api4-wl.collective2.com/Autotrade/SetAutotradeSettings \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X POST \
https://api4-wl.collective2.com/Autotrade/NewAutotradeOrder \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X DELETE \
'https://api4-wl.collective2.com/Autotrade/CancelAutotradeOrder?Account=string&PersonId=0&OrderId=string'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X PUT \
https://api4-wl.collective2.com/Autotrade/ReplaceAutotradeOrder \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X POST \
https://api4-wl.collective2.com/General/Hello \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ "string" ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/General/GetAccessKey{ "Results": [ { "Id": 0, "AccessKey": "string", "PersonId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "WhiteLabelSiteId": 0, "GeoSiteId": "string", "Role": "string", "Message": "string", "CreateDate": "2019-08-24T14:15:22Z", "DeleteDate": "2019-08-24T14:15:22Z", "Comment": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
The person's subdivision (e.g. provinces or states). See https://en.wikipedia.org/wiki/ISO_3166-2
curl -i -X POST \
https://api4-wl.collective2.com/General/AddProfile \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "PersonId": 0, "CSRF": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Update customer contact information. A site administrator with write authority may edit a customer belonging to that site without customer participation. Supports FirstName, LastName, Phone, CountryCode, Street, Street2, City, DivisionCode and ZipCode only. Brokerage accounts, credentials, AutoTrade settings and approval records cannot be changed here. A changed phone number becomes unverified; supplying the same number preserves its verification. Omitted/null fields are unchanged; use IsClearPhone to remove the number. General API does not yet implement this endpoint.
Optional phone in international format, e.g. +14155550123. Changing the number removes its verified status.
Remove the customer's contact phone and its verification. Cannot be combined with Phone.
Optional two-letter contact-country code. Does not change site membership or location recorded at login.
Optional street address, up to 80 characters. Empty clears it; null leaves it unchanged.
Optional second address line, up to 80 characters. Empty clears it; null leaves it unchanged.
Optional state or province, up to 20 characters. Empty clears it; null leaves it unchanged.
curl -i -X PUT \
https://api4-wl.collective2.com/General/UpdateProfile \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "PersonId": 0, "CSRF": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/General/GetProfile{ "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", "Icon": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
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.
The person's country code. Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2
The person's subdivision (e.g. provinces or states). Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2
(Optional) Set to TRUE to include the profile icon in the response.
curl -i -X GET \
https://api4-wl.collective2.com/General/SearchProfiles{ "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", "Icon": "string" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetInvestorPlanSubscriptions?PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetManagerPlanSubscriptions?PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetSubscribedStrategies?PersonId=0'{ "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, "NextChargeDate": "2019-08-24T14:15:22Z", "NextBillingPrice": 0.1, "BillingInterval": "string", "BillingIntervalCount": 0, "IsCancelPending": true, "BillingFailureCount": 0, "LastBillingFailureReason": "string", "LastBillingFailureAt": "2019-08-24T14:15:22Z" } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetWhiteLabelSiteUsers?WhiteLabelSiteId=0'{ "Results": [ { "Id": 0, "Alias": "string", "FirstName": "string", "LastName": "string", "Email": "string", "Phone": "string", "Language": "string", "IsWhiteLabelSiteAdmin": true, "WhiteLabelSiteId": 0, "WhiteLabelPermissions": "string", "CountryCode": "string", "DivisionCode": "string", "Created": "2019-08-24T14:15:22Z", "LastLoggedIn": "2019-08-24T14:15:22Z", "LastIP": "string", "IsEmailValidated": true, "IsAlive": true, "IsManager": true, "IsInvestor": true, "GeoSite": "string", "IsGeoSiteAdmin": true } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/General/GetKYCScore{ "Results": [ { "Id": 0, "PersonId": 0, "Created": "2019-08-24T14:15:22Z", "Approved": "2019-08-24T14:15:22Z", "Started": "2019-08-24T14:15:22Z", "Finished": "2019-08-24T14:15:22Z", "RedirectedToKYCTimes": 0, "Score": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X PUT \
https://api4-wl.collective2.com/General/UpdateKYCScore \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "Id": 0, "PersonId": 0, "Created": "2019-08-24T14:15:22Z", "Approved": "2019-08-24T14:15:22Z", "Started": "2019-08-24T14:15:22Z", "Finished": "2019-08-24T14:15:22Z", "RedirectedToKYCTimes": 0, "Score": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetKYCInfo?UserToken=string'{ "Results": [ { "Id": 0, "PersonId": 0, "FirstName": "string", "LastName": "string", "Email": "string", "Phone": "string", "IsPhoneVerified": true, "Street": "string", "City": "string", "Province": "string", "PostCode": "string", "Country": "string", "PhotoId1": "string", "PhotoId1Title": "string", "PhotoId2": "string", "PhotoId2Title": "string", "WhiteLabelSiteId": 0, "GeoSite": "string", "SiteURL": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X POST \
https://api4-wl.collective2.com/General/AddKYCInfo \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "Id": 0, "PersonId": 0, "Created": "2019-08-24T14:15:22Z", "Approved": "2019-08-24T14:15:22Z", "Started": "2019-08-24T14:15:22Z", "Finished": "2019-08-24T14:15:22Z", "RedirectedToKYCTimes": 0, "Score": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetPhoneAlreadyExists?Phone=string'{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Export instrumentation data for a White Label site, including session events, subscriptions, autotrade account stability, and executions within the requested time window. These are SSO/login handshakes, not full pageview analytics. Only WhiteLabel admins can access this endpolong. Non-Paginated endpolong.
(Optional) The start of the export window as a Unix timestamp (seconds). If omitted, DaysBack is used to calculate the window start.
(Optional) The end of the export window as a Unix timestamp (seconds). Defaults to now if omitted.
(Optional) The lookback window in days, used when FromWhen is omitted. Default: 30.
(Optional) Maximum number of session events to return. Default: 2000, max: 5000.
(Optional) Maximum number of subscriptions to return. Default: 2000, max: 5000.
curl -i -X GET \
'https://api4-wl.collective2.com/General/GetWlInstrumentationExport?WhiteLabelSiteId=0'{ "Results": [ { "WhiteLabelSiteId": 0, "WhiteLabelSiteName": "string", "WhiteLabelSiteDomain": "string", "RequestedWindow": { … }, "Filters": { … }, "SessionEventSummary": { … }, "SessionEvents": [ … ], "Autotrade": { … }, "Subscriptions": [ … ], "AccountStability": [ … ], "Executions": [ … ], "Summary": { … } } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyDetails?StrategyId=0'{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "ShortDescription": "string", "LongDescription": "string", "IsAlive": true, "IsResellable": 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, "TradeOwnSystemPercent": 0.1, "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, "NoSubsAllowed": true, "LatestTrade": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/SearchStrategies{ "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, "IsTradeOwnSystem": true, "IsResellable": true } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/GetLeaderBoard{ "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, "IsTradeOwnSystem": true, "IsResellable": true } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetSubscribers?StrategyId=0'{ "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": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/GetSubscriptionRevenue{ "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": [ { … } ] } }
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/NewStrategyOrder \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X DELETE \
'https://api4-wl.collective2.com/Strategies/CancelStrategyOrder?StrategyId=0&SignalId=0'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X PUT \
https://api4-wl.collective2.com/Strategies/ReplaceStrategyOrder \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "SignalId": 0, "ProfitTargetSignalId": 0, "StopLossSignalId": 0, "ExitSignalsOCAGroupId": 0, "ParkedUntilDate": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyActiveOrders?StrategyIds=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyOpenPositions?StrategyIds=0'{ "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": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/GetStrategyHistoricalOrders{ "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": [ { … } ] } }
(Optional) The starting capital. Must be set when Account is not specified, ignored when Account is specified
(Optional) The Strategy Owner's PersonId. Ignored on the General API (the owner is the caller by default). If you are a White Label site admin, the customer must belong to your White Label site
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/AddStrategy \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "StrategyId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Update the name and descriptions of a strategy you own. Omitted or null fields are unchanged; an empty description clears it. Descriptions follow the hosted compliance review process, so acceptance does not mean immediate publication. Trading settings, ownership, pricing and customer AutoTrade permissions cannot be changed here. Non-paginated endpoint.
Optional strategy name: 3-40 characters, letters, digits, spaces, apostrophe, # or /.
Optional short description, up to 300 characters. Empty clears it; null leaves it unchanged.
curl -i -X PUT \
https://api4-wl.collective2.com/Strategies/UpdateStrategy \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "StrategyId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyHistoricalEquity?StrategyId=0&CommissionPlan=string'{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": { … }, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "MonthlyResults": [ … ] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyHistoricalDailyEquity?StrategyId=0&CommissionPlan=string'{ "Results": [ { "StrategyId": 0, "StrategyName": "string", "StartDate": "2019-08-24T14:15:22Z", "SecurityTypesEnabled": { … }, "MonthlyCost": 0.1, "StrategyOwnerId": 0, "MonthlyResults": [ … ] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyHistoricalClosedTrades?CommissionPlan=string'{ "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": [ { … } ] } }
curl -i -X POST \
https://api4-wl.collective2.com/v2/Strategies/SetDesiredPositions \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "NewSignals": [ … ], "CanceledSignals": [ … ], "RejectedSignals": [ … ] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetWatchLists?PersonId=0'{ "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": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetWatchListMembers?PersonId=0&WatchListId=0'{ "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": [ { … } ] } }
The WatchList Id. Required except when ModificationAction=ADD and ModificationSource=LIST
The Type of list to modify. Valid values are 'LIST' (for the whole watchlist), 'MEMBER' (for the list items)
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/ManageWatchList \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X DELETE \
'https://api4-wl.collective2.com/Strategies/ManageWatchList?PersonId=0&ModificationSource=string&ModificationAction=string'{ "Results": [ true ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/GetSupportedSymbols{ "Results": [ { "Id": 0, "Currency": "string", "Description": "string", "PointValue": 0.1, "TickSize": 0.1, "DecimalPrecision": 0, "C2Symbol": { … }, "ExchangeSymbol": { … }, "MarginRequirements": { … }, "BrokerMarginRequirements": [ … ] } ], "Pagination": { "prev_cursor": "string", "next_cursor": "string" }, "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetRule575Status?WhiteLabelSiteId=0'{ "Results": [ { "ExceptionSummary": { … }, "Exceptions": [ … ], "Rule575": { … } } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
curl -i -X GET \
'https://api4-wl.collective2.com/Strategies/GetStrategyMuxStatus?WhiteLabelSiteId=0'{ "Results": [ { "FamilyGuid": 0, "VariantGuid": 0, "WhiteLabelSiteId": 0, "WhiteLabelSiteName": "string", "Ok": "string", "DriftGraceSecs": 0, "Summary": { … }, "ExceptionSummary": { … }, "SyncSummary": [ … ], "SyncDetails": [ … ], "Exceptions": [ … ] } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Return the catalog of strategies offered on your White Label site, priced as your customers see them. Each row shows the strategy's original name, the display name used on your site (when the site resells it under a custom name), the strategy's base monthly cost, any site markup in dollars, and the resulting monthly cost on your site. The site is the one your API key belongs to; C2 admin keys may pass WhiteLabelSiteId to view any site. Non-Paginated endpoint.
curl -i -X GET \
https://api4-wl.collective2.com/Strategies/GetSiteCatalog{ "Results": [ { "Id": 0, "StrategyId": 0, "OriginalName": "string", "DisplayName": "string", "BaseMonthlyCost": 0.1, "MarkupDollars": 0.1, "SiteMonthlyCost": 0.1, "ShortDescription": "string", "IsAlive": true, "IsOwnedBySite": true } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Add strategies to, or remove strategies from, your White Label site's catalog — the API version of the console's add/remove-strategy toggle. Send a list of StrategyIds (1 to 100 per call) with Action "Add" or "Remove", and get a per-strategy result back. The operation is idempotent: a strategy already in the requested state is reported as a success ("already_in_catalog" / "not_in_catalog"), so replays are safe. Removal is refused per-strategy while the strategy still has active paid subscribers who are customers of your site (the result carries the count); simulated subscriptions never block removal. The site is the one your API key belongs to; C2 admin keys may pass WhiteLabelSiteId to manage any site. Non-Paginated endpoint.
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/UpdateSiteCatalog \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "StrategyId": 0, "Ok": true, "Status": "string", "Reason": "string", "Message": "string", "ActiveSubscribers": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Set the resale pricing for one strategy your White Label site resells: the monthly markup added to the strategy's base price, and optionally the custom display name and descriptions shown on your site — the API version of the console's library pricing editor. One strategy per call. DisplayName is stated on every call: include it to show a custom name, or omit it (or send it empty) to show the strategy's original name. The two descriptions keep their stored values when omitted. Refused for strategies your site OWNS (Collective2 charges your customers nothing for those, so their pricing lives in your own product) and for strategies not currently in your resale catalog — add those first with UpdateSiteCatalog. The site is always the one your API key belongs to. The new pricing is reflected in GetSiteCatalog immediately. Non-Paginated endpoint.
The StrategyId to price. Must be a resold strategy currently in your site's catalog
The monthly markup in US dollars added on top of the strategy's base price (0 to offer the strategy at its base price). Non-negative, at most 2 decimal places
(optional) The custom display name shown for the strategy on your site, under 25 characters. Stated on every call: include it to show this name, omit it (or send an empty value) to show the strategy's original name
(optional) Short marketing description shown on your site, max 200 characters. Omit to keep the stored value
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/WhiteLabelUpdateSiteCatalogPricing \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "StrategyId": 0, "MarkupDollars": 0.1, "DisplayName": "string" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Start a strategy subscription for a customer of your White Label site. What the call does depends on who owns the strategy, and the response's Lane field tells you which contract applied. A strategy OWNED by your site becomes a finite access grant: Collective2 charges nothing, you bill your customer yourself, and you must supply a term — Months (1 to 24) or AccessUntil (a date), not both; calling again extends the same access, so renewal is simply a repeat call, and access lapses on its own if you stop renewing. A RESOLD Collective2 marketplace strategy from your site catalog becomes an open-ended monthly subscription billed to your site's house account at the wholesale price — supply no term. The first wholesale charge is attempted during the call and the response reports whether it settled (IsFirstChargeSuccessful; if it did not, Collective2's recurring biller retries and ResponseStatus.Message carries the detail). The call is refused when your house account balance cannot cover the first charge, unless your site is configured to allow negative billing. There are no free trials on this lane, and billing continues monthly until you call StopSubscription — keep the house account funded or monthly renewals will stall. Your customer never pays Collective2 in either lane and no card details are involved. A live simulated subscription for the same customer and strategy is superseded automatically — this is the natural sim-to-real conversion. Requires IdempotencyKey, a stable per-business-event string. Retrying a call never double-subscribes, but the two lanes confirm a retry differently. Owned strategies: repeating the same key with identical parameters replays the original grant (HTTP 200 with IsIdempotentReplay true); reusing a key with different parameters is refused — use a fresh key for each intended renewal. Resold strategies: the key is recorded for audit; a customer can hold only one live subscription per strategy, so a retry after a start that actually succeeded returns HTTP 409 "Already subscribed" with the existing subscription's id in the error's Meta["SubscriptionId"] — treat that 409 as confirmation the subscription is active, not as a failure. Refusals carry machine-readable detail in the error's Meta where prose alone would be ambiguous: Meta["SubscriptionId"] on "Already subscribed", Meta["HouseAccountBalance"] and Meta["WholesaleMonthly"] on "Insufficient house account funds". Starting a subscription does not start AutoTrading; that is StartAutotrade's customer-approval flow. Non-Paginated endpoint.
The PersonId of the customer to subscribe. The customer must belong to your White Label site
The StrategyId to subscribe to. The strategy must be in your site's catalog
A stable idempotency key for this business event (1 to 191 printable ASCII characters). Reusing the key on the owned-strategy lane replays the original grant instead of extending twice; make it unique per intended renewal
(owned strategies only) Grant length in months, 1 to 24. Provide Months or AccessUntil — not both. Leave empty for resold strategies
(owned strategies only) Grant end date, YYYYMMDD or YYYY-MM-DD, in the future. Access runs through the end of that calendar day, US Eastern time; the response's AccessEndUtc is the exact UTC moment access ends. Provide Months or AccessUntil — not both. Leave empty for resold strategies
curl -i -X POST \
https://api4-wl.collective2.com/Strategies/WhiteLabelStartSubscription \
-H 'Content-Type: application/json' \
-d '{}'{ "Results": [ { "Lane": "string", "PersonId": 0, "StrategyId": 0, "SubscriptionId": 0, "Action": "string", "IsIdempotentReplay": true, "AccessEndUtc": "2019-08-24T14:15:22Z", "PreviousAccessEndUtc": "2019-08-24T14:15:22Z", "WholesaleMonthly": 0.1, "RetailMonthly": 0.1, "MarkupMonthly": 0.1, "IsFirstChargeSuccessful": true, "NextBillUtc": "2019-08-24T14:15:22Z", "HouseAccountBalance": 0.1, "SupersededSimSubscriptionId": 0 } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }
Stop a customer's strategy subscription on your White Label site. Mode "EndOfTerm" (the default) lets the paid term run out: billing stops, access continues until the term ends, and there are no mid-term refunds — repeating the call is an idempotent no-op, and for an owned-strategy access grant (which never renews on its own) the call simply confirms the access end date. Mode "Immediate" ends the subscription now and forfeits the remainder of the term; if the customer is AutoTrading the strategy, supply AutotradePositions to say what happens to open positions ("LeaveInPlace" or "AttemptToClose") — an immediate stop that needs this and doesn't get it is refused. Simulated subscriptions are refused here; stop those with StopSim. Non-Paginated endpoint.
curl -i -X DELETE \
'https://api4-wl.collective2.com/Strategies/WhiteLabelStopSubscription?PersonId=0&StrategyId=0'{ "Results": [ { "Mode": "string", "PersonId": 0, "StrategyId": 0, "SubscriptionId": 0, "IsAlreadyEnding": true, "AccessEndUtc": "2019-08-24T14:15:22Z" } ], "ResponseStatus": { "ErrorCode": "string", "Message": "string", "Errors": [ { … } ] } }