Portfolio Performance

Retrieve cash-flow-adjusted daily P&L, time-weighted returns, and optional benchmark comparisons for master and customer portfolios.

Use GET /portfolio/performance for the partner master account and GET /users/{userId}/portfolio/performance for a customer sub-account. These endpoints are distinct from /portfolio/history, which intentionally returns raw equity snapshots without cash-flow adjustment.

Each point includes equity, marketValue, netCashFlow, dailyPnl, dailyReturn, cumulativeReturn, and—when requested—benchmarkReturn plus excessReturn.

GET

/portfolio/performance

Master-account cash-flow-adjusted performance

Full endpoint documentation

Sandbox availablegetPortfolioPerformance

Returns daily P&L, Modified Dietz interval returns, and geometrically linked cumulative time-weighted return. Completed master/sub-account transfers and completed external top-ups/payouts are cash-flow adjusted. Supply an optional exchange-qualified benchmark symbol for rebased price return and excess-return comparison. Benchmark return excludes dividends and FX. Use /portfolio/history when raw equity snapshots are required.

Parameters

period1M | 3M | 6M | 1Y | ALLquery

Example: 1Y

fromstringquery

tostringquery

benchmarkstringquery

Optional exchange-qualified benchmark symbol.

Example: SCOM.KE

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

accountTypeMASTER | SUBACCOUNTRequired

scopeMASTER_ACCOUNT | SUBACCOUNTRequired

subAccountIdstring

externalIdstring | null

baseCurrencyUSDRequired

timeframe1DRequired

period1M | 3M | 6M | 1Y | ALLRequired

calculationDAILY_MODIFIED_DIETZ_LINKED_TWRRequired

cashFlowAdjustedbooleanRequired

methodologystringRequired

benchmarkunionRequired

summaryobjectRequired

summary.startEquitynumberRequired

summary.endEquitynumberRequired

summary.netCashFlownumberRequired

summary.totalPnlnumberRequired

summary.totalReturnnumberRequired

summary.benchmarkReturnnumber | nullRequired

summary.excessReturnnumber | nullRequired

pointsobject[]Required

points[].timestampstringRequired

points[].equitynumberRequired

points[].marketValuenumberRequired

points[].netCashFlownumberRequired

Signed completed external cash flow during the interval.

points[].dailyPnlnumberRequired

End equity minus start equity minus net cash flow.

points[].dailyReturnnumber | nullRequired

Modified Dietz return for the snapshot interval.

points[].cumulativeReturnnumberRequired

Geometrically linked time-weighted return from the first point.

points[].benchmarkReturnnumber | nullRequired

Rebased benchmark price return when requested.

points[].excessReturnnumber | nullRequired

cumulativeReturn minus benchmarkReturn.

countintegerRequired

asOfstring | null

Response codes

200Cash-flow-adjusted master-account performance.

400Invalid period

404Benchmark symbol not found.

Sandbox playground

Read-only sandbox request

