Balance Summary

Retrieve detail for a position

POST

/account-api/v1/balance-summary

Request Body

Schema

When using the position-detail endpoint you are always required to send the below attributes. The remainder of the payload should only include data blocks which are being updated.

Attributes	Data Type	Length	Description
accountNumber	String	8	StoneX Account Number

Example

{
  "accountNumber": "string"
}

Response

Schema

Successful Response

The response for a Successful request will look like:

Attributes	Data Type	Length	Description
statusCode	Integer	3	Code identifies success of request
message	String		Outcome of request
data	Data Block		Main field containing information of request
errors	Errors		API errors
traceId	String		Unique identifier
hasErrors	Boolean		True or False

Example

{
  "statusCode": 0,
  "message": "string",
  "data": {
    "marginBalance": {
      "marginBuyingPower": 0,
      "nyseExcess": 0,
      "dtbp": 0,
      "marginDebitBalance": 0,
      "dailyMarginInterest": 0,
      "accruedMarginInterest": 0,
      "currentMarginRate": 0,
      "dayTradeBuyingPower": 0,
      "equity": 0,
      "equityPercentage": 0,
      "houseExcess": 0
    },
    "availableWithdrawal": {
      "freeCash": 0,
      "moneyMarket": 0,
      "marginCashAvailability": 0,
      "pendingMoneyMarketInterest": 0
    },
    "marginRequirements": [
      {
        "symbol": "string",
        "quantity": 0,
        "description": "string",
        "price": 0,
        "marketValue": 0,
        "housePercent": 0,
        "houseRequirement": 0,
        "regTPercent": 0,
        "regTRequirement": 0
      }
    ],
    "openCall": {
      "federalCall": 0,
      "maintenanceCall": 0,
      "dayTradeCall": 0,
      "accumFedAmount": 0
    }
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}

Schema

A successful request will respond with a result containing the account number, account status & all the current account data.

Attributes	Data Type	Length	Description
marginBalance	Number
marginBuyingPower	Number		Maximum amount of money an investor can use to purchase securities in a margin account
nyseExcess	Number		Funds remaining in a margin trading account that are available to trade with
dtbp	Number		Day Trade Buying Power refers to the funds a user has available in the account to place trades on a given trading day
marginDebitBalance	Number		Amount of money an investor owes to their broker for funds borrowed to buy securities on margin
dailyMarginInterest	Number		The interest that accrues each day on a margin account and is charged to the account monthly
accruedMarginInterest	Number		Margin interest that has been earned but not paid out
currentMarginRate	Number		Interest rate that a broker charges an investor to borrow money to buy investements
dayTradeBuyingPower	Number		The amount of money an account can use to day trade without incurring a day trade margin call
equity	Number		Amount of money an owner would receive if they sold the asset
equityPercentage	Number		Percentage of ownership or interest in an asset
houseExcess	Number
freeCash	Number		The amount of available, settled funds in the account today
moneyMarket	Number		Trading in very short-term debt investments
marginCashAvailability	Number
pendingMoneyMarketInterest	Number
margin requirements
symbol	String	10	Security symbol
quantity	Number		Number of shares, option contracts, or face value of bonds
description	String		description
price	Number		Trade execution price per share, option contract or face value of bonds
marketValue	Number		Price an asset gets in a marketplace
housePercent	Number
houseRequirement	Number
regTPercent	Number
regTRequirement	Number
OpenCall
federalCall	Number		A legal requirement to fund a purchase of securities in a margin account with at least 50% cash
maintenanceCall	Number		A demand made by securities broker to a customer to put up money or stock as collateral when the broker finances a purchase of securites.
dayTradeCall	Number		A margin call issued when a day trader exceeds their day trading buying power
accumFedAmount	Number

Example

{
  "statusCode": 0,
  "message": "string",
  "data": {
    "marginBalance": {
      "marginBuyingPower": 0,
      "nyseExcess": 0,
      "dtbp": 0,
      "marginDebitBalance": 0,
      "dailyMarginInterest": 0,
      "accruedMarginInterest": 0,
      "currentMarginRate": 0,
      "dayTradeBuyingPower": 0,
      "equity": 0,
      "equityPercentage": 0,0
      "houseExcess": 0
    },
    "availableWithdrawal": {
      "freeCash": 0,
      "moneyMarket": 0,
      "marginCashAvailability": 0,
      "pendingMoneyMarketInterest": 0
    },
    "marginRequirements": [
      {
        "symbol": "string",
        "quantity": 0,
        "description": "string",
        "price": 0,
        "marketValue": 0,
        "housePercent": 0,
        "houseRequirement": 0,
        "regTPercent": 0,
        "regTRequirement": 0
      }
    ],
    "openCall": {
      "federalCall": 0,
      "maintenanceCall": 0,
      "dayTradeCall": 0,
      "accumFedAmount": 0
    }
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}