Trading API

Trading Account and Buying Power

MyStocks Partner API

Understand master and sub-account wallets, buying power, portfolios, settlement-aware balances, and account state before placing orders.

Integration guides Get a sandbox key

Explore endpoints

7 of 7

GET

/buying-power

Master account buying power (settlement-aware)

Full endpoint documentation

Sandbox availablegetBuyingPower

Settlement-aware balance for the partner master account. See /users/{userId}/buying-power for field semantics.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

accountTypeMASTER | SUBACCOUNT

subAccountIdstring | null

currencystring

Example: "USD"

cashBalanceUsdnumber

Current USD wallet balance.

buyingPowerUsdnumber

Cash available to place new orders (already net of open-BUY escrow; includes unsettled SELL proceeds).

unsettledUsdnumber

SELL proceeds credited but not yet settled at the exchange (T+N).

withdrawableUsdnumber

Cash available to withdraw — cashBalanceUsd minus unsettledUsd. The free-riding guard.

pendingBuyEscrowUsdnumber

Funds locked in open (PENDING) BUY orders.

settlementsobject[]

settlements[].amountUsdnumber

settlements[].settlesOnstring

settlements[].symbolstring | null

settlements[].exchangestring | null

settlements[].orderIdstring | null

Response codes

200Settlement-aware balance.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/buying-power

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "description": "Settlement-aware balance for a master or sub-account.",
  "properties": {
    "accountType": {
      "type": "string",
      "enum": [
        "MASTER",
        "SUBACCOUNT"
      ]
    },
    "subAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "cashBalanceUsd": {
      "type": "number",
      "description": "Current USD wallet balance."
    },
    "buyingPowerUsd": {
      "type": "number",
      "description": "Cash available to place new orders (already net of open-BUY escrow; includes unsettled SELL proceeds)."
    },
    "unsettledUsd": {
      "type": "number",
      "description": "SELL proceeds credited but not yet settled at the exchange (T+N)."
    },
    "withdrawableUsd": {
      "type": "number",
      "description": "Cash available to withdraw — cashBalanceUsd minus unsettledUsd. The free-riding guard."
    },
    "pendingBuyEscrowUsd": {
      "type": "number",
      "description": "Funds locked in open (PENDING) BUY orders."
    },
    "settlements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "amountUsd": {
            "type": "number"
          },
          "settlesOn": {
            "type": "string",
            "format": "date-time"
          },
          "symbol": {
            "type": [
              "string",
              "null"
            ]
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "orderId": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

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

The Partner API supports a master trading account and isolated customer sub-accounts. Choose the account context explicitly when requesting a quote, placing an order, or reading portfolio state.

Account surfaces

Need	Endpoint
Master wallet and portfolio	`GET /account`, `GET /portfolio`
Master buying power	`GET /buying-power`
Sub-account wallet	`GET /users/{userId}/wallet`
Sub-account portfolio	`GET /users/{userId}/portfolio`
Sub-account buying power	`GET /users/{userId}/buying-power`
Account status	`GET /users/{userId}`

Buying power is settlement-aware. Unsettled sell proceeds may appear in portfolio or order state but remain unavailable for withdrawal until settlement. Do not use display portfolio value as withdrawable cash.

Before trading, confirm the account is active, not frozen, and KYC-eligible. See Custody and Beneficial Ownership for the distinction between ledger ownership and settled custody.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

Getting Started with Trading API

Portfolio Performance