Search account staking instances

Use the following parameters to search account staking instances.

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
path Parameters
account_id
required
integer

The account's ID

query Parameters
account_id
integer or null
Default: null

Filters stakes by the account id of their creation transaction.

Example: account_id=12
created_after
string or null <date-time>
Default: null

Returns objects created after the entered date.

Example: created_after=2020-09-12T14:15:22Z
created_before
string or null <date-time>
Default: null

Returns objects created before the entered date.

Example: created_before=2020-12-13T16:17:28Z
creation_tx
integer or null
Default: null

Filters stakes by their creation transaction id.

Example: creation_tx=123
id
integer or null
Default: null

Returns the object corresponding to the entered ID

light
boolean
Default: true

Returns a light or deep Vault stake object.

Example: light=true
order
string or null
Default: null

Orders the list of results

Enum: null "asc" "desc"
Example: order=desc
order_by
string or null
Default: null

criteria to order by

Example: order_by=name
page
integer or null >= 1
Default: 1

Defines the page number to be fetched.

Example: page=3
page_size
integer or null >= -1
Default: 20

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Example: page_size=40
stake_uid
Array of strings or null
Default: null

Filters stakes by their stake uid.

Example: stake_uid=['ca8b0b2d-b80f-4bf9-a754-f760a24ab359', 'fzqfr0b2d-b80f-4bf9-a754-f760a24dezgtyh']
status
Array of strings or null
Default: null

Filters stakes which status is in the list.

Example: status=['PENDING']
Responses
200

Account stakes search results

400

Invalid search parameter

404

This search parameter doesn't exist

get/tezos/accounts/{account_id}/stakes
Response samples
application/json
{
  • "edges": [
    ],
  • "page_info": {
    }
}
Copyright © Ledger Enterprise Platform 2023. All right reserved.