# Collective2 WhiteLabel API

πŸ“– For full documentation, see the Collective2 API Documentation.

Version: v4 ## Servers ``` https://api4-wl.collective2.com ``` ## Security ### bearerAuth Authorization header using the Bearer scheme. e.g. 'Bearer myAPIkey'. See https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/ Type: http Scheme: bearer Bearer Format: Bearer myAPIkey ## Download OpenAPI description [Collective2 WhiteLabel API](https://api-docs.collective2.com/_bundle/apis/whitelabel/swagger.yaml) ## Other ### GetAutotradedStrategies - [GET /Autotrade/GetAutotradedStrategies](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradedstrategies_get.md): Request the Autotraded strategies of the person. Paginated endpoint. ### GetAutotraders - [GET /Autotrade/GetAutotraders](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotraders_get.md): A list of Autotraders. Paginated endpoint. ### GetAutotradeSettings - [GET /Autotrade/GetAutotradeSettings](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradesettings_get.md): The Autotrade Settings. Non-paginated endpoint. ### SetAutotradeSettings - [PUT /Autotrade/SetAutotradeSettings](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/setautotradesettings_put.md): Enable or disable Autotrade or Autosync in the specified account. ### GetDashBoard - [GET /Autotrade/GetDashBoard](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getdashboard_get.md): Request the Person's Autotraded strategies and a performance summary. Non-paginated endpoint. ### GetSimResults - [GET /Autotrade/GetSimResults](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getsimresults_get.md): Return SIM trading results for all subscribers who are using β€œfree sims.”. Non-Paginated endpoint. ### SearchAccounts - [GET /Autotrade/SearchAccounts](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/searchaccounts_get.md): 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 ### GetAutotradeActiveOrders - [GET /Autotrade/GetAutotradeActiveOrders](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradeactiveorders_get.md): Request the Working orders of the Account. Non-paginated endpoint. ### GetAutotradeHistoricalOrders - [GET /Autotrade/GetAutotradeHistoricalOrders](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradehistoricalorders_get.md): Request the historical orders of the Account. Paginated endpoint. ### GetAutoTradeOpenPositions - [GET /Autotrade/GetAutoTradeOpenPositions](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradeopenpositions_get.md): Request the open positions of the Account. Non-paginated endpoint. ### NewAutotradeOrder - [POST /Autotrade/NewAutotradeOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/newautotradeorder_post.md): Send a new closing order to the specified account. Only Stop and Limit OrderTypes are supported. Non-paginated endpoint. ### CancelAutotradeOrder - [DELETE /Autotrade/CancelAutotradeOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/cancelautotradeorder_delete.md): Cancel an order in the specified account. Auto Stop-Loss orders are not currently supported. Non-paginated endpoint. ### ReplaceAutotradeOrder - [PUT /Autotrade/ReplaceAutotradeOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/replaceautotradeorder_put.md): Cancel/Replace an open closing order in the specified account. Only strategy and manual exit orders are currently supported. ### GetBrokers - [GET /Autotrade/GetBrokers](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getbrokers_get.md): Get a list of Autotrade brokers. Non-Paginated endpoint. ### SearchAutotradedAccounts - [GET /Autotrade/SearchAutotradedAccounts](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/searchautotradedaccounts_get.md): A list of Autotraded accounts. You must provide at least one parameter. Paginated endpoint. ### GetAutotradeStats - [GET /Autotrade/GetAutotradeStats](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradestats_get.md): Request the historical Autotraded accounts statistics. Non-paginated endpoint. ### GetPendingAccounts - [GET /Autotrade/GetPendingAccounts](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getpendingaccounts_get.md): Get the live accounts pending Autotrade approval. Non-paginated endpoint. ### StartAutotrade - [POST /Autotrade/StartAutotrade](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/startautotrade_post.md): Start or modify an Autotrade setup. Non-paginated endpoint. ### StopAutotrade - [DELETE /Autotrade/StopAutotrade](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/stopautotrade_delete.md): Stop a autotrade setup. Non-paginated endpoint. ### GetAutotradeApprovalStatus - [GET /Autotrade/GetAutotradeApprovalStatus](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradeapprovalstatus_get.md): Poll one AutoTrade approval request created by StartAutotrade. 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 StartAutotrade 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. ### ResetPaperTrade - [PUT /Autotrade/ResetPaperTrade](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/resetpapertrade_put.md): Reset the specified PaperTrade account. ### GetAutotradePlans - [GET /Autotrade/GetAutotradePlans](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/getautotradeplans_get.md): 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. ### StartSim - [POST /Autotrade/StartSim](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/startsim_post.md): 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. ### StopSim - [DELETE /Autotrade/StopSim](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_autotrade/stopsim_delete.md): 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. ### Hello - [POST /General/Hello](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/hello_post.md): Test endpoint that can be used to test your API Key, RateLimits, Headers, etc ### GetAccessKey - [GET /General/GetAccessKey](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getaccesskey_get.md): Get the requester's APIKey Role and expiration ### AddProfile - [POST /General/AddProfile](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/addprofile_post.md): Create a new C2 profile. Non-paginated endpoint. ### UpdateProfile - [PUT /General/UpdateProfile](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/updateprofile_put.md): Update an existing C2 profile. Not available. Please contact us if you need this endpoint. ### GetProfile - [GET /General/GetProfile](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getprofile_get.md): 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. ### SearchProfiles - [GET /General/SearchProfiles](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/searchprofiles_get.md): 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. ### GetInvestorPlanSubscriptions - [GET /General/GetInvestorPlanSubscriptions](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getinvestorplansubscriptions_get.md): Request details of a Person's strategy subscriptions. Paginated endpoint ### GetManagerPlanSubscriptions - [GET /General/GetManagerPlanSubscriptions](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getmanagerplansubscriptions_get.md): Request details of a Person's strategy manager subscriptions. Paginated endpoint ### GetSubscribedStrategies - [GET /General/GetSubscribedStrategies](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getsubscribedstrategies_get.md): Request the subscribed strategies of the person. Paginated endpoint. ### GetWhiteLabelSiteUsers - [GET /General/GetWhiteLabelSiteUsers](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getwhitelabelsiteusers_get.md): Get all members of a WL site. Only admins and WhiteLabel admins can access this endpoint. Paginated endpoint. ### GetKYCScore - [GET /General/GetKYCScore](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getkycscore_get.md): Request the KYC score of a Person. Only White Label Sites and GeoSites have access to this endpoint. Non-paginated endpoint. ### UpdateKYCScore - [PUT /General/UpdateKYCScore](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/updatekycscore_put.md): Update the KYC score of a Person. Only Geo and White Label Sites have access to this endpoint. Non-paginated endpoint. ### GetKYCInfo - [GET /General/GetKYCInfo](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getkycinfo_get.md): Request the KYC information of a Person. Only Geo and White Label Sites have access to this endpoint. Non-paginated endpoint. ### AddKYCInfo - [POST /General/AddKYCInfo](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/addkycinfo_post.md): Add/Update the KYC info of a Person. Each successful request for a PersonID will replace the old data. Only Geo and White Label Site admins have access to this endpoint. ### GetPhoneAlreadyExists - [GET /General/GetPhoneAlreadyExists](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getphonealreadyexists_get.md): Check if a verified phone number already exists on C2. Non-paginated endpoint. ### GetWlInstrumentationExport - [GET /General/GetWlInstrumentationExport](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_general/getwlinstrumentationexport_get.md): 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. ### GetStrategyDetails - [GET /Strategies/GetStrategyDetails](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategydetails_get.md): Request the strategy statistics. Non-paginated endpoint. ### SearchStrategies - [GET /Strategies/SearchStrategies](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/searchstrategies_get.md): Request a list of strategies available to the user. Paginated endpoint. ### GetLeaderBoard - [GET /Strategies/GetLeaderBoard](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getleaderboard_get.md): Request the curated public leaderboard of strategies. Non-Paginated endpoint. ### GetWatchLists - [GET /Strategies/GetWatchLists](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getwatchlists_get.md): Request all watchlists available to the user. Paginated endpoint. ### GetWatchListMembers - [GET /Strategies/GetWatchListMembers](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getwatchlistmembers_get.md): Request a list of strategies in the watchlist. Paginated endpoint. ### ManageWatchList - [POST /Strategies/ManageWatchList](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/managewatchlist_post.md): Edit watchlists and their members. Non-paginated endpoint. ### ManageWatchList - [DELETE /Strategies/ManageWatchList](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/managewatchlist_delete.md): Edit watchlists and their members. Non-paginated endpoint. ### GetSubscribers - [GET /Strategies/GetSubscribers](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getsubscribers_get.md): Request the list of subscribers of a strategy and their subscrition history. Paginated endpoint. ### GetSubscriptionRevenue - [GET /Strategies/GetSubscriptionRevenue](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getsubscriptionrevenue_get.md): Request the subscriber revenue of a strategy. Paginated endpoint. You must provide at least one parameter other than Start/End date. ### NewStrategyOrder - [POST /Strategies/NewStrategyOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/newstrategyorder_post.md): Send a new order for the strategy. Non-paginated endpoint. ### CancelStrategyOrder - [DELETE /Strategies/CancelStrategyOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/cancelstrategyorder_delete.md): Cancel a order. Non-paginated endpoint. ### ReplaceStrategyOrder - [PUT /Strategies/ReplaceStrategyOrder](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/replacestrategyorder_put.md): Send a cancel/replace a order for the strategy. Non-paginated endpoint. ### GetStrategyActiveOrders - [GET /Strategies/GetStrategyActiveOrders](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyactiveorders_get.md): Request the open orders for the strategies. Non-paginated endpoint. ### GetStrategyOpenPositions - [GET /Strategies/GetStrategyOpenPositions](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyopenpositions_get.md): Request the open positions for the strategy. Non-paginated endpoint. ### GetStrategyHistoricalOrders - [GET /Strategies/GetStrategyHistoricalOrders](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyhistoricalorders_get.md): Returns the historical orders of the strategy. Paginated endpoint. ### GetStrategyHistoricalClosedTrades - [GET /Strategies/GetStrategyHistoricalClosedTrades](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyhistoricalclosedtrades_get.md): 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. ### GetStrategyHistoricalEquity - [GET /Strategies/GetStrategyHistoricalEquity](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyhistoricalequity_get.md): Returns monthly returns for the strategy. Non-paginated endpoint. ### GetStrategyHistoricalDailyEquity - [GET /Strategies/GetStrategyHistoricalDailyEquity](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategyhistoricaldailyequity_get.md): Returns daily returns for the strategy. Non-paginated endpoint. ### AddStrategy - [POST /Strategies/AddStrategy](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/addstrategy_post.md): Create a new, empty, publicly visible strategy. Non-paginated endpoint. ### UpdateStrategy - [PUT /Strategies/UpdateStrategy](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/updatestrategy_put.md): Modify a strategy. Not available yet. Please contact us if you ened this endpoint. Non-paginated endpoint. ### SetDesiredPositionsV2 - [POST /v2/Strategies/SetDesiredPositions](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_v2/strategies/setdesiredpositions_post.md): 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. ### GetSupportedSymbols - [GET /Strategies/GetSupportedSymbols](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getsupportedsymbols_get.md): 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. ### GetRule575Status - [GET /Strategies/GetRule575Status](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getrule575status_get.md): Returns Rule 575 exception fills and rollup summaries for a White Label site. Only WhiteLabel admins can access this endpoint. Non-Paginated endpoint. ### GetStrategyMuxStatus - [GET /Strategies/GetStrategyMuxStatus](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getstrategymuxstatus_get.md): Get the signal multiplexer status report for a family of child strategies, including position sync state, exception counts, and per-variant sync details. Only WhiteLabel admins can access this endpoint. Non-Paginated endpoint. ### GetSiteCatalog - [GET /Strategies/GetSiteCatalog](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/getsitecatalog_get.md): 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. ### UpdateSiteCatalog - [POST /Strategies/UpdateSiteCatalog](https://api-docs.collective2.com/apis/whitelabel/swagger/other/c2_api_strategies/updatesitecatalog_post.md): 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.