github.com/vmpartner/bitmex@v1.1.0/swagger/position.go (about)

     1  /* 
     2   * BitMEX API
     3   *
     4   * ## REST API for the BitMEX Trading Platform  [View Changelog](/app/apiChangelog)    #### Getting Started   ##### Fetching Data  All REST endpoints are documented below. You can try out any query right from this interface.  Most table queries accept `count`, `start`, and `reverse` params. Set `reverse=true` to get rows newest-first.  Additional documentation regarding filters, timestamps, and authentication is available in [the main API documentation](https://www.bitmex.com/app/restAPI).  *All* table data is available via the [Websocket](/app/wsAPI). We highly recommend using the socket if you want to have the quickest possible data without being subject to ratelimits.  ##### Return Types  By default, all data is returned as JSON. Send `?_format=csv` to get CSV data or `?_format=xml` to get XML data.  ##### Trade Data Queries  *This is only a small subset of what is available, to get you started.*  Fill in the parameters and click the `Try it out!` button to try any of these queries.  * [Pricing Data](#!/Quote/Quote_get)  * [Trade Data](#!/Trade/Trade_get)  * [OrderBook Data](#!/OrderBook/OrderBook_getL2)  * [Settlement Data](#!/Settlement/Settlement_get)  * [Exchange Statistics](#!/Stats/Stats_history)  Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available.  ##### Swagger Specification  [⇩ Download Swagger JSON](swagger.json)    ## All API Endpoints  Click to expand a section. 
     5   *
     6   * OpenAPI spec version: 1.2.0
     7   * Contact: support@bitmex.com
     8   * Generated by: https://github.com/swagger-api/swagger-codegen.git
     9   */
    10  
    11  package swagger
    12  
    13  import (
    14  	"time"
    15  )
    16  
    17  // Summary of Open and Closed Positions
    18  type Position struct {
    19  	Account float32 `json:"account"`
    20  
    21  	Symbol string `json:"symbol"`
    22  
    23  	Currency string `json:"currency"`
    24  
    25  	Underlying string `json:"underlying,omitempty"`
    26  
    27  	QuoteCurrency string `json:"quoteCurrency,omitempty"`
    28  
    29  	Commission float64 `json:"commission,omitempty"`
    30  
    31  	InitMarginReq float64 `json:"initMarginReq,omitempty"`
    32  
    33  	MaintMarginReq float64 `json:"maintMarginReq,omitempty"`
    34  
    35  	RiskLimit float32 `json:"riskLimit,omitempty"`
    36  
    37  	Leverage float64 `json:"leverage,omitempty"`
    38  
    39  	CrossMargin bool `json:"crossMargin,omitempty"`
    40  
    41  	DeleveragePercentile float64 `json:"deleveragePercentile,omitempty"`
    42  
    43  	RebalancedPnl float32 `json:"rebalancedPnl,omitempty"`
    44  
    45  	PrevRealisedPnl float32 `json:"prevRealisedPnl,omitempty"`
    46  
    47  	PrevUnrealisedPnl float32 `json:"prevUnrealisedPnl,omitempty"`
    48  
    49  	PrevClosePrice float64 `json:"prevClosePrice,omitempty"`
    50  
    51  	OpeningTimestamp time.Time `json:"openingTimestamp,omitempty"`
    52  
    53  	OpeningQty float32 `json:"openingQty,omitempty"`
    54  
    55  	OpeningCost float32 `json:"openingCost,omitempty"`
    56  
    57  	OpeningComm float32 `json:"openingComm,omitempty"`
    58  
    59  	OpenOrderBuyQty float32 `json:"openOrderBuyQty,omitempty"`
    60  
    61  	OpenOrderBuyCost float32 `json:"openOrderBuyCost,omitempty"`
    62  
    63  	OpenOrderBuyPremium float32 `json:"openOrderBuyPremium,omitempty"`
    64  
    65  	OpenOrderSellQty float32 `json:"openOrderSellQty,omitempty"`
    66  
    67  	OpenOrderSellCost float32 `json:"openOrderSellCost,omitempty"`
    68  
    69  	OpenOrderSellPremium float32 `json:"openOrderSellPremium,omitempty"`
    70  
    71  	ExecBuyQty float32 `json:"execBuyQty,omitempty"`
    72  
    73  	ExecBuyCost float32 `json:"execBuyCost,omitempty"`
    74  
    75  	ExecSellQty float32 `json:"execSellQty,omitempty"`
    76  
    77  	ExecSellCost float32 `json:"execSellCost,omitempty"`
    78  
    79  	ExecQty float32 `json:"execQty,omitempty"`
    80  
    81  	ExecCost float32 `json:"execCost,omitempty"`
    82  
    83  	ExecComm float32 `json:"execComm,omitempty"`
    84  
    85  	CurrentTimestamp time.Time `json:"currentTimestamp,omitempty"`
    86  
    87  	CurrentQty float32 `json:"currentQty,omitempty"`
    88  
    89  	CurrentCost float32 `json:"currentCost,omitempty"`
    90  
    91  	CurrentComm float32 `json:"currentComm,omitempty"`
    92  
    93  	RealisedCost float32 `json:"realisedCost,omitempty"`
    94  
    95  	UnrealisedCost float32 `json:"unrealisedCost,omitempty"`
    96  
    97  	GrossOpenCost float32 `json:"grossOpenCost,omitempty"`
    98  
    99  	GrossOpenPremium float32 `json:"grossOpenPremium,omitempty"`
   100  
   101  	GrossExecCost float32 `json:"grossExecCost,omitempty"`
   102  
   103  	IsOpen bool `json:"isOpen,omitempty"`
   104  
   105  	MarkPrice float64 `json:"markPrice,omitempty"`
   106  
   107  	MarkValue float32 `json:"markValue,omitempty"`
   108  
   109  	RiskValue float32 `json:"riskValue,omitempty"`
   110  
   111  	HomeNotional float64 `json:"homeNotional,omitempty"`
   112  
   113  	ForeignNotional float64 `json:"foreignNotional,omitempty"`
   114  
   115  	PosState string `json:"posState,omitempty"`
   116  
   117  	PosCost float32 `json:"posCost,omitempty"`
   118  
   119  	PosCost2 float32 `json:"posCost2,omitempty"`
   120  
   121  	PosCross float32 `json:"posCross,omitempty"`
   122  
   123  	PosInit float32 `json:"posInit,omitempty"`
   124  
   125  	PosComm float32 `json:"posComm,omitempty"`
   126  
   127  	PosLoss float32 `json:"posLoss,omitempty"`
   128  
   129  	PosMargin float32 `json:"posMargin,omitempty"`
   130  
   131  	PosMaint float32 `json:"posMaint,omitempty"`
   132  
   133  	PosAllowance float32 `json:"posAllowance,omitempty"`
   134  
   135  	TaxableMargin float32 `json:"taxableMargin,omitempty"`
   136  
   137  	InitMargin float32 `json:"initMargin,omitempty"`
   138  
   139  	MaintMargin float32 `json:"maintMargin,omitempty"`
   140  
   141  	SessionMargin float32 `json:"sessionMargin,omitempty"`
   142  
   143  	TargetExcessMargin float32 `json:"targetExcessMargin,omitempty"`
   144  
   145  	VarMargin float32 `json:"varMargin,omitempty"`
   146  
   147  	RealisedGrossPnl float32 `json:"realisedGrossPnl,omitempty"`
   148  
   149  	RealisedTax float32 `json:"realisedTax,omitempty"`
   150  
   151  	RealisedPnl float32 `json:"realisedPnl,omitempty"`
   152  
   153  	UnrealisedGrossPnl float32 `json:"unrealisedGrossPnl,omitempty"`
   154  
   155  	LongBankrupt float32 `json:"longBankrupt,omitempty"`
   156  
   157  	ShortBankrupt float32 `json:"shortBankrupt,omitempty"`
   158  
   159  	TaxBase float32 `json:"taxBase,omitempty"`
   160  
   161  	IndicativeTaxRate float64 `json:"indicativeTaxRate,omitempty"`
   162  
   163  	IndicativeTax float32 `json:"indicativeTax,omitempty"`
   164  
   165  	UnrealisedTax float32 `json:"unrealisedTax,omitempty"`
   166  
   167  	UnrealisedPnl float32 `json:"unrealisedPnl,omitempty"`
   168  
   169  	UnrealisedPnlPcnt float64 `json:"unrealisedPnlPcnt,omitempty"`
   170  
   171  	UnrealisedRoePcnt float64 `json:"unrealisedRoePcnt,omitempty"`
   172  
   173  	SimpleQty float64 `json:"simpleQty,omitempty"`
   174  
   175  	SimpleCost float64 `json:"simpleCost,omitempty"`
   176  
   177  	SimpleValue float64 `json:"simpleValue,omitempty"`
   178  
   179  	SimplePnl float64 `json:"simplePnl,omitempty"`
   180  
   181  	SimplePnlPcnt float64 `json:"simplePnlPcnt,omitempty"`
   182  
   183  	AvgCostPrice float64 `json:"avgCostPrice,omitempty"`
   184  
   185  	AvgEntryPrice float64 `json:"avgEntryPrice,omitempty"`
   186  
   187  	BreakEvenPrice float64 `json:"breakEvenPrice,omitempty"`
   188  
   189  	MarginCallPrice float64 `json:"marginCallPrice,omitempty"`
   190  
   191  	LiquidationPrice float64 `json:"liquidationPrice,omitempty"`
   192  
   193  	BankruptPrice float64 `json:"bankruptPrice,omitempty"`
   194  
   195  	Timestamp time.Time `json:"timestamp,omitempty"`
   196  
   197  	LastPrice float64 `json:"lastPrice,omitempty"`
   198  
   199  	LastValue float32 `json:"lastValue,omitempty"`
   200  }