You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api.yaml
+52-26Lines changed: 52 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -26794,15 +26794,15 @@ paths:
26794
26794
properties:
26795
26795
currency:
26796
26796
type: string
26797
-
description: Symbol of the collateral asset
26797
+
description: Currency symbol
26798
26798
quantity:
26799
26799
type: string
26800
-
description: String representing the balance for the specified collateral
26800
+
description: Net position after the position transfer
26801
26801
balanceValue:
26802
26802
allOf:
26803
26803
- $ref: '#/components/schemas/Amount3'
26804
26804
- 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.
26806
26806
example:
26807
26807
balances:
26808
26808
- currency: BTC
@@ -26855,10 +26855,10 @@ paths:
26855
26855
properties:
26856
26856
currency:
26857
26857
type: string
26858
-
description: Symbol of the margin position asset
26858
+
description: Currency symbol
26859
26859
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
26862
26862
balanceValue:
26863
26863
allOf:
26864
26864
- $ref: '#/components/schemas/Amount3'
@@ -26867,7 +26867,7 @@ paths:
26867
26867
example:
26868
26868
balances:
26869
26869
- currency: BTC
26870
-
quantity: 2
26870
+
quantity: '2'
26871
26871
balanceValue:
26872
26872
quantity: '1000000'
26873
26873
currency: USD
@@ -45008,13 +45008,19 @@ components:
45008
45008
name: Example Trading Wallet
45009
45009
AccountBalance:
45010
45010
required:
45011
+
- currencyId
45011
45012
- currency
45012
45013
- balance
45013
45014
- heldBalance
45015
+
- unsettledHeldBalance
45014
45016
- tradableBalance
45015
45017
- withdrawableBalance
45016
45018
type: object
45017
45019
properties:
45020
+
currencyId:
45021
+
type: string
45022
+
format: uuid
45023
+
description: ID of the currency
45018
45024
currency:
45019
45025
type: string
45020
45026
description: Currency symbol
@@ -45026,6 +45032,10 @@ components:
45026
45032
type: string
45027
45033
format: decimal
45028
45034
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.
45029
45039
tradableBalance:
45030
45040
type: string
45031
45041
format: decimal
@@ -45039,7 +45049,9 @@ components:
45039
45049
currency: BTC
45040
45050
balance: '100.0'
45041
45051
heldBalance: '10.0'
45052
+
unsettledHeldBalance: '0.0'
45042
45053
tradableBalance: '90.0'
45054
+
withdrawableBalance: '90.0'
45043
45055
AccountBalanceRecord:
45044
45056
title: AccountBalanceRecord
45045
45057
type: object
@@ -52618,6 +52630,7 @@ components:
52618
52630
- id
52619
52631
- name
52620
52632
- symbol
52633
+
- minIncrement
52621
52634
type: object
52622
52635
properties:
52623
52636
id:
@@ -52630,10 +52643,15 @@ components:
52630
52643
name:
52631
52644
type: string
52632
52645
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.
52633
52650
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'
52637
52655
Currency1:
52638
52656
title: Currency
52639
52657
type: object
@@ -62442,26 +62460,27 @@ components:
62442
62460
type: string
62443
62461
pattern: ^-?[0-9]+(\.[0-9]+)?$
62444
62462
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.
62446
62464
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)
62450
62469
shortMarginPositionNotionalLimit:
62451
62470
allOf:
62452
62471
- $ref: '#/components/schemas/Amount3'
62453
62472
- 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
62455
62474
longMarginPositionNotionalLimit:
62456
62475
allOf:
62457
62476
- $ref: '#/components/schemas/Amount3'
62458
62477
- 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)
62460
62479
unrealizedPnL:
62461
62480
allOf:
62462
62481
- $ref: '#/components/schemas/Amount3'
62463
62482
- 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.
62465
62484
lastModified:
62466
62485
type: string
62467
62486
format: date-time
@@ -62470,15 +62489,17 @@ components:
62470
62489
currency: BTC
62471
62490
enterpriseId: 63925f940c259a00061853808ffea830
62472
62491
netOpenPosition: '-2.3242'
62473
-
netOpenPositionValue: -124017.22
62492
+
netOpenPositionValue:
62493
+
quantity: '-124017.22'
62494
+
currency: USD
62474
62495
shortMarginPositionNotionalLimit:
62475
-
quantity: 1000000
62496
+
quantity: '1000000.00'
62476
62497
currency: USD
62477
62498
longMarginPositionNotionalLimit:
62478
-
quantity: 1000000
62499
+
quantity: '1000000.00'
62479
62500
currency: USD
62480
62501
unrealizedPnL:
62481
-
quantity: 1200
62502
+
quantity: '1200.00'
62482
62503
currency: USD
62483
62504
lastModified: '2024-07-29T21:13:09.000Z'
62484
62505
MarginNetOpenPositionLimit:
@@ -64040,7 +64061,7 @@ components:
64040
64061
- accountId
64041
64062
- enterpriseId
64042
64063
- initiatedByUserId
64043
-
- cancelledByUserId
64064
+
- canceledByUserId
64044
64065
- clientOrderId
64045
64066
- time
64046
64067
- creationDate
@@ -64066,7 +64087,7 @@ components:
64066
64087
- limitPrice
64067
64088
- duration
64068
64089
- twapInterval
64069
-
- rtid
64090
+
- rtId
64070
64091
- notes
64071
64092
type: object
64072
64093
properties:
@@ -64080,7 +64101,7 @@ components:
64080
64101
type: string
64081
64102
initiatedByUserId:
64082
64103
type: string
64083
-
cancelledByUserId:
64104
+
canceledByUserId:
64084
64105
type: string
64085
64106
clientOrderId:
64086
64107
$ref: '#/components/schemas/ClientOrderId'
@@ -64164,7 +64185,7 @@ components:
64164
64185
twapInterval:
64165
64186
type: integer
64166
64187
description: Interval length of the TWAP order in minutes.
64167
-
rtid:
64188
+
rtId:
64168
64189
type: string
64169
64190
description: The request tracking ID associated with the order.
0 commit comments