Skip to content

Commit 4bc8f87

Browse files
dev-portal-updater-unprotected[bot]dev-portal-updater-unprotected[bot]
authored
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 9c01e7a commit 4bc8f87

File tree

1 file changed

+165
-0
lines changed

1 file changed

+165
-0
lines changed

‎api.yaml‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22942,6 +22942,59 @@ paths:
2294222942
oneOf:
2294322943
- $ref: '#/components/schemas/PlatformError'
2294422944
- $ref: '#/components/schemas/InvalidWalletId'
22945+
/api/v2/{coin}/wallet/{walletId}/token/approval/build:
22946+
post:
22947+
summary: Build an approval transaction for ERC20 token
22948+
operationId: v2.wallet.token.approval.build
22949+
tags:
22950+
- Wallet
22951+
parameters:
22952+
- name: coin
22953+
in: path
22954+
required: true
22955+
schema:
22956+
$ref: '#/components/schemas/CoinNonEmptyString'
22957+
- name: walletId
22958+
in: path
22959+
required: true
22960+
schema:
22961+
$ref: '#/components/schemas/WalletIdNonEmptyString'
22962+
requestBody:
22963+
content:
22964+
application/json:
22965+
schema:
22966+
type: object
22967+
properties:
22968+
amount:
22969+
type: string
22970+
minLength: 1
22971+
gasLimit:
22972+
type: number
22973+
gasPrice:
22974+
type: number
22975+
eip1559:
22976+
type: object
22977+
properties:
22978+
maxFeePerGas:
22979+
type: number
22980+
maxPriorityFeePerGas:
22981+
type: number
22982+
required:
22983+
- maxFeePerGas
22984+
- maxPriorityFeePerGas
22985+
responses:
22986+
'200':
22987+
description: OK
22988+
content:
22989+
application/json:
22990+
schema:
22991+
$ref: '#/components/schemas/BuildTokenApprovalResponse'
22992+
'400':
22993+
description: Bad Request
22994+
content:
22995+
application/json:
22996+
schema:
22997+
$ref: '#/components/schemas/PlatformError'
2294522998
/api/v2/{coin}/wallet/{walletId}/tx/changeFee:
2294622999
post:
2294723000
summary: Change Fee
@@ -23046,6 +23099,15 @@ paths:
2304623099
- 'true'
2304723100
- 'false'
2304823101
default: 'false'
23102+
- name: includeStakingBalances
23103+
description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet.
23104+
in: query
23105+
schema:
23106+
type: string
23107+
enum:
23108+
- 'true'
23109+
- 'false'
23110+
default: 'false'
2304923111
- name: coin
2305023112
in: path
2305123113
required: true
@@ -26981,6 +27043,15 @@ paths:
2698127043
type: string
2698227044
example: 59cd72485007a239fb00282ed480da1f
2698327045
pattern: ^[0-9a-f]{32}$
27046+
- name: includeStakingBalances
27047+
description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet.
27048+
in: query
27049+
schema:
27050+
type: string
27051+
enum:
27052+
- 'true'
27053+
- 'false'
27054+
default: 'false'
2698427055
- name: labelContains
2698527056
description: Filter by label substring
2698627057
in: query
@@ -27175,6 +27246,15 @@ paths:
2717527246
enum:
2717627247
- 'true'
2717727248
- 'false'
27249+
- name: includeStakingBalances
27250+
description: Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet. Requires 'expandBalance' to be set to true.
27251+
in: query
27252+
schema:
27253+
type: string
27254+
enum:
27255+
- 'true'
27256+
- 'false'
27257+
default: 'false'
2717827258
- name: limit
2717927259
description: Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.
2718027260
in: query
@@ -33618,6 +33698,44 @@ components:
3361833698
format: date-time
3361933699
description: Required. The time that the unspent reservations should expire.
3362033700
description: Optional parameter for UTXO coins to automatically reserve the unspents that are used in the build. Useful for Cold wallets. If using, must set expireTime.
33701+
BuildTokenApprovalResponse:
33702+
title: BuildTokenApprovalResponse
33703+
type: object
33704+
properties:
33705+
txHex:
33706+
type: string
33707+
txInfo:
33708+
type: object
33709+
properties:
33710+
amount:
33711+
type: string
33712+
contractAddress:
33713+
type: string
33714+
spender:
33715+
type: string
33716+
required:
33717+
- amount
33718+
- contractAddress
33719+
- spender
33720+
recipients:
33721+
type: array
33722+
items:
33723+
type: object
33724+
properties:
33725+
address:
33726+
type: string
33727+
amount:
33728+
type: string
33729+
data:
33730+
type: string
33731+
required:
33732+
- address
33733+
- amount
33734+
- data
33735+
required:
33736+
- txHex
33737+
- txInfo
33738+
- recipients
3362133739
BusinessModel:
3362233740
title: BusinessModel
3362333741
type: string
@@ -39400,6 +39518,12 @@ components:
3940039518
spendableBalanceString:
3940139519
type: string
3940239520
description: String representation of the spendable in base units. Guaranteed to not lose precision. Will not be included if 'excludeSpendableBalances=false'
39521+
stakingBalanceString:
39522+
type: string
39523+
description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
39524+
rewardBalanceString:
39525+
type: string
39526+
description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
3940339527
required:
3940439528
- coin
3940539529
- balanceString
@@ -40023,6 +40147,22 @@ components:
4002340147
type: boolean
4002440148
description: true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
4002540149
example: false
40150+
InquiryStatus:
40151+
title: InquiryStatus
40152+
type: string
40153+
enum:
40154+
- completed
40155+
- failed
40156+
InquirySubType:
40157+
title: InquirySubType
40158+
type: string
40159+
enum:
40160+
- withdrawalLivenessCheck
40161+
InquiryType:
40162+
title: InquiryType
40163+
type: string
40164+
enum:
40165+
- livenessCheck
4002640166
InscriptionId:
4002740167
type: string
4002840168
description: The ID of the inscription in the form <txid>i<vin>
@@ -43532,6 +43672,25 @@ components:
4353243672
enum:
4353343673
- frozen
4353443674
- unFrozen
43675+
associatedInquiries:
43676+
type: array
43677+
items:
43678+
type: object
43679+
properties:
43680+
inquiryId:
43681+
type: string
43682+
inquiryStatus:
43683+
$ref: '#/components/schemas/InquiryStatus'
43684+
inquirySubType:
43685+
$ref: '#/components/schemas/InquirySubType'
43686+
inquiryType:
43687+
$ref: '#/components/schemas/InquiryType'
43688+
required:
43689+
- inquiryId
43690+
- inquiryStatus
43691+
- inquirySubType
43692+
- inquiryType
43693+
description: Associated inquiries
4353543694
required:
4353643695
- id
4353743696
- creator
@@ -56111,6 +56270,12 @@ components:
5611156270
spendableBalanceString:
5611256271
type: string
5611356272
description: String representation of the total balance of all wallets containing the given coin which may be used as inputs for creating new transactions. Guaranteed to not lose precision.
56273+
stakingBalanceString:
56274+
type: string
56275+
description: The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
56276+
rewardBalanceString:
56277+
type: string
56278+
description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
5611456279
required:
5611556280
- balanceString
5611656281
- confirmedBalanceString

0 commit comments

Comments
 (0)