Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JKorf committed Aug 25, 2023
1 parent b40923c commit 5dc67ef
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ var result = await client.DerivativesApi\ContractApi.ContractApiTrading.PlaceOrd
```

```csharp
Task<WebCallResult<BybitDerivativesOrderId>> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, bool? reduceOnly = default, bool? closeOnTrigger = default, decimal? price = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default);
Task<WebCallResult<BybitDerivativesOrderId>> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, bool? reduceOnly = default, bool? closeOnTrigger = default, decimal? price = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, PositionMode? positionMode = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, long? receiveWindow = default, CancellationToken ct = default);
```

|Parameter|Description|
Expand All @@ -162,6 +162,7 @@ Task<WebCallResult<BybitDerivativesOrderId>> PlaceOrderAsync(string symbol, Orde
|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice|
|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice|
|_[Optional]_ positionMode|Position mode|
|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode|
|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request|
|_[Optional]_ ct|Cancellation token|

Expand Down Expand Up @@ -217,7 +218,7 @@ var result = await client.DerivativesApi\ContractApi.ContractApiTrading.SetTradi
```

```csharp
Task<WebCallResult> SetTradingStop(string symbol, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? activePrice = default, decimal? trailingStop = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? stopLossSize = default, decimal? takeProfitSize = default, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default);
Task<WebCallResult> SetTradingStop(string symbol, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? activePrice = default, decimal? trailingStop = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? stopLossSize = default, decimal? takeProfitSize = default, PositionMode? positionMode = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, long? receiveWindow = default, CancellationToken ct = default);
```

|Parameter|Description|
Expand All @@ -232,6 +233,7 @@ Task<WebCallResult> SetTradingStop(string symbol, decimal? takeProfitPrice = def
|_[Optional]_ stopLossSize|Stop loss quantity|
|_[Optional]_ takeProfitSize|Take profit quantity|
|_[Optional]_ positionMode|Position mode|
|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode|
|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request|
|_[Optional]_ ct|Cancellation token|

Expand Down
11 changes: 9 additions & 2 deletions docs/ClientInfo/V5/IBybitRestClientApiTrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ var result = await client.V5.ApiTrading.GetOrderHistoryAsync(/* parameters */);
```

```csharp
Task<WebCallResult<BybitResponse<BybitOrder>>> GetOrderHistoryAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, Enums.V5.OrderStatus? status = default, OrderFilter? orderFilter = default, int? limit = default, string? cursor = default, CancellationToken ct = default);
Task<WebCallResult<BybitResponse<BybitOrder>>> GetOrderHistoryAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, Enums.V5.OrderStatus? status = default, OrderFilter? orderFilter = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default);
```

|Parameter|Description|
Expand All @@ -245,6 +245,8 @@ Task<WebCallResult<BybitResponse<BybitOrder>>> GetOrderHistoryAsync(Category cat
|_[Optional]_ clientOrderId|Filter by client order id|
|_[Optional]_ status|Filter by status|
|_[Optional]_ orderFilter|Order filter|
|_[Optional]_ startTime|Filter by start time|
|_[Optional]_ endTime|Filter by end time|
|_[Optional]_ limit|Number of results per page|
|_[Optional]_ cursor|Pagination cursor|
|_[Optional]_ ct|Cancellation token|
Expand Down Expand Up @@ -392,7 +394,7 @@ var result = await client.V5.ApiTrading.PlaceOrderAsync(/* parameters */);
```

```csharp
Task<WebCallResult<BybitOrderId>> PlaceOrderAsync(Category category, string symbol, OrderSide side, NewOrderType type, decimal quantity, decimal? price = default, bool? isLeverage = default, TriggerDirection? triggerDirection = default, OrderFilter? orderFilter = default, decimal? triggerPrice = default, TriggerType? triggerBy = default, decimal? orderIv = default, TimeInForce? timeInForce = default, Enums.V5.PositionIdx? positionIdx = default, string? clientOrderId = default, decimal? takeProfit = default, decimal? stopLoss = default, TriggerType? takeProfitTriggerBy = default, TriggerType? stopLossTriggerBy = default, bool? reduceOnly = default, bool? closeOnTrigger = default, bool? marketMakerProtection = default, CancellationToken ct = default);
Task<WebCallResult<BybitOrderId>> PlaceOrderAsync(Category category, string symbol, OrderSide side, NewOrderType type, decimal quantity, decimal? price = default, bool? isLeverage = default, TriggerDirection? triggerDirection = default, OrderFilter? orderFilter = default, decimal? triggerPrice = default, TriggerType? triggerBy = default, decimal? orderIv = default, TimeInForce? timeInForce = default, PositionIdx? positionIdx = default, string? clientOrderId = default, OrderType? takeProfitOrderType = default, decimal? takeProfit = default, decimal? takeProfitLimitPrice = default, OrderType? stopLossOrderType = default, decimal? stopLoss = default, decimal? stopLossLimitPrice = default, TriggerType? takeProfitTriggerBy = default, TriggerType? stopLossTriggerBy = default, bool? reduceOnly = default, bool? closeOnTrigger = default, bool? marketMakerProtection = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, CancellationToken ct = default);
```

|Parameter|Description|
Expand All @@ -412,13 +414,18 @@ Task<WebCallResult<BybitOrderId>> PlaceOrderAsync(Category category, string symb
|_[Optional]_ timeInForce|Time in force|
|_[Optional]_ positionIdx|Position idx|
|_[Optional]_ clientOrderId|Client order id|
|_[Optional]_ takeProfitOrderType||
|_[Optional]_ takeProfit|Take profit price|
|_[Optional]_ takeProfitLimitPrice||
|_[Optional]_ stopLossOrderType||
|_[Optional]_ stopLoss|Stop loss price|
|_[Optional]_ stopLossLimitPrice||
|_[Optional]_ takeProfitTriggerBy|Take profit trigger|
|_[Optional]_ stopLossTriggerBy|Stop loss trigger|
|_[Optional]_ reduceOnly|Is reduce only|
|_[Optional]_ closeOnTrigger|Close on trigger|
|_[Optional]_ marketMakerProtection|Market maker protection|
|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode|
|_[Optional]_ ct|Cancellation token|

</p>
Expand Down

0 comments on commit 5dc67ef

Please sign in to comment.