Skip to content

Commit 1e96f42

Browse files
dev-portal-updater-protected[bot]dev-portal-updater-protected[bot]
authored
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 8e47fe8 commit 1e96f42

1 file changed

Lines changed: 247 additions & 0 deletions

File tree

‎api.yaml‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33259,6 +33259,76 @@ paths:
3325933259
application/json:
3326033260
schema:
3326133261
$ref: '#/components/schemas/PlatformError'
33262+
/api/v2/{coin}/wallet/{walletId}/delegateResources/build:
33263+
post:
33264+
summary: Build bulk resource delegation transactions
33265+
description: |-
33266+
Builds one delegation transaction per entry, collecting per-entry errors
33267+
rather than aborting the batch on first failure.
33268+
operationId: v2.wallet.delegateresources.build
33269+
tags:
33270+
- Wallet
33271+
x-internal: false
33272+
parameters:
33273+
- name: coin
33274+
description: The coin ticker symbol (e.g. 'trx', 'ttrx')
33275+
in: path
33276+
required: true
33277+
schema:
33278+
allOf:
33279+
- $ref: '#/components/schemas/CoinString'
33280+
- name: walletId
33281+
description: The wallet ID
33282+
in: path
33283+
required: true
33284+
schema:
33285+
allOf:
33286+
- $ref: '#/components/schemas/WalletIdString'
33287+
requestBody:
33288+
content:
33289+
application/json:
33290+
schema:
33291+
type: object
33292+
description: |-
33293+
Build Resource Delegations Request Body
33294+
33295+
Request body for building bulk resource delegation transactions.
33296+
Each entry delegates a resource (ENERGY or BANDWIDTH) from the wallet's root address to a receiver address.
33297+
properties:
33298+
delegations:
33299+
type: array
33300+
items:
33301+
type: object
33302+
properties:
33303+
receiverAddress:
33304+
type: string
33305+
description: The address receiving the delegated resource
33306+
amount:
33307+
type: string
33308+
description: Amount of resource to delegate (in sun for TRX)
33309+
resource:
33310+
type: string
33311+
description: Resource type to delegate, e.g. 'ENERGY' or 'BANDWIDTH'
33312+
required:
33313+
- receiverAddress
33314+
- amount
33315+
- resource
33316+
description: Array of resource delegation entries, each specifying a receiver address, amount, and resource type
33317+
required:
33318+
- delegations
33319+
responses:
33320+
'200':
33321+
description: OK
33322+
content:
33323+
application/json:
33324+
schema:
33325+
$ref: '#/components/schemas/BuildDelegationsResponse'
33326+
'400':
33327+
description: Bad Request
33328+
content:
33329+
application/json:
33330+
schema:
33331+
$ref: '#/components/schemas/PlatformError'
3326233332
/api/v2/{coin}/wallet/{walletId}/forwarders/balances:
3326333333
get:
3326433334
summary: List forwarder addresses and balances
@@ -33804,6 +33874,76 @@ paths:
3380433874
application/json:
3380533875
schema:
3380633876
$ref: '#/components/schemas/PlatformError'
33877+
/api/v2/{coin}/wallet/{walletId}/undelegateResources/build:
33878+
post:
33879+
summary: Build bulk resource undelegation transactions
33880+
description: |-
33881+
Builds one undelegation transaction per entry, collecting per-entry errors
33882+
rather than aborting the batch on first failure.
33883+
operationId: v2.wallet.undelegateresources.build
33884+
tags:
33885+
- Wallet
33886+
x-internal: false
33887+
parameters:
33888+
- name: coin
33889+
description: The coin ticker symbol (e.g. 'trx', 'ttrx')
33890+
in: path
33891+
required: true
33892+
schema:
33893+
allOf:
33894+
- $ref: '#/components/schemas/CoinString'
33895+
- name: walletId
33896+
description: The wallet ID
33897+
in: path
33898+
required: true
33899+
schema:
33900+
allOf:
33901+
- $ref: '#/components/schemas/WalletIdString'
33902+
requestBody:
33903+
content:
33904+
application/json:
33905+
schema:
33906+
type: object
33907+
description: |-
33908+
Build Resource Undelegations Request Body
33909+
33910+
Request body for building bulk resource undelegation transactions.
33911+
Each entry undelegates a resource (ENERGY or BANDWIDTH) previously delegated from the wallet's root address.
33912+
properties:
33913+
undelegations:
33914+
type: array
33915+
items:
33916+
type: object
33917+
properties:
33918+
receiverAddress:
33919+
type: string
33920+
description: The address receiving the delegated resource
33921+
amount:
33922+
type: string
33923+
description: Amount of resource to delegate (in sun for TRX)
33924+
resource:
33925+
type: string
33926+
description: Resource type to delegate, e.g. 'ENERGY' or 'BANDWIDTH'
33927+
required:
33928+
- receiverAddress
33929+
- amount
33930+
- resource
33931+
description: Array of resource undelegation entries, each specifying a receiver address, amount, and resource type
33932+
required:
33933+
- undelegations
33934+
responses:
33935+
'200':
33936+
description: OK
33937+
content:
33938+
application/json:
33939+
schema:
33940+
$ref: '#/components/schemas/BuildDelegationsResponse'
33941+
'400':
33942+
description: Bad Request
33943+
content:
33944+
application/json:
33945+
schema:
33946+
$ref: '#/components/schemas/PlatformError'
3380733947
/api/v2/{coin}/wallet/{walletId}/unspents:
3380833948
get:
3380933949
summary: List unspents on a wallet
@@ -35893,6 +36033,7 @@ paths:
3589336033
- holdingsByAddress
3589436034
- userAccess
3589536035
- policies
36036+
- costBasis
3589636037
- organizationHoldings
3589736038
- organizationHoldingsByAddress
3589836039
- organizationTransactions
@@ -36384,6 +36525,33 @@ paths:
3638436525
minLength: 1
3638536526
required:
3638636527
- enterprise
36528+
costBasis:
36529+
type: object
36530+
description: Cost basis report
36531+
properties:
36532+
account:
36533+
type: string
36534+
assets:
36535+
type: array
36536+
items:
36537+
type: string
36538+
minLength: 1
36539+
endDate:
36540+
type: string
36541+
description: Date of the snapshot
36542+
format: date-time
36543+
title: ISO Date String
36544+
enterprise:
36545+
$ref: '#/components/schemas/EnterpriseIdNonEmptyString'
36546+
startDate:
36547+
type: string
36548+
description: Date of the snapshot
36549+
format: date-time
36550+
title: ISO Date String
36551+
required:
36552+
- endDate
36553+
- enterprise
36554+
- startDate
3638736555
required:
3638836556
- type
3638936557
- format
@@ -37589,6 +37757,7 @@ paths:
3758937757
- holdingsByAddress
3759037758
- userAccess
3759137759
- policies
37760+
- costBasis
3759237761
- organizationHoldings
3759337762
- organizationHoldingsByAddress
3759437763
- organizationTransactions
@@ -38078,6 +38247,33 @@ paths:
3807838247
minLength: 1
3807938248
required:
3808038249
- enterprise
38250+
costBasis:
38251+
type: object
38252+
description: Cost basis report
38253+
properties:
38254+
account:
38255+
type: string
38256+
assets:
38257+
type: array
38258+
items:
38259+
type: string
38260+
minLength: 1
38261+
endDate:
38262+
type: string
38263+
description: Date of the snapshot
38264+
format: date-time
38265+
title: ISO Date String
38266+
enterprise:
38267+
$ref: '#/components/schemas/EnterpriseIdNonEmptyString'
38268+
startDate:
38269+
type: string
38270+
description: Date of the snapshot
38271+
format: date-time
38272+
title: ISO Date String
38273+
required:
38274+
- endDate
38275+
- enterprise
38276+
- startDate
3808138277
required:
3808238278
- type
3808338279
- format
@@ -53988,6 +54184,28 @@ components:
5398854184
type: string
5398954185
validatorAddress:
5399054186
type: string
54187+
BuildDelegationsResponse:
54188+
title: BuildDelegationsResponse
54189+
type: object
54190+
properties:
54191+
transactions:
54192+
type: array
54193+
items: {}
54194+
errors:
54195+
type: array
54196+
items:
54197+
type: object
54198+
properties:
54199+
receiverAddress:
54200+
type: string
54201+
message:
54202+
type: string
54203+
required:
54204+
- receiverAddress
54205+
- message
54206+
required:
54207+
- transactions
54208+
- errors
5399154209
BuildParams:
5399254210
type: object
5399354211
properties:
@@ -59804,6 +60022,7 @@ components:
5980460022
- holdingsByAddress
5980560023
- userAccess
5980660024
- policies
60025+
- costBasis
5980760026
EnterpriseStakingTotals:
5980860027
type: object
5980960028
properties:
@@ -75527,6 +75746,33 @@ components:
7552775746
minLength: 1
7552875747
required:
7552975748
- enterprise
75749+
costBasis:
75750+
type: object
75751+
description: Cost basis report
75752+
properties:
75753+
account:
75754+
type: string
75755+
assets:
75756+
type: array
75757+
items:
75758+
type: string
75759+
minLength: 1
75760+
endDate:
75761+
type: string
75762+
description: Date of the snapshot
75763+
format: date-time
75764+
title: ISO Date String
75765+
enterprise:
75766+
$ref: '#/components/schemas/EnterpriseIdNonEmptyString'
75767+
startDate:
75768+
type: string
75769+
description: Date of the snapshot
75770+
format: date-time
75771+
title: ISO Date String
75772+
required:
75773+
- endDate
75774+
- enterprise
75775+
- startDate
7553075776
ReportStatus1:
7553175777
title: ReportStatus
7553275778
type: string
@@ -77557,6 +77803,7 @@ components:
7755777803
- holdingsByAddress
7755877804
- userAccess
7755977805
- policies
77806+
- costBasis
7756077807
- organizationHoldings
7756177808
- organizationHoldingsByAddress
7756277809
- organizationTransactions

0 commit comments

Comments
 (0)