> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.oppigames.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jackpot Reward List

> This API retrieves a paginated list of jackpot rewards given to players. It supports optional filters by gameId and playerId to narrow down the results.

## Headers

<ParamField header="x-api-key" type="string" required>
  A unique identifier associated with operator calling API.
</ParamField>

<ParamField header="x-signature" type="string" required>
  A SHA256 HMAC signature generated using the request body and timestamp.
  Format: HMAC\_SHA256(JSON.stringify(data) + '|' + timestamp), signed using the
  provided secret key.
</ParamField>

<ParamField header="x-timestamp" type="string" required>
  An Unix timestamp (milliseconds) Used to verify the request’s freshness.
  Ensure the same value is used in signature generation.

  <Note>
    The signature will remain valid for only 5 minutes from the provided
    timestamp.
  </Note>
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Must be set to `application/json`.
</ParamField>

## Query Parameters

<ParamField query="page" type="number" default={1}>
  Specifies the current page number for pagination purposes.
</ParamField>

<ParamField query="limit" type="number" default={10}>
  Specifies how many records to display on each page, controlling the size of each data segment.
</ParamField>

<ParamField query="gameId" type="string">
  Retrieve jackpot rewards for a specific game.
</ParamField>

<ParamField query="playerId" type="string">
  Retrieve jackpot rewards received by a specific player.
</ParamField>

## Response

<ResponseField name="status" type="string" required>
  Code indicates status of the request weather it is succeed or failed. We have listed error codes <a href="/introduction#error-codes">here</a>
</ResponseField>

<ResponseField name="data" type="Data Object" />

<Expandable title="Data properties">
  <ResponseField name="currentPage" type="integer" required>
    The current page number of the results.
  </ResponseField>

  <ResponseField name="totalPages" type="integer" required>
    The total number of pages available.
  </ResponseField>

  {" "}

  <ResponseField name="totalCount" type="integer" required>
    The total number of records matching the query.
  </ResponseField>

  <ResponseField name="result" type="array" required> An array of  objects containing details about awarded jackpots. </ResponseField>

  <Expandable title="result properties">
    <ResponseField name="playerId" type="string" required>
      Unique identifier for the player.
    </ResponseField>

    <ResponseField name="gameId" type="string" required>
      Unique identifier for the game.
    </ResponseField>

    <ResponseField name="amount" type="number" required>
      The amount of the jackpot rewarded to the player.

      <Note>
        To maintain precision and avoid floating-point errors, the amount field is processed as an integer value by multiplying the actual amount by 100000.

        For example, a amount of 12.34567 will be represented as 1234567 in the API.
      </Note>
    </ResponseField>

    <ResponseField name="createdAt" type="string" required>
      Timestamp indicating when the session was created (UTC format).
    </ResponseField>
  </Expandable>
</Expandable>

<ResponseExample>
  ```json SUCCESS theme={null}
  {
      "status": "RS_OK",
      "data": {
          "totalPages": 1,
          "currentPage": 1,
          "totalCount": 2,
          "result": [
              {
                  "amount": 50,
                  "gameId": "G1720761376617",
                  "playerId": "PAWAN_PAREEK1",
                  "createdAt": "2025-07-15T09:14:18.339Z"
              }
          ]
      }
  }

  ```

  ```json FAILURE theme={null}
  {
    "status": "RS_ERROR",
    "message": "Oops! Something went wrong. Please refresh the page or try again in a moment"
  }
  ```
</ResponseExample>