Skip to content

Commit 3455645

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

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

api.yaml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27865,6 +27865,7 @@ paths:
2786527865
summary: Cancel staking request
2786627866
description: Cancel an existing staking request.
2786727867
operationId: v1.staking.request.cancel
27868+
x-internal: false
2786827869
parameters:
2786927870
- $ref: '#/components/parameters/pathCoin2'
2787027871
- $ref: '#/components/parameters/pathWalletId1'
@@ -27895,6 +27896,7 @@ paths:
2789527896
summary: Retry staking request
2789627897
description: Try to resubmit the failed staking transaction
2789727898
operationId: v1.staking.request.retry
27899+
x-internal: false
2789827900
parameters:
2789927901
- $ref: '#/components/parameters/pathCoin2'
2790027902
- $ref: '#/components/parameters/pathStakingRequestId'
@@ -27924,6 +27926,7 @@ paths:
2792427926
summary: Create staking request
2792527927
description: Create a staking request of type STAKE or UNSTAKE.
2792627928
operationId: v1.staking.request.create
27929+
x-internal: false
2792727930
parameters:
2792827931
- $ref: '#/components/parameters/pathCoin2'
2792927932
- $ref: '#/components/parameters/pathWalletId1'
@@ -28467,6 +28470,7 @@ paths:
2846728470
summary: List staking requests by asset
2846828471
description: Retrieve staking requests for a user's wallet.
2846928472
operationId: v1.user.staking.request
28473+
x-internal: false
2847028474
parameters:
2847128475
- $ref: '#/components/parameters/pathCoin2'
2847228476
- $ref: '#/components/parameters/pathWalletId1'
@@ -28515,6 +28519,7 @@ paths:
2851528519
summary: List Staking Requests for a Wallet
2851628520
description: List staking requests for a wallet.
2851728521
operationId: v1.staking.request.list
28522+
x-internal: false
2851828523
parameters:
2851928524
- $ref: '#/components/parameters/pathWalletId1'
2852028525
- $ref: '#/components/parameters/queryCoins'
@@ -28595,6 +28600,7 @@ paths:
2859528600
summary: List staking requests by ID
2859628601
description: Retrieve A Specific Staking Request.
2859728602
operationId: v1.staking.request
28603+
x-internal: false
2859828604
parameters:
2859928605
- $ref: '#/components/parameters/pathStakingRequestId'
2860028606
- $ref: '#/components/parameters/queryExpandBuildParams'
@@ -28652,6 +28658,7 @@ paths:
2865228658
summary: List staking requests by enterprise
2865328659
description: Retrieve staking requests and staking transactions for a given enterprise and query params.
2865428660
operationId: v1.staking.transactions
28661+
x-internal: false
2865528662
parameters:
2865628663
- $ref: '#/components/parameters/pathEnterpriseId1'
2865728664
- $ref: '#/components/parameters/queryCoins'
@@ -28750,6 +28757,7 @@ paths:
2875028757
summary: Get a staking transaction
2875128758
description: Retrieve details of a staking transaction for a given wallet and staking request.
2875228759
operationId: v1.staking.transaction.get
28760+
x-internal: false
2875328761
parameters:
2875428762
- $ref: '#/components/parameters/pathCoin2'
2875528763
- $ref: '#/components/parameters/pathWalletId1'
@@ -28804,6 +28812,7 @@ paths:
2880428812
summary: Sign staking transaction
2880528813
description: Use to act on a transaction like sending a transaction
2880628814
operationId: v1.staking.transaction.act
28815+
x-internal: false
2880728816
parameters:
2880828817
- $ref: '#/components/parameters/pathCoin2'
2880928818
- $ref: '#/components/parameters/pathWalletId1'
@@ -28865,6 +28874,7 @@ paths:
2886528874
summary: List staking details by wallet
2886628875
description: Get staking wallet information including staking delegated balance, rewards accrued, and rewards accrual annual percentage rate.
2886728876
operationId: v1.stakingWallet.get
28877+
x-internal: false
2886828878
parameters:
2886928879
- $ref: '#/components/parameters/pathCoin2'
2887028880
- $ref: '#/components/parameters/pathWalletId1'
@@ -28903,6 +28913,7 @@ paths:
2890328913
summary: List staking delegations
2890428914
description: Retrieve staking wallet delegation information.
2890528915
operationId: v1.staking.wallet.delegations
28916+
x-internal: false
2890628917
parameters:
2890728918
- $ref: '#/components/parameters/pathCoin2'
2890828919
- $ref: '#/components/parameters/pathWalletId1'
@@ -28996,6 +29007,7 @@ paths:
2899629007
summary: Get staking totals at the enterprise level
2899729008
description: Retrieve staking totals across all coins for a given enterprise, including delegated balances, rewards, and staking metadata.
2899829009
operationId: v1.staking.enterprise.allCoins
29010+
x-internal: false
2899929011
parameters:
2900029012
- $ref: '#/components/parameters/pathEnterpriseId1'
2900129013
- $ref: '#/components/parameters/queryPage'
@@ -29032,6 +29044,7 @@ paths:
2903229044
summary: List staking details by enterprise
2903329045
description: Retrieve staking information such as delegated balance, rewards accrued, and rewards accrual annual percentage rate.
2903429046
operationId: v1.staking.enterprise
29047+
x-internal: false
2903529048
parameters:
2903629049
- $ref: '#/components/parameters/pathCoin2'
2903729050
- $ref: '#/components/parameters/pathEnterpriseId1'
@@ -29064,6 +29077,7 @@ paths:
2906429077
summary: List staking details by enterprise tokens
2906529078
description: Retrieve staking information at the enterprise and token level.
2906629079
operationId: v1.staking.enterprise.tokens
29080+
x-internal: false
2906729081
parameters:
2906829082
- $ref: '#/components/parameters/pathCoin2'
2906929083
- $ref: '#/components/parameters/pathEnterpriseId1'
@@ -29093,6 +29107,7 @@ paths:
2909329107
summary: Get staking reward history
2909429108
description: Retrieve staking reward history.
2909529109
operationId: v1.staking.reward.history
29110+
x-internal: false
2909629111
parameters:
2909729112
- $ref: '#/components/parameters/pathCoin2'
2909829113
- name: enterpriseId
@@ -29225,11 +29240,13 @@ paths:
2922529240
$ref: '#/components/responses/InternalServerError1'
2922629241
/api/staking/v1/{coin}/wallets/{walletId}/delegations/accruals:
2922729242
get:
29243+
deprecated: true
2922829244
tags:
2922929245
- Staking History
2923029246
summary: Get staking accrual history
29231-
description: Retrieve staking delegation accrual history.
29247+
description: '**Deprecated.** This endpoint is being decommissioned. Please use `/{coin}/reward-accrual-report` (https://app.bitgo-test.com/api/staking/v1/{coin}/reward-accrual-report) for reward reports. Retrieve staking delegation accrual history.'
2923229248
operationId: v1.staking.reward.accrual
29249+
x-internal: false
2923329250
parameters:
2923429251
- $ref: '#/components/parameters/pathCoin2'
2923529252
- $ref: '#/components/parameters/pathWalletId1'
@@ -29282,6 +29299,7 @@ paths:
2928229299
summary: List staking wallet tokens
2928329300
description: Get staking wallets for a specific wallet ID that has been used for staking tokens.
2928429301
operationId: v1.staking.wallet.tokens
29302+
x-internal: false
2928529303
parameters:
2928629304
- $ref: '#/components/parameters/pathCoin2'
2928729305
- $ref: '#/components/parameters/pathWalletId1'
@@ -29313,6 +29331,7 @@ paths:
2931329331
summary: Get staking requirements
2931429332
description: Retrieve staking wallet state attribute information.
2931529333
operationId: v1.staking.wallet.attributes
29334+
x-internal: false
2931629335
parameters:
2931729336
- $ref: '#/components/parameters/pathCoin2'
2931829337
- $ref: '#/components/parameters/pathWalletId1'
@@ -29371,6 +29390,7 @@ paths:
2937129390
summary: List coins available for staking
2937229391
description: Retrieve a list of coins available for staking and additional information.
2937329392
operationId: v1.staking.coins
29393+
x-internal: false
2937429394
parameters:
2937529395
- $ref: '#/components/parameters/queryPage'
2937629396
- $ref: '#/components/parameters/queryPageSize1'
@@ -29411,6 +29431,7 @@ paths:
2941129431
summary: List staking validators for a wallet
2941229432
description: Returns a list of staking validators for a wallet, and includes the total delegated amount and the amount of accrued rewards.
2941329433
operationId: v1.validators.list
29434+
x-internal: false
2941429435
parameters:
2941529436
- $ref: '#/components/parameters/pathCoin2'
2941629437
- $ref: '#/components/parameters/pathWalletId1'
@@ -29465,6 +29486,7 @@ paths:
2946529486
summary: List staking partnered validators
2946629487
description: Returns a list of staking partnered validators.
2946729488
operationId: v1.partneredValidators.list
29489+
x-internal: false
2946829490
parameters:
2946929491
- $ref: '#/components/parameters/coin1'
2947029492
- name: enterpriseId
@@ -29536,6 +29558,7 @@ paths:
2953629558
summary: Get staking license
2953729559
description: Returns a staking license for the given enterprise.
2953829560
operationId: v1.license
29561+
x-internal: false
2953929562
parameters:
2954029563
- $ref: '#/components/parameters/pathEnterpriseId1'
2954129564
responses:
@@ -29565,6 +29588,7 @@ paths:
2956529588
summary: List staking rewards
2956629589
description: Returns total rewards per staking wallet for an enterprise.
2956729590
operationId: v1.enterprise.stakingWallets.list
29591+
x-internal: false
2956829592
parameters:
2956929593
- $ref: '#/components/parameters/pathEnterpriseId1'
2957029594
- $ref: '#/components/parameters/queryCoins'
@@ -29609,6 +29633,7 @@ paths:
2960929633
summary: Get list of stake-able coins
2961029634
description: Returns a paginated list of stake-able coins for the given enterprise with basic attributes.
2961129635
operationId: v1.enterprise.stakingCoins.list
29636+
x-internal: false
2961229637
parameters:
2961329638
- $ref: '#/components/parameters/pathEnterpriseId1'
2961429639
- $ref: '#/components/parameters/queryPage'
@@ -29643,6 +29668,7 @@ paths:
2964329668
summary: List coins available to enterprise for staking
2964429669
description: Retrieve a list of coins available for staking.
2964529670
operationId: v1.enterprise.stakeableCoins
29671+
x-internal: false
2964629672
parameters:
2964729673
- $ref: '#/components/parameters/pathEnterpriseId1'
2964829674
responses:

0 commit comments

Comments
 (0)