Skip to content

Commit e8632fc

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent dbd4404 commit e8632fc

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

api.yaml

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24147,16 +24147,19 @@ paths:
2414724147
description: Quantity representing the total NOP limit across all currencies. It sets a limit that is compared to the total short position across all currencies (eg. 1000000). Currency represents the currency that the quantity is valued in (eg. USD)
2414824148
marginCallPercentage:
2414924149
description: Number representing the percentage at which a margin call will be initiated if the margin percentage falls below this number. It is in decimal form (eg. 0.8 to mean 80%)
24150-
type: number
24151-
format: decimal
24150+
type: string
24151+
pattern: ^[0-9]+(\.[0-9]+)?$
24152+
example: '0.8'
2415224153
liquidationThresholdPercentage:
2415324154
description: Number representing the liquidation threshold percentage at which positions will be automatically liquidated if the margin utilization exceeds this level. It is in decimal form (eg. 1.2 to mean 120%)
24154-
type: number
24155-
format: decimal
24155+
type: string
24156+
pattern: ^[0-9]+(\.[0-9]+)?$
24157+
example: '1.2'
2415624158
marginRequirementPercentage:
2415724159
description: Number representing the margin requirement percentage which is used with the NOP to determine the margin required. It is in decimal form (eg.0.2 for 20%)
24158-
type: number
24159-
format: decimal
24160+
type: string
24161+
pattern: ^[0-9]+(\.[0-9]+)?$
24162+
example: '0.2'
2416024163
minimumCollateralValue:
2416124164
allOf:
2416224165
- $ref: '#/components/schemas/Amount3'
@@ -24283,8 +24286,10 @@ paths:
2428324286
- type: object
2428424287
description: Quantity representing the marginBalance required to continue trading without risk of margin call or liquidation. If margin requirement is not present, either netOpenPosition is zero or there is no requirement. Currency represents the notional currency (eg. USD)
2428524288
marginUtilizationPercentage:
24286-
type: number
24289+
type: string
24290+
pattern: ^[0-9]+(\.[0-9]+)?$
2428724291
nullable: true
24292+
example: '0.85'
2428824293
description: Quantity representing the ratio of marginRequirement to marginBalance, measured directly against liquidation and margin call thresholds. This is null if there is no margin requirement.
2428924294
example:
2429024295
riskProfile:
@@ -24303,7 +24308,7 @@ paths:
2430324308
marginRequirement:
2430424309
quantity: '600000'
2430524310
currency: USD
24306-
marginUtilizationPercentage: 0.85
24311+
marginUtilizationPercentage: '0.85'
2430724312
/api/prime/trading/v1/accounts/{accountID}/margin/collateral/transfer:
2430824313
post:
2430924314
summary: Transfer collateral for margin
@@ -57992,8 +57997,9 @@ components:
5799257997
format: uuid
5799357998
description: Enterprise ID for the margin NOP limit
5799457999
netOpenPosition:
57995-
type: number
57996-
format: decimal
58000+
type: string
58001+
pattern: ^-?[0-9]+(\.[0-9]+)?$
58002+
example: '-2.3242'
5799758003
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.
5799858004
netOpenPositionValue:
5799958005
type: number
@@ -58021,7 +58027,7 @@ components:
5802158027
example:
5802258028
currency: BTC
5802358029
enterpriseId: 63925f940c259a00061853808ffea830
58024-
netOpenPosition: -2.3242
58030+
netOpenPosition: '-2.3242'
5802558031
netOpenPositionValue: -124017.22
5802658032
shortMarginPositionNotionalLimit:
5802758033
quantity: 1000000

0 commit comments

Comments
 (0)