Position Summary

Retrieve detail for a position

POST

/account-api/v1/position-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": {
    "acctNo": "string",
    "date": "2024-10-08T14:55:27.996Z",
    "totalShortMarket": 0,
    "totalLongMarket": 0,
    "totalCash": 0,
    "totalMoneyMarket": 0,
    "netMarket": 0,
    "netCustodied": 0,
    "assetsHeldAway": 0,
    "totalAccountValue": 0,
    "freeCash": 0,
    "industrySummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "assetSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "accountTypeSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "currencyTypeSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "portfolios": [
      {
        "date": "2024-10-08T14:55:27.996Z",
        "acctTypeCode": 0,
        "acctType": "string",
        "acctNo": "string",
        "accountName": "string",
        "currencyCode": 0,
        "currency": "string",
        "marketValue": 0,
        "marketUsdeValue": 0,
        "quantity": 0,
        "gainLoss": 0,
        "fxRate": 0,
        "price": 0,
        "priceType": "CurrentSnap",
        "marketValueFactor": 0,
        "marketUsdeValueFactor": 0,
        "priceDate": "2024-10-08T14:55:27.996Z",
        "symbolId": "string",
        "secNo": "string",
        "isin": "string",
        "sedol": "string",
        "cusip": "string",
        "symbol": "string",
        "description": "string",
        "secTypeCode": "string",
        "secTypeName": "string",
        "industryGroupName": "string",
        "industryGroupCode": 0,
        "isOffShore": true,
        "offshoreShareClass": "string",
        "currentFactor": 0,
        "unitQuantity": 0,
        "newSecCode": "string",
        "typeClassCode": "string",
        "unrealizedGainLoss": {
          "symbolId": "string",
          "description": "string",
          "acctType": 0,
          "openDate": "2024-10-08T14:55:27.996Z",
          "term": "string",
          "longShortInd": "SHORT",
          "secNo": "string",
          "recon": "string",
          "quantity": 0,
          "unitQuantity": 0,
          "displayQuantity": 0,
          "cost": 0,
          "unitCost": 0,
          "summaryLevelUnitCost": 0,
          "value": 0,
          "noCost": "string",
          "noCostLot": "string",
          "trueZero": "string",
          "portfolioPercent": 0,
          "gainLoss": 0,
          "gainLossPercent": 0,
          "closePrice": 0,
          "currentPrice": 0,
          "yield": 0,
          "washDisallowedAmt": 0,
          "wash": "string",
          "totalCost": 0,
          "totalValue": 0,
          "totalUnrealizedAmount": 0,
          "totalUnrealizedPercent": 0,
          "glNoWash": 0,
          "unrealizedGainPercentage": 0,
          "totalGlNoWash": 0,
          "totalGlNoWashPercentage": 0,
          "transactionQuantity": 0,
          "safekeepFirmQuantity": 0,
          "transferType": "PartialTransfer"
        }
      }
    ],
    "gainLoss": 0,
    "gainLossPercentage": 0,
    "fundsAvailable": 0,
    "fedCallAmount": 0,
    "maintCallAmount": 0,
    "marginCashAvailable": 0,
    "buyingPower": 0,
    "accumFedAmount": 0,
    "accruedInterest": 0,
    "totalCashUsdOnly": 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
