Skip to content

Add new staking endpoints #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add new staking endpoints #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e85f42
add endpoints
denalimarsh Aug 15, 2025
bf5038c
additional updates
denalimarsh Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 215 additions & 0 deletions docs/stakingAPI/swagger/mainnet.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,12 @@ paths:
description: Public key hash associated with the given BTC address.
schema:
type: string
- name: coreAddress
in: query
required: false
description: The reward address of BTC staking.
schema:
type: string
responses:
'200':
description: Active BTC staking transactions retrieved successfully.
Expand Down Expand Up @@ -487,6 +493,71 @@ paths:
message:
type: string
description: Error message explaining the issue.
/staking/summary/group_candidate_detail:
get:
summary: Retrieve Staking Summary Group By Candidate
description: Retrieve Staking Summary Group By Candidate.
parameters:
- name: coreAddress
in: query
required: false
description: Core staking address or the Core reward address corresponding to BTC staking
schema:
type: string
responses:
'200':
description: Staking summary grouped by candidate retrieved successfully.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Status code indicating the result of the operation.
data:
type: array
description: List of staking details grouped by candidate.
items:
type: object
properties:
address:
type: string
description: The address of the candidate.
candidateAddress:
type: string
description: The candidate validator address.
candidateName:
type: string
description: The name of the candidate validator.
stakedBTCAmount:
type: string
description: The amount of BTC staked with this candidate.
stakedCoreAmount:
type: string
description: The amount of CORE staked with this candidate.
candidateEstimatedCoreRewardRate:
type: string
description: The estimated CORE reward rate for this candidate.
candidateEstimatedBtcRewardRate:
type: string
description: The estimated BTC reward rate for this candidate.
message:
type: string
description: Additional information or message about the response.
'400':
description: Invalid parameters or an error occurred while retrieving the data.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Error code indicating the result of the operation.
message:
type: string
description: Error message explaining the issue.
/staking/summary/rewards:
get:
summary: Retrieve Reward Distribution of a Round
Expand Down Expand Up @@ -604,6 +675,12 @@ paths:
description: The public key hash associated with the given Bitcoin address.
schema:
type: string
- name: coreAddress
in: query
required: false
description: The reward address of BTC staking.
schema:
type: string
- name: pageNum
in: query
required: false
Expand Down Expand Up @@ -750,6 +827,60 @@ paths:
message:
type: string
description: Error message explaining the issue.
/staking/btc/transactions/reward:
get:
summary: Retrieve BTC staking transaction rewards
description: Retrieve BTC staking transaction rewards.
parameters:
- name: txId
in: query
required: true
description: The Bitcoin transaction id of the staking transaction.
schema:
type: string
responses:
'200':
description: BTC staking transaction rewards retrieved successfully.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Status code indicating the result of the operation.
data:
type: object
description: BTC staking transaction reward details.
properties:
btcTxId:
type: string
description: The Bitcoin transaction ID.
rewardAddress:
type: string
description: The reward address for the staking transaction.
pendingReward:
type: string
description: The pending reward amount.
claimedReward:
type: string
description: The claimed reward amount.
message:
type: string
description: Additional information or message about the response.
'400':
description: Invalid transaction ID or an error occurred while retrieving the rewards.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Error code indicating the result of the operation.
message:
type: string
description: Error message explaining the issue.
/staking/rewards/detail:
get:
summary: Retrieve Collected and Pending Rewards
Expand Down Expand Up @@ -810,6 +941,90 @@ paths:
message:
type: string
description: Error message explaining the issue.
/staking/rewards/reward_rate:
get:
summary: Retrieve Staking Reward Rate
description: Retrieve staking reward rates for a delegator address.
parameters:
- name: coreAddress
in: query
required: true
description: The delegator address.
schema:
type: string
- name: btcStakeAmount
in: query
required: true
description: The amount of BTC planned to stake. Example - 0.1 BTC
schema:
type: number
- name: coreStakeAmount
in: query
required: true
description: The amount of Core planned to stake. Example - 100.1 CORE
schema:
type: number
- name: btcStakingValidatorAddress
in: query
required: true
description: The validator address for delegating BTC.
schema:
type: string
- name: coreStakingValidatorAddress
in: query
required: true
description: The validator address for delegating CORE.
schema:
type: string
responses:
'200':
description: Staking reward rates retrieved successfully.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Status code indicating the result of the operation.
data:
type: object
description: Staking reward rate details.
properties:
annualRewardRateOverall:
type: string
description: Overall annual reward rate.
annualRewardRateCurrent:
type: string
description: Current annual reward rate.
newStakedBTCRewardRate:
type: string
description: Reward rate for newly staked BTC.
newStakedCoreRewardRate:
type: string
description: Reward rate for newly staked CORE.
activeStakedBTCRewardRate:
type: string
description: Reward rate for actively staked BTC.
activeStakedCoreRewardRate:
type: string
description: Reward rate for actively staked CORE.
message:
type: string
description: Additional information or message about the response.
'400':
description: Invalid parameters or an error occurred while retrieving reward rates.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Error code indicating the result of the operation.
message:
type: string
description: Error message explaining the issue.
/staking/helper/redeemscript:
post:
summary: Submit RedeemScript for Staking Transaction
Expand Down
Loading