List rewards

GET 
https://croissant.network/api/v2/rewards

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

Request

Query Parameters

partyId string

Restrict rewards data to those that were received by the given party.

assetId string

Restrict rewards data to those that were paid with the given asset 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.

fromEpoch uint64

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

toEpoch uint64

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

teamId string

Filter for rewards paid if the party is a member of the given team.

gameId string

Filter for rewards paid if the party participated in the given game.

includeDerivedParties boolean

Whether to return all derived parties from AMMs for the given party.

marketId string

Filter the rewards by market ID.

Responses

200

A successful response.

application/json

Schema

Schema

rewards object

Page of rewards data and corresponding page information.

edges object[]

Page of rewards data items and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Details for a single reward payment.

amount string

Amount paid as a reward. 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.

gameId string

ID of the game the reward payment was made for if the payment was made for participation in a game.

lockedUntilEpoch uint64

The epoch when the reward is being released.

marketId string

Market ID in which the reward is being paid.

partyId string

Party ID to whom the reward is being paid.

percentageOfTotal string

Percentage of total rewards paid in the epoch.

quantumAmount string

Amount paid as a reward, expressed in asset's quantum unit.

receivedAt int64

Timestamp at which the reward was paid as Unix nano time.

rewardType string

Type of reward being paid.

teamId string

ID of the team the party is a member of, if the party is a member of a participating team, and the reward payment was made for participation in a game. This field is currently only populated by the rewards API.

]

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)

{
  "rewards": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "assetId": "string",
          "epoch": "string",
          "gameId": "string",
          "lockedUntilEpoch": "string",
          "marketId": "string",
          "partyId": "string",
          "percentageOfTotal": "string",
          "quantumAmount": "string",
          "receivedAt": "string",
          "rewardType": "string",
          "teamId": "string"
        }
      }
    ],
    "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"
}

• curl
• python
• go
• nodejs

• CURL

curl -L -X GET 'https://croissant.network/api/v2/rewards' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://croissant.network

Parameters

partyId — query

assetId — query

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

fromEpoch — query

toEpoch — query

teamId — query

gameId — query

includeDerivedParties — query

---truefalse

marketId — query

ResponseClear

Click the Send API Request button above and see the response here!