API product catalogSub-Accounts & White-Label Retail KYC

Sub-account equity history

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/portfolio/history

Sandbox availablegetUserPortfolioHistory

Daily raw-equity history for one sub-account owned by the authenticated partner. Values include wallet cash and holdings but are not cash-flow adjusted, so they must not be presented as investment P&L.

Parameters

userIdstringpathRequired

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

Example: 1Y

fromstringquery

tostringquery

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

calculationRAW_EQUITYRequired

cashFlowAdjustedbooleanRequired

methodologystringRequired

pointsobject[]Required

points[].timestampstringRequired

points[].equitynumberRequired

Total account value including cash and holdings.

points[].marketValuenumberRequired

Holdings value only.

countintegerRequired

asOfstring | null

Response codes

200Sub-account daily equity points.

400Invalid period or date range.

404Sub-account not found or not owned by this partner.

Sandbox playground

Read-only sandbox request

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

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "accountType",
    "scope",
    "baseCurrency",
    "timeframe",
    "period",
    "calculation",
    "cashFlowAdjusted",
    "methodology",
    "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": [
        "RAW_EQUITY"
      ]
    },
    "cashFlowAdjusted": {
      "type": "boolean",
      "const": false
    },
    "methodology": {
      "type": "string"
    },
    "points": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "timestamp",
          "equity",
          "marketValue"
        ],
        "properties": {
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "equity": {
            "type": "number",
            "description": "Total account value including cash and holdings."
          },
          "marketValue": {
            "type": "number",
            "description": "Holdings value only."
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "asOf": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

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

GET /users/{userId}/portfolio

GET /users/{userId}/portfolio/performance