> For the complete documentation index, see [llms.txt](https://docs.clickoptions.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clickoptions.ai/api/positions-controller.md).

# Positions Controller

## Get opened positions

> Return list of opened positions.

```json
{"openapi":"3.1.0","info":{"title":"fintp-public-api","version":"0.0.1"},"tags":[],"servers":[{"url":"https://api.clickoptions.ai/api","description":"Generated server url"}],"paths":{"/v1/options/positions":{"get":{"tags":["positions-controller"],"summary":"Get opened positions","description":"Return list of opened positions.","operationId":"getPositions_1","responses":{"200":{"description":"successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OptionPositionDto"}}}}},"400":{"description":"Invalid input data","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OptionPositionDto"}}}}},"500":{"description":"Internal server error"}},"deprecated":true}}},"components":{"schemas":{"OptionPositionDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"},"accountId":{"type":"integer","format":"int64"},"sellerAccountId":{"type":"integer","format":"int64"},"parentPositionId":{"type":"integer","format":"int64"},"symbol":{"type":"string"},"optionSide":{"type":"string"},"tradeSide":{"type":"string"},"strikePrice":{"type":"number"},"expiration":{"type":"integer","format":"int64"},"openQty":{"type":"number"},"closeQty":{"type":"number"},"openQtyNotional":{"type":"number"},"closeQtyNotional":{"type":"number"},"openPrice":{"type":"number"},"closePrice":{"type":"number"},"openTime":{"type":"integer","format":"int64"},"closeTime":{"type":"integer","format":"int64"},"fee":{"type":"number"},"feeAsset":{"type":"string"},"positionType":{"type":"string"},"positionState":{"type":"string"},"pl":{"type":"number"},"indexPrice":{"type":"number"},"excercisePl":{"type":"number"},"quoteAsset":{"type":"string"},"bookedMargin":{"type":"number"},"bookedMarginCcy":{"type":"string"},"underlying":{"type":"string"},"premiumTotal":{"type":"number"},"easyOptionId":{"type":"integer","format":"int64"}}}}}}
```

## get position

> Get position by id

```json
{"openapi":"3.1.0","info":{"title":"fintp-public-api","version":"0.0.1"},"tags":[],"servers":[{"url":"https://api.clickoptions.ai/api","description":"Generated server url"}],"paths":{"/v1/options/positions/{id}":{"get":{"tags":["positions-controller"],"summary":"get position","description":"Get position by id","operationId":"getPosition_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OptionPositionDto"}}}},"400":{"description":"Invalid input data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OptionPositionDto"}}}},"500":{"description":"Internal server error"}},"deprecated":true}}},"components":{"schemas":{"OptionPositionDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"},"accountId":{"type":"integer","format":"int64"},"sellerAccountId":{"type":"integer","format":"int64"},"parentPositionId":{"type":"integer","format":"int64"},"symbol":{"type":"string"},"optionSide":{"type":"string"},"tradeSide":{"type":"string"},"strikePrice":{"type":"number"},"expiration":{"type":"integer","format":"int64"},"openQty":{"type":"number"},"closeQty":{"type":"number"},"openQtyNotional":{"type":"number"},"closeQtyNotional":{"type":"number"},"openPrice":{"type":"number"},"closePrice":{"type":"number"},"openTime":{"type":"integer","format":"int64"},"closeTime":{"type":"integer","format":"int64"},"fee":{"type":"number"},"feeAsset":{"type":"string"},"positionType":{"type":"string"},"positionState":{"type":"string"},"pl":{"type":"number"},"indexPrice":{"type":"number"},"excercisePl":{"type":"number"},"quoteAsset":{"type":"string"},"bookedMargin":{"type":"number"},"bookedMarginCcy":{"type":"string"},"underlying":{"type":"string"},"premiumTotal":{"type":"number"},"easyOptionId":{"type":"integer","format":"int64"}}}}}}
```

## Get closed positions history

> Return list of closed positions, using provided filter

```json
{"openapi":"3.1.0","info":{"title":"fintp-public-api","version":"0.0.1"},"tags":[],"servers":[{"url":"https://api.clickoptions.ai/api","description":"Generated server url"}],"paths":{"/v1/options/positions/history":{"get":{"tags":["positions-controller"],"summary":"Get closed positions history","description":"Return list of closed positions, using provided filter","operationId":"getPositionHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionPositionSearchDto"}}}},"responses":{"200":{"description":"successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OptionPositionDto"}}}}},"400":{"description":"Invalid input data","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OptionPositionDto"}}}}},"500":{"description":"Internal server error"}},"deprecated":true}}},"components":{"schemas":{"OptionPositionSearchDto":{"type":"object","description":"DTO for OptionPosition search form parameters.","properties":{"search":{"type":"string","description":"Search query string"},"pageNumber":{"type":"integer","format":"int32","default":0,"description":"Page number (zero-based)"},"pageSize":{"type":"integer","format":"int32","default":40,"description":"Page size (number of items per page)"},"wl":{"type":"integer","format":"int32","description":"Whitelist filter value"},"sortByField":{"type":"string","description":"Field to sort by"},"sortByDirection":{"type":"string","description":"Sort direction (ASC or DESC)","enum":["ASC","DESC"]},"id":{"type":"integer","format":"int64","description":"Unique identifier of the option position"},"accountId":{"type":"integer","format":"int64","description":"Account ID"},"parentPositionId":{"type":"integer","format":"int64","description":"Parent position ID"},"easyOptionId":{"type":"integer","format":"int64","description":"Easy Option ID"},"symbol":{"type":"string","description":"Symbol of the option"},"optionSide":{"type":"string","description":"Option side (CALL/PUT)"},"tradeSide":{"type":"string","description":"Trade side (BUY/SELL)"},"positionType":{"type":"string","description":"Type of the position"},"positionState":{"type":"string","description":"State of the position"},"feeAsset":{"type":"string","description":"Fee asset"},"quoteAsset":{"type":"string","description":"Quote asset"},"symbolContains":{"type":"string","description":"Symbol pattern for search"},"strikePriceMin":{"type":"number","description":"Minimum strike price"},"strikePriceMax":{"type":"number","description":"Maximum strike price"},"openQtyMin":{"type":"number","description":"Minimum open quantity"},"openQtyMax":{"type":"number","description":"Maximum open quantity"},"closeQtyMin":{"type":"number","description":"Minimum close quantity"},"closeQtyMax":{"type":"number","description":"Maximum close quantity"},"openPriceMin":{"type":"number","description":"Minimum open price"},"openPriceMax":{"type":"number","description":"Maximum open price"},"closePriceMin":{"type":"number","description":"Minimum close price"},"closePriceMax":{"type":"number","description":"Maximum close price"},"feeMin":{"type":"number","description":"Minimum fee"},"feeMax":{"type":"number","description":"Maximum fee"},"plMin":{"type":"number","description":"Minimum profit/loss"},"plMax":{"type":"number","description":"Maximum profit/loss"},"openTimeFrom":{"type":"string","format":"date-time","description":"Open time from (ISO 8601)"},"openTimeTo":{"type":"string","format":"date-time","description":"Open time to (ISO 8601)"},"closeTimeFrom":{"type":"string","format":"date-time","description":"Close time from (ISO 8601)"},"closeTimeTo":{"type":"string","format":"date-time","description":"Close time to (ISO 8601)"},"expirationFrom":{"type":"string","format":"date-time","description":"Expiration from (ISO 8601)"},"expirationTo":{"type":"string","format":"date-time","description":"Expiration to (ISO 8601)"}}},"OptionPositionDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"},"accountId":{"type":"integer","format":"int64"},"sellerAccountId":{"type":"integer","format":"int64"},"parentPositionId":{"type":"integer","format":"int64"},"symbol":{"type":"string"},"optionSide":{"type":"string"},"tradeSide":{"type":"string"},"strikePrice":{"type":"number"},"expiration":{"type":"integer","format":"int64"},"openQty":{"type":"number"},"closeQty":{"type":"number"},"openQtyNotional":{"type":"number"},"closeQtyNotional":{"type":"number"},"openPrice":{"type":"number"},"closePrice":{"type":"number"},"openTime":{"type":"integer","format":"int64"},"closeTime":{"type":"integer","format":"int64"},"fee":{"type":"number"},"feeAsset":{"type":"string"},"positionType":{"type":"string"},"positionState":{"type":"string"},"pl":{"type":"number"},"indexPrice":{"type":"number"},"excercisePl":{"type":"number"},"quoteAsset":{"type":"string"},"bookedMargin":{"type":"number"},"bookedMarginCcy":{"type":"string"},"underlying":{"type":"string"},"premiumTotal":{"type":"number"},"easyOptionId":{"type":"integer","format":"int64"}}}}}}
```
