Client APIs

• Verify Redeem Code Redeem Coupon/QR code where codes are system generated for an utility

Redeem code

POSThttps://devutility.streamnft.tech/verify

Body

application/json

utilityId*string

code*string

Response

201500

Code redeemed successfully

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://devutility.streamnft.tech/verify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "utilityId": "text",
      "code": "text"
    }),
});
const data = await response.json();

• Get All Benefits of Collection Get all benefits present on a collection address

Get utilities by collection address

GEThttps://devutility.streamnft.tech/collection/{address}

Path parameters

address*string

The address of the collection

Response

200500

Utilities retrieved successfully

Body

application/json

utilityIdstring

utilityIndexinteger

providerstring

winnersarray of string

participantsarray of string

chainIdinteger

utilityTypestring

usageobject

raffleRaffleSchema (object)

eligibleobject

partnerstring

selectionTypestring

titlestring

categorystring

image_urlstring

rewardRewardSchema (object)

createdAtstring (date)

descriptionstring

startDatestring (date)

endDatestring (date)

Request

JavaScriptCurl

const response = await fetch('https://devutility.streamnft.tech/collection/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "utilityId": "text",
    "provider": "text",
    "winners": [
      "text"
    ],
    "participants": [
      "text"
    ],
    "utilityType": "text",
    "usage": {
      "startOnClaim": false
    },
    "raffle": {
      "winnersMerkle": "text",
      "claimDate": "2024-07-27"
    },
    "partner": "text",
    "selectionType": "text",
    "title": "text",
    "category": "text",
    "image_url": "text",
    "reward": {
      "value": "text",
      "contentBlock": {
        "type": "text",
        "url": "text",
        "question": "text",
        "options": [
          "text"
        ]
      },
      "estimatedValue": "text",
      "details": [
        "text"
      ],
      "image": "text",
      "type": "text",
      "currency": "text",
      "expiry": "text"
    },
    "createdAt": "2024-07-27",
    "description": "text",
    "startDate": "2024-07-27",
    "endDate": "2024-07-27"
  }
]

• Get Claimed Users of an Utility Get all claimed users for custom codes provided

Get claimed users

GEThttps://devutility.streamnft.tech/claims/{utilityId}

Path parameters

utilityId*string

The utility ID

Response

201500

Claimed users retrieved successfully

Body

application/json

itemsstring

Request

JavaScriptCurl

const response = await fetch('https://devutility.streamnft.tech/claims/{utilityId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  "text"
]