Reports

Read-only reporting across all sub-accounts — AUM, positions, fees, revenue, dividends, monthly invoices, dividend calendar, audit log, usage analytics, the daily reconciliation pack, per-order executions, and the unified client-activity feed. Most support ?format=csv.

Portfolio snapshots, revenue reporting, dividends, and audit logs across all sub-accounts. All reporting endpoints are read-only and safe to call on every page load. Most support ?format=csv for spreadsheet or data-warehouse export.

AUM

Current aggregate cash and stored portfolio valuations across your sub-accounts, with a per-account breakdown. This is not a historical snapshot and does not represent streaming market valuations. Live uses stored holding currentValue; Sandbox uses units times the stored currentUsdPrice. generatedAt marks response assembly, not quote freshness or an atomic valuation timestamp.

Empty reports include breakdown: [] and zero totals. ?format=csv downloads the same per-account values. Invalid formats return 400. Historical ?asOf= requests return 422 HISTORICAL_REPORT_UNSUPPORTED; do not use this endpoint for historical reconciliation. The separate reconciliation report retains its documented date filters.

GET

/report/aum

Report — AUM

Full endpoint documentation

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"

Positions

All open equity positions across all sub-accounts. Supports ?exchange=, ?symbol=, ?format=csv.

GET

/report/positions

Report — Positions

Full endpoint documentation

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"

Fees & revenue

/report/fees — trading fees paid across all sub-accounts (base fees + partner markup). /report/revenue — partner markup revenue per trade with net payable. Both filter by ?from=/?to=.

GET

/report/fees

Report — Fees

Full endpoint documentation

Sandbox availablelistFees

Returns fees earned by MyStocks and your markup fees, broken down by period and sub-account.

Parameters

fromstringquery

tostringquery

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

partnerKeystringRequired

periodobjectRequired

period.fromstring | nullRequired

period.tostring | nullRequired

totalFeesnumberRequired

tradeCountintegerRequired

currencyUSDRequired

monthlyobject[]Required

monthly[].monthstringRequired

monthly[].feesnumberRequired

monthly[].tradeCountintegerRequired

transactionsobject[]Required

transactions[].idstringRequired

transactions[].orderIdstring

transactions[].symbolstring

transactions[].tradeTypestring

transactions[].amountnumberRequired

transactions[].currencystringRequired

transactions[].createdAtstring | nullRequired

Response codes

200Fee report.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "partnerKey",
    "period",
    "totalFees",
    "tradeCount",
    "currency",
    "monthly",
    "transactions"
  ],
  "properties": {
    "partnerKey": {
      "type": "string"
    },
    "period": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "totalFees": {
      "type": "number"
    },
    "tradeCount": {
      "type": "integer"
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "monthly": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "month",
          "fees",
          "tradeCount"
        ],
        "properties": {
          "month": {
            "type": "string"
          },
          "fees": {
            "type": "number"
          },
          "tradeCount": {
            "type": "integer"
          }
        }
      }
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "amount",
          "currency",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "orderId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "tradeType": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

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

GET

/report/revenue

Report — Revenue

Full endpoint documentation

Sandbox availablelistRevenue

Returns your net revenue (markup fees) across all sub-accounts for the given period.

Parameters

fromstringquery

tostringquery

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

partnerKeystringRequired

markupBpsnumberRequired

periodobjectRequired

period.fromstring | nullRequired

period.tostring | nullRequired

currencyUSDRequired

totalRevenuenumberRequired

totalBaseFeesnumberRequired

tradeCountintegerRequired

monthlyobject[]Required

monthly[].monthstringRequired

monthly[].revenuenumberRequired

monthly[].baseFeesnumberRequired

monthly[].tradeCountintegerRequired

bySymbolobject[]Required

bySymbol[].symbolstringRequired

bySymbol[].revenuenumberRequired

bySymbol[].baseFeesnumberRequired

bySymbol[].tradeCountintegerRequired

transactionsobject[]Required

transactions[].idstringRequired

transactions[].orderIdstring

transactions[].symbolstring

transactions[].tradeTypestring

transactions[].markupFeenumberRequired

transactions[].baseFeenumberRequired

transactions[].totalFeenumber

transactions[].markupBpsnumber

transactions[].currencystringRequired

transactions[].createdAtstring | nullRequired

Response codes

