{ "openapi": "3.0.4", "info": { "title": "Collective2 General API", "description": "API to automate your trading", "termsOfService": "https://trade.collective2.com/terms-of-service.html", "contact": { "name": "C2 Support", "url": "https://support.collective2.com", "email": "help@collective2.com" }, "version": "v4" }, "servers": [ { "url": "https://api4-general.collective2.com" } ], "paths": { "/Autotrade/GetAutotradedStrategies": { "get": { "summary": "GetAutotradedStrategies", "description": "Request the Autotraded strategies of the person. Paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutotradedStrategies_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Account", "in": "query", "description": "The Autotrade account (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutotradedStrategiesResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetAutotraders": { "get": { "summary": "GetAutotraders", "description": "A list of Autotraders. Paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutotraders_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "(Optional) StrategyId filter", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "BrokerId", "in": "query", "description": "(optional) The Autotrade BrokerId", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "(optional) The White Label Site Id", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutotradersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetAutotradeSettings": { "get": { "summary": "GetAutotradeSettings", "description": "The Autotrade Settings. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutotradeSettings_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Account", "in": "query", "description": "(Optional) Account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutotradeSettingsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/SetAutotradeSettings": { "put": { "summary": "SetAutotradeSettings", "description": "Enable or disable Autotrade or Autosync in the specified account.", "operationId": "C2_API_Autotrade/SetAutotradeSettings_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAutotradeSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponseBase" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetDashBoard": { "get": { "summary": "GetDashBoard", "description": "Request the Person's Autotraded strategies and a performance summary. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/GetDashBoard_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Account", "in": "query", "description": "The brokerage Account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDashBoardResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/SearchAccounts": { "get": { "summary": "SearchAccounts", "description": "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", "operationId": "C2_API_Autotrade/SearchAccounts_GET", "parameters": [ { "name": "Account", "in": "query", "description": "The Autotrade account (optional)", "schema": { "type": "string" } }, { "name": "PersonId", "in": "query", "description": "PersonId (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "BrokerId", "in": "query", "description": "The Autotrade BrokerId (optional)", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "FirstName", "in": "query", "description": "The FirstName (optional). Not case-sensitive", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "description": "The FirstName (optional). Not case-sensitive", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "description": "The Email (optional)", "schema": { "type": "string" } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "The White Label site Id (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "CountryCode", "in": "query", "description": "The person's country code. Not case-sensitive (optional)", "schema": { "type": "string" } }, { "name": "IPAddress", "in": "query", "description": "The person's last known IP address (optional)", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "description": "The Phone number (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetAutotradeActiveOrders": { "get": { "summary": "GetAutotradeActiveOrders", "description": "Request the Working orders of the Account. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutotradeActiveOrders_GET", "parameters": [ { "name": "Account", "in": "query", "description": "The Brokerage Account", "required": true, "schema": { "type": "string" } }, { "name": "PersonId", "in": "query", "description": "The PersonId owning the account", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "StrategyId", "in": "query", "description": "(Optional) StrategyId filter", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActiveOrdersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetAutotradeHistoricalOrders": { "get": { "summary": "GetAutotradeHistoricalOrders", "description": "Request the historical orders of the Account. Paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutotradeHistoricalOrders_GET", "parameters": [ { "name": "Account", "in": "query", "description": "Brokerage Account filter", "required": true, "schema": { "type": "string" } }, { "name": "PersonId", "in": "query", "description": "The PersonId owning the account", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "BrokerId", "in": "query", "description": "BrokerId (Optional)", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "StrategyId", "in": "query", "description": "StrategyId (Optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "OrderStatus", "in": "query", "description": "'A' = PendingNew, '0' = Working, '1' = Partially filled, '2' = Filled, '4' = Canceled, '5' = Replaced, '6' = Pending Cancel, '8' = Rejected, 'C' = Expired, 'E' = Pending Replace (Optional)", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "description": "StartDate (Optional)", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "EndDate", "in": "query", "description": "EndDate (Optional)", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutotradeHistoricalOrdersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetAutoTradeOpenPositions": { "get": { "summary": "GetAutoTradeOpenPositions", "description": "Request the open positions of the Account. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/GetAutoTradeOpenPositions_GET", "parameters": [ { "name": "Account", "in": "query", "description": "Brokerage Account filter", "required": true, "schema": { "type": "string" } }, { "name": "StrategyId", "in": "query", "description": "(Optional) StrategyId filter", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOpenPositionsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/NewAutotradeOrder": { "post": { "summary": "NewAutotradeOrder", "description": "Send a new closing order to the specified account. Only Stop and Limit OrderTypes are supported. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/NewAutotradeOrder_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAutotradeOrder" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAutotradeOrderResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/CancelAutotradeOrder": { "delete": { "summary": "CancelAutotradeOrder", "description": "Cancel an order in the specified account. Auto Stop-Loss orders are not currently supported. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/CancelAutotradeOrder_DELETE", "parameters": [ { "name": "Account", "in": "query", "description": "The Autotrade account", "required": true, "schema": { "type": "string" } }, { "name": "PersonId", "in": "query", "description": "The C2 PersonID", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "OrderId", "in": "query", "description": "The OrderID to be cancelled", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAutotradeOrderResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/ReplaceAutotradeOrder": { "put": { "summary": "ReplaceAutotradeOrder", "description": "Cancel/Replace an open closing order in the specified account. Only strategy and manual exit orders are currently supported.", "operationId": "C2_API_Autotrade/ReplaceAutotradeOrder_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceAutotradeOrder" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceAutotradeOrderResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetBrokers": { "get": { "summary": "GetBrokers", "description": "Get a list of Autotrade brokers. Non-Paginated endpoint.", "operationId": "C2_API_Autotrade/GetBrokers_GET", "parameters": [ { "name": "IncludeDisabled", "in": "query", "description": "Include the disabled brokers. Default is FALSE. (optional)", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBrokersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/StartAutotrade": { "post": { "summary": "StartAutotrade", "description": "Start or modify an Autotrade setup. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/StartAutotrade_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartAutotrade" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/StopAutotrade": { "delete": { "summary": "StopAutotrade", "description": "Stop a autotrade setup. Non-paginated endpoint.", "operationId": "C2_API_Autotrade/StopAutotrade_DELETE", "parameters": [ { "name": "Account", "in": "query", "description": "The Autotrade account", "required": true, "schema": { "type": "string" } }, { "name": "PersonId", "in": "query", "description": "The C2 PersonID", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "BrokerId", "in": "query", "description": "The BrokerId", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "StrategyId", "in": "query", "description": "The StrategyId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "LeavePositionsOpen", "in": "query", "description": "TRUE to leave positions open in the autotraded account. Default is FALSE", "schema": { "type": "boolean" } }, { "name": "TerminateStrategySubscription", "in": "query", "description": "TRUE to stop the Strategy subscription. Default is FALSE", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/GetSimResults": { "get": { "summary": "GetSimResults", "description": "Return SIM trading results for all subscribers who are using “free sims.”. Non-Paginated endpoint.", "operationId": "C2_API_Autotrade/GetSimResults_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "PersonId (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "The WhiteLabel SiteId (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ActiveOnly", "in": "query", "description": "Set to FALSE to get the full history of all Simulation results (optional). Default is TRUE", "schema": { "type": "boolean" } }, { "name": "MaxAccountDays", "in": "query", "description": "The maximum account number of days to include (optional). Maximum default value is 365 days", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "MinLoginDays", "in": "query", "description": "The minimum number of days since the user logged in (optional)", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSimResultsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/ResetPaperTrade": { "put": { "summary": "ResetPaperTrade", "description": "Reset the specified PaperTrade account.", "operationId": "C2_API_Autotrade/ResetPaperTrade_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPaperTrade" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponseBase" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Autotrade/SyncPositionsToOpen": { "post": { "summary": "SyncPositionsToOpen", "description": "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).", "operationId": "C2_API_Autotrade/SyncPositionsToOpen_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncPositionsToOpen" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncPositionsToOpenResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/Hello": { "post": { "summary": "Hello", "description": "Test endpoint that can be used to test your API Key, RateLimits, Headers, etc", "operationId": "C2_API_General/Hello_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hello" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelloResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/GetProfile": { "get": { "summary": "GetProfile", "description": "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.", "operationId": "C2_API_General/GetProfile_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId. If omitted, the requester's information will be returned.", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/SearchProfiles": { "get": { "summary": "SearchProfiles", "description": "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.", "operationId": "C2_API_General/SearchProfiles_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "FirstName", "in": "query", "description": "The FirstName. Not case-sensitive (optional)", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "description": "The FirstName. Not case-sensitive (optional)", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "description": "The Email. Not case-sensitive (optional)", "schema": { "type": "string" } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "The White Label site Id (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "CountryCode", "in": "query", "description": "The person's country code. Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2", "schema": { "type": "string" } }, { "name": "DivisionCode", "in": "query", "description": "The person's subdivision (e.g. provinces or states). Not case-sensitive. (optional) See https://en.wikipedia.org/wiki/ISO_3166-2", "schema": { "type": "string" } }, { "name": "IPAddress", "in": "query", "description": "The person's last known IP address (optional)", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "description": "The verified Phone number (optional)", "schema": { "type": "string" } }, { "name": "IsAlive", "in": "query", "description": "The Person's Status (optional)", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsEmailValidated", "in": "query", "description": "The Person's email validation status (optional)", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/UpdateProfile": { "put": { "summary": "UpdateProfile", "description": "Update an existing C2 profile. Not available. Please contact us if you need this endpoint.", "operationId": "C2_API_General/UpdateProfile_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfile" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProfileResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/GetInvestorPlanSubscriptions": { "get": { "summary": "GetInvestorPlanSubscriptions", "description": "Request details of a Person's strategy subscriptions. Paginated endpoint", "operationId": "C2_API_General/GetInvestorPlanSubscriptions_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ActiveOnly", "in": "query", "description": "Set to FALSE to get all transactions (optional). Default is TRUE", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/GetManagerPlanSubscriptions": { "get": { "summary": "GetManagerPlanSubscriptions", "description": "Request details of a Person's strategy manager subscriptions. Paginated endpoint", "operationId": "C2_API_General/GetManagerPlanSubscriptions_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ActiveOnly", "in": "query", "description": "Set to FALSE to get all transactions (optional). Default is TRUE", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/GetSubscribedStrategies": { "get": { "summary": "GetSubscribedStrategies", "description": "Request the subscribed strategies of the person. Paginated endpoint.", "operationId": "C2_API_General/GetSubscribedStrategies_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ActiveOnly", "in": "query", "description": "Set to FALSE to get all transactions (optional). Default is TRUE", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscribedStrategiesResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/General/GetAccessKey": { "get": { "summary": "GetAccessKey", "description": "Get the requester's APIKey Role and expiration", "operationId": "C2_API_General/GetAccessKey_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccessKeyResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyDetails": { "get": { "summary": "GetStrategyDetails", "description": "Request the strategy statistics. Non-paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyDetails_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The Strategy ID", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStrategyDetailsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/SearchStrategies": { "get": { "summary": "SearchStrategies", "description": "Request a list of strategies available to the user. Paginated endpoint.", "operationId": "C2_API_Strategies/SearchStrategies_GET", "parameters": [ { "name": "SecurityType", "in": "query", "description": "(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'", "schema": { "type": "string" } }, { "name": "CreatedBeforeDate", "in": "query", "description": "(optional) Filter used to search old stategies. The date must be in ISO 8601 Date Format.", "schema": { "type": "string" } }, { "name": "StrategyName", "in": "query", "description": "Search strategies on name (optional). Partial matches will be returned. Wildcards % and _ are supported", "schema": { "type": "string" } }, { "name": "StrategyOwnerPersonId", "in": "query", "description": "The C2 PersonId (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "The White Label site Id (optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchStrategiesResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetLeaderBoard": { "get": { "summary": "GetLeaderBoard", "description": "Request the curated public leaderboard of strategies. Non-Paginated endpoint.", "operationId": "C2_API_Strategies/GetLeaderBoard_GET", "parameters": [ { "name": "SecurityType", "in": "query", "description": "(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchStrategiesResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetSubscribers": { "get": { "summary": "GetSubscribers", "description": "Request the list of subscribers of a strategy and their subscrition history. Paginated endpoint.", "operationId": "C2_API_Strategies/GetSubscribers_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The C2 StrategyId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ActiveOnly", "in": "query", "description": "Set to True to include only currently active subscribers. Default is False", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscribersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetSubscriptionRevenue": { "get": { "summary": "GetSubscriptionRevenue", "description": "Request the subscriber revenue of a strategy. Paginated endpoint. You must provide at least one parameter other than Start/End date.", "operationId": "C2_API_Strategies/GetSubscriptionRevenue_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The C2 StrategyId (Optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "StartDate", "in": "query", "description": "StartDate (Optional)", "schema": { "type": "string" } }, { "name": "EndDate", "in": "query", "description": "EndDate (Optional)", "schema": { "type": "string" } }, { "name": "StrategyOwnerPersonId", "in": "query", "description": "The Strategy Owner's PersonId (Optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "SubscriberPersonId", "in": "query", "description": "The Subscriber's PersonId (Optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WhiteLabelSiteId", "in": "query", "description": "The White Label Site Id (Optional)", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscribersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/NewStrategyOrder": { "post": { "summary": "NewStrategyOrder", "description": "Send a new order for the strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/NewStrategyOrder_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStrategyOrder" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSignalResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/CancelStrategyOrder": { "delete": { "summary": "CancelStrategyOrder", "description": "Cancel a order. Non-paginated endpoint.", "operationId": "C2_API_Strategies/CancelStrategyOrder_DELETE", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The Strategy ID", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "SignalId", "in": "query", "description": "The Signal ID to be cancelled", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSignalResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/ReplaceStrategyOrder": { "put": { "summary": "ReplaceStrategyOrder", "description": "Send a cancel/replace a order for the strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/ReplaceStrategyOrder_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceStrategyOrder" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceSignalResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyActiveOrders": { "get": { "summary": "GetStrategyActiveOrders", "description": "Request the open orders for the strategies. Non-paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyActiveOrders_GET", "parameters": [ { "name": "StrategyIds", "in": "query", "description": "A list of Strategy IDs", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "SecurityType", "in": "query", "description": "(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'", "schema": { "type": "string" } }, { "name": "OrderType", "in": "query", "description": "(optional) OrderType filter. e.g. '1' = Market, '2' = Limit, '3' = Stop", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActiveOrdersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyOpenPositions": { "get": { "summary": "GetStrategyOpenPositions", "description": "Request the open positions for the strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyOpenPositions_GET", "parameters": [ { "name": "StrategyIds", "in": "query", "description": "A list of Strategy IDs", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "SecurityType", "in": "query", "description": "(optional) SecurityType filter. e.g. Stocks = 'CS', Futures = 'FUT', Options = 'OPT', Forex = 'FOR'", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOpenPositionsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyHistoricalOrders": { "get": { "summary": "GetStrategyHistoricalOrders", "description": "Returns the historical orders of the strategy. Paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyHistoricalOrders_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "StrategyId (optional: StrategyId or SignalId must be present)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "SignalId", "in": "query", "description": "SignalId (optional: StrategyId or SignalId must be present)", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "OrderStatus", "in": "query", "description": "Optional. Available values: '2' = Filled, '4' = Canceled, 'C' = Expired", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "description": "UTC StartDate (Optional)", "schema": { "type": "string" } }, { "name": "EndDate", "in": "query", "description": "UTC EndDate (Optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHistoricalOrdersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/AddStrategy": { "post": { "summary": "AddStrategy", "description": "Create a new, empty, publicly visible strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/AddStrategy_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddStrategy" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddStrategyResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/UpdateStrategy": { "put": { "summary": "UpdateStrategy", "description": "Modify a strategy. Not available yet. Please contact us if you ened this endpoint. Non-paginated endpoint.", "operationId": "C2_API_Strategies/UpdateStrategy_PUT", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStrategy" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStrategyResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyHistoricalEquity": { "get": { "summary": "GetStrategyHistoricalEquity", "description": "Returns monthly returns for the strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyHistoricalEquity_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The Strategy ID to get data for", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "CommissionPlan", "in": "query", "description": "(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", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStrategyHistoricalEquityResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyHistoricalDailyEquity": { "get": { "summary": "GetStrategyHistoricalDailyEquity", "description": "Returns daily returns for the strategy. Non-paginated endpoint.", "operationId": "C2_API_Strategies/GetStrategyHistoricalDailyEquity_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The Strategy ID to get data for", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "CommissionPlan", "in": "query", "description": "(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", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStrategyHistoricalEquityResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetStrategyHistoricalClosedTrades": { "get": { "summary": "GetStrategyHistoricalClosedTrades", "description": "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.", "operationId": "C2_API_Strategies/GetStrategyHistoricalClosedTrades_GET", "parameters": [ { "name": "StrategyId", "in": "query", "description": "The StrategyId", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "PersonId", "in": "query", "description": "(optional) The PersonId who will view the information. Available to WhiteLabel and GeoSite admins only. Default is the requester's PersonId", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "CommissionPlan", "in": "query", "description": "(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", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStrategyHistoricalClosedTradesResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/SetDesiredPositions": { "post": { "summary": "SetDesiredPositions", "description": "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.", "operationId": "C2_API_Strategies/SetDesiredPositions_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDesiredPositions" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDesiredPositionsResponse" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/v2/Strategies/SetDesiredPositions": { "post": { "summary": "SetDesiredPositionsV2", "description": "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.", "operationId": "C2_API_v2/Strategies/SetDesiredPositions_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDesiredPositionsV2" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDesiredPositionsV2Response" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetWatchLists": { "get": { "summary": "GetWatchLists", "description": "Request all watchlists available to the user. Paginated endpoint.", "operationId": "C2_API_Strategies/GetWatchLists_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWatchListsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetWatchListMembers": { "get": { "summary": "GetWatchListMembers", "description": "Request a list of strategies in the watchlist. Paginated endpoint.", "operationId": "C2_API_Strategies/GetWatchListMembers_GET", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WatchListId", "in": "query", "description": "The WatchList Id", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWatchListMembersResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/ManageWatchList": { "post": { "summary": "ManageWatchList", "description": "Edit watchlists and their members. Non-paginated endpoint.", "operationId": "C2_API_Strategies/ManageWatchList_POST", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageWatchList" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponseBase" } } } }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } }, "delete": { "summary": "ManageWatchList", "description": "Edit watchlists and their members. Non-paginated endpoint.", "operationId": "C2_API_Strategies/ManageWatchList_DELETE", "parameters": [ { "name": "PersonId", "in": "query", "description": "The C2 PersonId", "required": true, "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WatchListId", "in": "query", "description": "The WatchList Id. Required except when ModificationAction=ADD and ModificationSource=LIST", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "ModificationSource", "in": "query", "description": "The Type of list to modify. Valid values are 'LIST' (for the whole watchlist), 'MEMBER' (for the list items)", "required": true, "schema": { "type": "string" } }, { "name": "ModificationAction", "in": "query", "description": "The change to make. Valid values are: ADD, DELETE", "required": true, "schema": { "type": "string" } }, { "name": "StrategyId", "in": "query", "description": "The Strategy Id. Only required when ModificationSource=MEMBER", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "WatchListName", "in": "query", "description": "The name of the watchlist. Only required when ModificationAction=ADD and ModificationSource=LIST", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResponseBase" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } }, "/Strategies/GetSupportedSymbols": { "get": { "summary": "GetSupportedSymbols", "description": "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.", "operationId": "C2_API_Strategies/GetSupportedSymbols_GET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSupportedSymbolsResponse" } } } }, "304": { "description": "NotModified: Used when HTTP caching headers are in play. Only sent in response to If-Modified-Since headers." }, "400": { "description": "BadRequest: Your request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "401": { "description": "Unauthorized: Your API key is wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "403": { "description": "Forbidden: You do not have access rights to the content. Unlike 401, your identity is known to the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "404": { "description": "NotFound: When a non-existent endpoint or resource is requested (bad URL or requested data was not found).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "406": { "description": "NotAcceptable: If incorrect Accept header was provided as part of the request. Accept header must be 'application/json'.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "409": { "description": "Conflict: When the request is well-formed and valid, but conflicts with the current resource state in a way that prevents processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "429": { "description": "TooManyRequests: When a request is rejected due to rate limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "500": { "description": "InternalServerError: Used for internal errors. No details are provided to clients for security reasons. Please contact us at help@collective2.com if you see this.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } }, "503": { "description": "ServiceUnavailable: We're temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseStatus" } } } } } } } }, "components": { "schemas": { "AccessKeyDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The row ID", "format": "int64" }, "AccessKey": { "required": [ "AccessKey" ], "type": "string", "description": "The API AccessKey", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId assigned to the AccessKey", "format": "int64" }, "FirstName": { "required": [ "FirstName" ], "type": "string", "description": "The FirstName. Not case-sensitive", "nullable": true }, "LastName": { "required": [ "LastName" ], "type": "string", "description": "The FirstName. Not case-sensitive", "nullable": true }, "Email": { "required": [ "Email" ], "type": "string", "description": "The Email. Not case-sensitive", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The White Label site Id", "format": "int64", "nullable": true }, "Role": { "required": [ "Role" ], "type": "string", "description": "The Role assigned to the AccessKey", "nullable": true }, "Message": { "required": [ "Message" ], "type": "string", "description": "A human-frienly message", "nullable": true }, "CreateDate": { "required": [ "CreateDate" ], "type": "string", "description": "The UTC DateTime when the key was created", "format": "date-time", "nullable": true }, "DeleteDate": { "required": [ "DeleteDate" ], "type": "string", "description": "The UTC DateTime when the key was deleted", "format": "date-time", "nullable": true }, "Comment": { "required": [ "Comment" ], "type": "string", "description": "A user comment about the key", "nullable": true } }, "additionalProperties": false }, "AccountDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The row ID", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64", "nullable": true }, "Account": { "required": [ "Account" ], "type": "string", "description": "The Brokerage/SIM/Papertrade Account", "nullable": true }, "BrokerName": { "required": [ "BrokerName" ], "type": "string", "description": "The broker name", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The broker ID", "format": "int64", "nullable": true }, "FirstName": { "required": [ "FirstName" ], "type": "string", "description": "The FirstName. Not case-sensitive", "nullable": true }, "LastName": { "required": [ "LastName" ], "type": "string", "description": "The FirstName. Not case-sensitive", "nullable": true }, "Email": { "required": [ "Email" ], "type": "string", "description": "The Email", "nullable": true }, "Language": { "required": [ "Language" ], "type": "string", "description": "The person's preferred language", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The White Label SiteId", "format": "int64", "nullable": true }, "GeoSite": { "required": [ "GeoSite" ], "type": "string", "description": "The account GeoSite", "nullable": true }, "CountryCode": { "required": [ "CountryCode" ], "type": "string", "description": "The person's country code", "nullable": true }, "DivisionCode": { "required": [ "DivisionCode" ], "type": "string", "description": "The person's division (usually the state) code", "nullable": true }, "AuthenticatedDate": { "required": [ "AuthenticatedDate" ], "type": "string", "description": "When the Account was Authenticated. Some broker connections (e.g. CQG, Rithmic, ETNA, ORBIS, StoneX, Tradovate, TransACT) require the broker to approve the account, while others (e.g. IB) don't, in which case the date will be when the client setup Autotrading. NULL if never approved by the broker and it is a broker that requires account approval", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AccountNAVDTO": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Brokerage Account", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "The StartDate of the report", "format": "date-time" }, "EndDate": { "required": [ "EndDate" ], "type": "string", "description": "The EndDate of the report", "format": "date-time" }, "TotalDataDays": { "required": [ "TotalDataDays" ], "type": "integer", "description": "The total number of days where we have data", "format": "int32" }, "Currency": { "required": [ "Currency" ], "type": "string", "description": "The base currency of the account", "nullable": true }, "StartNAV": { "required": [ "StartNAV" ], "type": "number", "description": "The Start NAV of the report", "format": "double" }, "EndNAV": { "required": [ "EndNAV" ], "type": "number", "description": "The End NAV of the report", "format": "double" }, "Deposits": { "required": [ "Deposits" ], "type": "number", "description": "The total deposits in the account during the report period", "format": "double" }, "Withdrawals": { "required": [ "Withdrawals" ], "type": "number", "description": "The total withdrawals in the account during the report period", "format": "double" }, "Return1Month": { "required": [ "Return1Month" ], "type": "number", "description": "1 month percent return for the account", "format": "double" }, "Return3Month": { "required": [ "Return3Month" ], "type": "number", "description": "3 month percent return for the account", "format": "double" }, "Return12Month": { "required": [ "Return12Month" ], "type": "number", "description": "12 month percent return for the account. This will be annualized if there is less than 12 months of data available", "format": "double" }, "ReturnEntirePeriod": { "required": [ "ReturnEntirePeriod" ], "type": "number", "description": "Percent return for the entire specified period", "format": "double" } }, "additionalProperties": false }, "AccountsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AccountDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "AddPersonResponseDTO": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId", "format": "int64" }, "Csrf": { "required": [ "CSRF" ], "type": "string", "description": "The CSRF to be used by the White Label Site. Only send in response when Person was created by a White Label Site admin", "nullable": true } }, "additionalProperties": false }, "AddProfileResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AddPersonResponseDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "AddStrategy": { "type": "object", "properties": { "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The desired strategy name", "nullable": true }, "StartingCapital": { "required": [ "StartingCapital" ], "type": "integer", "description": "(Optional) The starting capital. Must be set when Account is not specified, ignored when Account is specified", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AddStrategyResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "ApprovedAccount": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId", "format": "int64", "nullable": true }, "AddedDate": { "required": [ "AddedDate" ], "type": "string", "description": "The UTC date when the record was created", "format": "date-time" }, "Account": { "required": [ "Account" ], "type": "string", "description": "The Brokerage Account", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The BrokerId", "format": "int64" }, "ConnectionType": { "required": [ "ConnectionType" ], "type": "integer", "description": "The Connection type. 0 = Autotrade, 1 = BrokerTransmit", "format": "int32" }, "AddedByPersonId": { "required": [ "AddedByPersonId" ], "type": "integer", "description": "The PersonId who approved the account", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AutotradeSettingsDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The unique Id", "format": "int64" }, "PersonId": { "type": "integer", "format": "int64" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "State": { "type": "string", "nullable": true }, "Language": { "type": "string", "nullable": true }, "SiteDomain": { "type": "string", "nullable": true }, "BrokerId": { "type": "integer", "format": "int32" }, "Connection": { "type": "string", "nullable": true }, "IntroducingBrokerId": { "type": "integer", "format": "int32" }, "IntroducingBroker": { "type": "string", "nullable": true }, "StrategyId": { "type": "integer", "format": "int64" }, "StrategyName": { "type": "string", "nullable": true }, "Account": { "type": "string", "nullable": true }, "AccountType": { "type": "integer", "format": "int32" }, "BrokerUserID": { "type": "string", "nullable": true }, "Currency": { "type": "string", "nullable": true }, "SalesRepId": { "type": "integer", "format": "int32" }, "SalesRep": { "type": "string", "nullable": true }, "IsTradeLeader": { "type": "boolean" }, "IsManualDiscardedPosition": { "type": "boolean", "nullable": true }, "IgnoreManualOrders": { "type": "boolean" }, "IsConfirmationNeeded": { "type": "boolean" }, "IsSyncEnabled": { "type": "boolean" }, "WillSyncToOpenStocksUSA": { "type": "boolean" }, "WillSyncToOpenStocksEurope": { "type": "boolean" }, "WillSyncToOpenOptionsUSA": { "type": "boolean" }, "WillSyncToOpenOptionsEurope": { "type": "boolean" }, "WillSyncToOpenFuturesUSA": { "type": "boolean" }, "WillSyncToOpenFuturesEurope": { "type": "boolean" }, "WillSyncToOpenFuturesAsia": { "type": "boolean" }, "WillSyncToOpenForex": { "type": "boolean" }, "LastSyncStocksUSA": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncStocksEurope": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncOptionsUSA": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncOptionsEurope": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncFuturesUSA": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncFuturesEurope": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncFuturesAsia": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncForex": { "type": "string", "format": "date-time", "nullable": true }, "IsBrokerEnabled": { "type": "boolean" }, "IsAutotradeDisabled": { "type": "boolean" }, "IsAutotradeDisabledReason": { "type": "string", "nullable": true }, "SyncDisabledReason": { "type": "string", "nullable": true }, "FirstBrokerActivationDate": { "type": "string", "format": "date-time", "nullable": true }, "NetLiquidationValue": { "type": "number", "format": "double", "nullable": true }, "NetLiquidationValueDate": { "type": "string", "format": "date-time", "nullable": true }, "VirtualLimitOrdersEnabled": { "type": "boolean" }, "ScalingPercentage": { "type": "number", "format": "double" }, "SettingsLastUpdateUTC": { "type": "string", "format": "date-time" }, "Approved": { "type": "boolean" }, "ClosingOrdersOnly": { "type": "boolean" }, "EnabledFutures": { "type": "boolean" }, "FuturesLong": { "type": "boolean" }, "FuturesShort": { "type": "boolean" }, "MinFutures": { "type": "integer", "format": "int32", "nullable": true }, "MaxFutures": { "type": "integer", "format": "int32", "nullable": true }, "EnabledForex": { "type": "boolean" }, "ForexEnabledLong": { "type": "boolean" }, "ForexEnabledShort": { "type": "boolean" }, "ForexLotSize": { "type": "integer", "format": "int32", "nullable": true }, "MinForex": { "type": "integer", "format": "int32", "nullable": true }, "MaxForex": { "type": "integer", "format": "int32", "nullable": true }, "EnabledStocks": { "type": "boolean" }, "StocksLong": { "type": "boolean" }, "StocksShort": { "type": "boolean" }, "MaxStocksDollars": { "type": "integer", "format": "int32", "nullable": true }, "TradeStocksAsCFD": { "type": "boolean" }, "EnabledOptions": { "type": "boolean" }, "OptionsLong": { "type": "boolean" }, "OptionsShort": { "type": "boolean" }, "MinOptions": { "type": "integer", "format": "int32", "nullable": true }, "MaxOptions": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AutotradedStrategyDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The Subscription ID", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64" }, "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotraded Account", "nullable": true }, "ScalingPercentage": { "required": [ "ScalingPercentage" ], "type": "number", "description": "The Autotraded Scaling Percentage", "format": "double" }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 SystemID", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The BrokerId", "format": "int32", "nullable": true }, "BrokerName": { "required": [ "BrokerName" ], "type": "string", "description": "The broker name", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date when the person setup Autotrading for the Strategy", "format": "date-time", "nullable": true }, "LastModified": { "required": [ "LastModified" ], "type": "string", "description": "UTC Date when the person last modified the Autotrade settings for the Strategy", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BooleanResponseBase": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "type": "boolean" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "BrokerDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The unique Id", "format": "int64" }, "Name": { "required": [ "Name" ], "type": "string", "description": "The broker name", "nullable": true }, "IsEnabled": { "required": [ "IsEnabled" ], "type": "boolean", "description": "TRUE if broker is Live" }, "ConnectionName": { "required": [ "ConnectionName" ], "type": "string", "description": "The Autotrade name to show clients", "nullable": true } }, "additionalProperties": false }, "C2SymbolDTO": { "type": "object", "properties": { "FullSymbol": { "required": [ "FullSymbol" ], "type": "string", "description": "The full native C2 symbol e.g. BSRR2121Q22.5", "nullable": true }, "SymbolType": { "required": [ "SymbolType" ], "type": "string", "description": "The type of instrument. e.g. 'stock', 'option', 'future', 'forex'", "nullable": true }, "Underlying": { "required": [ "Underlying" ], "type": "string", "description": "Option Underlying symbol. Read-only value sent in responses. It is ignored in requests.", "nullable": true }, "Expiry": { "required": [ "Expiry" ], "type": "string", "description": "Option expiry. Format is 'May21'. Read-only value sent in responses. It is ignored in requests.", "nullable": true }, "PutOrCall": { "required": [ "PutOrCall" ], "type": "string", "description": "Option 'put' or 'call'. Read-only value sent in responses. It is ignored in requests.", "nullable": true }, "StrikePrice": { "required": [ "StrikePrice" ], "type": "number", "description": "Option strike price. Read-only value sent in responses. It is ignored in requests.", "format": "double", "nullable": true }, "Description": { "required": [ "Description" ], "type": "string", "description": "(optional) Instrument description. Read-only value sent in responses. It is ignored in requests.", "nullable": true } }, "additionalProperties": false }, "CancelAutotradeOrderResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "CancelSignalResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "DashBoardItemDTO": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64" }, "BrokerName": { "required": [ "BrokerName" ], "type": "string", "description": "The broker name, if any", "nullable": true }, "Account": { "required": [ "Account" ], "type": "string", "description": "The Brokerage/SIM/Papertrade Account", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "StrategyId", "format": "int64", "nullable": true }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date when the person setup Autotrading for the Strategy", "format": "date-time", "nullable": true }, "TodayReturn": { "required": [ "TodayReturn" ], "type": "number", "description": "Today's profit", "format": "double", "nullable": true }, "TotalReturn": { "required": [ "TotalReturn" ], "type": "number", "description": "The total profit", "format": "double", "nullable": true } }, "additionalProperties": false }, "DesiredPositionResponseDTO": { "type": "object", "properties": { "NewSignals": { "required": [ "NewSignals" ], "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "New Signals", "nullable": true }, "CanceledSignals": { "required": [ "CanceledSignals" ], "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Canceled Signals", "nullable": true } }, "additionalProperties": false }, "DesiredPositionResponseDTOV2": { "type": "object", "properties": { "NewSignals": { "required": [ "NewSignals" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalResponse" }, "description": "New Signals", "nullable": true }, "CanceledSignals": { "required": [ "CanceledSignals" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalResponse" }, "description": "Canceled Signals", "nullable": true }, "RejectedSignals": { "required": [ "RejectedSignals" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalResponse" }, "description": "Rejected Signals", "nullable": true } }, "additionalProperties": false }, "ExchangeSymbolDTO": { "type": "object", "properties": { "Symbol": { "required": [ "Symbol" ], "type": "string", "description": "The exchange root symbol e.g. AAPL", "nullable": true }, "Currency": { "required": [ "Currency" ], "type": "string", "description": "The 3-character ISO instrument currency. E.g. 'USD'", "nullable": true }, "SecurityExchange": { "required": [ "SecurityExchange" ], "type": "string", "description": "The MIC Exchange code. Set to DEFAULT for stocks, forex & options. For Futures, valid values are: XCME, XEUR, XICE, XLIF, XNYB, XNYM, XASX, XCBF, XCBT, XCEC, XKBT, XSES. See details at http://www.iso15022.org/MIC/homepageMIC.htm", "nullable": true }, "SecurityType": { "required": [ "SecurityType" ], "type": "string", "description": "The SecurityType e.g. 'CS', 'FUT', 'OPT', 'FOR'", "nullable": true }, "MaturityMonthYear": { "required": [ "MaturityMonthYear" ], "type": "string", "description": "The MaturityMonthYear e.g. '202503' (March 2025), or if the contract requires a day: '20210521' (May 21, 2025)", "nullable": true }, "PutOrCall": { "required": [ "PutOrCall" ], "type": "integer", "description": "The Option PutOrCall e.g. 0 = Put, 1 = Call", "format": "int32", "nullable": true }, "StrikePrice": { "required": [ "StrikePrice" ], "type": "number", "description": "The ISO Option Strike Price. Zero means none", "format": "double", "nullable": true }, "PriceMultiplier": { "required": [ "PriceMultiplier" ], "type": "number", "description": "The multiplier to apply to the Exchange price to get the C2-formatted price. Read-only value sent in responses. It is ignored in requests.", "format": "double", "nullable": true } }, "additionalProperties": false }, "GetAccessKeyResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AccessKeyDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetActiveOrdersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetAutotradeHistoricalOrdersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetAutotradeSettingsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AutotradeSettingsDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetAutotradedStrategiesResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AutotradedStrategyDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetAutotradersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/AutotradedStrategyDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetBrokersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/BrokerDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetDashBoardResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/DashBoardItemDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetHistoricalOrdersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetOpenPositionsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/PositionDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetSimResultsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SimResultDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetStrategyDetailsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyDetailsDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetStrategyHistoricalClosedTradesResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/HistoricalTradeDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetStrategyHistoricalEquityResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyHistoricalEquityDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetSubscribedStrategiesResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SubcribedStrategyDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetSubscribersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategySubscriberDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetSubscriptionsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetSupportedSymbolsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SupportedSymbolDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetWatchListMembersResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/WatchListMemberDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "GetWatchListsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/WatchListDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "Hello": { "type": "object", "properties": { "Name": { "required": [ "Name" ], "type": "string", "description": "Your name (or any string)", "nullable": true } }, "additionalProperties": false }, "HelloResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "type": "string" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "HistoricalStatDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "Report Id", "format": "int64" }, "StatName": { "required": [ "StatName" ], "type": "string", "description": "The Statistic Name", "nullable": true }, "Operator": { "required": [ "Operator" ], "type": "string", "description": "The logical operation to perform. Must be one of: > >= = <> < <=", "nullable": true }, "StatValue": { "required": [ "StatValue" ], "type": "number", "description": "The value", "format": "double", "nullable": true } }, "additionalProperties": false }, "HistoricalTradeDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The row ID", "format": "int64" }, "TradeId": { "required": [ "TradeId" ], "type": "integer", "description": "The TradeId", "format": "int64", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "OpenDate": { "required": [ "OpenDate" ], "type": "string", "description": "DateTime when the trade was opened", "format": "date-time", "nullable": true }, "CloseDate": { "required": [ "CloseDate" ], "type": "string", "description": "DateTime when the trade was closed", "format": "date-time", "nullable": true }, "AvgOpenFillPrice": { "required": [ "AvgOpenFillPrice" ], "type": "number", "description": "The volume-weighted average opening fill price (VWAP)", "format": "double", "nullable": true }, "AvgCloseFillPrice": { "required": [ "AvgCloseFillPrice" ], "type": "number", "description": "The volume-weighted average closing fill price (VWAP)", "format": "double", "nullable": true }, "OpenedQuantity": { "required": [ "OpenedQuantity" ], "type": "number", "description": "The total quantity opened", "format": "double", "nullable": true }, "ClosedQuantity": { "required": [ "ClosedQuantity" ], "type": "number", "description": "The total quantity closed", "format": "double", "nullable": true }, "OpenSide": { "required": [ "OpenSide" ], "enum": [ "1", "2" ], "type": "string", "description": "'1' = Buy, '2' = Sell", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Buy", "2": "Sell" } }, "CloseSide": { "required": [ "CloseSide" ], "enum": [ "1", "2" ], "type": "string", "description": "'1' = Buy, '2' = Sell", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Buy", "2": "Sell" } }, "ProfitLoss": { "required": [ "ProfitLoss" ], "type": "number", "description": "The net profit or loss of the trade", "format": "double", "nullable": true }, "Commission": { "required": [ "Commission" ], "type": "number", "description": "The commission included in the ProfitLoss", "format": "double", "nullable": true }, "MaxDrawdown": { "required": [ "MaxDrawdown" ], "type": "number", "description": "The unrealized currency loss when the maximum peak-to-valley drawdown occurred for this trade", "format": "double", "nullable": true }, "MaxDrawdown_DateCalculated": { "required": [ "MaxDrawdown_DateCalculated" ], "type": "string", "description": "The timestamp when this maximum peak-to-valley drawdown was calculated in New York time zone", "format": "date-time", "nullable": true }, "MaxDrawdown_WorstPrice": { "required": [ "MaxDrawdown_WorstPrice" ], "type": "number", "description": "The worst price during the peak-to-valley drawdown for this trade", "format": "double", "nullable": true }, "MaxDrawdown_WorstPriceDate": { "required": [ "MaxDrawdown_WorstPriceDate" ], "type": "string", "description": "The date in New York time zone when the worst price occurred during the peak-to-valley drawdown for this trade", "format": "date-time", "nullable": true }, "MaxDrawdown_StrategyEquity": { "required": [ "MaxDrawdown_StrategyEquity" ], "type": "number", "description": "The Strategy equity when the maximum peak-to-valley drawdown occurred for this trade", "format": "double", "nullable": true }, "MaxDrawdown_EntryPrice": { "required": [ "MaxDrawdown_EntryPrice" ], "type": "number", "description": "The price at which the trade causing the maximum equity drop", "format": "double", "nullable": true }, "MaxDrawdown_OpenQuantity": { "required": [ "MaxDrawdown_OpenQuantity" ], "type": "number", "description": "The size of the trade (number of units) that initiated the maximum peak-to-valley drawdown", "format": "double", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" } }, "additionalProperties": false }, "ManageWatchList": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64", "nullable": true }, "WatchListId": { "required": [ "WatchListId" ], "type": "integer", "description": "The WatchList Id. Required except when ModificationAction=ADD and ModificationSource=LIST", "format": "int64", "nullable": true }, "ModificationSource": { "required": [ "ModificationSource" ], "type": "string", "description": "The Type of list to modify. Valid values are 'LIST' (for the whole watchlist), 'MEMBER' (for the list items)", "nullable": true }, "ModificationAction": { "required": [ "ModificationAction" ], "type": "string", "description": "The change to make. Valid values are: ADD, DELETE", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The Strategy Id. Only required when ModificationSource=MEMBER", "format": "int64", "nullable": true }, "WatchListName": { "required": [ "WatchListName" ], "type": "string", "description": "The name of the watchlist. Only required when ModificationAction=ADD and ModificationSource=LIST", "nullable": true } }, "additionalProperties": false }, "MarginRequirementsDTO": { "type": "object", "properties": { "Initial": { "required": [ "Initial" ], "type": "number", "description": "Upfront amount needed to trade the instrument", "format": "double", "nullable": true }, "Maintenance": { "required": [ "Maintenance" ], "type": "number", "description": "Minimum account balance required to keep the position open", "format": "double", "nullable": true } }, "additionalProperties": false }, "NewAutotradeOrder": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true }, "Order": { "$ref": "#/components/schemas/OrderDTO" } }, "additionalProperties": false }, "NewAutotradeOrderResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "NewSignalResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "NewStrategyOrder": { "type": "object", "properties": { "Order": { "$ref": "#/components/schemas/OrderDTO" } }, "additionalProperties": false }, "OrderDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The row ID. Read-only. Only present in response", "format": "int64" }, "OrderId": { "required": [ "OrderId" ], "type": "string", "description": "The OrderId. Only required in NewAutotradeOrder and ReplaceAutotradeOrder endpoints", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The C2 Strategy name. Read-only. Only present in response", "nullable": true }, "SignalId": { "required": [ "SignalId" ], "type": "integer", "description": "Only required in ReplaceAutotradeOrder endpoint. The C2 SignalId", "format": "int64", "nullable": true }, "AvgPx": { "required": [ "AvgPx" ], "type": "number", "description": "The order average fill price", "format": "double", "nullable": true }, "OrderType": { "required": [ "OrderType" ], "enum": [ "1", "2", "3" ], "type": "string", "description": "'1' = Market, '2' = Limit, '3' = Stop", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Market", "2": "Limit", "3": "Stop" } }, "Side": { "required": [ "Side" ], "enum": [ "1", "2" ], "type": "string", "description": "'1' = Buy, '2' = Sell", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Buy", "2": "Sell" } }, "OpenClose": { "required": [ "OpenClose" ], "enum": [ "O", "C" ], "type": "string", "description": "Only required in ReplaceAutotradeOrder endpoint. 'O' = Open, 'C' = Close", "nullable": true, "example": "O", "x-enumDescriptions": { "O": "Open", "C": "Close" } }, "OrderQuantity": { "required": [ "OrderQuantity" ], "type": "number", "description": "The unsigned order quantity", "format": "double", "nullable": true }, "Limit": { "required": [ "Limit" ], "type": "number", "description": "The C2-formatted Limit Price", "format": "double", "nullable": true }, "Stop": { "required": [ "Stop" ], "type": "number", "description": "The C2-formatted Stop Price", "format": "double", "nullable": true }, "Tif": { "required": [ "TIF" ], "enum": [ "0", "1" ], "type": "string", "description": "The time in force. 0 = Day, 1 = Good Till Cancel (GTC)", "nullable": true, "example": "0", "x-enumDescriptions": { "0": "Day", "1": "GTC" } }, "ProfitTarget": { "required": [ "ProfitTarget" ], "type": "number", "description": "Only available in NewStrategyOrder endpoint. The C2-formatted Price at which to place a exit conditional order", "format": "double", "nullable": true }, "StopLoss": { "required": [ "StopLoss" ], "type": "number", "description": "Only available in NewStrategyOrder endpoint. The C2-formatted Price at which to place a exit conditional order", "format": "double", "nullable": true }, "DoNotCreateOCAGroup": { "required": [ "DoNotCreateOCAGroup" ], "type": "boolean", "description": "Only available in NewStrategyOrder endpoint. Default is false. Used to indicate the ProfitTarget and StopLoss orders should not be added to a OCA group. Each exit order will be managed separately", "nullable": true }, "CancelReplaceSignalId": { "required": [ "CancelReplaceSignalId" ], "type": "integer", "description": "Used to specify that this order replaces another", "format": "int64", "nullable": true }, "ParentSignalId": { "required": [ "ParentSignalId" ], "type": "integer", "description": "Used to specify that this order is conditional (a child) on another", "format": "int64", "nullable": true }, "ParkedUntilDate": { "required": [ "ParkedUntilDate" ], "type": "string", "description": "The New-York date/time when the signal should be released. Applies only to Strategy signals", "format": "date-time", "nullable": true }, "DoNotSyncToOpen": { "required": [ "DoNotSyncToOpen" ], "type": "boolean", "description": "Used to indicate this order should not be synched in the brokerage account. Only applies to Opening non-market orders", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" }, "RejectMessage": { "required": [ "RejectMessage" ], "type": "string", "description": "The order rejection message. Only available in response when OrderStatus = '8' (Rejected)", "nullable": true } }, "additionalProperties": false }, "OrderStatusDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The row ID. Read-only. Only present in response", "format": "int64" }, "OrderId": { "required": [ "OrderId" ], "type": "string", "description": "The OrderId. Only required in NewAutotradeOrder and ReplaceAutotradeOrder endpoints", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The C2 Strategy name. Read-only. Only present in response", "nullable": true }, "SignalId": { "required": [ "SignalId" ], "type": "integer", "description": "Only required in ReplaceAutotradeOrder endpoint. The C2 SignalId", "format": "int64", "nullable": true }, "AvgPx": { "required": [ "AvgPx" ], "type": "number", "description": "The order average fill price", "format": "double", "nullable": true }, "OrderType": { "required": [ "OrderType" ], "enum": [ "1", "2", "3" ], "type": "string", "description": "'1' = Market, '2' = Limit, '3' = Stop", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Market", "2": "Limit", "3": "Stop" } }, "Side": { "required": [ "Side" ], "enum": [ "1", "2" ], "type": "string", "description": "'1' = Buy, '2' = Sell", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Buy", "2": "Sell" } }, "OpenClose": { "required": [ "OpenClose" ], "enum": [ "O", "C" ], "type": "string", "description": "Only required in ReplaceAutotradeOrder endpoint. 'O' = Open, 'C' = Close", "nullable": true, "example": "O", "x-enumDescriptions": { "O": "Open", "C": "Close" } }, "OrderQuantity": { "required": [ "OrderQuantity" ], "type": "number", "description": "The unsigned order quantity", "format": "double", "nullable": true }, "Limit": { "required": [ "Limit" ], "type": "number", "description": "The C2-formatted Limit Price", "format": "double", "nullable": true }, "Stop": { "required": [ "Stop" ], "type": "number", "description": "The C2-formatted Stop Price", "format": "double", "nullable": true }, "Tif": { "required": [ "TIF" ], "enum": [ "0", "1" ], "type": "string", "description": "The time in force. 0 = Day, 1 = Good Till Cancel (GTC)", "nullable": true, "example": "0", "x-enumDescriptions": { "0": "Day", "1": "GTC" } }, "ProfitTarget": { "required": [ "ProfitTarget" ], "type": "number", "description": "Only available in NewStrategyOrder endpoint. The C2-formatted Price at which to place a exit conditional order", "format": "double", "nullable": true }, "StopLoss": { "required": [ "StopLoss" ], "type": "number", "description": "Only available in NewStrategyOrder endpoint. The C2-formatted Price at which to place a exit conditional order", "format": "double", "nullable": true }, "DoNotCreateOCAGroup": { "required": [ "DoNotCreateOCAGroup" ], "type": "boolean", "description": "Only available in NewStrategyOrder endpoint. Default is false. Used to indicate the ProfitTarget and StopLoss orders should not be added to a OCA group. Each exit order will be managed separately", "nullable": true }, "CancelReplaceSignalId": { "required": [ "CancelReplaceSignalId" ], "type": "integer", "description": "Used to specify that this order replaces another", "format": "int64", "nullable": true }, "ParentSignalId": { "required": [ "ParentSignalId" ], "type": "integer", "description": "Used to specify that this order is conditional (a child) on another", "format": "int64", "nullable": true }, "ParkedUntilDate": { "required": [ "ParkedUntilDate" ], "type": "string", "description": "The New-York date/time when the signal should be released. Applies only to Strategy signals", "format": "date-time", "nullable": true }, "DoNotSyncToOpen": { "required": [ "DoNotSyncToOpen" ], "type": "boolean", "description": "Used to indicate this order should not be synched in the brokerage account. Only applies to Opening non-market orders", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" }, "RejectMessage": { "required": [ "RejectMessage" ], "type": "string", "description": "The order rejection message. Only available in response when OrderStatus = '8' (Rejected)", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "BrokerId", "format": "int64", "nullable": true }, "OrderStatus": { "required": [ "OrderStatus" ], "type": "string", "description": "'A' = PendingNew, '0' = Working, '1' = Partially filled, '2' = Filled, '4' = Canceled, '5' = Replaced, '6' = Pending Cancel, '8' = Rejected, 'C' = Expired, 'E' = Pending Replace", "nullable": true }, "FilledQuantity": { "required": [ "FilledQuantity" ], "type": "number", "description": "The unsigned quantity filled", "format": "double", "nullable": true }, "AvgFillPrice": { "required": [ "AvgFillPrice" ], "type": "number", "description": "The average fill price, if FilledQuantity > 0", "format": "double", "nullable": true }, "PostedDate": { "required": [ "PostedDate" ], "type": "string", "description": "UTC DateTime when the order was posted", "format": "date-time", "nullable": true }, "SignalType": { "required": [ "SignalType" ], "type": "integer", "description": "The type of signal. 1 = StrategySignal, 4 = ManualSignal, 5 = StrategySignalManualOverride, 6 = AutoStopLoss", "format": "int32" }, "Info": { "required": [ "Info" ], "type": "string", "description": "Detailed information about the order, if available", "nullable": true } }, "additionalProperties": false }, "PaginationProperties": { "type": "object", "properties": { "Prev_cursor": { "required": [ "prev_cursor" ], "type": "string", "description": "The previous Pagination Cursor", "nullable": true }, "Next_cursor": { "required": [ "next_cursor" ], "type": "string", "description": "The next Pagination Cursor", "nullable": true } }, "additionalProperties": false }, "PersonDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The PersonId", "format": "int64" }, "Alias": { "required": [ "Alias" ], "type": "string", "description": "The person's alias", "nullable": true }, "FirstName": { "required": [ "FirstName" ], "type": "string", "description": "The person's first name", "nullable": true }, "LastName": { "required": [ "LastName" ], "type": "string", "description": "The person's last name", "nullable": true }, "Email": { "required": [ "Email" ], "type": "string", "description": "The person's email. This is also the username when logging in to C2", "nullable": true }, "Phone": { "required": [ "Phone" ], "type": "string", "description": "The person's telephone", "nullable": true }, "IsPhoneVerified": { "required": [ "IsPhoneVerified" ], "type": "boolean", "description": "True if the the person's telephone is verified" }, "Language": { "required": [ "Language" ], "type": "string", "description": "The person's preferred language", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The White Label site Id", "format": "int64", "nullable": true }, "CountryCode": { "required": [ "CountryCode" ], "type": "string", "description": "The person's country code", "nullable": true }, "DivisionCode": { "required": [ "DivisionCode" ], "type": "string", "description": "The person's division (usually the state) code", "nullable": true }, "Created": { "required": [ "Created" ], "type": "string", "description": "The UTC date when the person was created", "format": "date-time" }, "LastLoggedIn": { "required": [ "LastLoggedIn" ], "type": "string", "description": "The UTC date when the person last logged in", "format": "date-time" }, "LastIP": { "required": [ "LastIP" ], "type": "string", "description": "The person's last known IP", "nullable": true }, "IsEmailValidated": { "required": [ "IsEmailValidated" ], "type": "boolean", "description": "The Person's email validation status" }, "IsAlive": { "required": [ "IsAlive" ], "type": "boolean", "description": "The Person's user account status" }, "ApprovedAccounts": { "required": [ "ApprovedAccounts" ], "type": "array", "items": { "$ref": "#/components/schemas/ApprovedAccount" }, "description": "The list of approved brokerage accounts for this person", "nullable": true }, "IsManager": { "required": [ "IsManager" ], "type": "boolean", "description": "True if the the person is a strategy manager" }, "IsInvestor": { "required": [ "IsInvestor" ], "type": "boolean", "description": "True if the the person is a strategy investor" }, "GeoSite": { "required": [ "GeoSite" ], "type": "string", "description": "The GeoSite", "nullable": true }, "IsGeoSiteAdmin": { "required": [ "IsGeoSiteAdmin" ], "type": "boolean", "description": "True if the the person is a GeoSite administrator", "nullable": true }, "SupportCompanyName": { "required": [ "SupportCompanyName" ], "type": "string", "description": "The customer support autotrade provider", "nullable": true }, "SupportSiteURL": { "required": [ "SupportSiteURL" ], "type": "string", "description": "The customer support website address", "nullable": true }, "SupportEmail": { "required": [ "SupportEmail" ], "type": "string", "description": "The customer support email", "nullable": true } }, "additionalProperties": false }, "PositionBase": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "Quantity": { "required": [ "Quantity" ], "type": "number", "description": "The net signed position quantity. Short positions will be negative.", "format": "double", "nullable": true }, "AvgPx": { "required": [ "AvgPx" ], "type": "number", "description": "The position average price", "format": "double", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" } }, "additionalProperties": false }, "PositionDTO": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "Quantity": { "required": [ "Quantity" ], "type": "number", "description": "The net signed position quantity. Short positions will be negative.", "format": "double", "nullable": true }, "AvgPx": { "required": [ "AvgPx" ], "type": "number", "description": "The position average price", "format": "double", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The C2 Strategy name", "nullable": true }, "Currency": { "required": [ "Currency" ], "type": "string", "description": "The 3-character ISO instrument currency. E.g. 'USD'", "nullable": true }, "OpenedDate": { "required": [ "OpenedDate" ], "type": "string", "description": "UTC DateTime when the position was opened", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ProfileResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/PersonDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "ReplaceAutotradeOrder": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true }, "OrderId": { "required": [ "OrderId" ], "type": "string", "description": "The OrderID to be replaced", "nullable": true }, "Price": { "required": [ "Price" ], "type": "number", "description": "The new Order price", "format": "double", "nullable": true } }, "additionalProperties": false }, "ReplaceAutotradeOrderResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "ReplaceSignalResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SignalIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "ReplaceStrategyOrder": { "type": "object", "properties": { "Order": { "$ref": "#/components/schemas/OrderDTO" } }, "additionalProperties": false }, "ResetPaperTrade": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ResponseError": { "type": "object", "properties": { "ErrorCode": { "type": "string", "description": "The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.", "nullable": true }, "FieldName": { "type": "string", "description": "The affected parameter.", "nullable": true }, "Message": { "type": "string", "description": "More details about the ErrorCode.", "nullable": true } }, "additionalProperties": false, "description": "Error information pertaining to a particular named field. Used for returning multiple field validation errors." }, "ResponseStatus": { "type": "object", "properties": { "ErrorCode": { "type": "string", "description": "The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.", "nullable": true }, "Message": { "type": "string", "description": "The human-readable meaning of the ErrorCode.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseError" }, "nullable": true } }, "additionalProperties": false }, "SearchStrategiesResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyBasicDetailsDTO" }, "description": "Result array", "nullable": true }, "Pagination": { "$ref": "#/components/schemas/PaginationProperties" }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "SetAutotradeSettings": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The C2 PersonID", "format": "int32", "nullable": true }, "IsAutotradeEnabled": { "required": [ "IsAutotradeEnabled" ], "type": "boolean", "description": "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.", "nullable": true }, "IsAutoSyncEnabled": { "required": [ "IsAutoSyncEnabled" ], "type": "boolean", "description": "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.", "nullable": true } }, "additionalProperties": false }, "SetDesiredPositions": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "Positions": { "required": [ "Positions" ], "type": "array", "items": { "$ref": "#/components/schemas/PositionBase" }, "description": "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.", "nullable": true } }, "additionalProperties": false }, "SetDesiredPositionsResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/DesiredPositionResponseDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "SetDesiredPositionsV2": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true }, "Positions": { "required": [ "Positions" ], "type": "array", "items": { "$ref": "#/components/schemas/PositionBase" }, "description": "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.", "nullable": true } }, "additionalProperties": false }, "SetDesiredPositionsV2Response": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/DesiredPositionResponseDTOV2" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "SignalIdDTO": { "type": "object", "properties": { "SignalId": { "required": [ "SignalId" ], "type": "integer", "description": "The parent C2 SignalId", "format": "int64" }, "ProfitTargetSignalId": { "required": [ "ProfitTargetSignalId" ], "type": "integer", "description": "The C2 ProfitTarget SignalId", "format": "int64", "nullable": true }, "StopLossSignalId": { "required": [ "StopLossSignalId" ], "type": "integer", "description": "The C2 StopLoss SignalId", "format": "int64", "nullable": true }, "ExitSignalsOCAGroupId": { "required": [ "ExitSignalsOCAGroupId" ], "type": "integer", "description": "The StopLossSignalId and ProfitTargetSignalId OCA (One-Cancels-All) group", "format": "int64", "nullable": true }, "ParkedUntilDate": { "required": [ "ParkedUntilDate" ], "type": "string", "description": "The New-York date/time when the signal should be released", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SignalResponse": { "type": "object", "properties": { "SignalId": { "required": [ "SignalId" ], "type": "integer", "description": "The unique SignalId", "format": "int64", "nullable": true }, "OrderStatus": { "required": [ "OrderStatus" ], "type": "string", "description": "'A' = PendingNew, '0' = Working, '1' = Partially filled, '2' = Filled, '4' = Canceled, '5' = Replaced, '6' = Pending Cancel, '8' = Rejected, 'C' = Expired, 'E' = Pending Replace", "nullable": true }, "OrderType": { "required": [ "OrderType" ], "enum": [ "1", "2", "3" ], "type": "string", "description": "'1' = Market, '2' = Limit, '3' = Stop", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Market", "2": "Limit", "3": "Stop" } }, "Side": { "required": [ "Side" ], "enum": [ "1", "2" ], "type": "string", "description": "'1' = Buy, '2' = Sell", "nullable": true, "example": "1", "x-enumDescriptions": { "1": "Buy", "2": "Sell" } }, "OpenClose": { "required": [ "OpenClose" ], "enum": [ "O", "C" ], "type": "string", "description": "'O' = Open, 'C' = Close", "nullable": true, "example": "O", "x-enumDescriptions": { "O": "Open", "C": "Close" } }, "OrderQuantity": { "required": [ "OrderQuantity" ], "type": "number", "description": "The unsigned (absolute value) order quantity", "format": "double", "nullable": true }, "Limit": { "required": [ "Limit" ], "type": "number", "description": "The C2-formatted Limit Price", "format": "double", "nullable": true }, "Stop": { "required": [ "Stop" ], "type": "number", "description": "The C2-formatted Stop Price", "format": "double", "nullable": true }, "Tif": { "required": [ "TIF" ], "enum": [ "0", "1" ], "type": "string", "description": "The time in force. 0 = Day, 1 = Good Till Cancel (GTC)", "nullable": true, "example": "0", "x-enumDescriptions": { "0": "Day", "1": "GTC" } }, "FilledQuantity": { "required": [ "FilledQuantity" ], "type": "number", "description": "The unsigned (absolute value) quantity filled", "format": "double", "nullable": true }, "AvgFillPrice": { "required": [ "AvgFillPrice" ], "type": "number", "description": "The average fill price, if FilledQuantity > 0", "format": "double", "nullable": true }, "PostedDate": { "required": [ "PostedDate" ], "type": "string", "description": "UTC DateTime when the order was posted", "format": "date-time", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" }, "RejectMessage": { "required": [ "RejectMessage" ], "type": "string", "description": "The signal rejection message. Only available in response when OrderStatus = '8' (Rejected)", "nullable": true } }, "additionalProperties": false }, "SimResultDTO": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64" }, "FirstName": { "required": [ "FirstName" ], "type": "string", "description": "The person's first name", "nullable": true }, "LastName": { "required": [ "LastName" ], "type": "string", "description": "The person's last name", "nullable": true }, "Email": { "required": [ "Email" ], "type": "string", "description": "The person's email", "nullable": true }, "Account": { "required": [ "Account" ], "type": "string", "description": "The SIM Account", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "StrategyId", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date when the person started SIM for the Strategy", "format": "date-time" }, "EndDate": { "required": [ "EndDate" ], "type": "string", "description": "UTC Date when the person stopped SIM for the Strategy", "format": "date-time", "nullable": true }, "StartEquity": { "required": [ "StartEquity" ], "type": "integer", "description": "Dollar amount to start calculation", "format": "int64" }, "EndEquity": { "required": [ "EndEquity" ], "type": "integer", "description": "Dollar amount to end calculation", "format": "int64", "nullable": true }, "TotalReturn": { "required": [ "TotalReturn" ], "type": "number", "description": "Last 90 day's performance percent", "format": "double" }, "TotalDelta": { "required": [ "TotalDelta" ], "type": "number", "description": "Last 90 day's performance in dollars", "format": "double" }, "ScalingFactor": { "required": [ "ScalingFactor" ], "type": "integer", "description": "The % scaling factor. e.g. 2 means 2x the strategy quantities", "format": "int64" } }, "additionalProperties": false }, "StartAutotrade": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The BrokerId", "format": "int32", "nullable": true }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The StrategyId", "format": "int64", "nullable": true }, "ScalingPercentage": { "required": [ "ScalingPercentage" ], "type": "integer", "description": "The Autotrade Scaling factor. e.g. Enter 105 for 105%", "format": "int64" }, "FuturesEnabled": { "required": [ "FuturesEnabled" ], "type": "boolean", "description": "(optional) TRUE to enable the Futures asset class when autotrading this strategy. Default is FALSE", "default": false }, "MaxFutures": { "required": [ "MaxFutures" ], "type": "integer", "description": "(optional) Set a maximum number of contracts to hold in a position for this strategy", "format": "int32", "nullable": true }, "ForexEnabled": { "required": [ "ForexEnabled" ], "type": "boolean", "description": "(optional) TRUE to enable autotrading Forex for this strategy. Default is FALSE", "default": false }, "MaxForex": { "required": [ "MaxForex" ], "type": "integer", "description": "(optional) Set a maximum number of units (each unit on C2 is 1000 currency units) to hold in a position for this strategy", "format": "int32", "nullable": true }, "StocksEnabled": { "required": [ "StocksEnabled" ], "type": "boolean", "description": "(optional) TRUE to enable autotrading Stocks for this strategy. Default is FALSE", "default": false }, "MaxStocksDollars": { "required": [ "MaxStocksDollars" ], "type": "integer", "description": "(optional) Set a maximum number of dollars to hold in a position for this strategy (no decimals)", "format": "int32", "nullable": true }, "OptionsEnabled": { "required": [ "OptionsEnabled" ], "type": "boolean", "description": "(optional) TRUE to enable autotrading Options for this strategy. Default is FALSE", "default": false }, "ShortOptionsEnabled": { "required": [ "ShortOptionsEnabled" ], "type": "boolean", "description": "(optional) TRUE to enable the shorting of Options when autotrading this strategy. Default is FALSE", "default": false }, "MaxOptions": { "required": [ "MaxOptions" ], "type": "integer", "description": "(optional) Set a maximum number of contracts to hold in a position for this strategy", "format": "int32", "nullable": true }, "DoNotJoinCurrentSystemPositions": { "required": [ "DoNotJoinCurrentSystemPositions" ], "type": "boolean", "description": "(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.", "nullable": true }, "AutoStopLoss": { "required": [ "AutoStopLoss" ], "type": "integer", "description": "(optional) Dollar value of the automated stop loss which will rest in addition to the strategy stop loss orders", "format": "int64", "nullable": true }, "AccountUserName": { "required": [ "AccountUserName" ], "type": "string", "description": "(optional) The Brokerage account username. Only needed for specific Brokers, please enquire with support at help@collective2.com", "nullable": true }, "AccountPassword": { "required": [ "AccountPassword" ], "type": "string", "description": "(optional) The Brokerage account password. Only needed for specific Brokers, please enquire with support at help@collective2.com", "nullable": true } }, "additionalProperties": false }, "StrategyBasicDetailsDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "Same value as StrategyId", "format": "int64" }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 SystemID", "format": "int64" }, "IsAlive": { "required": [ "IsAlive" ], "type": "boolean", "description": "TRUE if the Strategy is alive" }, "IsPrivate": { "required": [ "IsPrivate" ], "type": "boolean", "description": "TRUE if the Strategy is a test or private strategy", "nullable": true }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date of when the Strategy was created", "format": "date-time", "nullable": true }, "SecurityTypesEnabled": { "required": [ "SecurityTypesEnabled" ], "type": "object", "additionalProperties": { "type": "boolean" }, "description": "List of all SecurityTypes enabled for trading in the strategy", "nullable": true }, "MonthlyCost": { "required": [ "MonthlyCost" ], "type": "number", "description": "Cost of Strategy lease per month", "format": "double", "nullable": true }, "StrategyOwnerId": { "required": [ "StrategyOwnerId" ], "type": "integer", "description": "The Strategy Owner's PersonId", "format": "int64", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The Strategy Owner's White Label Site Id", "format": "int64", "nullable": true } }, "additionalProperties": false }, "StrategyDetailsDTO": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 strategyID", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "IsAlive": { "required": [ "IsAlive" ], "type": "boolean", "description": "TRUE if the Strategy is alive" }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date of when the Strategy was created", "format": "date-time", "nullable": true }, "PrimarySecurityTypes": { "required": [ "PrimarySecurityTypes" ], "type": "string", "description": "Primary asset class traded e.g. Stocks, Options, Forex, Futures", "nullable": true }, "SecurityTypesEnabled": { "required": [ "SecurityTypesEnabled" ], "type": "object", "additionalProperties": { "type": "boolean" }, "description": "List of all SecurityTypes enabled for trading in the strategy", "nullable": true }, "MonthlyCost": { "required": [ "MonthlyCost" ], "type": "number", "description": "Cost of Strategy lease per month", "format": "double", "nullable": true }, "StrategyOwnerId": { "required": [ "StrategyOwnerId" ], "type": "integer", "description": "The Strategy Owner's PersonId", "format": "int64", "nullable": true }, "StrategyOwnerName": { "required": [ "StrategyOwnerName" ], "type": "string", "description": "The Strategy Owner's name", "nullable": true }, "SuggestedCapital": { "required": [ "SuggestedCapital" ], "type": "integer", "description": "The suggested capital to invest in the Strategy", "format": "int32", "nullable": true }, "LastModified": { "required": [ "LastModified" ], "type": "string", "description": "UTC Date of when the Strategy was last modified", "format": "date-time", "nullable": true }, "Score": { "required": [ "Score" ], "type": "integer", "description": "The C2 score", "format": "int32", "nullable": true }, "IsTradeOwnSystem": { "required": [ "IsTradeOwnSystem" ], "type": "boolean", "description": "TRUE if Strategy owner Trades his Own Strategy", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The WhiteLabel SiteId, if any", "format": "int64", "nullable": true }, "IsPrivate": { "required": [ "IsPrivate" ], "type": "boolean", "description": "TRUE if Strategy is private", "nullable": true }, "Aum": { "required": [ "AUM" ], "type": "integer", "description": "The total USD assets under management", "format": "int32", "nullable": true }, "AuM_NumberOfAccounts": { "required": [ "AUM_NumberOfAccounts" ], "type": "integer", "description": "The number of accounts used in the AUM calculation", "format": "int32", "nullable": true }, "Return": { "required": [ "Return" ], "type": "number", "description": "The total Strategy return", "format": "double", "nullable": true }, "ReturnLabel": { "required": [ "ReturnLabel" ], "type": "string", "description": "The total Strategy return label which explains the Return calculation", "nullable": true }, "Equity": { "required": [ "Equity" ], "type": "number", "description": "The current open profits (or open losses) in the positions the strategy is currently holding", "format": "double", "nullable": true }, "Cash": { "required": [ "Cash" ], "type": "number", "description": "The current strategy cash", "format": "double", "nullable": true }, "StartingCash": { "required": [ "StartingCash" ], "type": "number", "description": "The starting strategy cash", "format": "double", "nullable": true }, "ProfitFactor": { "required": [ "ProfitFactor" ], "type": "number", "description": "The win/loss ratio", "format": "double", "nullable": true }, "CashDividends": { "required": [ "CashDividends" ], "type": "number", "description": "The strategy's total cash dividends", "format": "double", "nullable": true }, "BuyingPower": { "required": [ "BuyingPower" ], "type": "number", "description": "The strategy's remaining Buying Power", "format": "double", "nullable": true }, "MarginUsed": { "required": [ "MarginUsed" ], "type": "number", "description": "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", "format": "double", "nullable": true }, "AgeInDays": { "required": [ "AgeInDays" ], "type": "integer", "description": "Number of days the Strategy traded", "format": "int32", "nullable": true }, "ModelAccountValue": { "required": [ "ModelAccountValue" ], "type": "number", "description": "The current strategy account value", "format": "double", "nullable": true }, "NumTrades": { "required": [ "NumTrades" ], "type": "integer", "description": "The number of executed signals", "format": "int32", "nullable": true }, "NumWinners": { "required": [ "NumWinners" ], "type": "integer", "description": "The number of winning signals", "format": "int32", "nullable": true }, "NumLosers": { "required": [ "NumLosers" ], "type": "integer", "description": "The number of losing signals", "format": "int32", "nullable": true }, "PercentWinTrades": { "required": [ "PercentWinTrades" ], "type": "number", "description": "% of winning trades", "format": "double", "nullable": true }, "SumDollarWinners": { "required": [ "SumDollarWinners" ], "type": "number", "description": "Total USD of winning trades", "format": "double", "nullable": true }, "SumDollarLosers": { "required": [ "SumDollarLosers" ], "type": "number", "description": "Total USD of losing trades", "format": "double", "nullable": true }, "NumMonths": { "required": [ "NumMonths" ], "type": "integer", "description": "The total number of months for the strategy", "format": "int32", "nullable": true }, "WinMonthsInUI": { "required": [ "WinMonthsInUI" ], "type": "integer", "description": "The number of profitable months as shown on the C2 UI", "format": "int32", "nullable": true }, "WinMonths": { "required": [ "WinMonths" ], "type": "number", "description": "The number of profitable months", "format": "double", "nullable": true }, "WinMonthsRatio": { "required": [ "WinMonthsRatio" ], "type": "number", "description": "The ratio of winning months", "format": "double", "nullable": true }, "MaxDrawdown": { "required": [ "MaxDrawdown" ], "type": "number", "description": "The % of maximum peak-to-valley historical drawdown", "format": "double", "nullable": true }, "MaxDrawdownDays": { "required": [ "MaxDrawdownDays" ], "type": "number", "description": "The number of days of the maximum peak-to-valley historical drawdown", "format": "double", "nullable": true }, "MaxDrawdownStartDate": { "required": [ "MaxDrawdownStartDate" ], "type": "string", "description": "The maximum drawdown start date YYYYMMDD", "nullable": true }, "MaxDrawdownEndDate": { "required": [ "MaxDrawdownEndDate" ], "type": "string", "description": "The maximum drawdown end date YYYYMMDD", "nullable": true }, "AvgWinDollars": { "required": [ "AvgWinDollars" ], "type": "number", "description": "The average Strategy winning trade in dollars", "format": "double", "nullable": true }, "AvgLossDollars": { "required": [ "AvgLossDollars" ], "type": "number", "description": "The average Strategy losing trade in dollars", "format": "double", "nullable": true }, "AvgTradeDuration": { "required": [ "AvgTradeDuration" ], "type": "number", "description": "The average number of trading days that a position is held", "format": "double", "nullable": true }, "CorrelationSP500": { "required": [ "CorrelationSP500" ], "type": "number", "description": "The Correlation to the S&P 500 during strategy life", "format": "double", "nullable": true }, "SP500Return": { "required": [ "SP500Return" ], "type": "number", "description": "The cumulative % return of the SP500 during strategy life", "format": "double", "nullable": true }, "ReturnVsSP500": { "required": [ "ReturnVsSP500" ], "type": "number", "description": "The % return of the strategy - Return of SP500 % (cumulative)", "format": "double", "nullable": true }, "AvgLeverage": { "required": [ "AvgLeverage" ], "type": "number", "description": "The average leverage used by the Strategy", "format": "double", "nullable": true }, "MaxLeverage": { "required": [ "MaxLeverage" ], "type": "number", "description": "The max leverage used by the Strategy", "format": "double", "nullable": true }, "CorrelationToSP500": { "required": [ "CorrelationToSP500" ], "type": "number", "description": "The strategy correlation to the SP500", "format": "double", "nullable": true }, "Alpha": { "required": [ "Alpha" ], "type": "number", "description": "The Alpha ratio", "format": "double", "nullable": true }, "Beta": { "required": [ "Beta" ], "type": "number", "description": "The Beta ratio", "format": "double", "nullable": true }, "Treynor": { "required": [ "Treynor" ], "type": "number", "description": "The Treynor ratio", "format": "double", "nullable": true }, "Sortino": { "required": [ "Sortino" ], "type": "number", "description": "The Sortino ratio", "format": "double", "nullable": true }, "Sharpe": { "required": [ "Sharpe" ], "type": "number", "description": "The Sharpe ratio tells us whether a portfolio's returns are due to smart investment decisions or a result of excess risk", "format": "double", "nullable": true }, "Calmar": { "required": [ "Calmar" ], "type": "number", "description": "The Calmar ratio", "format": "double", "nullable": true } }, "additionalProperties": false }, "StrategyHistoricalEquityDTO": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 strategyID", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date of when the Strategy was created", "format": "date-time", "nullable": true }, "SecurityTypesEnabled": { "required": [ "SecurityTypesEnabled" ], "type": "object", "additionalProperties": { "type": "boolean" }, "description": "List of all SecurityTypes enabled for trading in the strategy", "nullable": true }, "MonthlyCost": { "required": [ "MonthlyCost" ], "type": "number", "description": "Cost of Strategy lease per month", "format": "double", "nullable": true }, "StrategyOwnerId": { "required": [ "StrategyOwnerId" ], "type": "integer", "description": "The Strategy Owner's PersonId", "format": "int64", "nullable": true }, "MonthlyResults": { "required": [ "MonthlyResults" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyMonthlyResultsDTO" }, "description": "Monthly and Yearly stats for the strategy", "nullable": true } }, "additionalProperties": false }, "StrategyIdDTO": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64" } }, "additionalProperties": false }, "StrategyMonthlyResultsDTO": { "type": "object", "properties": { "Month": { "required": [ "Month" ], "type": "integer", "description": "The month of the year", "format": "int32", "nullable": true }, "MonthName": { "required": [ "MonthName" ], "type": "string", "description": "The English name of the month", "nullable": true }, "Year": { "required": [ "Year" ], "type": "integer", "description": "The year", "format": "int32" }, "Return": { "required": [ "Return" ], "type": "number", "description": "The return % of the month or year (see IsAnnual property)", "format": "double" }, "IsAnnual": { "required": [ "IsAnnual" ], "type": "boolean", "description": "True if the Return is the annual ROI for the Year", "nullable": true } }, "additionalProperties": false }, "StrategySubscriberDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The Row Id", "format": "int64" }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The StrategyId", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy name", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId", "format": "int64" }, "SubscriptionId": { "required": [ "SubscriptionId" ], "type": "integer", "description": "The Subscription Id", "format": "int64" }, "SubscriberId": { "required": [ "SubscriberId" ], "type": "integer", "description": "The Subscriber Id", "format": "int64" }, "IsStrategyOwner": { "required": [ "IsStrategyOwner" ], "type": "boolean", "description": "The PersonId is also the strategy owner" }, "Alias": { "required": [ "Alias" ], "type": "string", "description": "The Subscriber screen name", "nullable": true }, "FirstName": { "required": [ "FirstName" ], "type": "string", "description": "The Subscriber's first name", "nullable": true }, "LastName": { "required": [ "LastName" ], "type": "string", "description": "The Subscriber's last name", "nullable": true }, "Email": { "required": [ "Email" ], "type": "string", "description": "The Subscriber email", "nullable": true }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "The strategy StartDate", "format": "date-time" }, "EndDate": { "required": [ "EndDate" ], "type": "string", "description": "The strategy EndDate, if it was killed", "format": "date-time", "nullable": true }, "BasePrice": { "required": [ "BasePrice" ], "type": "number", "description": "The strategy's base monthly price", "format": "double", "nullable": true }, "Markup": { "required": [ "Markup" ], "type": "number", "description": "The price markup", "format": "double", "nullable": true }, "Cost": { "required": [ "Cost" ], "type": "number", "description": "The strategy cost per period", "format": "double", "nullable": true }, "LastTransactionDate": { "required": [ "LastTransactionDate" ], "type": "string", "description": "The Last Transaction Date", "format": "date-time", "nullable": true }, "LastTransactionAmount": { "required": [ "LastTransactionAmount" ], "type": "number", "description": "The Last Transaction Amount", "format": "double", "nullable": true }, "IsResale": { "required": [ "IsResale" ], "type": "number", "description": "True if the strategy is bing resold through this White Label Site Id", "format": "double", "nullable": true }, "WhiteLabelSiteId": { "required": [ "WhiteLabelSiteId" ], "type": "integer", "description": "The White Label Site Id", "format": "int64", "nullable": true }, "GeoSiteId": { "required": [ "GeoSiteId" ], "type": "string", "description": "The GeoSite Id", "nullable": true } }, "additionalProperties": false }, "SubcribedStrategyDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The Subscription ID", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64" }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 SystemID", "format": "int64" }, "StrategyName": { "required": [ "StrategyName" ], "type": "string", "description": "The Strategy Name", "nullable": true }, "IsSimulation": { "required": [ "IsSimulation" ], "type": "boolean", "description": "TRUE if the person is Autotrading as a simulation" }, "IsPaperTrade": { "required": [ "IsPaperTrade" ], "type": "boolean", "description": "TRUE if the person is Autotrading in a PaperTrade account" }, "IsAlive": { "required": [ "IsAlive" ], "type": "boolean", "description": "TRUE if the subscription is active" }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "UTC Date when the subscription started", "format": "date-time", "nullable": true }, "EndDate": { "required": [ "EndDate" ], "type": "string", "description": "UTC Date when the subscription ended", "format": "date-time", "nullable": true }, "MonthlyCost": { "required": [ "MonthlyCost" ], "type": "number", "description": "The subscription monthly cost", "format": "double", "nullable": true } }, "additionalProperties": false }, "SubscriptionDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The PersonId", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId subscribed", "format": "int64" }, "LicenseType": { "required": [ "LicenseType" ], "type": "string", "description": "The type of license", "nullable": true }, "LicenseTypeId": { "required": [ "LicenseTypeId" ], "type": "integer", "description": "The license type id", "format": "int64" }, "StartDate": { "required": [ "StartDate" ], "type": "string", "description": "The UTC start date of the subscription", "format": "date-time", "nullable": true }, "EndDate": { "required": [ "EndDate" ], "type": "string", "description": "The UTC end date of the subscription", "format": "date-time", "nullable": true }, "IsRecurring": { "required": [ "IsRecurring" ], "type": "boolean", "description": "TRUE if the subscription automatically renews" }, "Cost": { "required": [ "Cost" ], "type": "number", "description": "The last subscription fee", "format": "double" } }, "additionalProperties": false }, "SupportedSymbolDTO": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64" }, "Currency": { "required": [ "Currency" ], "type": "string", "description": "The instrument currency", "nullable": true }, "Description": { "required": [ "Description" ], "type": "string", "description": "The instrument description", "nullable": true }, "PointValue": { "required": [ "PointValue" ], "type": "number", "description": "The value of a point (used with futures)", "format": "double", "nullable": true }, "TickSize": { "required": [ "TickSize" ], "type": "number", "description": "The minimum ticksize (used with futures)", "format": "double", "nullable": true }, "DecimalPrecision": { "required": [ "DecimalPrecision" ], "type": "integer", "description": "The decimal precision of the price (used with futures)", "format": "int64", "nullable": true }, "C2Symbol": { "$ref": "#/components/schemas/C2SymbolDTO" }, "ExchangeSymbol": { "$ref": "#/components/schemas/ExchangeSymbolDTO" }, "MarginRequirements": { "$ref": "#/components/schemas/MarginRequirementsDTO" } }, "additionalProperties": false }, "SyncPositionsToOpen": { "type": "object", "properties": { "Account": { "required": [ "Account" ], "type": "string", "description": "The Autotrade account", "nullable": true }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonID", "format": "int64", "nullable": true }, "BrokerId": { "required": [ "BrokerId" ], "type": "integer", "description": "The C2 PersonID", "format": "int32", "nullable": true }, "StrategyIds": { "required": [ "StrategyIds" ], "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "A list of Strategy IDs", "nullable": true } }, "additionalProperties": false }, "SyncPositionsToOpenDTO": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The StrategyId", "format": "int64" }, "Success": { "required": [ "Success" ], "type": "boolean", "description": "TRUE if operation was successful for the strategy" }, "Reason": { "required": [ "Reason" ], "type": "string", "description": "Will contain a reason if operation was not successful", "nullable": true }, "ReasonCode": { "required": [ "ReasonCode" ], "type": "integer", "description": "Will contain the reason HTTP code if operation was not successful", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SyncPositionsToOpenResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/SyncPositionsToOpenDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "UpdateProfile": { "type": "object", "properties": { "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The C2 PersonId", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UpdateStrategy": { "type": "object", "properties": { "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The C2 StrategyId", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UpdateStrategyResponse": { "type": "object", "properties": { "Results": { "required": [ "Results" ], "type": "array", "items": { "$ref": "#/components/schemas/StrategyIdDTO" }, "description": "Result array", "nullable": true }, "ResponseStatus": { "$ref": "#/components/schemas/ResponseStatus" } }, "additionalProperties": false }, "WatchListDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The List Id", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId", "format": "int64" }, "CreatedDate": { "required": [ "CreatedDate" ], "type": "string", "description": "When the list was created (UTC)", "format": "date-time" }, "ListName": { "required": [ "ListName" ], "type": "string", "description": "The List Name", "nullable": true } }, "additionalProperties": false }, "WatchListMemberDTO": { "type": "object", "properties": { "Id": { "required": [ "Id" ], "type": "integer", "description": "The Item Id", "format": "int64" }, "AddedDate": { "required": [ "AddedDate" ], "type": "string", "description": "When the item was added (UTC)", "format": "date-time" }, "StrategyId": { "required": [ "StrategyId" ], "type": "integer", "description": "The StrategyId", "format": "int64" }, "PersonId": { "required": [ "PersonId" ], "type": "integer", "description": "The PersonId", "format": "int64" } }, "additionalProperties": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Authorization header using the Bearer scheme. e.g. 'Bearer myAPIkey'. See https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/", "scheme": "bearer", "bearerFormat": "Bearer myAPIkey" } } }, "security": [ {} ], "tags": [ { "name": "APIGateway" } ] }