Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get Account Positions
This request returns the position information for a single account.
Request URL
| Syntax | GET /restapi/accounts/{accountnumber}/positions |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/positions |
Response Data Fields
This request returns the list of positions held in an account. The following table describes the fields for each position.
| Field | Description |
|---|---|
| accountNumber | The account number you are requesting positions for. |
| security.ticker | The ticker of the security. |
| security.companyName | The name of the company that issued the security. |
| security.instrumentType | The instrument type of the security. See Instrument Types for more information. |
| security.windowBuyable | An indicator of whether the security is window-tradable. See Order Types for more information. |
| security.directBuyable | An indicator of whether the security is direct-tradable. See Order Types for more information. |
| security.settlementPeriod | The number of days after trade date a purchase or sale of this security takes to settle. |
| security.id | The Folio brokerage platform’s unique identifier for the security. |
| shareQuantity | The total quantity of shares in the account for the security. This includes restricted and unrestricted shares. |
| restrictedShareQuantity | The quantity of restricted shares, disallowing the shares from being moved or sold. |
| targetWeight | The target weight of the security. See Folio Weights to learn more about target weight. |
| currentWeight | The current weight of the security, as determined calculating (market value of the position) ÷ (market value of all invested assets in the account). See Folio Weights to learn more about current weight. |
| longTermCostBasis | The net long-term cost basis of the individual position. |
| shortTermCostBasis | The net short-term cost basis of the individual position. |
| unknownTermCostBasis | The net unknown term cost basis of the individual position. |
Response Example
Status Code: 200 OK
Content-Type: application/json
Date: Thu, 19 Dec 2013 13:02:27 GMT
Location: http://localhost:6880/restapi/accounts/RA1234ABCD/positions
Server: Sun GlassFish Enterprise Server v2.1.1
Transfer-Encoding: chunked
X-Powered-By: Servlet/2.5
[
{
"accountNumber": "RA1234ABCD",
"security": {
"ticker": "ADX",
"companyName": "ADAMS EXPRESS CO",
"instrumentType": "MUTFUND",
"windowBuyable": true,
"directBuyable": true,
"settlementPeriod": "2",
},
"shareQuantity": "600.00000",
"restrictedShareQuantity": "0.00000",
"targetWeight": "7.77",
"currentWeight": "1.39",
"longTermCostBasis": "159736.21",
"shortTermCostBasis": "319247.96",
"unknownTermCostBasis": "0.00"
},
{
"accountNumber": "RA5471700Y",
"security": {
"ticker": "AAPL",
"companyName": "APPLE INC COM",
"instrumentType": "COMSTOCK",
"windowBuyable": true,
"directBuyable": true,
"settlementPeriod": "2",
},
"shareQuantity": "16.03243",
"restrictedShareQuantity": "0.00000",
"targetWeight": "8.23",
"currentWeight": "1.63",
"longTermCostBasis": "159736.21",
"shortTermCostBasis": "319247.96",
"unknownTermCostBasis": "0.00"
}
]