STstreamelements
single giveaway
giveaways

/:channel/:giveawayId

Changed on

Get giveaway details. This endpoint is available only in the API version 3. Make sure to use the v3 base URL: https://api.streamelements.com/kappa/v3.

get/giveaways/{channel}/{giveawayId}

Request

Path parameters

channelstring required
Example:5b2e2007760aeb7729487dab

guid - Channel id

giveawayIdstring required

guid - Giveaway id

Query parameters

entrantsstring required

boolean

Headers

Acceptstring required
Example:application/json; charset=utf-8

Response

activestring nullable required

Example response

{
  "active": null,
  "giveaways": [
    {
      "subscriberLuck": 1,
      "subscriberOnly": false,
      "totalAmount": 0,
      "totalUsers": 0,
      "botResponses": false,
      "_id": "5c0a6c00de9a4c3a70a14da6",
      "winners": [],
      "channel": "5b2e2007760aeb7729487dab",
      "createdAt": "2018-12-07T12:48:00.133Z",
      "updatedAt": "2018-12-07T12:48:00.133Z"
    },
    {
      "subscriberLuck": 1,
      "subscriberOnly": false,
      "totalAmount": 0,
      "totalUsers": 0,
      "botResponses": false,
      "_id": "5c0a6bdfde9a4c6faaa14da2",
      "winners": [],
      "channel": "5b2e2007760aeb7729487dab",
      "createdAt": "2018-12-07T12:47:27.369Z",
      "updatedAt": "2018-12-07T12:49:10.109Z",
      "startedAt": "2018-12-07T12:47:55.782Z",
      "state": "closed",
      "endedAt": "2018-12-07T12:49:10.108Z"
    }
  ]
}

Changes

  • 7ec3cd3b664eRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8421cd25897fRevision changes
    • info

      api tag giveaways added