PortfolioResponse

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etoro/refs/heads/main/json-schema/PortfolioResponse.json",
  "title": "PortfolioResponse",
  "type": "object",
  "description": "Comprehensive portfolio information including positions, orders, and account status",
  "properties": {
    "clientPortfolio": {
      "type": "object",
      "description": "Container for all portfolio-related information",
      "properties": {
        "positions": {
          "type": "array",
          "description": "List of currently open trading positions",
          "items": {
            "$ref": "#/components/schemas/Position"
          }
        },
        "credit": {
          "type": "number",
          "format": "float",
          "description": "Available trading balance in USD, representing funds available for new positions"
        },
        "mirrors": {
          "type": "array",
          "description": "Copy trading configurations and positions",
          "items": {
            "type": "object",
            "description": "Individual mirror trading setup",
            "properties": {
              "mirrorID": {
                "type": "integer",
                "description": "Unique identifier for the mirror trading configuration"
              },
              "CID": {
                "type": "integer",
                "description": "Customer ID associated with the mirror"
              },
              "parentCID": {
                "type": "integer",
                "description": "Customer ID of the trader being copied"
              },
              "stopLossPercentage": {
                "type": "number",
                "format": "float",
                "description": "The precentage of the mirror value that the StopLossAmount represented at the time of the last edit. Adding or removing funds from the mirror will trigger recalculation of StopLossAmount based on this value compared to the current mirror value"
              },
              "isPaused": {
                "type": "boolean",
                "description": "Indication if the mirror is currently paused, restricting open of additional positions inside the mirror"
              },
              "copyExistingPositions": {
                "type": "boolean",
                "description": "Indication if mirror originally copied all parent existing position on mirror registration"
              },
              "availableAmount": {
                "type": "number",
                "format": "float",
                "description": "Available to trade USD balance in the mirror. This balance is reserved for mirror operations"
              },
              "stopLossAmount": {
                "type": "number",
                "format": "float",
                "description": "USD value of the mirror at which MirrorStopLoss will be triggered and cause liquidation of the mirror. Adding or removing funds from the mirror will trigger recalculation of this value based on StopLossPercentage compared to the current mirror value"
              },
              "initialInvestment": {
                "type": "number",
                "format": "float",
                "description": "USD amount initially invested in the mirror"
              },
              "depositSummary": {
                "type": "number",
                "format": "float",
                "description": "Total USD amount deposited into the mirror after initial investment"
              },
              "withdrawalSummary": {
                "type": "number",
                "format": "float",
                "description": "Total USD amount withdrawn from the mirror"
              },
              "positions": {
                "type": "array",
                "description": "Positions within this copy trading mirror",
                "items": {
                  "$ref": "#/components/schemas/Position"
                }
              },
              "entryOrders": {
                "type": "array",
                "description": "Obsolete",
                "items": {
                  "type": "object"
                }
              },
              "exitOrders": {
                "type": "array",
                "description": "Obsolete",
                "items": {
                  "type": "object"
                }
              },
              "parentUsername": {
                "type": "string",
                "description": "Username of the trader being copied"
              },
              "closedPositionsNetProfit": {
                "type": "number",
                "format": "float",
                "description": "Total USD net profit of all positions that closed in the mirror"
              },
              "startedCopyDate": {
                "type": "string",
                "format": "date-time",
                "description": "Date and time when the mirror trading was initiated"
              },
              "pendingForClosure": {
                "type": "boolean",
                "description": "Indication if the mirror is in closure process"
              },
              "parentMirrors": {
                "type": "array",
                "items": {
                  "type": "object"
                }
              },
              "mirrorCalculationType": {
                "type": "integer",
                "description": "(Obsolete) Mirror positions weights calculation methodology"
              },
              "ordersForOpen": {
                "type": "array",
                "description": "Active orders in the mirror to open positions",
                "items": {
                  "type": "object"
                }
              },
              "ordersForClose": {
                "type": "array",
                "description": "Active orders in the mirror to close positions",
                "items": {
                  "type": "object"
                }
              },
              "ordersForCloseMultiple": {
                "type": "array",
                "description": "Active orders in the mirror to close positions",
                "items": {
                  "type": "object"
                }
              },
              "delayedOrderForClose": {
                "type": "array",
                "description": "Obsolete",
                "items": {
                  "type": "object"
                }
              },
              "delayedOrderForOpen": {
                "type": "array",
                "description": "Obsolete",
                "items": {
                  "type": "object"
                }
              },
              "mirrorStatusID": {
                "type": "integer",
                "description": "Current status of the mirror. 0 - Active, 1 - Paused, 2 - Pending Closure, 3 - In Alignment Process"
              }
            }
          }
        },
        "orders": {
          "type": "array",
          "description": "List of pending orders",
          "items": {
            "type": "object",
            "description": "Individual order details",
            "properties": {
              "orderID": {
                "type": "integer",
                "description": "Unique identifier for the order"
              },
              "CID": {
                "type": "integer",
                "description": "Customer ID associated with the order"
              },
              "openDateTime": {
                "type": "string",
                "format": "date-time",
                "description": "Date and time when the order was created"
              },
              "instrumentID": {
                "type": "integer",
                "description": "Identifier of the instrument being traded"
              },
              "isBuy": {
                "type": "boolean",
                "description": "Direction of the position. true - Long, false - Short"
              },
              "takeProfitRate": {
                "type": "number",
                "format": "float",
                "description": "The take-profit trigger price at which the position will generate a Market Order to close (after it has opened). TakeProfit trigger price must be better than the current price."
              },
              "stopLossRate": {
                "type": "number",
                "format": "float",
                "description": "The stop-loss trigger price at which the position will generate a Market Order to close (after it was opened). StopLoss trigger price must be worse than current price."
              },
              "rate": {
                "type": "number",
                "format": "float",
                "description": "Asset rate at which to send market order to the market"
              },
              "amount": {
                "type": "number",
                "format": "float",
                "description": "USD amount to invest in the position"
              },
              "leverage": {
                "type": "number",
                "format": "float",
                "description": "Leverage multiplier to apply to the position"
              },
              "units": {
                "type": "number",
                "format": "float",
                "description": "Units to open the position. If this value is greater than zero the position will open on the requested units, and not amount"
              },
              "isTslEnabled": {
                "type": "boolean",
                "description": "Indicates if a trailing stop loss (TSL) is enabled. This means that the stoploss rate indicated will get updated automatically whenever the asset price increases (for long positions) or decreases (for short position) effectively keeping the stoploss in a constant gap from the best price achieved so far."
              },
              "executionType": {
                "type": "integer",
                "description": "Type of order execution"
              },
              "isDiscounted": {
                "type": "boolean",
                "description": "Obsolete"
              }
            }
          }
        },
        "stockOrders": {
          "type": "array",
          "description": "Obsolete",
          "items": {
            "type": "object"
          }
        },
        "entryOrders": {
          "type": "array",
          "description": "Obsolete",
          "items": {
            "type": "object"
          }
        },
        "exitOrders": {
          "type": "array",
          "description": "Obsolete",
          "items": {
            "type": "object"
          }
        },
        "ordersForOpen": {
          "type": "array",
          "description": "Active orders to open positions",
          "items": {
            "type": "object"
          }
        },
        "ordersForClose": {
          "type": "array",
          "description": "Active orders to close positions",
          "items": {
            "type": "object"
          }
        },
        "ordersForCloseMultiple": {
          "type": "array",
          "description": "Active orders to close multiple positions",
          "items": {
            "type": "object"
          }
        },
        "bonusCredit": {
          "type": "number",
          "format": "float",
          "description": "Bonus credit amount in USD available for trading"
        }
      }
    }
  }
}