200Revenue report.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "partnerKey",
    "markupBps",
    "period",
    "currency",
    "totalRevenue",
    "totalBaseFees",
    "tradeCount",
    "monthly",
    "bySymbol",
    "transactions"
  ],
  "properties": {
    "partnerKey": {
      "type": "string"
    },
    "markupBps": {
      "type": "number"
    },
    "period": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "totalRevenue": {
      "type": "number"
    },
    "totalBaseFees": {
      "type": "number"
    },
    "tradeCount": {
      "type": "integer"
    },
    "monthly": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "month",
          "revenue",
          "baseFees",
          "tradeCount"
        ],
        "properties": {
          "month": {
            "type": "string"
          },
          "revenue": {
            "type": "number"
          },
          "baseFees": {
            "type": "number"
          },
          "tradeCount": {
            "type": "integer"
          }
        }
      }
    },
    "bySymbol": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "symbol",
          "revenue",
          "baseFees",
          "tradeCount"
        ],
        "properties": {
          "symbol": {
            "type": "string"
          },
          "revenue": {
            "type": "number"
          },
          "baseFees": {
            "type": "number"
          },
          "tradeCount": {
            "type": "integer"
          }
        }
      }
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "markupFee",
          "baseFee",
          "currency",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "orderId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "tradeType": {
            "type": "string"
          },
          "markupFee": {
            "type": "number"
          },
          "baseFee": {
            "type": "number"
          },
          "totalFee": {
            "type": "number"
          },
          "markupBps": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

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

Dividends & calendar

/report/dividends — aggregated dividend report across all sub-accounts, with per-account breakdown. /dividends/calendar — upcoming declarations; partnerEligible: true flags dividends where at least one of your sub-accounts holds the stock.

GET

/report/dividends

Report — Dividends

Full endpoint documentation

Sandbox availablegetDividendReport

Aggregated dividend distributions paid to sub-accounts for a given period. Returns totals, a per-symbol breakdown, and a per-sub-account breakdown. Add ?format=csv to download a spreadsheet of the by-symbol totals.

Parameters

fromstringquery

Start of period (ISO date, e.g. 2026-01-01). Defaults to 365 days ago.

tostringquery

End of period (ISO date). Defaults to today.

formatcsvquery

Pass csv to receive a downloadable spreadsheet instead of JSON.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

totalUsdReceivednumber

Total USD credited to sub-accounts as dividends in the period.

distributionCountinteger

Number of individual distribution transactions.

currencystring

Example: "USD"

fromstring

tostring

bySymbolobject[]

Totals grouped by stock symbol.

bySymbol[].symbolstring

bySymbol[].totalUsdnumber

bySymbol[].countinteger

bySubAccountobject[]

Totals grouped by sub-account.

bySubAccount[].subAccountIdstring

bySubAccount[].externalIdstring | null

bySubAccount[].displayNamestring | null

bySubAccount[].totalUsdnumber

bySubAccount[].countinteger

Response codes

200Dividend distribution report (JSON) or CSV file.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · queryformat Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "totalUsdReceived": {
      "type": "number",
      "description": "Total USD credited to sub-accounts as dividends in the period."
    },
    "distributionCount": {
      "type": "integer",
      "description": "Number of individual distribution transactions."
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    },
    "bySymbol": {
      "type": "array",
      "description": "Totals grouped by stock symbol.",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string"
          },
          "totalUsd": {
            "type": "number"
          },
          "count": {
            "type": "integer"
          }
        }
      }
    },
    "bySubAccount": {
      "type": "array",
      "description": "Totals grouped by sub-account.",
      "items": {
        "type": "object",
        "properties": {
          "subAccountId": {
            "type": "string"
          },
          "externalId": {
            "type": [
              "string",
              "null"
            ]
          },
          "displayName": {
            "type": [
              "string",
              "null"
            ]
          },
          "totalUsd": {
            "type": "number"
          },
          "count": {
            "type": "integer"
          }
        }
      }
    }
  }
}

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

GET

/dividends/calendar

Dividend calendar

Full endpoint documentation

Sandbox availablelistCalendar

Returns dividend declarations for stocks held across the partner's sub-accounts. Pass all=true to include declarations for symbols that no sub-account currently holds.

Parameters

statusDECLARED | PAID | CANCELLED | ALLquery

Filter declarations by lifecycle status.

allbooleanquery

Return declarations for all symbols, including those not held by partner sub-accounts.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

declarationsobject[]

declarations[].idstring

declarations[].symbolstring

declarations[].namestring

declarations[].amountnumber

declarations[].currencystring

declarations[].exDividendDatestring | null

declarations[].recordDatestring | null

declarations[].paymentDatestring | null

declarations[].statusstring

declarations[].partnerEligibleboolean

declarations[].createdAtstring | null

countinteger

Response codes

200Dividend declarations visible to this partner.

Sandbox playground

Read-only sandbox request

status Optional · queryall Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/dividends/calendar

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "declarations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "exDividendDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "recordDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "paymentDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "partnerEligible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

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

Invoice

Monthly statement of account with platform fees owed, partner markup earned, float movements, payouts, issued invoices, and manual adjustments. Pass ?month=YYYY-MM or ?format=csv.

GET

/report/invoice

Report — Invoice

Full endpoint documentation

Sandbox availablelistInvoice

Returns invoiceable fee data for a billing period, formatted for your finance team. Includes base fees billed by MyStocks and markup collected by you.

Parameters

monthstringqueryRequired

Billing month in YYYY-MM format.

Example: 2026-04

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

invoiceIdstringRequired

monthstringRequired

periodobjectRequired

period.fromstring | nullRequired

