ZEzerohash
Staking

List participant unstakes

Changed on

List all unstakes for a participant with optional filtering by asset, status, creation time and completion time. Time filters take full RFC3339 timestamps; the rewards endpoint instead filters by calendar date with start_date and end_date. Returns paginated results with completion timestamps.

get/stakes/{participant_code}/unstakes

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/stakes/{participant_code}/unstakes
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

participant_codestring required
Example:XXXXXX

Participant identifier

Query parameters

assetstring
Example:ETH

Filter by specific asset

status'submitted' | 'queued' | 'canceled' | 'broadcasted' | 'confirmed' | 'unstaked' | 'failed'
Example:unstaked

Filter by unstake status

account_labelstring
Example:general

Filter by settlement account label

created_afterstring date-time
Example:2026-01-01T00:00:00Z

Only return unstakes created at or after this time. RFC3339 timestamp with a time zone, for example 2026-01-01T00:00:00Z.

created_beforestring date-time
Example:2026-02-01T00:00:00Z

Only return unstakes created strictly before this time. RFC3339 timestamp with a time zone. Must not be earlier than created_after.

completed_afterstring date-time
Example:2026-01-01T00:00:00Z

Only return unstakes completed at or after this time. RFC3339 timestamp with a time zone.

completed_beforestring date-time
Example:2026-02-01T00:00:00Z

Only return unstakes completed strictly before this time. RFC3339 timestamp with a time zone. Must not be earlier than completed_after.

pageinteger
Example:1

Page number for pagination

page_sizeinteger
Example:50

Number of results per page

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

Unstakes retrieved successfully

request_idstring

Request identifier

pageinteger

Current page number

total_pagesinteger

Total number of pages

Example response

{
  "request_id": "req_321654987",
  "message": {
    "unstakes": [
      {
        "unstake_id": "c761fc96-5c44-40d4-8eb2-3fcd5d06757d",
        "participant_code": "CUST01",
        "asset": "ETH",
        "account_group": "CUST01",
        "account_label": "general",
        "amount": "5.0",
        "status": "unstaked",
        "created_at": "2025-08-24T16:00:00Z",
        "completed_at": "2025-09-03T16:00:00Z",
        "tx_hash": "0x3a1f9c2b7e4d5a6f8b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a"
      }
    ]
  },
  "page": 1,
  "total_pages": 1
}

Changes