Operate

SSE Events

MyStocks Partner API

Subscribe to MyStocks Server-Sent Events for order, wallet, KYC, dividend, market, and incident updates.

Integration guides Get a sandbox key

Explore endpoints

43 of 43

GET

/account

Get partner account

Full endpoint documentation

Sandbox availablelistAccount

Returns your partner profile — tier, wallet balance, API key metadata, and feature flags.

Parameters

walletContract1 | 2query

Opt in to actual currency wallets. Legacy indicative views remain unchanged.

Example: 1

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

accountIdstring

businessNamestring

emailstring

walletobject

wallet.currencystring

Example: "USD"

wallet.balancenumber

walletContractVersion1 | 2

walletModelUSD_LEDGER_WITH_INDICATIVE_EQUIVALENTS | NATIVE_CURRENCY_WALLETS

supportedConversionCurrenciesstring[]

currencyWalletsobject[]

currencyWallets[].currencystring

currencyWallets[].balanceKindstring

currencyWallets[].cashBalancenumber

currencyWallets[].reservednumber

currencyWallets[].externallyReservednumber

currencyWallets[].totalCashnumber

currencyWallets[].availablenumber

currencyWallets[].withdrawablenumber

currencyWallets[].availableForConversionnumber

currencyWallets[].policyEligibleboolean

currencyWallets[].internalTransferAvailablenumber

Traceable available funds for internal transfers

currencyWallets[].nativeFundingEnabledboolean

currencyWallets[].nativePayoutEnabledboolean

currencyWallets[].conversionEnabledboolean

walletsobject[]

wallets[].balanceKindstring

wallets[].indicativeboolean

wallets[].spendableboolean

wallets[].currencystring

Example: "KES"

wallets[].balancenumber

Example: 65000

wallets[].availablenumber

Example: 65000

wallets[].ledgerCurrencystring

Example: "USD"

wallets[].ledgerBalancenumber

Example: 500

wallets[].fxRatenumber

Example: 130

wallets[].fxSourcestring

Example: "MYSTOCKS_MANAGED_FX"

wallets[].fxRateAsOfstring | null

managedFxobject

managedFx.ledgerCurrencystring

Example: "USD"

managedFx.sourcestring

Example: "MYSTOCKS_MANAGED_FX"

managedFx.rateConventionstring

Example: "local currency units per USD"

managedFx.supportedCurrenciesstring[]

managedFx.asOfstring | null

portfolioValuenumber

investedCapitalnumber

realizedGainUsdnumber

environmentproduction | sandbox

pilotobject

Controlled-production policy. When enabled, production mutations fail closed unless admission, ownership, feature, limit, and reconciliation controls pass.

pilot.enabledbooleanRequired

pilot.statusNOT_APPROVED | APPROVED | PAUSED | COMPLETEDRequired

pilot.operationalOwnerunion

pilot.incidentContactunion

pilot.manualTreasuryReviewbooleanRequired

Always true for a controlled pilot; master-wallet top-ups and payouts remain pending until MyStocks treasury review.

pilot.featuresobjectRequired

pilot.limitsobjectRequired

pilot.reconciliationobjectRequired

pilot.readinessobjectRequired

Evidence and approvals required before mutations may resume and before the controlled pilot may complete.

Response codes

200Partner account details.

401Invalid API key.

Sandbox playground