period.tostring | nullRequired

generatedAtstringRequired

partnerobjectRequired

partner.keyIdstringRequired

partner.businessNamestringRequired

partner.emailstringRequired

partner.tierstring

partner.markupBpsnumber

summaryobjectRequired

summary.tradeCountintegerRequired

summary.subAccountCountintegerRequired

summary.walletBalancenumberRequired

summary.totalMarkupRevenuenumberRequired

summary.totalBaseFeesnumberRequired

summary.totalFeesnumberRequired

summary.currencyUSDRequired

summary.feesOwednumber

summary.markupEarnednumber

summary.approvedTopupsnumber

summary.pendingTopupsnumber

summary.processedPayoutsnumber

summary.pendingPayoutsnumber

summary.adjustmentsnumber

statementOfAccountobjectRequired

statementOfAccount.feesOwedUsdnumberRequired

statementOfAccount.markupEarnedUsdnumberRequired

statementOfAccount.netPartnerPositionUsdnumberRequired

statementOfAccount.floatMovementsobject[]

statementOfAccount.payoutsobject[]

statementOfAccount.invoicesobject[]

statementOfAccount.adjustmentsobject[]

lineItemsobject[]Required

lineItems[].datestringRequired

lineItems[].orderIdstringRequired

lineItems[].symbolstringRequired

lineItems[].tradeTypestringRequired

lineItems[].markupFeenumberRequired

lineItems[].baseFeenumberRequired

lineItems[].totalFeenumberRequired

Response codes

200Invoice data.

Sandbox playground

Read-only sandbox request

month Required · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "invoiceId",
    "month",
    "period",
    "generatedAt",
    "partner",
    "summary",
    "statementOfAccount",
    "lineItems"
  ],
  "properties": {
    "invoiceId": {
      "type": "string"
    },
    "month": {
      "type": "string"
    },
    "period": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "generatedAt": {
      "type": "string"
    },
    "partner": {
      "type": "object",
      "required": [
        "keyId",
        "businessName",
        "email"
      ],
      "properties": {
        "keyId": {
          "type": "string"
        },
        "businessName": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "tier": {
          "type": "string"
        },
        "markupBps": {
          "type": "number"
        }
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "tradeCount",
        "subAccountCount",
        "walletBalance",
        "totalMarkupRevenue",
        "totalBaseFees",
        "totalFees",
        "currency"
      ],
      "properties": {
        "tradeCount": {
          "type": "integer"
        },
        "subAccountCount": {
          "type": "integer"
        },
        "walletBalance": {
          "type": "number"
        },
        "totalMarkupRevenue": {
          "type": "number"
        },
        "totalBaseFees": {
          "type": "number"
        },
        "totalFees": {
          "type": "number"
        },
        "currency": {
          "type": "string",
          "enum": [
            "USD"
          ]
        },
        "feesOwed": {
          "type": "number"
        },
        "markupEarned": {
          "type": "number"
        },
        "approvedTopups": {
          "type": "number"
        },
        "pendingTopups": {
          "type": "number"
        },
        "processedPayouts": {
          "type": "number"
        },
        "pendingPayouts": {
          "type": "number"
        },
        "adjustments": {
          "type": "number"
        }
      }
    },
    "statementOfAccount": {
      "type": "object",
      "required": [
        "feesOwedUsd",
        "markupEarnedUsd",
        "netPartnerPositionUsd"
      ],
      "properties": {
        "feesOwedUsd": {
          "type": "number"
        },
        "markupEarnedUsd": {
          "type": "number"
        },
        "netPartnerPositionUsd": {
          "type": "number"
        },
        "floatMovements": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "payouts": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "invoices": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "adjustments": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date",
          "orderId",
          "symbol",
          "tradeType",
          "markupFee",
          "baseFee",
          "totalFee"
        ],
        "properties": {
          "date": {
            "type": "string"
          },
          "orderId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "tradeType": {
            "type": "string"
          },
          "markupFee": {
            "type": "number"
          },
          "baseFee": {
            "type": "number"
          },
          "totalFee": {
            "type": "number"
          }
        }
      }
    }
  }
}

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

Reconciliation

Daily reconciliation pack for B2B operations: cash ledger, securities ledger, unsettled trades, fees, dividends, corporate actions, and custody positions across the master account and all sub-accounts. Pass ?asOf=YYYY-MM-DD (or ?from=/?to=). Add ?format=csv&section=cash|securities|unsettled|fees|dividends|custody|summary to download one section.

GET

/report/reconciliation

Report - Reconciliation suite

Full endpoint documentation

Sandbox availablegetReconciliationReport