acctNo	String	8	StoneX Account Number
date	String		Date
totalShortMarket	Number		Total short value for the account including non-marginable positions, options, and below-firm-minimum positions
totalLongMarket	Number		Total long value for the account including non-marginable positions, options, and below-firm-minimum positions
totalCash	Number		Amount of cash in account
totalMoneyMarket	Number		Customer's combined money market fund balance
netMarket	Number		Value of the assets a person or corporation owns minus the liabilities they owe
netCustodied	Number		Value of the assets held by a financial institution that holds customers' securities for sakekeeping
assetsHeldAway	Number		Assets outside the range of your management as an advsior
totalAccountValue	Number		Value of the account
freeCash	Number		Today's free cash for margin purposes
industrySummary
name	String		Name of position
longMarketValue	Number		Value calculated using the prior trading day's closing prices
shortMarketValue	Number		Current market value of securities that have been sold short in a margin account
totalMarketValue	Number		Total price assets would fetch in the market
quantity	Number		Quantity
assetsummary
name	String		Name of position
longMarketValue	Number		Value calculated using the prior trading day's closing prices
shortMarketValue	Number		Current market value of securities that have been sold short in a margin account
totalMarketValue	Number		Total price assets would fetch in the market
quantity	Number		Quantity
accountTypeSummary
name	String		Name of position
longMarketValue	Number		Value calculated using the prior trading day's closing prices
shortMarketValue	Number		Current market value of securities that have been sold short in a margin account
totalMarketValue	Number		Total price assets would fetch in the market
quantity	Number		Quantity
currencyTypeSummary
name	String		Name of position
longMarketValue	Number		Value calculated using the prior trading day's closing prices
shortMarketValue	Number		Current market value of securities that have been sold short in a margin account
totalMarketValue	Number		Total price assets would fetch in the market
quantity	Number		Quantity
portfolios
date	String		Date
acctTypeCode	Integer	1	Account Type indicator
acctType	String		Cash, Margin, Short
acctNo	String	8	StoneX Account Number
accountName	String		Account Name
currencyCode	Integer	3	Code assigned to a currency
currency	String	5	Currency
marketValue	Number		Price an asset gets in a marketplace
marketUsdeValue	Number		Price an asset gets in a marketplace with the exchange rate for another currency
quantity	Number		Quantity
gainLoss	Number		An increase or loss in the value of an asset
fxRate	Number		Rate at which one currency will be exchanged for another currency
price	Number		Price
priceType	String		CurrentSnap, DelayedSnap, LastClose
marketValueFactor	Number
marketUsdeValueFactor	Number
priceDate	String		Date on which the position was last priced
symbolId	String		Logic based on different security identifiers
secNo	String		BETA internal security number
isin	String	12	Identifies a specific security
sedol	String	7	Code assigned to securities that trade on the London Stock Exchange and various smaller exchanges in the United Kingdom
cusip	String	9	ID for a security
symbol	String	10	Security symbol
description	String		Description
secTypeCode	String	1	The Original security type code
secTypeName	String		Name of security type
industryGroupName	String		Name of industry group
industryGroupCode	Integer	3	Industry group indicator used to group securities together
isOffShore	Boolean	1	Indicating if the position is offshore
offshoreShareClass	String		Different pricing arrangements
currentFactor	Number		The amount calculated by dividing the current face value by original value
unitQuantity	Number		Number of shares to be used as a unit of trade
newSecCode	String	2	New security type code
typeClassCode	String	3	Security class code used to further specify security type, bond type, or security number range
unrealizedGainLoss
symbolID	String		Logic based on different security identifiersLogic based on different security identifiers
description	String		Description
acctType	Integer	1	Account Type indicator
openType	String
term	String
longShortInd	String		Long or short indicator
secNo	String		BETA internal security number
recon	String
quantity	Number		Number of shares, option contracts, or face value of bonds
unitQuantity	Number		Number of shares to be used as a unit of trade
displayQuantity	Number
cost	Number		The amount of money for the position
unitCost	String		Cost of one unit of a position bought or sold
summaryLevelUnitCost	Number
value	Number		Total market value of the position
noCost	String
noCostLot	String
trueZero	String
portfolioPercent	Number		The weight of a specific asset or type of asset
gainLoss	Number		An increase or loss in the value of an asset
gainLossPercent	Number
closePrice	Number		Price per share for the sale of a closed tax lot
currentPrice	Number		Most recent price at which a unit was sold on an exchange
yield	Number		Income returned on an investment
washDisallowedAmt	Number
wash	String
totalCost	Number
totalValue	Number		Total market value of the position
totalUnrealizedAmount	Number
totalUnrealizedPercent	Number
glNoWash	Number
unrealizedGainPercentage	Number
totalGlNoWash	Number
totalGlNoWashPercentage	Number
transactionQuantity	Number		Amount of a position associated with a transaction
safekeepFirmQuantity	Number		Number of shares or face value of bonds in safekeeping firm name
transferType	String		PartialTransfer or FullTransfer
gainLoss	Number		An increase or loss in the value of an asset
gainLossPercentage	Number
fundsAvailable	Number
fedCallAmount	Number		If there is an outstanding Federal call for the account or a Federal call was created for the account today, the amount of the call
maintCallAmount	Number		Maximum debit for the account.
marginCashAvailable	Number
buyingPower	Number		Total cash held in the brokerage account plus all available margin
accumFedAmount	Number		Accumulated dollar amount of all Federal calls currently outstanding for the account
accruedInterest	Number
totalCashUsdOnly	Number

