MyStocks Africa Partner API Reference | NSE, NGX, JSE, GSE Stock API

Embed African stock trading (NSE, NGX, JSE, GSE, BRVM) via REST API. Market data, orders, sub-account wallets, KYC, bonds, funds, and webhooks. Free sandbox.

This page requires JavaScript to render the interactive API explorer. Machine-readable resources are available without JavaScript:

• OpenAPI 3.1 Spec (YAML) — complete endpoint definitions, schemas, and examples
• OpenAPI 3.1 Spec (JSON) — same spec in JSON
• AI-readable Partner API Reference — plain-text endpoint reference for LLMs
• API Documentation — full server-rendered reference

Partner API Endpoint Index

Authentication & Account

• POST /api/sandbox/v1/register — create sandbox partner account and get API key
• GET /api/v1/partner/me — fetch partner profile and master wallet balance
• POST /api/v1/partner/api-keys/data-key — generate read-only client-safe data key
• POST /api/v1/partner/api-keys/revoke — revoke a partner API key

Market Data (data key safe)

• GET /api/v1/partner/stocks — list all tradeable stocks across 8+ African exchanges
• GET /api/v1/partner/stocks/{symbol} — real-time quote for a single stock (e.g. SCOM.KE, DANGCEM.NG, MTN.ZA)
• GET /api/v1/partner/stocks/{symbol}/chart — price history (1d, 1w, 1m, 3m, 6m, 1y, 5y)
• GET /api/v1/partner/stocks/{symbol}/history — OHLCV history array
• GET /api/v1/partner/stocks/{symbol}/pulse — sentiment and news pulse for a stock
• GET /api/v1/partner/etfs — list ETFs (JSE Satrix, etc.) with fund metadata
• GET /api/v1/partner/etfs/{symbol} — single ETF detail including expense ratio and top holdings
• GET /api/v1/partner/etfs/{symbol}/chart — ETF price chart
• GET /api/v1/partner/market/quotes — batch real-time quotes, up to 50 symbols per call
• GET /api/v1/partner/market/status — open/closed status and next-open time for each exchange
• GET /api/v1/partner/market/movers — top gainers or losers for an exchange
• GET /api/v1/partner/market/settlement — T+2/T+3 settlement schedule by exchange
• GET /api/v1/partner/companies — company fundamentals and financials
• GET /api/v1/partner/companies/{symbol}/news — company news and announcements
• GET /api/v1/partner/companies/tickers — canonical ticker list for symbol resolution
• GET /api/v1/partner/market-intel — curated market intelligence feed
• GET /api/v1/partner/opportunities — highlighted investment opportunities
• GET /api/v1/partner/dividends/calendar — upcoming dividend declarations
• GET /api/v1/partner/bonds — bonds, T-bills, Eurobonds, corporate bonds, infrastructure bonds
• GET /api/v1/partner/bonds/{id} — single bond detail
• GET /api/v1/partner/funds — money market and yield funds
• GET /api/v1/partner/funds/{id} — single fund detail

Master Account Trading

• GET /api/v1/partner/quote/{symbol} — fee breakdown preview before placing a trade
• POST /api/v1/partner/trade — place BUY or SELL order on the master account
• GET /api/v1/partner/orders — list all master-account orders
• GET /api/v1/partner/orders/{orderId} — single order status
• DELETE /api/v1/partner/orders/{orderId} — cancel a PENDING order
• GET /api/v1/partner/portfolio — master portfolio: holdings, value, P&L

Sub-Account Management

• POST /api/v1/partner/users — create sub-account with isolated USD wallet
• POST /api/v1/partner/auto-register — idempotent sub-account creation (safe on every login)
• GET /api/v1/partner/users — list all sub-accounts
• GET /api/v1/partner/users/{userId} — fetch a sub-account
• PATCH /api/v1/partner/users/{userId} — update sub-account profile
• GET /api/v1/partner/users/{userId}/wallet — wallet balance and currency
• POST /api/v1/partner/users/{userId}/deposit — credit sub-account wallet (partner handles FX)
• POST /api/v1/partner/users/{userId}/withdraw — debit sub-account wallet for withdrawal
• POST /api/v1/partner/users/{userId}/kyc — assert KYC verification for a sub-account
• POST /api/v1/partner/users/{userId}/trade — place BUY or SELL on behalf of a sub-account
• GET /api/v1/partner/users/{userId}/orders — order history for a sub-account
• DELETE /api/v1/partner/users/{userId}/orders/{orderId} — cancel a PENDING sub-account order
• GET /api/v1/partner/users/{userId}/portfolio — holdings, value, and P&L for a sub-account
• GET /api/v1/partner/users/{userId}/transactions — transaction ledger for a sub-account
• GET /api/v1/partner/users/{userId}/dividends — dividend history for a sub-account
• POST /api/v1/partner/users/{userId}/subscribe — subscribe sub-account to a bond or fund
• POST /api/v1/partner/users/{userId}/redeem — redeem a fund holding

Reporting & Webhooks

• GET /api/v1/partner/report/aum — total AUM across all sub-accounts by asset class
• GET /api/v1/partner/report/positions — all open positions across all sub-accounts
• GET /api/v1/partner/report/revenue — fee revenue report
• GET /api/v1/partner/audit — full audit log of all partner API calls
• POST /api/v1/partner/webhooks — register a webhook endpoint
• GET /api/v1/partner/webhooks — list webhook subscriptions
• DELETE /api/v1/partner/webhooks/{id} — delete a webhook
• GET /api/v1/partner/webhooks/{id}/deliveries — webhook delivery log with retry history

Supported Exchanges

• NSE — Nairobi Securities Exchange, Kenya (KES, T+2)
• NGX — Nigerian Exchange Group, Nigeria (NGN, T+3)
• JSE — Johannesburg Stock Exchange, South Africa (ZAR, T+3)
• GSE — Ghana Stock Exchange, Ghana (GHS, T+3)
• BRVM — Bourse Régionale des Valeurs Mobilières, West Africa (XOF, T+3)
• LuSE — Lusaka Securities Exchange, Zambia (ZMW, T+5)
• USE — Uganda Securities Exchange, Uganda (UGX, T+3)
• DSE — Dar es Salaam Stock Exchange, Tanzania (TZS, T+3)
• EGX — Egyptian Exchange, Egypt (EGP, T+2)

Full documentation: mystocks.africa/partners/docs

OpenAPI spec: mystocks.africa/openapi.yaml