PositionRecord
forge.typesclassSince Forge API 1
Signaturepython
forge.types.PositionRecord(id: int,symbol: str,side: PositionSide,size: float,avg_price: float,open_time: int,stop: float | None,target: float | None,unrealized: float,swap: float,commission: float,r_multiple: float | None,risk_cash: float | None,mae: float,mfe: float,bars_held: int,tag: str | None,entry_reason: str,add_count: int = 0,reduce_count: int = 0,peak_size: float = 0.0) -> NoneThe mutable state behind a Position. The run writes it; a strategy never sees it.
Parameters
| Name | Type | Default |
|---|---|---|
| id | int | |
| symbol | str | |
| side | PositionSide | |
| size | float | |
| avg_price | float | |
| open_time | int | |
| stop | float | None | |
| target | float | None | |
| unrealized | float | |
| swap | float | |
| commission | float | |
| r_multiple | float | None | |
| risk_cash | float | None | |
| mae | float | |
| mfe | float | |
| bars_held | int | |
| tag | str | None | |
| entry_reason | str | |
| add_count | int | 0 |
| reduce_count | int | 0 |
| peak_size | float | 0.0 |