API product catalogInstitutional Reporting, Auditing & Compliance

Report — Positions

Institutional Reporting, Auditing & Compliance

GET

/report/positions

Report — Positions

Sandbox availablelistPositions

Returns all open positions across all sub-accounts, aggregated by symbol. Useful for calculating exposure and hedging needs.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

subAccountCountintegerRequired

symbolCountintegerRequired

positionsobject[]Required

positions[].symbolstringRequired

positions[].totalUnitsnumberRequired

positions[].totalValuenumberRequired

positions[].totalInvestednumberRequired

positions[].totalUnrealisedPnlnumberRequired

positions[].subAccountsobject[]Required

Response codes

200Aggregated positions.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "subAccountCount",
    "symbolCount",
    "positions"
  ],
  "properties": {
    "subAccountCount": {
      "type": "integer"
    },
    "symbolCount": {
      "type": "integer"
    },
    "positions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "symbol",
          "totalUnits",
          "totalValue",
          "totalInvested",
          "totalUnrealisedPnl",
          "subAccounts"
        ],
        "properties": {
          "symbol": {
            "type": "string"
          },
          "totalUnits": {
            "type": "number"
          },
          "totalValue": {
            "type": "number"
          },
          "totalInvested": {
            "type": "number"
          },
          "totalUnrealisedPnl": {
            "type": "number"
          },
          "subAccounts": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "subAccountId",
                "externalId",
                "units",
                "value"
              ],
              "properties": {
                "subAccountId": {
                  "type": "string"
                },
                "externalId": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "units": {
                  "type": "number"
                },
                "value": {
                  "type": "number"
                }
              }
            }
          }
        }
      }
    }
  }
}

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

GET /report/invoice

GET /report/reconciliation