Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Staking

Get staking summary

Get a summary of the staking activity for a given participant_code and asset, including total staked amount, total rewards earned, and average APY.

get/stakes/{participant_code}/{asset}/summary

Path parameters

participant_codestring required
Example:CUST01

Participant identifier

assetstring required
Example:ETH

Asset symbol

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Summary retrieved successfully

request_idstring

Request identifier

Example response

{
  "request_id": "8bb7e203-13e0-4208-80bc-e9fdb7faa13e",
  "message": {
    "total_staked": "27.8956102943",
    "total_rewards_earned": "0.0493095935",
    "average_apy_net": "3.92"
  }
}