period Optional · queryfrom Optional · queryto Optional · querybenchmark Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/portfolio/performance

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "accountType",
    "scope",
    "baseCurrency",
    "timeframe",
    "period",
    "calculation",
    "cashFlowAdjusted",
    "methodology",
    "benchmark",
    "summary",
    "points",
    "count"
  ],
  "properties": {
    "accountType": {
      "type": "string",
      "enum": [
        "MASTER",
        "SUBACCOUNT"
      ]
    },
    "scope": {
      "type": "string",
      "enum": [
        "MASTER_ACCOUNT",
        "SUBACCOUNT"
      ]
    },
    "subAccountId": {
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "baseCurrency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "timeframe": {
      "type": "string",
      "enum": [
        "1D"
      ]
    },
    "period": {
      "type": "string",
      "enum": [
        "1M",
        "3M",
        "6M",
        "1Y",
        "ALL"
      ]
    },
    "calculation": {
      "type": "string",
      "enum": [
        "DAILY_MODIFIED_DIETZ_LINKED_TWR"
      ]
    },
    "cashFlowAdjusted": {
      "type": "boolean",
      "const": true
    },
    "methodology": {
      "type": "string"
    },
    "benchmark": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "symbol",
            "methodology"
          ],
          "properties": {
            "symbol": {
              "type": "string"
            },
            "methodology": {
              "type": "string"
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "summary": {
      "type": "object",
      "required": [
        "startEquity",
        "endEquity",
        "netCashFlow",
        "totalPnl",
        "totalReturn",
        "benchmarkReturn",
        "excessReturn"
      ],
      "properties": {
        "startEquity": {
          "type": "number"
        },
        "endEquity": {
          "type": "number"
        },
        "netCashFlow": {
          "type": "number"
        },
        "totalPnl": {
          "type": "number"
        },
        "totalReturn": {
          "type": "number"
        },
        "benchmarkReturn": {
          "type": [
            "number",
            "null"
          ]
        },
        "excessReturn": {
          "type": [
            "number",
            "null"
          ]
        }
      }
    },
    "points": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "timestamp",
          "equity",
          "marketValue",
          "netCashFlow",
          "dailyPnl",
          "dailyReturn",
          "cumulativeReturn",
          "benchmarkReturn",
          "excessReturn"
        ],
        "properties": {
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "equity": {
            "type": "number"
          },
          "marketValue": {
            "type": "number"
          },
          "netCashFlow": {
            "type": "number",
            "description": "Signed completed external cash flow during the interval."
          },
          "dailyPnl": {
            "type": "number",
            "description": "End equity minus start equity minus net cash flow."
          },
          "dailyReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "Modified Dietz return for the snapshot interval."
          },
          "cumulativeReturn": {
            "type": "number",
            "description": "Geometrically linked time-weighted return from the first point."
          },
          "benchmarkReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "Rebased benchmark price return when requested."
          },
          "excessReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "cumulativeReturn minus benchmarkReturn."
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "asOf": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/portfolio/performance' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET

/users/{userId}/portfolio/performance

Sub-account cash-flow-adjusted performance

Full endpoint documentation

Sandbox availablegetUserPortfolioPerformance

Returns daily P&L, Modified Dietz interval returns, and geometrically linked cumulative time-weighted return for one partner-owned sub-account. Completed deposits and withdrawals are treated as external cash flows. Supply an optional exchange-qualified benchmark symbol for rebased price return and excess-return comparison.

Parameters

userIdstringpathRequired

period1M | 3M | 6M | 1Y | ALLquery

Example: 1Y

fromstringquery

tostringquery

benchmarkstringquery

Optional exchange-qualified benchmark symbol.

Example: SCOM.KE

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

accountTypeMASTER | SUBACCOUNTRequired

scopeMASTER_ACCOUNT | SUBACCOUNTRequired

subAccountIdstring

externalIdstring | null

baseCurrencyUSDRequired

timeframe1DRequired

period1M | 3M | 6M | 1Y | ALLRequired

calculationDAILY_MODIFIED_DIETZ_LINKED_TWRRequired

cashFlowAdjustedbooleanRequired

methodologystringRequired

benchmarkunionRequired

summaryobjectRequired

summary.startEquitynumberRequired

summary.endEquitynumberRequired

summary.netCashFlownumberRequired

summary.totalPnlnumberRequired

summary.totalReturnnumberRequired

summary.benchmarkReturnnumber | nullRequired

summary.excessReturnnumber | nullRequired

pointsobject[]Required

points[].timestampstringRequired

points[].equitynumberRequired

points[].marketValuenumberRequired

points[].netCashFlownumberRequired

Signed completed external cash flow during the interval.

points[].dailyPnlnumberRequired

End equity minus start equity minus net cash flow.

points[].dailyReturnnumber | nullRequired

Modified Dietz return for the snapshot interval.

points[].cumulativeReturnnumberRequired

Geometrically linked time-weighted return from the first point.

points[].benchmarkReturnnumber | nullRequired

Rebased benchmark price return when requested.

points[].excessReturnnumber | nullRequired

cumulativeReturn minus benchmarkReturn.

