Skip to content

Commit 66bba36

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent b167b74 commit 66bba36

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

api.yaml

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43671,7 +43671,6 @@ components:
4367143671
- side
4367243672
- type
4367343673
- duration
43674-
- interval
4367543674
type: object
4367643675
properties:
4367743676
clientOrderId:
@@ -43702,10 +43701,27 @@ components:
4370243701
description: Duration of the TWAP order in minutes.
4370343702
interval:
4370443703
type: integer
43705-
description: Interval of the TWAP order in minutes.
43704+
description: Interval of the time-sliced TWAP order in minutes. Only required if 'isTimeSliced' is 'true'.
4370643705
scheduledDate:
4370743706
type: string
4370843707
format: date-time
43708+
isTimeSliced:
43709+
type: boolean
43710+
description: |
43711+
The isTimeSliced field, when provided under the parameters section, determines the order's time slicing behavior:
43712+
- If isTimeSliced is set to true, the order will be executed using a time-sliced strategy.
43713+
- If isTimeSliced is set to false, the order will be executed using a regular TWAP strategy without time slicing.
43714+
- If isTimeSliced is not specified, the default behavior uses a regular TWAP strategy without time slicing.
43715+
boundsControl:
43716+
type: string
43717+
description: |
43718+
The boundsControl field, when provided under the parameters section, determines how strictly the TWAP algorithm adheres to the target fill progression.
43719+
- It is optional but can be provided for a regular TWAP strategy.
43720+
- Default value is 'standard'.
43721+
enum:
43722+
- narrow
43723+
- standard
43724+
- wide
4370943725
example:
4371043726
clientOrderId: myorder1
4371143727
type: twap
@@ -43715,6 +43731,9 @@ components:
4371543731
quantityCurrency: USD
4371643732
duration: 60
4371743733
interval: 5
43734+
parameters:
43735+
isTimeSliced: false
43736+
boundsControl: wide
4371843737
NextBatchPrevId:
4371943738
type: string
4372043739
format: uuid
@@ -44103,6 +44122,15 @@ components:
4410344122
- internalError
4410444123
- insufficientFunds
4410544124
example: insufficientFunds
44125+
parameters:
44126+
type: object
44127+
properties:
44128+
isTimeSliced:
44129+
type: boolean
44130+
description: Indicates if the order is a time-sliced TWAP.
44131+
boundsControl:
44132+
type: string
44133+
description: Defines the bounds control strategy used to manage a regular TWAP order.
4410644134
example:
4410744135
id: 67fd640c-cb6c-4218-80ae-49e79ec15646
4410844136
accountId: 60e740e7898f7d00064d43769a73dc48

0 commit comments

Comments
 (0)