Daily reconciliation pack for B2B operations. Returns cash ledger, securities ledger, unsettled trades, fees, dividends, corporate actions, and custody position files for the partner master account and all sub-accounts. Add format=csv&section=... to download a section as CSV for finance, SFTP mirroring, or data warehouse ingestion. JSON responses include an explicit cash roll-forward, data-quality controls, and customer-sub-ledger-versus-MyStocks-omnibus proof. A status of EXCEPTIONS identifies unit or invalid-value differences; INCOMPLETE means no MyStocks omnibus positions were available for comparison. Sandbox returns current virtual wallets and holdings for the master and at most 500 sub-accounts, with null custody totals and INCOMPLETE status. Sandbox historical dates and from/to receive 422; section filtering receives 400. Sandbox format=csv exports current account totals. Neither this Sandbox report nor an internal ledger alone proves external settlement.

Parameters

asOfstringquery

Single business date to reconcile. Overrides default today when from/to are omitted.

Example: 2026-06-30

fromstringquery

tostringquery

formatjson | csvquery

Example: json

CSV export section.

limitintegerquery

Per-account transaction/order scan limit.

Example: 1000

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

See the response format and API Reference for this endpoint.

Response codes

200Reconciliation report or CSV file.

422Sandbox historical report or account limit unsupported.

Sandbox playground

Read-only sandbox request

