All URIs are relative to https://www.bitmex.com/api/v1
| Method | HTTP request | Description |
|---|---|---|
| PositionGet | Get /position | Get your positions. |
| PositionIsolateMargin | Post /position/isolate | Enable isolated margin or cross margin per-position. |
| PositionTransferIsolatedMargin | Post /position/transferMargin | Transfer equity in or out of a position. |
| PositionUpdateLeverage | Post /position/leverage | Choose leverage for a position. |
| PositionUpdateRiskLimit | Post /position/riskLimit | Update your risk limit. |
[]Position PositionGet(ctx, optional) Get your positions.
This endpoint is used for retrieving position information. The fields largely follow the FIX spec definitions. Some selected fields are explained in more detail below. The fields account, symbol, currency are unique to each position and form its key. - account: Your unique account ID. - symbol: The contract for this position. - currency: The margin currency for this position. - underlying: Meta data of the symbol. - quoteCurrency: Meta data of the symbol, All prices are in the quoteCurrency - commission: The maximum of the maker, taker, and settlement fee. - initMarginReq: The initial margin requirement. This will be at least the symbol's default initial maintenance margin, but can be higher if you choose lower leverage. - maintMarginReq: The maintenance margin requirement. This will be at least the symbol's default maintenance maintenance margin, but can be higher if you choose a higher risk limit. - riskLimit: This is a function of your maintMarginReq. - leverage: 1 / initMarginReq. - crossMargin: True/false depending on whether you set cross margin on this position. - deleveragePercentile: Indicates where your position is in the ADL queue. - rebalancedPnl: The value of realised PNL that has transferred to your wallet for this position. - prevRealisedPnl: The value of realised PNL that has transferred to your wallet for this position since the position was closed. - currentQty: The current position amount in contracts. - currentCost: The current cost of the position in the settlement currency of the symbol (currency). - currentComm: The current commission of the position in the settlement currency of the symbol (currency). - realisedCost: The realised cost of this position calculated with regard to average cost accounting. - unrealisedCost: currentCost - realisedCost. - grossOpenCost: The absolute value of your open orders for this symbol. - grossOpenPremium: The amount your bidding above the mark price in the settlement currency of the symbol (currency). - markPrice: The mark price of the symbol in quoteCurrency. - markValue: The currentQty at the mark price in the settlement currency of the symbol (currency). - homeNotional: Value of position in units of underlying. - foreignNotional: Value of position in units of quoteCurrency. - realisedPnl: The negative of realisedCost. - unrealisedGrossPnl: markValue - unrealisedCost. - unrealisedPnl: unrealisedGrossPnl. - liquidationPrice: Once markPrice reaches this price, this position will be liquidated. - bankruptPrice: Once markPrice reaches this price, this position will have no equity.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *PositionGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PositionGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | optional.String | Table filter. For example, send {"symbol": "XBTUSD"}. | |
| columns | optional.String | Which columns to fetch. For example, send ["columnName"]. | |
| count | optional.Float32 | Number of rows to fetch. |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Position PositionIsolateMargin(ctx, symbol, optional) Enable isolated margin or cross margin per-position.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Position symbol to isolate. | |
| optional | *PositionIsolateMarginOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PositionIsolateMarginOpts struct
| Name | Type | Description | Notes |
|---|
enabled | optional.Bool| True for isolated margin, false for cross margin. | [default to true]
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Position PositionTransferIsolatedMargin(ctx, symbol, amount) Transfer equity in or out of a position.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Symbol of position to isolate. | |
| amount | float32 | Amount to transfer, in Satoshis. May be negative. |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Position PositionUpdateLeverage(ctx, symbol, leverage) Choose leverage for a position.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Symbol of position to adjust. | |
| leverage | float64 | Leverage value. Send a number between 0.01 and 100 to enable isolated margin with a fixed leverage. Send 0 to enable cross margin. |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Position PositionUpdateRiskLimit(ctx, symbol, riskLimit) Update your risk limit.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Symbol of position to update risk limit on. | |
| riskLimit | float32 | New Risk Limit, in Satoshis. |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]