---
updatedAt: 2026-07-29T09:31:58.000Z
---

# Rewards leaderboard

Returns the rewards leaderboard. Use period=all for all-time or period=range with from/to. sort selects the ranking metric. Set include=summary to also return aggregate leaderboard statistics.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "CantonView Public API",
    "description": "Public API for accessing Canton Network explorer data through CCView",
    "contact": {
      "name": "API Maintainer",
      "email": "cantonview@pixelplex.io"
    },
    "license": {
      "name": ""
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://ccview.io",
      "description": "Production HTTPS server"
    }
  ],
  "paths": {
    "/api/rewards/leaderboard": {
      "get": {
        "tags": [
          "Rewards"
        ],
        "summary": "Rewards leaderboard",
        "description": "Returns the rewards leaderboard. Use period=all for all-time or period=range with from/to. sort selects the ranking metric. Set include=summary to also return aggregate leaderboard statistics.",
        "operationId": "rewards_leaderboard_v1",
        "parameters": [
          {
            "name": "period",
            "in": "query",
            "required": false,
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/LeaderboardPeriod"
                }
              ],
              "default": "all"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/LeaderboardSort"
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "include",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/LeaderboardInclude"
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 25,
              "maximum": 100,
              "minimum": 1
            },
            "example": 25
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "example": "2026-07-28T13:25:25.423861513Z"
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "example": "2026-07-28T13:25:25.423862124Z"
          }
        ],
        "responses": {
          "200": {
            "description": "Rewards leaderboard.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LeaderboardResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "LeaderboardEntry": {
        "type": "object",
        "required": [
          "party_id",
          "validator_change_amount",
          "sv_change_amount",
          "app_change_amount",
          "total_amount"
        ],
        "properties": {
          "app_change_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Rewards as of role 'app'",
            "example": "1235.000123",
            "minimum": 0
          },
          "party_id": {
            "$ref": "#/components/schemas/PartyId"
          },
          "sv_change_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Rewards as of role 'super validator'",
            "example": "1235.000123",
            "minimum": 0
          },
          "total_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Rewards across all roles",
            "example": "1235.000123",
            "minimum": 0
          },
          "validator_change_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Rewards as of role 'validator'",
            "example": "1235.000123",
            "minimum": 0
          }
        }
      },
      "LeaderboardInclude": {
        "type": "string",
        "enum": [
          "summary"
        ]
      },
      "LeaderboardPeriod": {
        "type": "string",
        "enum": [
          "all",
          "range"
        ]
      },
      "LeaderboardResult": {
        "type": "object",
        "required": [
          "entries"
        ],
        "properties": {
          "entries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LeaderboardEntry"
            }
          },
          "summary": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/LeaderboardStatistic",
                "description": "Aggregate leaderboard statistics (populated when `include=summary`)."
              }
            ]
          }
        }
      },
      "LeaderboardSort": {
        "type": "string",
        "enum": [
          "validator",
          "super_validator",
          "app",
          "total"
        ]
      },
      "LeaderboardStatistic": {
        "type": "object",
        "required": [
          "total_parties",
          "total_rewards_amount",
          "total_validator_rewarded_amount",
          "total_sv_rewarded_amount",
          "total_app_rewarded_amount",
          "marker_cost_avg"
        ],
        "properties": {
          "marker_cost_avg": {
            "type": "string",
            "format": "decimal",
            "description": "Actual Featured App Marker cost average for latest 3 rounds.",
            "example": "1235.000123",
            "minimum": 0
          },
          "total_app_rewarded_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Total rewards as of role 'app' summary",
            "example": "1235.000123",
            "minimum": 0
          },
          "total_parties": {
            "type": "integer",
            "format": "integer",
            "description": "Total parties rewarded count",
            "example": "1235",
            "minimum": 0
          },
          "total_rewards_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Total rewards summary",
            "example": "1235.000123",
            "minimum": 0
          },
          "total_sv_rewarded_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Total rewards as of role 'super validator' summary",
            "example": "1235.000123",
            "minimum": 0
          },
          "total_validator_rewarded_amount": {
            "type": "string",
            "format": "decimal",
            "description": "Total rewards as of role 'validator' summary",
            "example": "1235.000123",
            "minimum": 0
          }
        }
      },
      "PartyId": {
        "type": "string",
        "title": "PartyId",
        "format": "hint::hash",
        "description": "Party ID in format `hint::hash`\n \n- `hint` - human-readable prefix (optional, for debugging)\n \n- `hash` - cryptographic identifier (the real identity)",
        "example": "dev_test::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90",
        "examples": [
          "dev_test::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90"
        ],
        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*::1220[a-f0-9]{64}$"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Rewards",
      "description": "Rewards history and statistics"
    }
  ],
  "externalDocs": {
    "url": "https://swagger.io/resources/open-api/",
    "description": "OpenAPI Documentation Reference"
  }
}
```