Skip to content

Commit 23b950a

Browse files
Merge pull request #193 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 13e3bac + e9a7d12 commit 23b950a

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

api.yaml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8828,7 +8828,7 @@ paths:
88288828
/api/v1/marketdata/cryptocompare/historical/prices:
88298829
get:
88308830
tags:
8831-
- Market Data
8831+
- CryptoCompare
88328832
summary: Get historical prices
88338833
description: Get a list of historical prices in a specified time range. Using this endpoint requires an access token with the appropriate enterprise ID.
88348834
operationId: marketdata.cryptocompare.historical.prices.get
@@ -8856,7 +8856,7 @@ paths:
88568856
/api/v1/marketdata/cryptocompare/spot/prices:
88578857
get:
88588858
tags:
8859-
- Market Data
8859+
- CryptoCompare
88608860
summary: Get spot prices
88618861
description: Get historical spot prices from a specific time. Using this endpoint requires an access token with the appropriate enterprise ID.
88628862
operationId: marketdata.cryptocompare.spot.prices.get
@@ -21630,7 +21630,7 @@ paths:
2163021630
description: Get the current user’s public information.
2163121631
operationId: trade.user.current
2163221632
tags:
21633-
- Accounts
21633+
- Trade REST API
2163421634
responses:
2163521635
'200':
2163621636
description: A user
@@ -21650,7 +21650,7 @@ paths:
2165021650
description: Get the list of trading accounts that the current user belongs to.
2165121651
operationId: trade.accounts
2165221652
tags:
21653-
- Accounts
21653+
- Trade REST API
2165421654
responses:
2165521655
'200':
2165621656
description: An array of accounts
@@ -21675,7 +21675,7 @@ paths:
2167521675
description: Get balance information about a single trading account.
2167621676
operationId: trade.accounts.balances
2167721677
tags:
21678-
- Accounts
21678+
- Trade REST API
2167921679
parameters:
2168021680
- name: accountId
2168121681
in: path
@@ -21709,7 +21709,7 @@ paths:
2170921709
description: Lists all orders from the given trading account.
2171021710
operationId: trade.orders.detail
2171121711
tags:
21712-
- Orders
21712+
- Trade REST API
2171321713
parameters:
2171421714
- name: accountId
2171521715
in: path
@@ -21790,7 +21790,7 @@ paths:
2179021790
description: Places a new order. There are several types of orders available - Market, Limit, TWAP and SteadyPace (with or without a limit). Orders can only be placed if your account has a sufficient balance. When an order is placed, funds will be reserved for the amount of the order.
2179121791
operationId: trade.orders.add
2179221792
tags:
21793-
- Orders
21793+
- Trade REST API
2179421794
parameters:
2179521795
- name: accountId
2179621796
in: path
@@ -21825,7 +21825,7 @@ paths:
2182521825
description: Get a single order by order id.
2182621826
operationId: trade.orders.order
2182721827
tags:
21828-
- Orders
21828+
- Trade REST API
2182921829
parameters:
2183021830
- name: accountId
2183121831
in: path
@@ -21862,7 +21862,7 @@ paths:
2186221862
description: Attempt to cancel an order that was previously placed. The response will return successful if the cancel request is submitted. Use Get Order endpoint or subscribe to the orders websocket to get the order details.
2186321863
operationId: trade.orders.order.cancel
2186421864
tags:
21865-
- Orders
21865+
- Trade REST API
2186621866
parameters:
2186721867
- name: accountId
2186821868
in: path
@@ -21895,7 +21895,7 @@ paths:
2189521895
description: Lists trades from the trading account. This will include trades that have not yet settled.
2189621896
operationId: trade.trades
2189721897
tags:
21898-
- Orders
21898+
- Trade REST API
2189921899
parameters:
2190021900
- name: accountId
2190121901
in: path
@@ -21970,7 +21970,7 @@ paths:
2197021970
description: Get the details of a single trade by trade id.
2197121971
operationId: trade.trades.trade
2197221972
tags:
21973-
- Orders
21973+
- Trade REST API
2197421974
parameters:
2197521975
- name: accountId
2197621976
in: path
@@ -22007,7 +22007,7 @@ paths:
2200722007
description: Gets a list of all available currencies.
2200822008
operationId: trade.currencies
2200922009
tags:
22010-
- Products
22010+
- Trade REST API
2201122011
parameters:
2201222012
- name: accountId
2201322013
in: path
@@ -22041,7 +22041,7 @@ paths:
2204122041
description: Gets a list of all available products.
2204222042
operationId: trade.products
2204322043
tags:
22044-
- Products
22044+
- Trade REST API
2204522045
parameters:
2204622046
- name: accountId
2204722047
in: path
@@ -22075,7 +22075,7 @@ paths:
2207522075
description: Gets a snapshot of the level1 order book for product
2207622076
operationId: trade.products.product.level1
2207722077
tags:
22078-
- Order Book
22078+
- Trade REST API
2207922079
parameters:
2208022080
- name: accountId
2208122081
in: path
@@ -22112,7 +22112,7 @@ paths:
2211222112
description: Gets a snapshot of the order book for product
2211322113
operationId: products.product.level2
2211422114
tags:
22115-
- Order Book
22115+
- Trade REST API
2211622116
parameters:
2211722117
- name: accountId
2211822118
in: path
@@ -22149,7 +22149,7 @@ paths:
2214922149
description: Returns the list of currencies that are available for use as collateral.
2215022150
operationId: trade.margin.collateral.currencies.list
2215122151
tags:
22152-
- Margin
22152+
- Trade REST API
2215322153
parameters:
2215422154
- name: accountID
2215522155
in: path
@@ -22176,7 +22176,7 @@ paths:
2217622176
description: Returns the balance of assets deposited as collateral for the specified account.
2217722177
operationId: trade.margin.collateral.transferred.list
2217822178
tags:
22179-
- Margin
22179+
- Trade REST API
2218022180
parameters:
2218122181
- name: accountID
2218222182
in: path
@@ -22221,7 +22221,7 @@ paths:
2222122221
description: Returns the margin risk settings for the specified account.
2222222222
operationId: trade.margin.risksettings.get
2222322223
tags:
22224-
- Margin
22224+
- Trade REST API
2222522225
parameters:
2222622226
- name: accountID
2222722227
in: path
@@ -22267,7 +22267,7 @@ paths:
2226722267
description: Returns the net open positions for the specified account.
2226822268
operationId: trade.margin.netopenpositions.get
2226922269
tags:
22270-
- Margin
22270+
- Trade REST API
2227122271
parameters:
2227222272
- name: accountID
2227322273
in: path
@@ -22301,7 +22301,7 @@ paths:
2230122301
description: Returns the asset-specific net open position limits for the specified account.
2230222302
operationId: trade.margin.netopenpositionlimits.get
2230322303
tags:
22304-
- Margin
22304+
- Trade REST API
2230522305
parameters:
2230622306
- name: accountID
2230722307
in: path
@@ -22327,7 +22327,7 @@ paths:
2232722327
description: Runs margin calculations and returns the margin risk profile for the specified account.
2232822328
operationId: trade.margin.riskprofile.get
2232922329
tags:
22330-
- Margin
22330+
- Trade REST API
2233122331
parameters:
2233222332
- name: accountID
2233322333
in: path
@@ -22399,7 +22399,7 @@ paths:
2239922399
description: Transfers collateral for the specified account.
2240022400
operationId: trade.margin.collateral.transfer
2240122401
tags:
22402-
- Margin
22402+
- Trade REST API
2240322403
parameters:
2240422404
- name: accountID
2240522405
in: path
@@ -22452,7 +22452,7 @@ paths:
2245222452
description: Transfers the amount specified to cover margin position for the specified account.
2245322453
operationId: trade.margin.positions.transfer
2245422454
tags:
22455-
- Margin
22455+
- Trade REST API
2245622456
parameters:
2245722457
- name: accountID
2245822458
in: path
@@ -22505,7 +22505,7 @@ paths:
2250522505
description: Transfers the exact amount to cover all short margin positions for the specified account.
2250622506
operationId: trade.margin.positions.cover
2250722507
tags:
22508-
- Margin
22508+
- Trade REST API
2250922509
parameters:
2251022510
- name: accountID
2251122511
in: path
@@ -22571,7 +22571,7 @@ paths:
2257122571
description: Starts an asynchronous process to automatically close all positions by selling and buying assets to attempt to net them to zero.
2257222572
operationId: trade.margin.positions.close
2257322573
tags:
22574-
- Margin
22574+
- Trade REST API
2257522575
parameters:
2257622576
- name: accountID
2257722577
in: path

0 commit comments

Comments
 (0)