API product catalogInstitutional Reporting, Auditing & Compliance

Report — AUM

Institutional Reporting, Auditing & Compliance

GET

/report/aum

Report — AUM

Sandbox availablelistAum

Current aggregate cash and stored holding valuations across sub-accounts, not an atomic historical snapshot. generatedAt is response assembly time, not a market observation timestamp. valuationBasis identifies stored currentValue in Live or units times currentUsdPrice in Sandbox. asOf requests return 422 HISTORICAL_REPORT_UNSUPPORTED. Supports JSON and CSV.

Parameters

formatjson | csvquery

Example: json

asOfstringquery

Unsupported historical request; any supplied value returns 422.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

partnerKeystringRequired

generatedAtstringRequired

historicalbooleanRequired

valuationBasisstored_holdings_currentValue | units_times_currentUsdPriceRequired

totalAumnumberRequired

totalCashnumberRequired

totalPortfolioValuenumberRequired

subAccountCountintegerRequired

currencystringRequired

breakdownobject[]Required

breakdown[].subAccountIdstringRequired

breakdown[].externalIdstring | nullRequired

breakdown[].cashnumberRequired

breakdown[].portfolioValuenumberRequired

breakdown[].totalValuenumberRequired

Response codes

200AUM report.

400Invalid format.

422Historical asOf reports are unavailable (HISTORICAL_REPORT_UNSUPPORTED).

Sandbox playground

Read-only sandbox request

format Optional · queryasOf Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/report/aum

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "partnerKey",
    "generatedAt",
    "historical",
    "valuationBasis",
    "totalAum",
    "totalCash",
    "totalPortfolioValue",
    "subAccountCount",
    "currency",
    "breakdown"
  ],
  "properties": {
    "partnerKey": {
      "type": "string"
    },
    "generatedAt": {
      "type": "string"
    },
    "historical": {
      "type": "boolean",
      "const": false
    },
    "valuationBasis": {
      "type": "string",
      "enum": [
        "stored_holdings_currentValue",
        "units_times_currentUsdPrice"
      ]
    },
    "totalAum": {
      "type": "number"
    },
    "totalCash": {
      "type": "number"
    },
    "totalPortfolioValue": {
      "type": "number"
    },
    "subAccountCount": {
      "type": "integer"
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "breakdown": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "subAccountId",
          "externalId",
          "cash",
          "portfolioValue",
          "totalValue"
        ],
        "properties": {
          "subAccountId": {
            "type": "string"
          },
          "externalId": {
            "type": [
              "string",
              "null"
            ]
          },
          "cash": {
            "type": "number"
          },
          "portfolioValue": {
            "type": "number"
          },
          "totalValue": {
            "type": "number"
          }
        }
      }
    }
  }
}

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

POST /reconciliation-signoffs

GET /report/fees