Positions

GET

/positions

Account positions

Parameters

Header Parameters

X-API-KEY*

Type

string

Required

Query Parameters

account_number*

Type

string

Required

end_customer_id

Optional end-customer identifier for retrieving positions scoped to a single end-customer account under the omnibus account.

Type

string

include_all_custodians

Aggregates positions across all the clearing firms the broker has accounts at.

Type

boolean

Responses

OK

Content-Type

application/json

[

  

{

  

  

"quantity_long": "1.23",

  

  

"quantity_short": "0",

  

  

"quantity_long_pending_sell": "0",

  

  

"quantity_short_pending_buy": "0",

  

  

"quantity_withheld": "0",

  

  

"symbol": "AAPL 230317C00120000"

  

}

]

GET

/positions

Playground

Headers

X-API-KEY*

Variables

Key

Value

account_number*

end_customer_id

include_all_custodians

Samples

Powered by VitePress OpenAPI