Skip to content
On this page

Fetch Staking Positions

[GET]/positions

EndpointDescription
https://eth-api.everstake.one/api/v1/eth2_staking/positionsRetrieves an array of staking positions.

Request Parameters

ParameterTypeDescription
withdrawal_addressstringA specific withdrawal address.
page[size]integerThe number of results to be displayed per page, used for pagination.
page[number]integerThe page number to be displayed.
fundable_positions_onlybooleanIf true, only positions which can be funded are shown.

Request Example

plaintext
https://eth-api.everstake.one/api/v1/eth2_staking/positions?
withdrawal_address=0x3F124C700fb5E741F128e28985267D44f56B242F&page%5Bsi
ze%5D=20&page%5Bnumber%5D=1&fundable_positions_only=true

Request cURL

bash
curl -X 'GET' \
'https://eth-api.everstake.one/api/v1/eth2_staking/positions?
withdrawal_address=0x3F124C700fb5E741F128e28985267D44f56B242F&page%5Bsi
ze%5D=20&page%5Bnumber%5D=1&fundable_positions_only=true'\
-H 'accept: application/json'

Response Details

ParameterTypeDescription
dataarrayContains an array of position objects.
object:idintegerA unique identifier for the position.
object:typestringDescribes the type of object, in this case, "position".
object:attributes:idintegerA unique identifier for the attributes.
object:attributes:namestringThe name of the position.
object:attributes:eth1_withdrawal_addressstringThe Ethereum address associated with the position.
object:attributes:staked_amountintegerThe amount of ETH staked in the position.
object:attributes:validators_countintegerThe number of validators related to the position.
object:attributes:created_attimestampThe time when the position was created.
object:attributes:updated_attimestampThe last time the position was updated.
linksobjectContains pagination links based on page[size] and page[number].

Response Example

json
{
  "data": [
    {
      "id": "77",
      "type": "position",
      "attributes": {
        "id": 77,
        "eth1_withdrawal_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
        "staked_amount": 128,
        "validators_count": 4,
        "created_at": "2022-03-21T13:50:54.214Z",
        "updated_at": "2022-10-17T14:40:10.618Z",
        "name": null
      }
    }
  ],
  "links": {
    "self": "string",
    "current": "string"
  }
}