Skip to navigation
TRANSFERS AND STAKINGStaking

Get stake accounts

This endpoint returns a list of stake accounts.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

addressIdstringOptionalformat: "uint64"
Identifier for the Protect address that the stake accounts are derived from.
accountTypeenumOptional
The type of stake account.
Allowed values:
accountAddressstringOptional
The address of the stake account.
cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"
The size of the page requested. The handling service should impose a hard limit on this

Response

A successful response.
stakeAccountslist of objectsOptional
cursorobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error