asOf Optional · queryfrom Optional · queryto Optional · queryformat Optional · querysection Optional · querylimit Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "partnerKey": {
          "type": "string"
        },
        "period": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date"
            },
            "to": {
              "type": "string",
              "format": "date"
            }
          }
        },
        "generatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "exportManifest": {
          "type": "object",
          "description": "Pointers to the JSON and per-section CSV variants of this report.",
          "properties": {
            "api": {
              "type": "string",
              "example": "/api/v1/partner/report/reconciliation"
            },
            "csv": {
              "type": "string",
              "example": "/api/v1/partner/report/reconciliation?format=csv&section={cash|securities|unsettled|fees|dividends|corporate_actions|custody_positions}"
            },
            "sftpEligible": {
              "type": "boolean"
            }
          }
        },
        "summary": {
          "type": "object",
          "properties": {
            "accountCount": {
              "type": "integer"
            },
            "closingCashBalance": {
              "type": "number"
            },
            "closingSecuritiesValue": {
              "type": "number"
            },
            "unsettledTradeCount": {
              "type": "integer"
            },
            "unsettledBuyAmount": {
              "type": "number"
            },
            "unsettledSellAmount": {
              "type": "number"
            },
            "totalFees": {
              "type": "number"
            },
            "totalDividends": {
              "type": "number"
            },
            "custodyPositionCount": {
              "type": "integer"
            },
            "corporateActionCount": {
              "type": "integer"
            },
            "reconciliationStatus": {
              "type": "string",
              "enum": [
                "BALANCED",
                "EXCEPTIONS",
                "INCOMPLETE"
              ]
            },
            "custodyExceptionCount": {
              "type": "integer"
            }
          }
        },
        "proof": {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "BALANCED",
                "EXCEPTIONS",
                "INCOMPLETE"
              ]
            },
            "cashRollForward": {
              "type": "object",
              "properties": {
                "closingCashBalance": {
                  "type": "number"
                },
                "completedCredits": {
                  "type": "number"
                },
                "completedDebits": {
                  "type": "number"
                },
                "netMovement": {
                  "type": "number"
                },
                "derivedOpeningCashBalance": {
                  "type": "number"
                },
                "equation": {
                  "type": "string"
                }
              }
            },
            "custody": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "BALANCED",
                    "EXCEPTIONS",
                    "INCOMPLETE"
                  ]
                },
                "comparedInstrumentCount": {
                  "type": "integer"
                },
                "beneficialUnits": {
                  "type": "number"
                },
                "custodyUnits": {
                  "type": "number"
                },
                "exceptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "instrumentId": {
                        "type": "string"
                      },
                      "beneficialUnits": {
                        "type": "number"
                      },
                      "custodyUnits": {
                        "type": "number"
                      },
                      "differenceUnits": {
                        "type": "number"
                      }
                    }
                  }
                }
              }
            },
            "notes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "accounts": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "One account (master or sub-account) covered by the reconciliation report.",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Your identifier for the sub-account, if set. Null for the master account."
              },
              "displayName": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "cashLedger": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "One wallet transaction in the reconciliation period. The fees and dividends arrays reuse this shape (filtered to type FEE and DISTRIBUTION/DIVIDEND respectively).",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "transactionId": {
                "type": "string"
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Transaction type, e.g. DEPOSIT, WITHDRAWAL, INVEST, FEE, DISTRIBUTION."
              },
              "status": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "direction": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "CREDIT or DEBIT where recorded."
              },
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string",
                "example": "USD"
              },
              "reference": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceType": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "settledAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "securitiesLedger": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "One holding row in the securities ledger, valued in USD.",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "symbol": {
                "type": "string",
                "example": "SCOM.KE"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "exchange": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceType": {
                "type": "string",
                "example": "LISTED_STOCK"
              },
              "sourceId": {
                "type": "string"
              },
              "units": {
                "type": "number"
              },
              "reservedUnits": {
                "type": "number",
                "description": "Units locked by open SELL orders."
              },
              "costBasis": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "amountInvested": {
                "type": "number"
              },
              "currentValue": {
                "type": "number"
              },
              "currency": {
                "type": "string",
                "example": "USD"
              },
              "localCurrency": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "updatedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              }
            }
          }
        },
        "unsettledTrades": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "One open (PENDING/PROCESSING) trade order awaiting settlement.",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "orderId": {
                "type": "string"
              },
              "clientOrderId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "quoteId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "BUY",
                  "SELL",
                  null
                ]
              },
              "symbol": {
                "type": "string"
              },
              "exchange": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "status": {
                "type": "string",
                "example": "PENDING"
              },
              "quantity": {
                "type": "number"
              },
              "filledQuantity": {
                "type": "number"
              },
              "remainingQuantity": {
                "type": "number"
              },
              "totalAmount": {
                "type": "number"
              },
              "feeAmount": {
                "type": "number"
              },
              "settlementUsdPrice": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "createdAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "settledAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "omsStatus": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "fees": {
          "type": "array",
          "description": "Cash-ledger entries with type FEE.",
          "items": {
            "type": "object",
            "description": "One wallet transaction in the reconciliation period. The fees and dividends arrays reuse this shape (filtered to type FEE and DISTRIBUTION/DIVIDEND respectively).",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "transactionId": {
                "type": "string"
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Transaction type, e.g. DEPOSIT, WITHDRAWAL, INVEST, FEE, DISTRIBUTION."
              },
              "status": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "direction": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "CREDIT or DEBIT where recorded."
              },
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string",
                "example": "USD"
              },
              "reference": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceType": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "settledAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "dividends": {
          "type": "array",
          "description": "Cash-ledger entries with type DISTRIBUTION or DIVIDEND.",
          "items": {
            "type": "object",
            "description": "One wallet transaction in the reconciliation period. The fees and dividends arrays reuse this shape (filtered to type FEE and DISTRIBUTION/DIVIDEND respectively).",
            "properties": {
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "transactionId": {
                "type": "string"
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Transaction type, e.g. DEPOSIT, WITHDRAWAL, INVEST, FEE, DISTRIBUTION."
              },
              "status": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "direction": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "CREDIT or DEBIT where recorded."
              },
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string",
                "example": "USD"
              },
              "reference": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "sourceType": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "settledAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "corporateActions": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "Corporate action affecting a symbol held by a reported account in the period.",
            "properties": {
              "id": {
                "type": "string"
              },
              "symbol": {
                "type": "string"
              },
              "type": {
                "type": [
                  "string",
                  "null"
                ],
                "example": "SPLIT"
              },
              "title": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "exDate": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "recordDate": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "payDate": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "amount": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "createdAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              }
            }
          }
        },
        "custodyPositions": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "Custody register entry for an account's beneficially-owned position.",
            "properties": {
              "positionId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "externalId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "instrumentId": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "legalHolder": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "beneficialOwner": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "unitsHeld": {
                "type": "number"
              },
              "averageCost": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "accruedInterest": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "status": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "updatedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              }
            }
          }
        }
      },
      "required": [
        "partnerKey",
        "period",
        "summary",
        "proof"
      ]
    },
    {
      "type": "object",
      "required": [
        "reconciliationId",
        "asOf",
        "generatedAt",
        "status",
        "cash",
        "positions",
        "accounts",
        "accountCount",
        "valuationBasis",
        "exceptions",
        "fixture",
        "sandbox",
        "note"
      ],
      "properties": {
        "reconciliationId": {
          "type": "string"
        },
        "asOf": {
          "type": "string"
        },
        "generatedAt": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "INCOMPLETE"
          ]
        },
        "cash": {
          "type": "object",
          "required": [
            "ledgerUsd",
            "custodyUsd",
            "differenceUsd"
          ],
          "properties": {
            "ledgerUsd": {
              "type": "number"
            },
            "custodyUsd": {
              "type": "null"
            },
            "differenceUsd": {
              "type": "null"
            }
          }
        },
        "positions": {
          "type": "object",
          "required": [
            "ledgerMarketValueUsd",
            "custodyMarketValueUsd",
            "differenceUsd"
          ],
          "properties": {
            "ledgerMarketValueUsd": {
              "type": "number"
            },
            "custodyMarketValueUsd": {
              "type": "null"
            },
            "differenceUsd": {
              "type": "null"
            }
          }
        },
        "accounts": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "accountId",
              "accountType",
              "cashBalance",
              "positions"
            ],
            "properties": {
              "accountId": {
                "type": "string"
              },
              "accountType": {
                "type": "string",
                "enum": [
                  "MASTER",
                  "SUBACCOUNT"
                ]
              },
              "cashBalance": {
                "type": "number"
              },
              "positions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "symbol",
                    "units",
                    "valueUsd"
                  ],
                  "properties": {
                    "symbol": {
                      "type": "string"
                    },
                    "units": {
                      "type": "number"
                    },
                    "valueUsd": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "accountCount": {
          "type": "integer"
        },
        "valuationBasis": {
          "type": "string",
          "enum": [
            "current_virtual_wallets_and_holdings"
          ]
        },
        "exceptions": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        },
        "fixture": {
          "type": "boolean",
          "enum": [
            false
          ]
        },
        "sandbox": {
          "type": "boolean",
          "enum": [
            true
          ]
        },
        "note": {
          "type": "string"
        }
      }
    }
  ]
}

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

