List epoch reward summaries

Get a list of reward summaries by epoch for a given range of epochs. The result is filtered by list of asset IDs, market IDs and starting and ending epochs, for which to return rewards. If no data is provided, all reward summaries will be returned, grouped by epochs, market IDs, asset IDs and reward type.

Query Parameters

filter.assetIds string[]

Restrict reward summaries to those connected to the assets in the given list.

filter.marketIds string[]

Restrict reward summaries to those connected to the markets in the given list.

filter.fromEpoch uint64

Restrict rewards summaries to those that were paid after and including the given epoch ID.

filter.toEpoch uint64

Restrict rewards summaries to those that were paid up to and including the given epoch ID.

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 for a single party and corresponding page information.

edges object[]

Page of rewards summary data for epochs and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Rewards summary data for epoch.

amount string

Amount distributed. This field is an unsigned integer scaled to the asset's decimal places.

assetId string

Asset ID in which the reward is being paid.

epoch uint64

Epoch in which the reward is being paid.

marketId string

Market ID in which the reward is being paid.

rewardType string

Type of reward being paid.

]

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.

{
  "summaries": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "assetId": "string",
          "epoch": "string",
          "marketId": "string",
          "rewardType": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "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/epoch/summaries

Request

Base URL

https://vega-data.nodes.guru:3008

filter.assetIds — query

filter.marketIds — query

filter.fromEpoch — query

filter.toEpoch — 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-data.nodes.guru:3008/api/v2/rewards/epoch/summaries' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-data.nodes.guru:3008/api/v2/rewards/epoch/summaries' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-data.nodes.guru:3008/api/v2/rewards/epoch/summaries' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-data.nodes.guru:3008/api/v2/rewards/epoch/summaries' \
-H 'Accept: application/json'