contests

/:channel

Changed on Feb 7, 2021

List contests

get/contests/{channel}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/streamelements/apis/se-api-docs/docs/contests/:channel/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Headers

Acceptstring required

Example:application/json; charset=utf-8

Response

activestring nullable required

Example response

{
  "active": null,
  "contests": [
    {
      "botResponses": true,
      "totalAmount": 0,
      "totalUsers": 0,
      "_id": "5c0a53cede9a4c207fa14d90",
      "title": "Will I win the next game?",
      "minBet": 10,
      "maxBet": 10000,
      "duration": 5,
      "options": [
        {
          "totalAmount": 0,
          "totalUsers": 0,
          "_id": "5c0a53cede9a4cc345a14d92",
          "title": "Win",
          "command": "win"
        },
        {
          "totalAmount": 0,
          "totalUsers": 0,
          "_id": "5c0a53cede9a4c4b39a14d91",
          "title": "Lose",
          "command": "lose"
        }
      ],
      "channel": "5b2e2007760aeb7729487dab",
      "state": "created",
      "createdAt": "2018-12-07T11:04:46.528Z",
      "updatedAt": "2018-12-07T11:04:46.528Z"
    }
  ]
}

Changes

Feb 7, 20218c745ed2e9e4 Revision changes
- warning
  the optional response header Access-Control-Allow-Credentials removed for the status 200
- warning
  the optional response header Access-Control-Expose-Headers removed for the status 200
- warning
  the optional response header ETag removed for the status 200
- warning
  the optional response header Server removed for the status 200
- warning
  the optional response header Strict-Transport-Security removed for the status 200
- warning
  the optional response header X-Content-Type-Options removed for the status 200
- warning
  the optional response header X-DNS-Prefetch-Control removed for the status 200
- warning
  the optional response header X-Download-Options removed for the status 200
- warning
  the optional response header X-Frame-Options removed for the status 200
- warning
  the optional response header X-Requested-From removed for the status 200
- warning
  the optional response header X-XSS-Protection removed for the status 200
- warning
  deleted the header request parameter Content-Type

Operation history