Executions

OMS-style execution reports for an order — every lifecycle transition (accepted, locked, settled, rejected, cancelled) with timestamps. Available for partner-level and sub-account orders.

Filled orders do not return an empty execution list. For orders created before the immutable execution journal existed, the endpoint derives one compatibility FILL from the order record and marks it synthetic: true with sourceEvidence: "LEGACY_ORDER_STATE". Native journal reports remain immutable and authoritative; consumers can distinguish the compatibility row explicitly.

GET

/orders/{orderId}/executions

Get order execution reports

Full endpoint documentation

Sandbox unsupportedgetOrderExecutions

Returns OMS execution reports for a partner master-account order, including receipt, fill, rejection, and cancellation reports.

Parameters

orderIdstringpathRequired

Example: ord_abc123xyz

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

orderIdstring

subAccountIdstring | null

executionsobject[]

executions[].executionReportIdstring

executions[].journalVersioninteger | null

executions[].immutableboolean

executions[].eventHashAlgorithmstring | null

executions[].eventHashstring | null

executions[].orderIdstring

executions[].clientOrderIdstring | null

executions[].accountTypeMASTER | SUBACCOUNT

executions[].subAccountIdstring | null

executions[].sideBUY | SELL

executions[].symbolstring

executions[].exchangestring | null

executions[].requestedQuantitynumber

executions[].filledQuantitynumber

executions[].remainingQuantitynumber

executions[].fillPricenumber | null

executions[].averageFillPricenumber | null

executions[].feeAmountnumber | null

executions[].netAmountnumber | null

executions[].currencystring

Example: "USD"

executions[].executionVenuestring | null

executions[].actorTypestring | null

executions[].actorIdstring | null

executions[].requestIdstring | null

executions[].sourcestring | null

executions[].correctsExecutionReportIdstring | null

executions[].syntheticboolean

True only for a read-time compatibility FILL derived from a legacy filled order that predates the immutable execution journal.

executions[].sourceEvidencestring | null

executions[].createdAtstring | null

executions[].occurredAtstring | null

executions[].recordedAtstring | null

countinteger

Response codes

200Execution reports for the order.

404Order not found.

Request reference

Sandbox unsupported

orderId Required · path

Use the API Reference for this production-only or streaming operation.

https://mystocks.africa/api/v1/partner/orders/%7BorderId%7D/executions

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "subAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "executions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "executionReportId": {
            "type": "string"
          },
          "journalVersion": {
            "type": [
              "integer",
              "null"
            ]
          },
          "immutable": {
            "type": "boolean"
          },
          "eventHashAlgorithm": {
            "type": [
              "string",
              "null"
            ]
          },
          "eventHash": {
            "type": [
              "string",
              "null"
            ]
          },
          "orderId": {
            "type": "string"
          },
          "clientOrderId": {
            "type": [
              "string",
              "null"
            ]
          },
          "accountType": {
            "type": "string",
            "enum": [
              "MASTER",
              "SUBACCOUNT"
            ]
          },
          "subAccountId": {
            "type": [
              "string",
              "null"
            ]
          },
          "reportType": {
            "type": "string",
            "enum": [
              "ORDER_RECEIVED",
              "FILL",
              "REJECT",
              "CANCEL",
              "REPLACE",
              "CORRECTION"
            ]
          },
          "orderStatus": {
            "type": "string",
            "enum": [
              "RECEIVED",
              "FILLED",
              "REJECTED",
              "CANCELLED",
              "REPLACED",
              "WORKING"
            ]
          },
          "side": {
            "type": "string",
            "enum": [
              "BUY",
              "SELL"
            ]
          },
          "symbol": {
            "type": "string"
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "requestedQuantity": {
            "type": "number"
          },
          "filledQuantity": {
            "type": "number"
          },
          "remainingQuantity": {
            "type": "number"
          },
          "fillPrice": {
            "type": [
              "number",
              "null"
            ]
          },
          "averageFillPrice": {
            "type": [
              "number",
              "null"
            ]
          },
          "feeAmount": {
            "type": [
              "number",
              "null"
            ]
          },
          "netAmount": {
            "type": [
              "number",
              "null"
            ]
          },
          "currency": {
            "type": "string",
            "example": "USD"
          },
          "executionVenue": {
            "type": [
              "string",
              "null"
            ]
          },
          "actorType": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "PARTNER_KEY",
              "ADMIN_USER",
              "SYSTEM_JOB",
              null
            ]
          },
          "actorId": {
            "type": [
              "string",
              "null"
            ]
          },
          "requestId": {
            "type": [
              "string",
              "null"
            ]
          },
          "source": {
            "type": [
              "string",
              "null"
            ]
          },
          "correctsExecutionReportId": {
            "type": [
              "string",
              "null"
            ]
          },
          "synthetic": {
            "type": "boolean",
            "description": "True only for a read-time compatibility FILL derived from a legacy filled order that predates the immutable execution journal."
          },
          "sourceEvidence": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "LEGACY_ORDER_STATE",
              null
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "occurredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "recordedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/v1/partner/orders/%7BorderId%7D/executions' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

