Fetch Staking Positions
[GET]/positions
Endpoint | Description |
---|---|
https://eth-api.everstake.one/api/v1/eth2_staking/positions | Retrieves an array of staking positions. |
Request Parameters
Parameter | Type | Description |
---|---|---|
withdrawal_address | string | A specific withdrawal address. |
page[size] | integer | The number of results to be displayed per page, used for pagination. |
page[number] | integer | The page number to be displayed. |
fundable_positions_only | boolean | If 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
Parameter | Type | Description |
---|---|---|
data | array | Contains an array of position objects. |
object:id | integer | A unique identifier for the position. |
object:type | string | Describes the type of object, in this case, "position". |
object:attributes:id | integer | A unique identifier for the attributes. |
object:attributes:name | string | The name of the position. |
object:attributes:eth1_withdrawal_address | string | The Ethereum address associated with the position. |
object:attributes:staked_amount | integer | The amount of ETH staked in the position. |
object:attributes:validators_count | integer | The number of validators related to the position. |
object:attributes:created_at | timestamp | The time when the position was created. |
object:attributes:updated_at | timestamp | The last time the position was updated. |
links | object | Contains 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"
}
}