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

# Game List

> This API is used for get game list.

## 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="gameType" type="integer">
  Game type filter is used for filter the records based on gameType (1=Slot and
  2=Crash).
</ParamField>

<ParamField query="search" type="string">
  Search functionality allow searching games based on gameId or gameName with
  case insensitive matching.
</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>
      List of games matching the query parameters.
    </ResponseField>

    <Expandable title="result properties">
      <ResponseField name="name" type="string" required>
        Name of the game.
      </ResponseField>

      <ResponseField name="slug" type="string" required>
        URL-friendly version of the game name.
      </ResponseField>

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

      <ResponseField name="gameType" type="integer" required>
        Type of game (1=Slot, 2=Crash).
      </ResponseField>

      <ResponseField name="bonuses" type="array" required>
        Allowed bonuses for the game.
      </ResponseField>

      <ResponseField name="images" type="array" required>
        Collection of game images in different formats.

        <Expandable title="Image properties">
          <ResponseField name="portrait" type="string" required>
            URL for the portrait orientation image.
          </ResponseField>

          <ResponseField name="animated" type="string" required>
            URL for the animated GIF image.
          </ResponseField>

          <ResponseField name="thumbnail" type="string" required>
            URL for the thumbnail image.
          </ResponseField>
        </Expandable>
      </ResponseField>
    </Expandable>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json SUCCESS theme={null}
  {
    "status": "RS_OK",
    "data": {
      "currentPage": 1,
      "totalPages": 1,
      "totalCount": 2,
      "result": [
        {
          "name": "Ghost Vault",
          "slug": "ghost-vault",
          "gameId": "G1720767064793",
          "gameType": 1,
          "bonuses": [
                      "Free Spins",
                      "Fortune Guess",
                      "Wagering"
                  ],
          "images": [
            {
              "portrait": "https://s-apis.oppigames.com/portrait/1dff1f405ee35c0ffc913f654903714e6a.jpg",
              "animated": "https://s-apis.oppigames.com/animated/fe10607dff11aa1994e10c18ajshjh4774fs7f.gif",
              "thumbnail": "https://s-apis.oppigames.com/thumbnail/b7d75901091fe5ac456esdj94a2b9b10e0.png"
            }
          ]
        },
        {
          "name": "Cricket Crash",
          "slug": "cricket-crash",
          "gameId": "G1742465405970",
          "gameType": 2,
          "bonuses": [],
          "images": [
            {
              "portrait": "https://s-apis.oppigames.com/portrait/825f35376e46b10db15c7c8833396b38.png",
              "animated": "https://s-apis.oppigames.com/animated/145f35376e46b155b15c7cre47juYT7e.gif",
              "thumbnail": "https://s-apis.oppigames.com/thumbnail/145f35376e46b155bfetji157562e4jhjf.png"
            }
          ]
        }
      ]
    }
  }
  ```

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