GET

/users/{userId}/orders/{orderId}/executions

Get sub-account order execution reports

Full endpoint documentation

Sandbox availablegetUserOrderExecutions

Returns OMS execution reports for a sub-account order, including receipt, fill, rejection, and cancellation reports.

Parameters

userIdstringpathRequired

Example: usr_abc123

orderIdstringpathRequired

Example: ord_abc123xyz

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

orderIdstring

subAccountIdstring | null

executionsobject[]

executions[].executionReportIdstring

executions[].journalVersioninteger | null

executions[].immutableboolean

executions[].eventHashAlgorithmstring | null

executions[].eventHashstring | null

executions[].orderIdstring

executions[].clientOrderIdstring | null

executions[].accountTypeMASTER | SUBACCOUNT

executions[].subAccountIdstring | null

executions[].sideBUY | SELL

executions[].symbolstring

executions[].exchangestring | null

executions[].requestedQuantitynumber

executions[].filledQuantitynumber

executions[].remainingQuantitynumber

executions[].fillPricenumber | null

executions[].averageFillPricenumber | null

executions[].feeAmountnumber | null

executions[].netAmountnumber | null

executions[].currencystring

Example: "USD"

executions[].executionVenuestring | null

executions[].actorTypestring | null

executions[].actorIdstring | null

executions[].requestIdstring | null

executions[].sourcestring | null

executions[].correctsExecutionReportIdstring | null

executions[].syntheticboolean

True only for a read-time compatibility FILL derived from a legacy filled order that predates the immutable execution journal.

executions[].sourceEvidencestring | null

executions[].createdAtstring | null

executions[].occurredAtstring | null

executions[].recordedAtstring | null

countinteger

Response codes

200Execution reports for the order.

404Sub-account or order not found.

Sandbox playground

Read-only sandbox request

userId Required · pathorderId Required · pathSandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/orders/%7BorderId%7D/executions

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "subAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "executions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "executionReportId": {
            "type": "string"
          },
          "journalVersion": {
            "type": [
              "integer",
              "null"
            ]
          },
          "immutable": {
            "type": "boolean"
          },
          "eventHashAlgorithm": {
            "type": [
              "string",
              "null"
            ]
          },
          "eventHash": {
            "type": [
              "string",
              "null"
            ]
          },
          "orderId": {
            "type": "string"
          },
          "clientOrderId": {
            "type": [
              "string",
              "null"
            ]
          },
          "accountType": {
            "type": "string",
            "enum": [
              "MASTER",
              "SUBACCOUNT"
            ]
          },
          "subAccountId": {
            "type": [
              "string",
              "null"
            ]
          },
          "reportType": {
            "type": "string",
            "enum": [
              "ORDER_RECEIVED",
              "FILL",
              "REJECT",
              "CANCEL",
              "REPLACE",
              "CORRECTION"
            ]
          },
          "orderStatus": {
            "type": "string",
            "enum": [
              "RECEIVED",
              "FILLED",
              "REJECTED",
              "CANCELLED",
              "REPLACED",
              "WORKING"
            ]
          },
          "side": {
            "type": "string",
            "enum": [
              "BUY",
              "SELL"
            ]
          },
          "symbol": {
            "type": "string"
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "requestedQuantity": {
            "type": "number"
          },
          "filledQuantity": {
            "type": "number"
          },
          "remainingQuantity": {
            "type": "number"
          },
          "fillPrice": {
            "type": [
              "number",
              "null"
            ]
          },
          "averageFillPrice": {
            "type": [
              "number",
              "null"
            ]
          },
          "feeAmount": {
            "type": [
              "number",
              "null"
            ]
          },
          "netAmount": {
            "type": [
              "number",
              "null"
            ]
          },
          "currency": {
            "type": "string",
            "example": "USD"
          },
          "executionVenue": {
            "type": [
              "string",
              "null"
            ]
          },
          "actorType": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "PARTNER_KEY",
              "ADMIN_USER",
              "SYSTEM_JOB",
              null
            ]
          },
          "actorId": {
            "type": [
              "string",
              "null"
            ]
          },
          "requestId": {
            "type": [
              "string",
              "null"
            ]
          },
          "source": {
            "type": [
              "string",
              "null"
            ]
          },
          "correctsExecutionReportId": {
            "type": [
              "string",
              "null"
            ]
          },
          "synthetic": {
            "type": "boolean",
            "description": "True only for a read-time compatibility FILL derived from a legacy filled order that predates the immutable execution journal."
          },
          "sourceEvidence": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "LEGACY_ORDER_STATE",
              null
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "occurredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "recordedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

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

