List votes

GET 
/api/v2/votes

Get a list of votes. A party ID or a proposal ID must be provided.

Request

Query Parameters

partyId string

Party for which the votes are requested.

proposalId string

Proposal ID to list votes for.

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

votes object

Page of votes data received and corresponding page information.

edges object[]

Page of vote data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Data associated with a governance vote.

partyId string

Voter's party ID.

perMarketEquityLikeShareWeight object

The per market weight of the vote compared to the total amount of equity-like share on the market.. It is only populated if the vote is for a batch type proposal.

property name* string

proposalId string

Proposal ID being voted on.

timestamp int64

Timestamp in Unix nanoseconds when the vote was acknowledged by the network.

totalEquityLikeShareWeight string

The weight of the vote compared to the total amount of equity-like share on the market. It is only populated if the vote is for a single type proposal.

totalGovernanceTokenBalance string

Total number of governance token for the party that cast the vote.

totalGovernanceTokenWeight string

The weight of this vote based on the total number of governance tokens.

value Vote value

Possible values: [VALUE_UNSPECIFIED, VALUE_NO, VALUE_YES]

Default value: VALUE_UNSPECIFIED

Which way the party voted.

]

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)

{
  "votes": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "partyId": "string",
          "perMarketEquityLikeShareWeight": {},
          "proposalId": "string",
          "timestamp": "string",
          "totalEquityLikeShareWeight": "string",
          "totalGovernanceTokenBalance": "string",
          "totalGovernanceTokenWeight": "string",
          "value": "VALUE_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...