Local-Currency Trading
Understand how MyStocks-managed funding, withdrawal, and execution FX work with local-market prices and USD wallets.
Explore endpoints
7 of 7/float
Master-account float / funding headroom
Full endpoint documentationgetFloatThe partner aggregates their end-users' deposits and remits to the master account (POST /topup); the master wallet funds sub-account deposits. This returns the funding headroom so the partner knows when to remit: masterBalanceUsd, pending top-ups, any credit line, availableToFundUsd, and a floatStatus of HEALTHY / LOW / DEPLETED / ON_CREDIT. Pair with the float.low and topup.confirmed webhooks.
Parameters
This endpoint has no path or query parameters.
Headers
AuthorizationstringRequiredBearer sk_sandbox_<your_key> for sandbox requests.
Response fields
currencystringExample: "USD"
masterBalanceUsdnumberCurrent master wallet balance (negative when drawn on the credit line).
reservedCashUsdnumberCash unavailable for spending
completenessobjectcompleteness.completebooleancompleteness.warningsstring[]pendingTopupsUsdnumberSum of PENDING top-up requests awaiting MyStocks confirmation.
pendingPayoutsUsdnumberSum of PENDING payout requests awaiting MyStocks processing.
creditLimitUsdnumberCredit line — how far the master balance may go negative while a remittance is in flight (MyStocks-set; 0 = pre-funded only).
outstandingCreditUsdnumberCredit currently drawn (present when masterBalanceUsd is negative).
availableToFundUsdnumberCash balance less reservations, plus approved credit only when there are no cash reservations.
lowBalanceThresholdUsdnumberMaster balance below which a float.low webhook fires (partner-set via PATCH /float).
minimumFloatUsdnumberPartner treasury policy floor for the master account.
floatStatusHEALTHY | LOW | DEPLETED | ON_CREDIT | UNKNOWNtreasuryStatusHEALTHY | LOW | DEPLETED | ON_CREDIT | BELOW_MINIMUM | UNKNOWNreminderSettingsobjectreminderSettings.autoTopupReminderEnabledbooleanreminderSettings.recipientsstring[]reminderSettings.frequencyHoursintegerreminderSettings.shouldRemindNowbooleanexposureobjectPartner treasury exposure dashboard.
exposure.subAccountCountintegerexposure.pendingTopupsUsdnumberexposure.pendingPayoutsUsdnumberexposure.pendingOrderExposureUsdnumberexposure.outstandingCreditUsdnumberexposure.availableToFundUsdnumberexposure.netLiquidityUsdnumberexposure.pendingCreditLimitRequestsobject[]Response codes
200Float status.MyStocks presents a USD-denominated wallet while instruments trade in their exchange currency. The FX responsibility depends on the flow.
| Flow | FX responsibility | API behavior |
|---|---|---|
| Deposit | MyStocks | Send local amount and currency; MyStocks converts and credits the USD wallet. |
| Quote and trade | MyStocks | Quote and execution use the live market conversion at the relevant point in the order flow. |
| Dividend | MyStocks | Declared local-currency dividends are converted and credited to the USD wallet. |
| Withdrawal | MyStocks | Send local amount and currency; MyStocks converts the ledger debit while your payout rail delivers local currency. |
Implementation rules
- Use
amountpluscurrencyfor supported non-USD funding and withdrawals. - Record the returned
fxRate,fxSource, andfxConversion.asOfconversion metadata. - Treat request
fxRateas deprecated legacy compatibility; omit it in new integrations. - Show the quote currency and wallet currency separately in your UI.
- Never calculate a trade’s final USD debit from a stale display price.
- Treat FX rate, timestamp, spread, and rounding as customer-disclosure data.
- Reconcile local-market fills and USD ledger movements together.
See the detailed FX & Currency model, Trading API, and Statements and Confirms.
Wallet balances are USD ledger balances. MyStocks does not provide an end-user FX hedge. Your product must disclose exchange-rate movement between funding, execution, dividend conversion, and withdrawal.
Was this page useful?
Your signal helps us tighten partner onboarding docs.
Last updated on
Fund Flow
Fund your master wallet via top-up requests to MyStocks operations and repatriate surplus via payout requests. Includes the aggregate partner account summary. Both money-movement endpoints are idempotent.
FX & Currency
MyStocks-managed conversion for supported non-USD funding and withdrawals, plus execution and dividend FX. All wallets remain denominated in USD.