PlaySuper LogoPlaySuper
API ReferenceSwaggerRewards

Search for rewards, categories, brands

GET
/rewards/search
AuthorizationBearer <token>

In: header

Query Parameters

coinIdstring

Coin ID

qstring

Pass a query string to search for an item

Length1 <= length
brand?array<string>

Filter by one or multiple brand names. We search based on exact matches only and ignore incorrect or non-existent matches.

category?array<string>

Filter by one or multiple category names. We search based on exact matches only and ignore incorrect or non-existent matches.

page?integer

The page number for paginated results. Starts from 1.

Range1 <= value
sortBy?string

Sorting order for the search results.

Value in"relevance" | "price:low-high" | "price:high-low" | "newest"
type?string | null

Pass an optional item type to filter the search. If not provided, it defaults to null and all types except "products" are returned.

Value in"brands" | "categories" | "rewards"

Header Parameters

x-languagestring

Language

x-api-keystring

Game API Key

Response Body

curl -X GET "https://api.playsuper.club/rewards/search?coinId=string&q=shoes&brand=string&category=string&page=1&sortBy=relevance&type=brands" \  -H "x-language: string" \  -H "x-api-key: string"
{
  "result": {
    "query": {
      "q": "laptop",
      "type": "rewards",
      "brandName": [
        "phonepe",
        "amazon"
      ],
      "categoryName": [
        "subscriptions",
        "gadgets"
      ],
      "sortBy": "relevance"
    },
    "filters": {
      "brandName": {
        "type": "multiselect",
        "options": [
          {
            "value": "Nike",
            "count": 25
          },
          {
            "value": "Adidas",
            "count": 18
          }
        ]
      },
      "categoryName": {
        "type": "multiselect",
        "options": [
          {
            "value": "Subscriptions",
            "count": 15
          },
          {
            "value": "Gaming",
            "count": 10
          }
        ]
      },
      "sortBy": {
        "type": "singleselect",
        "options": [
          {
            "value": "price:low-high"
          },
          {
            "value": "price:high-low"
          },
          {
            "value": "newest"
          },
          {
            "value": "relevance"
          }
        ]
      }
    },
    "items": {
      "brands": [
        {
          "name": "Cashify",
          "logo": "https://playsuper-bucket.s3.amazonaws.com/integrations/1744465430739-vb5m25.jpg"
        }
      ],
      "categories": [
        {
          "name": "Subscriptions",
          "logo": "https://playsuper-bucket.s3.amazonaws.com/integrations/1744465430739-vb5m25.jpg"
        }
      ],
      "rewards": [
        {
          "id": "456",
          "name": "Reward 1",
          "price": 200,
          "brand": "Brand B",
          "category": "Category Y"
        }
      ],
      "products": [
        {
          "id": "456",
          "name": "Product 2",
          "price": 200,
          "brand": "Brand B",
          "category": "Category Y"
        }
      ]
    }
  },
  "metadata": {
    "pagination": {
      "totalItems": 1,
      "totalPages": 10,
      "currentPage": 1,
      "pageSize": 10
    }
  }
}