Get stake

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

Get staking information for a given party

Request

Path Parameters

partyId stringrequired

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

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

currentStakeAvailable string

Current stake available information.

stakeLinkings object

Paged list of stake data with corresponding page information.

edges object[]

Page of stake data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Stake linking representing the intent from a party to deposit.

amount string

Amount of stake deposited or removed.

blockHeight uint64

Block when the event happened.

blockTime int64

Block time.

ethereumAddress string

Ethereum address from which the stake link was initiated.

finalizedAt int64

Time at which the Vega network finalised the state of the event.

id Internal ID for this staking event (string)

logIndex uint64

Log index.

party string

Party to whom the event is directed at.

status - STATUS_UNSPECIFIED: Default value - STATUS_PENDING: Indicates an event waiting for confirmation from the Vega network - STATUS_ACCEPTED: Indicates an event accepted by the Vega network - STATUS_REJECTED: Indicates an event rejected by the Vega network (string)

Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_ACCEPTED, STATUS_REJECTED]

Default value: STATUS_UNSPECIFIED

Status of the event.

ts int64

Timestamp in Unix nanoseconds of when the event was emitted by Ethereum.

txHash string

Hash of the transaction in which the event happened.

type - TYPE_UNSPECIFIED: Default value - TYPE_LINK: Indicate of a stake deposit instruction - TYPE_UNLINK: Indicate of a stake remove instruction (string)

Possible values: [TYPE_UNSPECIFIED, TYPE_LINK, TYPE_UNLINK]

Default value: TYPE_UNSPECIFIED

Stake linking event type.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "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"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

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

Loading...