List rewards

Get a list of rewards that match the provided criteria. If no filter is provided, all rewards will be returned.

Query Parameters

partyId string

Party ID for which to get the list of rewards.

assetId string

Asset ID for which to get the list of rewards, if provided.

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.

fromEpoch uint64

Epoch from which to list the rewards, if provided.

toEpoch uint64

Epoch up-to-which to list the rewards, if provided.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

rewards object
Page of rewards data and corresponding page information.
edges object[]
Page of rewards data items and their corresponding cursors.
cursor string
node object
Details for a single reward payment.
amount string
assetId string
epoch uint64
marketId string
partyId string
percentageOfTotal string
receivedAt int64
rewardType string
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "rewards": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "assetId": "string",
          "epoch": "string",
          "marketId": "string",
          "partyId": "string",
          "percentageOfTotal": "string",
          "receivedAt": "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[]
@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/rewards

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

fromEpoch — query

toEpoch — query

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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