Position Detail

Retrieve detail for a position

POST

/account-api/v1/position-detail

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": {
    "portfolios": [
      {
        "date": "2024-10-07T14:17:51.857Z",
        "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-07T14:17:51.857Z",
        "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",
        "transactionQuantity": 0,
        "safekeepFirmQuantity": 0,
        "unrealizedGainLoss": {
          "symbolId": "string",
          "description": "string",
          "acctType": 0,
          "openDate": "2024-10-07T14:17:51.858Z",
          "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"
        }
      }
    ]
  },
  "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
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
quantity	Number		Number of shares, option contracts, or face value of bonds
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		Trade execution price per share, option contract or face value of bonds
priceType	String		CurrentSnap, DelayedSnap, LastClosed
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 code
secTypeName	String		Name of security type
industryGroupName	String		Name of industry group
industryGroupCode	Integer	3	Industry group indicator used to group securities
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
transactionQuantity	Number		Amount of a position associated with a transaction
safekeepFirmQuantity	Number		Number of shares or face value of bonds in safekeeping firm name
unrealizedGainLoss	String		Change in value of a stock, bond or other asset you have purchased but not yet sold
symbolId	String		Logic based on different security identifiers
description	String		Description
acctType	Integer	1	Account Type indicator
openDate	String		Date that the position was purchased or added to the account
term	String
longShortInd	String
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	Number		Cost of one unit of a postion 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
gainLosspercentage	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
washDisallowedAmt	Number
wash	String
totalCost	Number
totalValue	Number		Total market value of the position
totalUnrealizedAmount	Number
totalUnrealizedPercent	Number
glNoWash	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, FullTransfer

Example

{
 "statusCode": 0,
  "message": "string",
  "data": {
    "portfolios": [
      {
        "date": "2024-10-07T14:17:51.857Z",
        "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-07T14:17:51.857Z",
        "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",
        "transactionQuantity": 0,
        "safekeepFirmQuantity": 0,
        "unrealizedGainLoss": {
          "symbolId": "string",
          "description": "string",
          "acctType": 0,
          "openDate": "2024-10-07T14:17:51.858Z",
          "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"
        }
      }
    ]
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}