Skip to main content

Get account positions

    -X GET
--header 'Authorization: Bearer {token here}'
'https://api.lime.co/accounts/{account_number}/positions?date={date}&strategy={strategy}'

Response example

[
{
"symbol": "F",
"average_open_price": 12.135,
"current_price": 9.82,
"quantity": -4,
"security_type": "common_stock"
},
{
"symbol": "NLY Credit Put Spread 1",
"average_open_price": 0,
"current_price": -0.1136,
"quantity": -2,
"security_type": "strategy",
"legs": [
{
"symbol": "NLY 231215P00016000",
"average_open_price": 0.2450,
"current_price": 0.1856,
"quantity": -2,
"security_type": "option"
},
{
"symbol": "NLY 231215P00015000",
"average_open_price": 0.1050,
"current_price": 0.072,
"quantity": 2,
"security_type": "option"
}
]
}
]

Request

parameterdescription
account_numberRequired. The account number
dateOptional. Date in the format of yyyy-MM-dd. If set, returns incoming positions for specified date. If not specified, the method returns current intraday positions
strategyOptional. If true, returns current intraday positions grouped by multi-leg strategies. Doesn't work together with date parameter

Response

nametypedescription
symbolstringThe security symbol
quantitynumberSigned number of shares or option contracts. Negative for short positions
average_open_pricenumberAverage historical cost basis
current_pricenumberCurrent price
security_typestringAsset type. Possible values are common_stock, preferred_stock, option, strategy
legsarrayLegs of the multi-leg strategy

Legs array element:

nametypedescription
symbolstringThe leg security symbol
quantitynumberSigned number of shares or option contracts for the leg
average_open_pricenumberThe leg cost basis
current_pricenumberThe leg current price
security_typenumberThe leg asset type. Possible values are common_stock, preferred_stock, option