countintegerRequired

asOfstring | null

Response codes

200Cash-flow-adjusted sub-account performance.

400Invalid period

404Sub-account or benchmark symbol not found.

Sandbox playground

Read-only sandbox request

userId Required · pathperiod Optional · queryfrom Optional · queryto Optional · querybenchmark Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/portfolio/performance

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "accountType",
    "scope",
    "baseCurrency",
    "timeframe",
    "period",
    "calculation",
    "cashFlowAdjusted",
    "methodology",
    "benchmark",
    "summary",
    "points",
    "count"
  ],
  "properties": {
    "accountType": {
      "type": "string",
      "enum": [
        "MASTER",
        "SUBACCOUNT"
      ]
    },
    "scope": {
      "type": "string",
      "enum": [
        "MASTER_ACCOUNT",
        "SUBACCOUNT"
      ]
    },
    "subAccountId": {
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "baseCurrency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "timeframe": {
      "type": "string",
      "enum": [
        "1D"
      ]
    },
    "period": {
      "type": "string",
      "enum": [
        "1M",
        "3M",
        "6M",
        "1Y",
        "ALL"
      ]
    },
    "calculation": {
      "type": "string",
      "enum": [
        "DAILY_MODIFIED_DIETZ_LINKED_TWR"
      ]
    },
    "cashFlowAdjusted": {
      "type": "boolean",
      "const": true
    },
    "methodology": {
      "type": "string"
    },
    "benchmark": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "symbol",
            "methodology"
          ],
          "properties": {
            "symbol": {
              "type": "string"
            },
            "methodology": {
              "type": "string"
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "summary": {
      "type": "object",
      "required": [
        "startEquity",
        "endEquity",
        "netCashFlow",
        "totalPnl",
        "totalReturn",
        "benchmarkReturn",
        "excessReturn"
      ],
      "properties": {
        "startEquity": {
          "type": "number"
        },
        "endEquity": {
          "type": "number"
        },
        "netCashFlow": {
          "type": "number"
        },
        "totalPnl": {
          "type": "number"
        },
        "totalReturn": {
          "type": "number"
        },
        "benchmarkReturn": {
          "type": [
            "number",
            "null"
          ]
        },
        "excessReturn": {
          "type": [
            "number",
            "null"
          ]
        }
      }
    },
    "points": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "timestamp",
          "equity",
          "marketValue",
          "netCashFlow",
          "dailyPnl",
          "dailyReturn",
          "cumulativeReturn",
          "benchmarkReturn",
          "excessReturn"
        ],
        "properties": {
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "equity": {
            "type": "number"
          },
          "marketValue": {
            "type": "number"
          },
          "netCashFlow": {
            "type": "number",
            "description": "Signed completed external cash flow during the interval."
          },
          "dailyPnl": {
            "type": "number",
            "description": "End equity minus start equity minus net cash flow."
          },
          "dailyReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "Modified Dietz return for the snapshot interval."
          },
          "cumulativeReturn": {
            "type": "number",
            "description": "Geometrically linked time-weighted return from the first point."
          },
          "benchmarkReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "Rebased benchmark price return when requested."
          },
          "excessReturn": {
            "type": [
              "number",
              "null"
            ],
            "description": "cumulativeReturn minus benchmarkReturn."
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "asOf": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/portfolio/performance' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

Methodology

Daily P&L is end equity - start equity - net external cash flow.
Each interval uses Modified Dietz, weighting completed cash flows by the time remaining in the interval.
Daily returns are geometrically linked to produce cumulative time-weighted return.
Sub-account DEPOSIT and WITHDRAWAL entries are external cash flows.
Master-account internal transfers and completed top-ups/payouts are adjusted so funding movement is not reported as investment return.
Benchmark comparison is price return rebased to the first available close. It excludes dividends and FX and must be labelled accordingly.

Performance is only as complete as the available daily valuation snapshots. Do not fabricate intraday returns from delayed quotes, and do not present the benchmark comparison as total return.

Portfolio Performance

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Methodology

On this page