Skip to content

Commit 8f58ea0

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 1247312 commit 8f58ea0

File tree

1 file changed

+52
-26
lines changed

1 file changed

+52
-26
lines changed

api.yaml

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26794,15 +26794,15 @@ paths:
2679426794
properties:
2679526795
currency:
2679626796
type: string
26797-
description: Symbol of the collateral asset
26797+
description: Currency symbol
2679826798
quantity:
2679926799
type: string
26800-
description: String representing the balance for the specified collateral
26800+
description: Net position after the position transfer
2680126801
balanceValue:
2680226802
allOf:
2680326803
- $ref: '#/components/schemas/Amount3'
2680426804
- type: object
26805-
description: Returns the value of the collateral. Has 2 fields denoting the currency used and the actual value.
26805+
description: Returns the value of the margin position. Has 2 fields denoting the currency used and the actual value.
2680626806
example:
2680726807
balances:
2680826808
- currency: BTC
@@ -26855,10 +26855,10 @@ paths:
2685526855
properties:
2685626856
currency:
2685726857
type: string
26858-
description: Symbol of the margin position asset
26858+
description: Currency symbol
2685926859
quantity:
26860-
type: number
26861-
description: Number representing the balance for the specified margin position
26860+
type: string
26861+
description: Net position after the position transfer
2686226862
balanceValue:
2686326863
allOf:
2686426864
- $ref: '#/components/schemas/Amount3'
@@ -26867,7 +26867,7 @@ paths:
2686726867
example:
2686826868
balances:
2686926869
- currency: BTC
26870-
quantity: 2
26870+
quantity: '2'
2687126871
balanceValue:
2687226872
quantity: '1000000'
2687326873
currency: USD
@@ -45008,13 +45008,19 @@ components:
4500845008
name: Example Trading Wallet
4500945009
AccountBalance:
4501045010
required:
45011+
- currencyId
4501145012
- currency
4501245013
- balance
4501345014
- heldBalance
45015+
- unsettledHeldBalance
4501445016
- tradableBalance
4501545017
- withdrawableBalance
4501645018
type: object
4501745019
properties:
45020+
currencyId:
45021+
type: string
45022+
format: uuid
45023+
description: ID of the currency
4501845024
currency:
4501945025
type: string
4502045026
description: Currency symbol
@@ -45026,6 +45032,10 @@ components:
4502645032
type: string
4502745033
format: decimal
4502845034
description: The total balance reserved for some purpose, e.g. a pending withdrawal.
45035+
unsettledHeldBalance:
45036+
type: string
45037+
format: decimal
45038+
description: The total unsettled balance reserved for some purpose, e.g. a pending withdrawal.
4502945039
tradableBalance:
4503045040
type: string
4503145041
format: decimal
@@ -45039,7 +45049,9 @@ components:
4503945049
currency: BTC
4504045050
balance: '100.0'
4504145051
heldBalance: '10.0'
45052+
unsettledHeldBalance: '0.0'
4504245053
tradableBalance: '90.0'
45054+
withdrawableBalance: '90.0'
4504345055
AccountBalanceRecord:
4504445056
title: AccountBalanceRecord
4504545057
type: object
@@ -52618,6 +52630,7 @@ components:
5261852630
- id
5261952631
- name
5262052632
- symbol
52633+
- minIncrement
5262152634
type: object
5262252635
properties:
5262352636
id:
@@ -52630,10 +52643,15 @@ components:
5263052643
name:
5263152644
type: string
5263252645
description: Name of the currency
52646+
minIncrement:
52647+
type: string
52648+
format: decimal
52649+
description: This is the smallest amount that can be traded for the currency.
5263352650
example:
52634-
id: 6016e0a9-545a-45fb-8370-caab1680956a
52635-
symbol: BTC
52636-
name: Bitcoin
52651+
id: 519824c6-b534-49b4-a636-22dfd0ade5cf
52652+
symbol: USD
52653+
name: US Dollar
52654+
minIncrement: '0.01'
5263752655
Currency1:
5263852656
title: Currency
5263952657
type: object
@@ -62442,26 +62460,27 @@ components:
6244262460
type: string
6244362461
pattern: ^-?[0-9]+(\.[0-9]+)?$
6244462462
example: '-2.3242'
62445-
description: Number representing the current net open position for the NOP instrument in question (ex. -10 BTC). Negative means a short position and positive means a long position.
62463+
description: The current net open position for the NOP instrument in question (ex. -10 BTC). Negative means a short position and positive means a long position.
6244662464
netOpenPositionValue:
62447-
type: number
62448-
format: decimal
62449-
description: Number representing the net open position denoted in notional amount (ex 600,000 USD)
62465+
allOf:
62466+
- $ref: '#/components/schemas/Amount3'
62467+
- type: object
62468+
description: The net open position denoted in notional amount (ex 600,000 USD)
6245062469
shortMarginPositionNotionalLimit:
6245162470
allOf:
6245262471
- $ref: '#/components/schemas/Amount3'
6245362472
- type: object
62454-
description: Number representing the maximum open margin position that can be short in terms of the notional instrument (ex. 10,000 USD) in absolute notional terms, as the NOP is signed
62473+
description: The maximum open margin position that can be short in terms of the notional instrument (ex. 10,000 USD) in absolute notional terms, as the NOP is signed
6245562474
longMarginPositionNotionalLimit:
6245662475
allOf:
6245762476
- $ref: '#/components/schemas/Amount3'
6245862477
- type: object
62459-
description: Number representing the maximum open margin position that can be long in terms of the notional instrument (ex. 10,000 USD)
62478+
description: The maximum open margin position that can be long in terms of the notional instrument (ex. 10,000 USD)
6246062479
unrealizedPnL:
6246162480
allOf:
6246262481
- $ref: '#/components/schemas/Amount3'
6246362482
- type: object
62464-
description: Number representing the unrealized profit and loss. Difference between the NOP value at the time of creation and the NOP value as of now.
62483+
description: The unrealized profit and loss. Difference between the NOP value at the time of creation and the NOP value as of now.
6246562484
lastModified:
6246662485
type: string
6246762486
format: date-time
@@ -62470,15 +62489,17 @@ components:
6247062489
currency: BTC
6247162490
enterpriseId: 63925f940c259a00061853808ffea830
6247262491
netOpenPosition: '-2.3242'
62473-
netOpenPositionValue: -124017.22
62492+
netOpenPositionValue:
62493+
quantity: '-124017.22'
62494+
currency: USD
6247462495
shortMarginPositionNotionalLimit:
62475-
quantity: 1000000
62496+
quantity: '1000000.00'
6247662497
currency: USD
6247762498
longMarginPositionNotionalLimit:
62478-
quantity: 1000000
62499+
quantity: '1000000.00'
6247962500
currency: USD
6248062501
unrealizedPnL:
62481-
quantity: 1200
62502+
quantity: '1200.00'
6248262503
currency: USD
6248362504
lastModified: '2024-07-29T21:13:09.000Z'
6248462505
MarginNetOpenPositionLimit:
@@ -64040,7 +64061,7 @@ components:
6404064061
- accountId
6404164062
- enterpriseId
6404264063
- initiatedByUserId
64043-
- cancelledByUserId
64064+
- canceledByUserId
6404464065
- clientOrderId
6404564066
- time
6404664067
- creationDate
@@ -64066,7 +64087,7 @@ components:
6406664087
- limitPrice
6406764088
- duration
6406864089
- twapInterval
64069-
- rtid
64090+
- rtId
6407064091
- notes
6407164092
type: object
6407264093
properties:
@@ -64080,7 +64101,7 @@ components:
6408064101
type: string
6408164102
initiatedByUserId:
6408264103
type: string
64083-
cancelledByUserId:
64104+
canceledByUserId:
6408464105
type: string
6408564106
clientOrderId:
6408664107
$ref: '#/components/schemas/ClientOrderId'
@@ -64164,7 +64185,7 @@ components:
6416464185
twapInterval:
6416564186
type: integer
6416664187
description: Interval length of the TWAP order in minutes.
64167-
rtid:
64188+
rtId:
6416864189
type: string
6416964190
description: The request tracking ID associated with the order.
6417064191
parameters:
@@ -64191,17 +64212,22 @@ components:
6419164212
type: market
6419264213
timeInForce: null
6419364214
status: completed
64215+
reason: null
64216+
reasonDescription: null
6419464217
product: BTC-USD
6419564218
side: buy
6419664219
quantity: '1000'
6419764220
quantityCurrency: USD
6419864221
filledQuantity: '0.02457152'
6419964222
filledQuoteQuantity: '1000'
64223+
leavesQuantity: null
64224+
leavesQuoteQuantity: '0'
6420064225
averagePrice: '40697.32'
6420164226
limitPrice: null
6420264227
duration: null
6420364228
twapInterval: null
6420464229
rtId: null
64230+
isFinanced: false
6420564231
notes: null
6420664232
OrderBooksRequest:
6420764233
title: Order Books
@@ -64351,7 +64377,7 @@ components:
6435164377
time: '2025-12-08T16:41:02.802558Z'
6435264378
creationDate: '2025-12-05T21:31:37.907912Z'
6435364379
scheduledDate: null
64354-
lastFillDate": null
64380+
lastFillDate: null
6435564381
completionDate: null
6435664382
settleDate: null
6435764383
accountId: f230fdebfa084ffebc7e00515f54603f

0 commit comments

Comments
 (0)