Get Stake

Get staking information for a given party

Path Parameters

partyId string required

Party ID for which the stake information is requested.

Query Parameters

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Newest records first, older records last, default is true.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

currentStakeAvailable string
stakeLinkings object
Paged list of stake data with corresponding page information.
edges object[]
Page of stake data and their corresponding cursors.
cursor string
node object
Stake linking represent the intent from a party to deposit.
amount Amount of stake deposited or removed
blockHeight uint64
blockTime int64
ethereumAddress Ethereum address from which the stake link was initiated
finalizedAt int64
id Internal ID for this staking event
logIndex uint64
party string
status Status of the event
Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_ACCEPTED, STATUS_REJECTED]
ts int64
txHash Hash of the transaction from which the events happen
type - TYPE_UNSPECIFIED: Default value - TYPE_LINK: Indicate of a stake deposit instruction - TYPE_UNLINK: Indicate of a stake remove instruction
Possible values: [TYPE_UNSPECIFIED, TYPE_LINK, TYPE_UNLINK]
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "currentStakeAvailable": "string",
  "stakeLinkings": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "blockHeight": "string",
          "blockTime": "string",
          "ethereumAddress": "string",
          "finalizedAt": "string",
          "id": "string",
          "logIndex": "string",
          "party": "string",
          "status": "STATUS_UNSPECIFIED",
          "ts": "string",
          "txHash": "string",
          "type": "TYPE_UNSPECIFIED"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

An internal server error

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

GET /api/v2/parties/:partyId/stake

Request

Base URL

https://vega-mainnet-data.commodum.io

partyId — path required

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

curl / cURL

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/parties/:partyId/stake' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/parties/:partyId/stake' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/parties/:partyId/stake' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/parties/:partyId/stake' \
-H 'Accept: application/json'