Audit, usage & activity

/audit — paginated API call log (endpoint, method, status, IP, user-agent, latency) including key events (key.rotated, key.revoked, settings.updated). /usage — 90-day rolling analytics: requests per day, error rate, current rate-limit window. /client-activity — unified reverse-chronological feed of trades, deposits, withdrawals, subscriptions, redemptions, and KYC changes across all sub-accounts.

GET

/audit

Audit log

Full endpoint documentation

Sandbox availablelistAudit

Returns a cursor-paginated list of API calls made with your live key, ordered newest first. Each entry includes the endpoint path, HTTP method, source IP, user-agent, and timestamp. Use ?limit= and ?cursor= for pagination (see the Pagination section).

Parameters

limitintegerquery

Example: 50

cursorstringquery

Opaque cursor from the previous page's nextCursor field.

beforestringquery

ISO timestamp — return only entries older than this value.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

entriesobject[]

entries[].idstring

entries[].endpointstring

Example: "/api/v1/partner/users/usr_abc/trade"

entries[].methodstring

Example: "POST"

entries[].ipstring | null

entries[].userAgentstring | null

entries[].timestampstring | null

countinteger

hasMoreboolean

nextCursorstring | null

Response codes

200Paginated audit log entries.

Sandbox playground

Read-only sandbox request

limit Optional · querycursor Optional · querybefore Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/audit

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "endpoint": {
            "type": "string",
            "example": "/api/v1/partner/users/usr_abc/trade"
          },
          "method": {
            "type": "string",
            "example": "POST"
          },
          "ip": {
            "type": [
              "string",
              "null"
            ]
          },
          "userAgent": {
            "type": [
              "string",
              "null"
            ]
          },
          "timestamp": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

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

GET

/usage

Usage analytics

Full endpoint documentation

Sandbox availablelistUsage

Returns daily API call totals for the last N days (default 30, max 90), aggregated from per-minute rate-limit windows. Also returns the current rate-limit window status so you can see remaining capacity in real time.

Parameters

daysintegerquery

Number of days to look back. Default 30, max 90.

Example: 30

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

keyIdstring

tierstring

Example: "starter"

periodDaysinteger

Example: 30

totalCallsinteger

Total API calls in the requested period.

dailyobject[]

One entry per calendar day, ordered oldest first.

daily[].datestring

Example: "2026-05-01"

daily[].callsinteger

currentWindowobject

Live rate-limit window status.

currentWindow.limitinteger

Maximum requests allowed per minute for your tier.

currentWindow.remaininginteger

Requests remaining in the current 1-minute window.

currentWindow.resetAtstring

When the current window resets.

Response codes

200Usage analytics and current rate-limit window.

Sandbox playground

Read-only sandbox request

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

https://mystocks.africa/api/sandbox/v1/partner/usage

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "keyId": {
      "type": "string"
    },
    "tier": {
      "type": "string",
      "example": "starter"
    },
    "periodDays": {
      "type": "integer",
      "example": 30
    },
    "totalCalls": {
      "type": "integer",
      "description": "Total API calls in the requested period."
    },
    "daily": {
      "type": "array",
      "description": "One entry per calendar day, ordered oldest first.",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "example": "2026-05-01"
          },
          "calls": {
            "type": "integer"
          }
        }
      }
    },
    "currentWindow": {
      "type": "object",
      "description": "Live rate-limit window status.",
      "properties": {
        "limit": {
          "type": "integer",
          "description": "Maximum requests allowed per minute for your tier."
        },
        "remaining": {
          "type": "integer",
          "description": "Requests remaining in the current 1-minute window."
        },
        "resetAt": {
          "type": "string",
          "format": "date-time",
          "description": "When the current window resets."
        }
      }
    }
  }
}

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

GET

/client-activity

Client activity feed

Full endpoint documentation

Sandbox availablelistClientActivity

Returns a chronological feed of all sub-account activity — trades, deposits, withdrawals, KYC changes, and dividends. Useful for building an admin dashboard.

Parameters

fromstringquery

Example: 2026-01-01

tostringquery

typeTRADE | DEPOSIT | WITHDRAWAL | KYC | DIVIDENDquery

Filter by event type.

limitintegerquery

Example: 100

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

eventsobject[]

events[].eventIdstring

events[].typestring

events[].subAccountIdstring

events[].detailobject

Event-specific payload.

events[].createdAtstring

totalinteger

Response codes

200Activity events.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · querytype Optional · querylimit Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/client-activity

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventId": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "subAccountId": {
            "type": "string"
          },
          "detail": {
            "type": "object",
            "description": "Event-specific payload."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "total": {
      "type": "integer"
    }
  }
}

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

Reports

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

Parameters

Headers

Response fields

Response codes

On this page