Read-only sandbox request

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

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string"
    },
    "businessName": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "wallet": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "example": "USD"
        },
        "balance": {
          "type": "number"
        }
      }
    },
    "walletContractVersion": {
      "type": "integer",
      "enum": [
        1,
        2
      ]
    },
    "walletModel": {
      "type": "string",
      "enum": [
        "USD_LEDGER_WITH_INDICATIVE_EQUIVALENTS",
        "NATIVE_CURRENCY_WALLETS"
      ]
    },
    "supportedConversionCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "currencyWallets": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Actual separate ledger cash. External escrow has already been debited from cash; do not subtract it again. Live non-USD operations require explicit enablement.",
        "properties": {
          "currency": {
            "type": "string"
          },
          "balanceKind": {
            "type": "string",
            "const": "ACTUAL_WALLET"
          },
          "cashBalance": {
            "type": "number"
          },
          "reserved": {
            "type": "number"
          },
          "externallyReserved": {
            "type": "number"
          },
          "totalCash": {
            "type": "number"
          },
          "available": {
            "type": "number"
          },
          "withdrawable": {
            "type": "number"
          },
          "availableForConversion": {
            "type": "number"
          },
          "policyEligible": {
            "type": "boolean"
          },
          "internalTransferAvailable": {
            "type": "number",
            "description": "Traceable available funds for internal transfers",
            "not bank payouts": null
          },
          "nativeFundingEnabled": {
            "type": "boolean"
          },
          "nativePayoutEnabled": {
            "type": "boolean"
          },
          "conversionEnabled": {
            "type": "boolean"
          }
        }
      }
    },
    "wallets": {
      "type": "array",
      "items": {
        "description": "Indicative equivalents of one USD balance. These views are not separately spendable wallets and must not be summed.",
        "type": "object",
        "properties": {
          "balanceKind": {
            "type": "string",
            "const": "INDICATIVE_EQUIVALENT"
          },
          "indicative": {
            "type": "boolean",
            "const": true
          },
          "spendable": {
            "type": "boolean",
            "const": false
          },
          "currency": {
            "type": "string",
            "example": "KES"
          },
          "balance": {
            "type": "number",
            "example": 65000
          },
          "available": {
            "type": "number",
            "example": 65000
          },
          "ledgerCurrency": {
            "type": "string",
            "example": "USD"
          },
          "ledgerBalance": {
            "type": "number",
            "example": 500
          },
          "fxRate": {
            "type": "number",
            "example": 130
          },
          "fxSource": {
            "type": "string",
            "example": "MYSTOCKS_MANAGED_FX"
          },
          "fxRateAsOf": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "managedFx": {
      "type": "object",
      "properties": {
        "ledgerCurrency": {
          "type": "string",
          "example": "USD"
        },
        "source": {
          "type": "string",
          "example": "MYSTOCKS_MANAGED_FX"
        },
        "rateConvention": {
          "type": "string",
          "example": "local currency units per USD"
        },
        "supportedCurrencies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "asOf": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    },
    "portfolioValue": {
      "type": "number"
    },
    "investedCapital": {
      "type": "number"
    },
    "realizedGainUsd": {
      "type": "number"
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "sandbox"
      ]
    },
    "pilot": {
      "type": "object",
      "description": "Controlled-production policy. When enabled, production mutations fail closed unless admission, ownership, feature, limit, and reconciliation controls pass.",
      "required": [
        "enabled",
        "status",
        "manualTreasuryReview",
        "features",
        "limits",
        "reconciliation",
        "readiness"
      ],
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "NOT_APPROVED",
            "APPROVED",
            "PAUSED",
            "COMPLETED"
          ]
        },
        "operationalOwner": {
          "anyOf": [
            {
              "allOf": [
                {
                  "type": "object",
                  "required": [
                    "name",
                    "email"
                  ],
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "phone": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "incidentContact": {
          "anyOf": [
            {
              "allOf": [
                {
                  "type": "object",
                  "required": [
                    "name",
                    "email"
                  ],
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "phone": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "manualTreasuryReview": {
          "type": "boolean",
          "description": "Always true for a controlled pilot; master-wallet top-ups and payouts remain pending until MyStocks treasury review."
        },
        "features": {
          "type": "object",
          "required": [
            "customerOnboarding",
            "funding",
            "trading",
            "withdrawals"
          ],
          "properties": {
            "customerOnboarding": {
              "type": "boolean"
            },
            "funding": {
              "type": "boolean"
            },
            "trading": {
              "type": "boolean"
            },
            "withdrawals": {
              "type": "boolean"
            }
          }
        },
        "limits": {
          "type": "object",
          "required": [
            "maxCustomers",
            "maxTransactionUsd",
            "maxDailyCustomerUsd",
            "maxDailyPartnerUsd"
          ],
          "properties": {
            "maxCustomers": {
              "type": "integer",
              "minimum": 1
            },
            "maxTransactionUsd": {
              "type": "number",
              "exclusiveMinimum": 0
            },
            "maxDailyCustomerUsd": {
              "type": "number",
              "exclusiveMinimum": 0
            },
            "maxDailyPartnerUsd": {
              "type": "number",
              "exclusiveMinimum": 0
            }
          }
        },
        "reconciliation": {
          "type": "object",
          "required": [
            "required",
            "maxAgeHours",
            "blockOnExceptions"
          ],
          "properties": {
            "required": {
              "type": "boolean"
            },
            "maxAgeHours": {
              "type": "number",
              "minimum": 24,
              "maximum": 48
            },
            "blockOnExceptions": {
              "type": "boolean"
            },
            "lastCompletedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "lastStatus": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "BALANCED",
                "EXCEPTIONS",
                "INCOMPLETE",
                null
              ]
            },
            "evidenceUrl": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        },
        "readiness": {
          "type": "object",
          "description": "Evidence and approvals required before mutations may resume and before the controlled pilot may complete.",
          "required": [
            "rollbackPlanUrl",
            "eventDeliveryVerifiedAt",
            "failoverTestedAt",
            "approvals",
            "exitEvidenceUrl"
          ],
          "properties": {
            "rollbackPlanUrl": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            },
            "eventDeliveryVerifiedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "failoverTestedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "approvals": {
              "type": "object",
              "required": [
                "operations",
                "risk",
                "compliance",
                "security"
              ],
              "properties": {
                "operations": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "risk": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "compliance": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "security": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                }
              }
            },
            "exitEvidenceUrl": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        }
      }
    }
  }
}

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

GET /stream is a Server-Sent Events feed for partner-facing state changes. Use it for live application updates; use signed webhooks for durable server-to-server processing and reconciliation.

Connect

The stream uses the same partner base URL and authentication model as REST:

const source = new EventSource(
  'https://mystocks.africa/api/v1/partner/stream?access_token=ms_oauth_<short-lived-token>'
);
 
source.onmessage = (message) => {
  const event = JSON.parse(message.data);
  console.log(event.eventId, event.event, event.data);
};

For browser clients, prefer a short-lived OAuth token over exposing a long-lived partner key. For server clients, send the normal Authorization: Bearer header.

Each frame carries an opaque timestamp:documentId stream cursor so events sharing a timestamp remain replayable. Legacy millisecond cursors are accepted. Persist the last id: value and reconnect with Last-Event-ID or ?since= after a network interruption. The connection may close after approximately 110 seconds; reconnect is expected. Heartbeat comments are sent periodically and should reset your idle timer.

id: 1842
data: {"eventId":"evt_...","event":"order.filled","data":{...}}

Delivery semantics

Events are at-least-once and can be duplicated.
Events can arrive out of order; derive state from the event payload and current REST state.
Deduplicate by eventId, not by cursor alone.
SSE is not a tick-by-tick market-price stream.
A stream reconnect does not replace daily reconciliation.

The same business events can be delivered through signed webhooks. See Trading lifecycles for order transitions and Daily Reconciliation for the durable operating record.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

Webhooks

Reports

SSE Events

Explore endpoints

/account

Parameters

Headers

Response fields

Response codes

Connect

Resume and reconnect

Delivery semantics

On this page