Skip to content

Commit acde388

Browse files
Merge pull request #105 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 1c6f143 + e7b56e1 commit acde388

File tree

1 file changed

+6
-123
lines changed

1 file changed

+6
-123
lines changed

api.yaml

Lines changed: 6 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -18970,52 +18970,6 @@ paths:
1897018970
properties:
1897118971
isValid:
1897218972
type: boolean
18973-
/api/v2/{coin}/wallet/{walletId}/balances/staked:
18974-
get:
18975-
tags:
18976-
- Wallet
18977-
summary: Get staked balance data
18978-
description: Returns staking information about validator and staked amount for the current wallet. Currently only available for Casper and Stacks.
18979-
operationId: v2.wallet.staked
18980-
parameters:
18981-
- $ref: '#/components/parameters/pathCoin'
18982-
- $ref: '#/components/parameters/pathWalletId'
18983-
responses:
18984-
'200':
18985-
description: OK
18986-
content:
18987-
application/json:
18988-
schema:
18989-
$ref: '#/components/schemas/BalanceStaked'
18990-
'400':
18991-
description: Bad Request
18992-
content:
18993-
application/json:
18994-
schema:
18995-
$ref: '#/components/schemas/PlatformError3'
18996-
/api/v2/{coin}/wallet/{walletId}/balances/totalrewards:
18997-
get:
18998-
tags:
18999-
- Wallet
19000-
summary: Get total rewards data
19001-
description: Returns staking information receiving address and the total rewards received for the current wallet. Currently only available for Stacks.
19002-
operationId: v2.wallet.totalrewards
19003-
parameters:
19004-
- $ref: '#/components/parameters/pathCoin'
19005-
- $ref: '#/components/parameters/pathWalletId'
19006-
responses:
19007-
'200':
19008-
description: OK
19009-
content:
19010-
application/json:
19011-
schema:
19012-
$ref: '#/components/schemas/BalanceTotalRewards'
19013-
'400':
19014-
description: Bad Request
19015-
content:
19016-
application/json:
19017-
schema:
19018-
$ref: '#/components/schemas/PlatformError3'
1901918973
/api/v2/{coin}/wallet/{walletId}/state:
1902018974
get:
1902118975
tags:
@@ -23845,6 +23799,7 @@ paths:
2384523799
- adminCreateReport
2384623800
- updateWalletApprovalsRequired
2384723801
- custodialHotRetrySignTx
23802+
- createUser
2384823803
- name: userId
2384923804
description: The user ID to filter by
2385023805
in: query
@@ -32849,7 +32804,6 @@ components:
3284932804
- $ref: '#/components/schemas/FiatAddress'
3285032805
- $ref: '#/components/schemas/HederaAddress'
3285132806
- $ref: '#/components/schemas/OffchainAddressSubdocument'
32852-
- $ref: '#/components/schemas/SilvergateUSDAddress'
3285332807
- $ref: '#/components/schemas/SolAddress'
3285432808
- $ref: '#/components/schemas/StacksAddress'
3285532809
- $ref: '#/components/schemas/StellarAddress'
@@ -33846,6 +33800,7 @@ components:
3384633800
- adminCreateReport
3384733801
- updateWalletApprovalsRequired
3384833802
- custodialHotRetrySignTx
33803+
- createUser
3384933804
AuditableItem:
3385033805
type: object
3385133806
properties:
@@ -34063,56 +34018,6 @@ components:
3406334018
type: integer
3406434019
description: the height of the block that provides the base values
3406534020
example: 11228504
34066-
BalanceStaked:
34067-
type: array
34068-
items:
34069-
type: object
34070-
properties:
34071-
address:
34072-
allOf:
34073-
- type: string
34074-
- $ref: '#/components/schemas/AddressString3'
34075-
description: the address of the wallet
34076-
balances:
34077-
type: array
34078-
items:
34079-
type: object
34080-
description: an object containing of validators and the current staked amount
34081-
properties:
34082-
validator:
34083-
allOf:
34084-
- type: string
34085-
- $ref: '#/components/schemas/AddressString3'
34086-
description: the validator
34087-
staked_amount:
34088-
type: string
34089-
description: the amount delegated to the validator
34090-
example: '5000000000'
34091-
BalanceTotalRewards:
34092-
type: array
34093-
items:
34094-
type: object
34095-
properties:
34096-
address:
34097-
allOf:
34098-
- type: string
34099-
- $ref: '#/components/schemas/AddressString3'
34100-
description: the address of the wallet
34101-
rewards:
34102-
type: array
34103-
items:
34104-
type: object
34105-
description: an object containing the reward recipient address and the total rewards received
34106-
properties:
34107-
reward_recipient:
34108-
allOf:
34109-
- type: string
34110-
- $ref: '#/components/schemas/AddressString3'
34111-
description: the receiving address
34112-
reward_amount:
34113-
type: string
34114-
description: the total rewards received
34115-
example: '5000000000'
3411634021
BankAccountCurrency:
3411734022
title: BankAccountCurrency
3411834023
description: |
@@ -34908,10 +34813,13 @@ components:
3490834813
required:
3490934814
- maxFeePerGas
3491034815
- maxPriorityFeePerGas
34816+
nextContractSequenceId:
34817+
type: number
3491134818
required:
3491234819
- txHex
3491334820
- txInfo
3491434821
- recipients
34822+
- nextContractSequenceId
3491534823
BusinessModel:
3491634824
title: BusinessModel
3491734825
type: string
@@ -36476,8 +36384,6 @@ components:
3647636384
properties:
3647736385
signingBitgoOrg:
3647836386
$ref: '#/components/schemas/BitgoOrg'
36479-
required:
36480-
- signingBitgoOrg
3648136387
DistributedCustodyUpdateEnterprise:
3648236388
type: object
3648336389
description: Parameters associated with distributed custody enterprises. If you want to remove 'signingBitgoOrg', set it to null.
@@ -38832,7 +38738,7 @@ components:
3883238738
- onchain
3883338739
- tss
3883438740
- blsdkg
38835-
description: If absent, BitGo uses the default wallet type for the asset. For Solana wallets, this parameter is required and must be set to 'tss'.
38741+
description: If absent, BitGo uses the default wallet type for the asset.
3883638742
type:
3883738743
type: string
3883838744
enum:
@@ -48468,28 +48374,6 @@ components:
4846848374
- from
4846948375
- to
4847048376
- share
48471-
SilvergateUSDAddress:
48472-
title: Silvergate USD Address
48473-
type: object
48474-
properties:
48475-
bankAccountId:
48476-
type: string
48477-
bankAccount:
48478-
$ref: '#/components/schemas/BankAccountJson'
48479-
required:
48480-
- bankAccountId
48481-
SilvergateUSDWallet:
48482-
title: Silvergate USD Wallet
48483-
type: object
48484-
properties:
48485-
backingBankAccountId: {}
48486-
backingSENBankAccountId: {}
48487-
lastUsedNonce:
48488-
type: number
48489-
required:
48490-
- backingBankAccountId
48491-
- backingSENBankAccountId
48492-
- lastUsedNonce
4849348377
SimulateEnterpriseWebhookResponseBody:
4849448378
title: SimulateEnterpriseWebhookResponseBody
4849548379
type: object
@@ -56851,7 +56735,6 @@ components:
5685156735
- $ref: '#/components/schemas/HederaWallet'
5685256736
- $ref: '#/components/schemas/NearWallet'
5685356737
- $ref: '#/components/schemas/Offchain'
56854-
- $ref: '#/components/schemas/SilvergateUSDWallet'
5685556738
- $ref: '#/components/schemas/StacksWallet'
5685656739
- $ref: '#/components/schemas/TestcoinWallet'
5685756740
- $ref: '#/components/schemas/TonWallet'

0 commit comments

Comments
 (0)