Skip to content

Commit fdd4e2d

Browse files
authored
Merge pull request #290 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 2474f95 + a9bfb87 commit fdd4e2d

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

api.yaml

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24175,6 +24175,7 @@ paths:
2417524175
explode: true
2417624176
schema:
2417724177
$ref: '#/components/schemas/OrderStatus'
24178+
- $ref: '#/components/parameters/FundingTypeQueryParam'
2417824179
responses:
2417924180
'200':
2418024181
description: An array of orders
@@ -24341,6 +24342,33 @@ paths:
2434124342
schema:
2434224343
type: string
2434324344
format: date-time
24345+
- name: creationDateGte
24346+
in: query
24347+
description: Return exchange trades with a creation date that is greater than or equal to the given timestamp
24348+
required: false
24349+
style: form
24350+
explode: true
24351+
schema:
24352+
type: string
24353+
format: date-time
24354+
- name: creationDateLt
24355+
in: query
24356+
description: Return exchange trades with a creation date that is less than the given timestamp
24357+
required: false
24358+
style: form
24359+
explode: true
24360+
schema:
24361+
type: string
24362+
format: date-time
24363+
- name: isSettled
24364+
in: query
24365+
description: Return trades based on settlement status. true for settled trades, false for unsettled trades.
24366+
required: false
24367+
style: form
24368+
explode: true
24369+
schema:
24370+
type: boolean
24371+
- $ref: '#/components/parameters/FundingTypeQueryParam'
2434424372
responses:
2434524373
'200':
2434624374
description: An array of trades
@@ -42428,6 +42456,15 @@ components:
4242842456
action.approvals.always.deny.parameters.actionId=ruleAction1
4242942457
action.parameters.bool=true
4243042458
action.parameters.userIds=user1,user2
42459+
FundingTypeQueryParam:
42460+
name: fundingType
42461+
in: query
42462+
description: Filter by funding type. 'funded' for available balance, 'margin' for margin balance.
42463+
required: false
42464+
style: form
42465+
explode: true
42466+
schema:
42467+
$ref: '#/components/schemas/FundingType'
4243142468
Interval:
4243242469
name: interval
4243342470
in: query
@@ -65948,11 +65985,13 @@ components:
6594865985
- id
6594965986
- orderId
6595065987
- time
65988+
- creationDate
6595165989
- product
6595265990
- side
6595365991
- price
6595465992
- quoteQuantity
6595565993
- quantity
65994+
- fundingType
6595665995
- settled
6595765996
type: object
6595865997
properties:
@@ -65965,6 +66004,11 @@ components:
6596566004
time:
6596666005
type: string
6596766006
format: date-time
66007+
description: The exchange trade date (when the trade occurred at the LP)
66008+
creationDate:
66009+
type: string
66010+
format: date-time
66011+
description: The date when the trade was created in our system
6596866012
product:
6596966013
type: string
6597066014
description: Product name e.g. BTC-USD
@@ -65981,17 +66025,21 @@ components:
6598166025
type: string
6598266026
format: decimal
6598366027
description: Base quantity, e.g. For BTC-USD product, 0.0045 BTC
66028+
fundingType:
66029+
$ref: '#/components/schemas/FundingType'
6598466030
settled:
6598566031
type: boolean
6598666032
example:
6598766033
id: 7e0c768e-2d16-4c1e-b39d-06fa20009397
6598866034
orderId: d50ec984-77a8-460a-b958-66f114b0de9b
65989-
time: '2025-11-26T15:27:41.5318Z'
66035+
time: '2025-11-26T15:27:35.1234Z'
66036+
creationDate: '2025-11-26T15:27:41.5318Z'
6599066037
side: buy
6599166038
product: BTC-USD
6599266039
quoteQuantity: '100.50'
6599366040
price: '22333.33'
6599466041
quantity: '0.0045'
66042+
fundingType: funded
6599566043
settled: true
6599666044
Product:
6599766045
required:

0 commit comments

Comments
 (0)