API product catalogDeveloper Platform, Sandbox & Key ManagementMyStocks Partner APIRegistration, API credentials, webhooks, SSE, sandbox certification, deterministic test tools, and settings.Integration guides Get a sandbox key Explore endpoints42 of 42GET/accountGet partner accountDELETE/api-keys/data-keyRevoke data API keyGET/api-keys/data-keyGet data API keyPOST/api-keys/data-keyIssue data API keyDELETE/api-keys/revokeSandbox key-revocation alias (unsupported)POST/api-keys/revokeRevoke API keyPOST/api-keys/rotateRotate API keyPOST/applySubmit partner applicationGET/certificationGet certification checklistPATCH/certificationUpdate certification evidencePOST/certificationRequest go-live reviewGET/installationsList this partner's OnPrem installation statusGET/meMy status and workspace accessPOST/meSelect a portal environment or save deployment preferenceGET/notification-rulesGet notification policyPUT/notification-rulesReplace notification policyGET/openapi.jsonDownload partner OpenAPI JSONGET/openapi.yamlDownload partner OpenAPI YAMLGET/pricingGet partner markup pricingPATCH/pricingUpdate partner markup pricingGET/public-brandResolve public partner brandingPOST/registerRegister sandbox accountPOST/resetReset sandbox accountPOST/sandbox/depositCredit virtual funds (deprecated alias)GET/sandbox/ordersList test orders (deprecated alias)POST/sandbox/tradeSubmit test trade (deprecated alias)POST/sessionMint a portal session tokenGET/settingsGet settingsPATCH/settingsUpdate settingsPOST/settingsTest SMTPPOST/test-tools/depositCredit virtual fundsGET/test-tools/ordersList test ordersPATCH/test-tools/orders/{orderId}Advance a sandbox test orderPOST/test-tools/tradeSubmit test tradeGET/upgrade-requestCheck upgrade request statusPOST/upgrade-requestSubmit upgrade requestGET/webhooksList webhooksPOST/webhooksRegister webhookDELETE/webhooks/{id}Delete webhookGET/webhooks/{id}Get sandbox webhookGET/webhooks/{id}/deliveriesWebhook deliveriesPOST/webhooks/{id}/testTest webhookGET/accountGet partner accountFull endpoint documentation Sandbox availablelistAccountReturns your partner profile — tier, wallet balance, API key metadata, and feature flags.ParameterswalletContract1 | 2queryOpt in to actual currency wallets. Legacy indicative views remain unchanged.Example: 1HeadersAuthorizationstringRequiredBearer sk_sandbox_<your_key> for sandbox requests.Response fieldsaccountIdstringbusinessNamestringemailstringwalletobjectwallet.currencystringExample: "USD"wallet.balancenumberwallet.reservednumberwallet.availablenumberwalletContractVersion1 | 2walletModelUSD_LEDGER_WITH_INDICATIVE_EQUIVALENTS | NATIVE_CURRENCY_WALLETSsupportedConversionCurrenciesstring[]currencyWalletsobject[]currencyWallets[].currencystringcurrencyWallets[].balanceKindstringcurrencyWallets[].cashBalancenumbercurrencyWallets[].reservednumbercurrencyWallets[].externallyReservednumbercurrencyWallets[].totalCashnumbercurrencyWallets[].availablenumbercurrencyWallets[].withdrawablenumbercurrencyWallets[].availableForConversionnumbercurrencyWallets[].policyEligiblebooleancurrencyWallets[].internalTransferAvailablenumberTraceable available funds for internal transferscurrencyWallets[].nativeFundingEnabledbooleancurrencyWallets[].nativePayoutEnabledbooleancurrencyWallets[].conversionEnabledbooleanwalletsobject[]wallets[].balanceKindstringwallets[].indicativebooleanwallets[].spendablebooleanwallets[].currencystringExample: "KES"wallets[].balancenumberExample: 65000wallets[].availablenumberExample: 65000wallets[].ledgerCurrencystringExample: "USD"wallets[].ledgerBalancenumberExample: 500wallets[].fxRatenumberExample: 130wallets[].fxSourcestringExample: "MYSTOCKS_MANAGED_FX"wallets[].fxRateAsOfstring | nullmanagedFxobjectmanagedFx.ledgerCurrencystringExample: "USD"managedFx.sourcestringExample: "MYSTOCKS_MANAGED_FX"managedFx.rateConventionstringExample: "local currency units per USD"managedFx.supportedCurrenciesstring[]managedFx.asOfstring | nullportfolioValuenumberinvestedCapitalnumberrealizedGainUsdnumberenvironmentproduction | sandboxpilotobjectControlled-production policy. When enabled, production mutations fail closed unless admission, ownership, feature, limit, and reconciliation controls pass.pilot.enabledbooleanRequiredpilot.statusNOT_APPROVED | APPROVED | PAUSED | COMPLETEDRequiredpilot.operationalOwnerunionpilot.incidentContactunionpilot.manualTreasuryReviewbooleanRequiredAlways true for a controlled pilot; master-wallet top-ups and payouts remain pending until MyStocks treasury review.pilot.featuresobjectRequiredpilot.limitsobjectRequiredpilot.reconciliationobjectRequiredpilot.readinessobjectRequiredEvidence and approvals required before mutations may resume and before the controlled pilot may complete.Response codes200Partner account details.401Invalid API key.Was this page useful?Your signal helps us tighten partner onboarding docs.YesNoSend noteCopy linkCopy MarkdownLast updated on PATCH /team/roles/{roleId}Previous PageGET /accountNext Page