Example

{
"statusCode": 0,
  "message": "string",
  "data": {
    "acctNo": "string",
    "date": "2024-10-08T14:55:27.996Z",
    "totalShortMarket": 0,
    "totalLongMarket": 0,
    "totalCash": 0,
    "totalMoneyMarket": 0,
    "netMarket": 0,
    "netCustodied": 0,
    "assetsHeldAway": 0,
    "totalAccountValue": 0,
    "freeCash": 0,
    "industrySummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "assetSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "accountTypeSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "currencyTypeSummary": [
      {
        "name": "string",
        "longMarketValue": 0,
        "shortMarketValue": 0,
        "totalMarketValue": 0,
        "quantity": 0
      }
    ],
    "portfolios": [
      {
        "date": "2024-10-08T14:55:27.996Z",
        "acctTypeCode": 0,
        "acctType": "string",
        "acctNo": "string",
        "accountName": "string",
        "currencyCode": 0,
        "currency": "string",
        "marketValue": 0,
        "marketUsdeValue": 0,
        "quantity": 0,
        "gainLoss": 0,
        "fxRate": 0,
        "price": 0,
        "priceType": "CurrentSnap",
        "marketValueFactor": 0,
        "marketUsdeValueFactor": 0,
        "priceDate": "2024-10-08T14:55:27.996Z",
        "symbolId": "string",
        "secNo": "string",
        "isin": "string",
        "sedol": "string",
        "cusip": "string",
        "symbol": "string",
        "description": "string",
        "secTypeCode": "string",
        "secTypeName": "string",
        "industryGroupName": "string",
        "industryGroupCode": 0,
        "isOffShore": true,
        "offshoreShareClass": "string",
        "currentFactor": 0,
        "unitQuantity": 0,
        "newSecCode": "string",
        "typeClassCode": "string",
        "unrealizedGainLoss": {
          "symbolId": "string",
          "description": "string",
          "acctType": 0,
          "openDate": "2024-10-08T14:55:27.996Z",
          "term": "string",
          "longShortInd": "SHORT",
          "secNo": "string",
          "recon": "string",
          "quantity": 0,
          "unitQuantity": 0,
          "displayQuantity": 0,
          "cost": 0,
          "unitCost": 0,
          "summaryLevelUnitCost": 0,
          "value": 0,
          "noCost": "string",
          "noCostLot": "string",
          "trueZero": "string",
          "portfolioPercent": 0,
          "gainLoss": 0,
          "gainLossPercent": 0,
          "closePrice": 0,
          "currentPrice": 0,
          "yield": 0,
          "washDisallowedAmt": 0,
          "wash": "string",
          "totalCost": 0,
          "totalValue": 0,
          "totalUnrealizedAmount": 0,
          "totalUnrealizedPercent": 0,
          "glNoWash": 0,
          "unrealizedGainPercentage": 0,
          "totalGlNoWash": 0,
          "totalGlNoWashPercentage": 0,
          "transactionQuantity": 0,
          "safekeepFirmQuantity": 0,
          "transferType": "PartialTransfer"
        }
      }
    ],
    "gainLoss": 0,
    "gainLossPercentage": 0,
    "fundsAvailable": 0,
    "fedCallAmount": 0,
    "maintCallAmount": 0,
    "marginCashAvailable": 0,
    "buyingPower": 0,
    "accumFedAmount": 0,
    "accruedInterest": 0,
    "totalCashUsdOnly": 0
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}