Ctrl+K

Get total rewards data

get/api/v2/{coin}/wallet/{walletId}/balances/totalrewards

Returns staking information receiving address and the total rewards received for the current wallet. Currently only available for Stacks.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

200 Response

Array of
address string
the address of the wallet
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
rewards array[object]
reward_recipient string
the receiving address
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
reward_amount string
the total rewards received
Example: 5000000000

400 Response

error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code