Skip to content

Commit f12e2c1

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

File tree

1 file changed

+170
-0
lines changed

1 file changed

+170
-0
lines changed

api.yaml

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27656,6 +27656,92 @@ paths:
2765627656
schema:
2765727657
type: object
2765827658
properties: {}
27659+
/api/stablecoin/v1/enterprise/{enterpriseId}/orders-summary:
27660+
get:
27661+
summary: Get orders summary for enterprise
27662+
description: |-
27663+
Returns aggregated order amounts and counts by asset.
27664+
Amounts are returned as strings in lowest denomination (no decimal formatting).
27665+
By default, includes all non-failed orders (created, pending, and fulfilled).
27666+
Use the optional status parameter to filter by specific order statuses.
27667+
operationId: stablecoin.v1.enterprise.orders.summary.get
27668+
tags:
27669+
- Stablecoin
27670+
parameters:
27671+
- name: stablecoin
27672+
description: Stablecoin name(s) to filter across all chains
27673+
in: query
27674+
schema:
27675+
oneOf:
27676+
- $ref: '#/components/schemas/BaseStablecoin'
27677+
- type: array
27678+
items:
27679+
type: string
27680+
enum:
27681+
- usd1
27682+
- gousd
27683+
example: usd1
27684+
- name: chain
27685+
description: Blockchain network identifier to filter summary
27686+
in: query
27687+
schema:
27688+
type: string
27689+
example: hteth
27690+
minLength: 1
27691+
- name: status
27692+
description: Order processing status(es) to filter summary - accepts only user-facing statuses
27693+
in: query
27694+
schema:
27695+
oneOf:
27696+
- type: array
27697+
items:
27698+
type: string
27699+
enum:
27700+
- created
27701+
- pending
27702+
- fulfilled
27703+
- type: string
27704+
enum:
27705+
- created
27706+
- pending
27707+
- fulfilled
27708+
example: created
27709+
- name: enterpriseId
27710+
description: Enterprise id
27711+
in: path
27712+
required: true
27713+
schema:
27714+
type: string
27715+
example: 67bc4ae090e8af8f9b412d3d67e85252
27716+
minLength: 1
27717+
responses:
27718+
'200':
27719+
description: OK
27720+
content:
27721+
application/json:
27722+
schema:
27723+
$ref: '#/components/schemas/GetOrdersSummaryResponse'
27724+
'400':
27725+
description: Bad Request
27726+
content:
27727+
application/json:
27728+
schema:
27729+
type: object
27730+
properties: {}
27731+
'404':
27732+
description: Not Found
27733+
content:
27734+
application/json:
27735+
schema:
27736+
type: object
27737+
properties: {}
27738+
'500':
27739+
description: Internal Server Error
27740+
content:
27741+
application/json:
27742+
schema:
27743+
type: object
27744+
properties: {}
2765927745
/api/stablecoin/v1/enterprise/{enterpriseId}/orders/{orderId}:
2766027746
get:
2766127747
summary: Get stablecoin order by ID
@@ -45108,6 +45194,12 @@ components:
4510845194
fee:
4510945195
description: The blockchain fee to submit the transactions.
4511045196
type: string
45197+
BaseStablecoin:
45198+
title: BaseStablecoin
45199+
type: string
45200+
enum:
45201+
- usd1
45202+
- gousd
4511145203
BaseStakeIntent:
4511245204
title: BaseStakeIntent
4511345205
allOf:
@@ -53891,6 +53983,39 @@ components:
5389153983
type: string
5389253984
required:
5389353985
- invoices
53986+
GetOrdersSummaryResponse:
53987+
title: GetOrdersSummaryResponse
53988+
type: object
53989+
properties:
53990+
byAsset:
53991+
type: object
53992+
additionalProperties:
53993+
type: object
53994+
properties:
53995+
chain:
53996+
type: string
53997+
description: Chain identifier
53998+
example: hteth
53999+
decimals:
54000+
type: number
54001+
description: Token decimals
54002+
example: 18
54003+
mint:
54004+
allOf:
54005+
- $ref: '#/components/schemas/OrderTypeSummary'
54006+
description: Mint order summary
54007+
burn:
54008+
allOf:
54009+
- $ref: '#/components/schemas/OrderTypeSummary'
54010+
description: Burn order summary
54011+
required:
54012+
- chain
54013+
- decimals
54014+
- mint
54015+
- burn
54016+
description: Breakdown by individual asset keyed by token identifier
54017+
required:
54018+
- byAsset
5389454019
GetPaymentsResponse:
5389554020
title: GetPaymentsResponse
5389654021
type: object
@@ -59565,6 +59690,51 @@ components:
5956559690
- canceled
5956659691
- error
5956759692
- scheduled
59693+
OrderStatusBreakdown:
59694+
title: OrderStatusBreakdown
59695+
type: object
59696+
properties:
59697+
count:
59698+
type: number
59699+
description: Number of orders in this status
59700+
example: 5
59701+
amount:
59702+
type: string
59703+
description: Total amount in lowest denomination
59704+
example: '45000000000000000000000000'
59705+
required:
59706+
- count
59707+
- amount
59708+
OrderTypeSummary:
59709+
title: OrderTypeSummary
59710+
type: object
59711+
properties:
59712+
amount:
59713+
type: string
59714+
description: Total amount in lowest denomination
59715+
example: '110002428000000000000000000'
59716+
count:
59717+
type: number
59718+
description: Total number of orders
59719+
example: 12
59720+
byStatus:
59721+
type: object
59722+
description: Breakdown by order status (only includes statuses with data)
59723+
example:
59724+
created:
59725+
count: 5
59726+
amount: '45000000000000000000000000'
59727+
properties:
59728+
created:
59729+
$ref: '#/components/schemas/OrderStatusBreakdown'
59730+
pending:
59731+
$ref: '#/components/schemas/OrderStatusBreakdown'
59732+
fulfilled:
59733+
$ref: '#/components/schemas/OrderStatusBreakdown'
59734+
required:
59735+
- amount
59736+
- count
59737+
- byStatus
5956859738
Orders:
5956959739
type: array
5957059740
items:

0 commit comments

Comments
 (0)