> ## 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 List

> This API is used to retrieve a paginated list of jackpots. It also allows optional filtering by gameId.   

status

* **0** = Inactive
* **1** = Active
* **2** = Awarded (Jackpot completed)

## 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">
  Specifies the current page number for pagination purposes ( default is 1).
</ParamField>

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

<ParamField query="gameId" type="string">
  Optional filter to fetch jackpots for a specific game. Pass the game's unique ID.
</ParamField>

## Response

<ResponseField name="status" type="string" required>
  Status of the request.
</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>
      List of jackpot matching the query parameters.
    </ResponseField>

    <Expandable title="result properties">
      <ResponseField name="jackpotId" type="string" required>
        Unique identifier of the Jackpot.
      </ResponseField>

      <ResponseField name="gameId" type="string" required>
        Unique identifier of the game associated with jackpot.
      </ResponseField>

      <ResponseField name="betPortion" type="integer" required>
        Bet portion (%) configured for the associated jackpot.
      </ResponseField>

      <ResponseField name="jackpotPool" type="integer" required>
        Jackpot pool amount configured for the associated jackpot.

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

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

      <ResponseField name="status" type="integer" required>
        Current status of the associated jackpot.
      </ResponseField>

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

      <ResponseField name="updatedAt" type="string" required>
        Timestamp indicating when the jackpot entry was last updated (UTC format).
      </ResponseField>
    </Expandable>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json SUCCESS theme={null}
  {
      "status": "RS_OK",
      "data": {
          "totalPages": 1,
          "currentPage": 1,
          "totalCount": 2,
          "result": [
              {
                  "jackpotId": "200b4487-3e2d-4c83-a85d-3f6d7245ba10",
                  "gameId": "G1720761376617",
                  "betPortion": 50,
                  "jackpotPool": 150000000,
                  "status": 0,
                  "createdAt": "2025-07-15T09:14:18.339Z",
                  "updatedAt": "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>