Skip to content

Commit 60f9bbd

Browse files
Merge pull request #410 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 530e009 + 1b1d745 commit 60f9bbd

1 file changed

Lines changed: 33 additions & 10 deletions

File tree

api.yaml

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11669,10 +11669,11 @@ paths:
1166911669
/api/go-staking/v1/{coin}/accounts/{accountId}/requests/{requestId}:
1167011670
get:
1167111671
tags:
11672-
- Go Account Staking (beta)
11672+
- Go Account Staking
1167311673
summary: Get staking request for Go Account
1167411674
description: Get a specific staking request for a given asset and Go Account.
1167511675
operationId: v1.goStaking.request.getById
11676+
x-internal: false
1167611677
parameters:
1167711678
- $ref: '#/components/parameters/pathCoin1'
1167811679
- $ref: '#/components/parameters/pathAccountId'
@@ -11697,10 +11698,11 @@ paths:
1169711698
/api/go-staking/v1/{coin}/accounts/{accountId}/requests:
1169811699
get:
1169911700
tags:
11700-
- Go Account Staking (beta)
11701+
- Go Account Staking
1170111702
summary: List staking requests by asset for Go Account
1170211703
description: List all staking requests for a given asset and Go Account.
1170311704
operationId: v1.goStaking.request.listByCoinAndAccount
11705+
x-internal: false
1170411706
parameters:
1170511707
- $ref: '#/components/parameters/pathCoin1'
1170611708
- $ref: '#/components/parameters/pathAccountId'
@@ -11728,10 +11730,11 @@ paths:
1172811730
/api/go-staking/v1/accounts/{accountId}/rewards:
1172911731
get:
1173011732
tags:
11731-
- Go Account Staking (beta)
11733+
- Go Account Staking
1173211734
summary: List staking rewards for Go Account
1173311735
description: List all staking rewards for a given Go Account.
1173411736
operationId: v1.goStaking.rewards.listByAccount
11737+
x-internal: false
1173511738
parameters:
1173611739
- $ref: '#/components/parameters/pathAccountId'
1173711740
- $ref: '#/components/parameters/queryPageNumber'
@@ -11756,10 +11759,11 @@ paths:
1175611759
/api/go-staking/v1/{coin}/accounts/{accountId}/rewards:
1175711760
get:
1175811761
tags:
11759-
- Go Account Staking (beta)
11762+
- Go Account Staking
1176011763
summary: List staking rewards by asset for Go Account
1176111764
description: List all staking rewards for a given asset and Go Account.
1176211765
operationId: v1.goStaking.rewards.listByAccountAndCoin
11766+
x-internal: false
1176311767
parameters:
1176411768
- $ref: '#/components/parameters/pathCoin1'
1176511769
- $ref: '#/components/parameters/pathAccountId'
@@ -11785,10 +11789,11 @@ paths:
1178511789
/api/go-staking/v1/accounts/{accountId}/requests:
1178611790
get:
1178711791
tags:
11788-
- Go Account Staking (beta)
11792+
- Go Account Staking
1178911793
summary: List staking requests for Go Account
1179011794
description: List all staking requests for a given Go Account.
1179111795
operationId: v1.goStaking.request.listByAccount
11796+
x-internal: false
1179211797
parameters:
1179311798
- $ref: '#/components/parameters/pathAccountId'
1179411799
- $ref: '#/components/parameters/queryRequestStatus'
@@ -11815,10 +11820,11 @@ paths:
1181511820
/api/go-staking/v1/{coin}/accounts/{accountId}/requests/preview:
1181611821
post:
1181711822
tags:
11818-
- Go Account Staking (beta)
11823+
- Go Account Staking
1181911824
summary: Generate staking request for Go Account
1182011825
description: Generate an unsigned staking request to preview for a given asset and Go Account. Use only for stake requests - don't use for unstaking requests.
1182111826
operationId: v1.goStaking.request.preview
11827+
x-internal: false
1182211828
parameters:
1182311829
- $ref: '#/components/parameters/pathCoin1'
1182411830
- $ref: '#/components/parameters/pathAccountId'
@@ -11853,10 +11859,11 @@ paths:
1185311859
/api/go-staking/v1/{coin}/accounts/{accountId}/requests/finalize:
1185411860
post:
1185511861
tags:
11856-
- Go Account Staking (beta)
11862+
- Go Account Staking
1185711863
summary: Finalize staking request for Go Account
1185811864
description: Create a finalized staking request based on previously previewed data for a given asset and Go Account.
1185911865
operationId: v1.goStaking.request.finalize
11866+
x-internal: false
1186011867
parameters:
1186111868
- $ref: '#/components/parameters/pathCoin1'
1186211869
- $ref: '#/components/parameters/pathAccountId'
@@ -11897,7 +11904,7 @@ paths:
1189711904
/api/go-staking/v1/coins:
1189811905
get:
1189911906
tags:
11900-
- Go Account Staking (beta)
11907+
- Go Account Staking
1190111908
summary: List supported coins
1190211909
description: Returns a paginated list of supported staking coins for the authenticated user.
1190311910
operationId: v1.goStaking.coins.list
@@ -11921,10 +11928,11 @@ paths:
1192111928
/api/go-staking/v1/accounts/{accountId}/coins:
1192211929
get:
1192311930
tags:
11924-
- Go Account Staking (beta)
11931+
- Go Account Staking
1192511932
summary: List staking wallets for Go Account
1192611933
description: List all staking wallets associated with a given Go Account.
1192711934
operationId: v1.goStaking.wallet.listByAccountId
11935+
x-internal: false
1192811936
parameters:
1192911937
- $ref: '#/components/parameters/pathAccountId'
1193011938
- $ref: '#/components/parameters/queryPageNumber'
@@ -11947,10 +11955,11 @@ paths:
1194711955
/api/go-staking/v1/{coin}/accounts/{accountId}/attributes:
1194811956
get:
1194911957
tags:
11950-
- Go Account Staking (beta)
11958+
- Go Account Staking
1195111959
summary: Get staking wallet attributes for Go Account
1195211960
description: Get staking wallet attributes for a given asset and Go Account.
1195311961
operationId: v1.goStaking.wallet.getAttributesByCoinAndAccount
11962+
x-internal: false
1195411963
parameters:
1195511964
- $ref: '#/components/parameters/pathCoin1'
1195611965
- $ref: '#/components/parameters/pathAccountId'
@@ -47512,20 +47521,23 @@ components:
4751247521
name: createdDateGte
4751347522
in: query
4751447523
required: false
47524+
description: Filter results created on or after this date-time (ISO 8601).
4751547525
schema:
4751647526
type: string
4751747527
format: date-time
4751847528
queryCreatedDateLt:
4751947529
name: createdDateLt
4752047530
in: query
4752147531
required: false
47532+
description: Filter results created before this date-time (ISO 8601).
4752247533
schema:
4752347534
type: string
4752447535
format: date-time
4752547536
queryEndDate:
4752647537
name: endDate
4752747538
in: query
4752847539
required: false
47540+
description: End of the date range filter (ISO 8601).
4752947541
schema:
4753047542
type: string
4753147543
format: date-time
@@ -47616,6 +47628,7 @@ components:
4761647628
name: sortBy
4761747629
in: query
4761847630
required: false
47631+
description: Sort order for results. Prefix with '-' for descending order.
4761947632
schema:
4762047633
type: string
4762147634
enum:
@@ -47650,6 +47663,7 @@ components:
4765047663
name: startDate
4765147664
in: query
4765247665
required: false
47666+
description: Start of the date range filter (ISO 8601).
4765347667
schema:
4765447668
type: string
4765547669
format: date-time
@@ -62928,6 +62942,8 @@ components:
6292862942
format: date-time
6292962943
properties:
6293062944
$ref: '#/components/schemas/GoStakingRequestProperties'
62945+
source:
62946+
$ref: '#/components/schemas/RequestSource'
6293162947
GoStakingRequestProperties:
6293262948
type: object
6293362949
properties:
@@ -62963,6 +62979,8 @@ components:
6296362979
type: string
6296462980
activeStake:
6296562981
type: string
62982+
activeAutoStaked:
62983+
type: string
6296662984
pendingStake:
6296762985
type: string
6296862986
pendingUnstake:
@@ -73430,6 +73448,11 @@ components:
7343073448
- processing
7343173449
- completed
7343273450
- failed
73451+
RequestSource:
73452+
type: string
73453+
enum:
73454+
- MANUAL
73455+
- AUTO_STAKE
7343373456
RequestedProductResponse:
7343473457
type: object
7343573458
properties:

0 commit comments

Comments
 (0)