List reward summaries

Get a list of reward summaries where the reward amount is the total rewards received over all epochs per party ID and asset ID. Request parameters are optional party ID and asset ID. If no data is provided, all reward summaries will be returned grouped by party and asset ID.

Query Parameters

partyId string

Restrict the reward summary to rewards paid to the given parties.

assetId string

Restrict the reward summary to rewards paid in the given assets.

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
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

summaries object[]
Page of rewards details data and corresponding page information.
Array [
amount string
Total amount of rewards paid in the asset. This field is an unsigned integer scaled to the asset's decimal places.
assetId string
Asset ID in which the reward is being paid.
partyId string
Party ID to whom the reward is being paid.
]

{
  "summaries": [
    {
      "amount": "string",
      "assetId": "string",
      "partyId": "string"
    }
  ]
}

An internal server error

application/json

Schema

Example (from 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

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

An unexpected error response.

application/json

Schema

Example (from 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

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

GET /api/v2/rewards/summaries

Request

Base URL

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

partyId — query

assetId — query

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/rewards/summaries' \
-H 'Accept: application/json'

python / requests

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

go / native

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

nodejs / axios

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