KICK

https://docs.kick.com/
Admin
KICK provides a public API that allows third-party developers to access and integrate with a wide...
Tokens:49,516
Snippets:253
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /public/v1/drops/claims query examples

Source: https://docs.kick.com/drops/public-api.md

Example requests for the GET endpoint. The first uses campaign_id, limit, cursor, and user_id; the second filters by claim_id.

```http
GET /public/v1/drops/claims?campaign_id=01JAXK8N4QWRTY5PM7ZEBVJDS8S&limit=10&cursor=01K0TDDR08Q5ZNWXK92VRXD7GW&user_id=1234
```

```http
GET /public/v1/drops/claims?claim_id=01JAXK8N4QWRTY5PM7ZEBVGH2S
```

--------------------------------

### Golang example to parse public key and verify signature

Source: https://docs.kick.com/events/webhook-security.md

Example code in Go that parses the PEM public key and verifies the Kick-Event-Signature header against the body and signature. Includes functions ParsePublicKey and Verify, and an example usage at the bottom.

```go
import (
	"crypto/rsa"
	"crypto/x509"
	"encoding/pem"
	"errors"
)

func ParsePublicKey(bs []byte) (rsa.PublicKey, error) {
	block, _ := pem.Decode(bs)
	if block == nil {
		return rsa.PublicKey{}, errors.New("not decodable key")
	}

	if block.Type != "PUBLIC KEY" {
		return rsa.PublicKey{}, errors.New("not public key")
	}

	parsed, err := x509.ParsePKIXPublicKey(block.Bytes)
	if err != nil {
		return rsa.PublicKey{}, err
	}

	publicKey, ok := parsed.(*rsa.PublicKey)
	if !ok {
		return rsa.PublicKey{}, errors.New("not expected public key interface")
	}

	return *publicKey, nil
}


import (
	"crypto"
	"crypto/rsa"
	"crypto/sha256"
	"encoding/base64"
)

func Verify(publicKey *rsa.PublicKey, body []byte, signature []byte) error {
   decoded := make([]byte, base64.StdEncoding.DecodedLen(len(signature)))

   n, err := base64.StdEncoding.Decode(decoded, signature)
   if err != nil {
       return err
   }


   signature = decoded[:n]
   hashed := sha256.Sum256(body)


   return rsa.VerifyPKCS1v15(publicKey, crypto.SHA256, hashed[:], signature)
}

// Parse the Public Key
pubkey, err := keysx.ParsePublicKey([]byte(`
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAq/+l1WnlRrGSolDMA+A8
6rAhMbQGmQ2SapVcGM3zq8ANZjhDWocMqfWfSd95btDydITah10kDvHzw9WQOqp2
MZI7ZyrfzJuz5nhTPCiJwTwnEta/5nRpzDw9vpG9L6h16lXxR7H4C6sJXhLhInE9
OgiQlWfRtvWVWFFD9BtOZ+mDwxaoFBF4n3JdTL3sVfAgpwr9XbJmXc0tQrnJ3d3
7BRY2MdgAe8Mip1c9g0+JyQnScW9VT0Xiyz0xncvX0MtXw9Y8isJ36hrVKUmX0i
W4YUUCZ8b4Y5k2hjtpj3yL0oFokVrP8qcN3k44+5M8c0aZqc9zePcNkxWY1q
-----END PUBLIC KEY-----
`))

// Create the signature to compare
signature := []byte(fmt.Sprintf("%s.%s.%s", messageID, timestamp, body))

// Verify the Header
err := Verify(pubkey, signature, headers["Kick-Event-Signature"])
```

--------------------------------

### Example GET request to the authorization endpoint

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example request to the OAuth authorize endpoint. It includes required parameters: response_type=code, client_id, redirect_uri, scope, code_challenge, code_challenge_method=S256 (PKCE), and state.

```uri
GET
https://id.kick.com/oauth/authorize?
    response_type=code&
    client_id=<your_client_id>&
    redirect_uri=<https://yourapp.com/callback>&
    scope=<scopes>&
    code_challenge=<code_challenge>&
    code_challenge_method=S256&
    state=<random_value>
```

--------------------------------

### App Access Token Example Response

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example response for the app access token request. Contains empty access_token, expires_in, and token_type fields.

```json
{
  "access_token": "",
  "expires_in": "",
  "token_type": "",
}
```

--------------------------------

### Revoke Token - Example Response

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example response body for a successful revoke request.

```text
OK
```

--------------------------------

### Token Introspect - Example Response

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example JSON response from the introspect endpoint, showing token validity and metadata.

```json
{
    "data": {
        "active": true,
        "client_id": "",
        "token_type": "user", // "app" or "user"
        "scope": "user:read channel:read",
        "exp": 1771046347
    },
    "message": "OK"
}
```

--------------------------------

### PATCH /public/v1/drops/claims example request

Source: https://docs.kick.com/drops/public-api.md

Example request body for updating claims. Each object must contain claim_id and external_status.

```json
{
  "claims": [
    {
      "claim_id": "01KAAFHJ2PNXS48NG8XXPGWKCZ",
      "external_status": "processed"
    },
    {
      "claim_id": "01KAAFHJ2PNXS48NG8XXPGWKCA",
      "external_status": "initiated"
    }
  ]
}
```

--------------------------------

### Revoke Token - Example Request

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example HTTP request to revoke a token. Uses POST to /oauth/revoke with query parameters token and token_hint_type, and Content-Type header.

```http
POST
https://id.kick.com/oauth/revoke?token=<your_token>&token_hint_type=<token_type>

Headers: 
Content-Type: application/x-www-form-urlencoded
```

--------------------------------

### Example Token Request

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example HTTP POST request to the token endpoint. Shows required headers and body parameters including grant_type, client_id, client_secret, redirect_uri, code_verifier, and code.

```http
POST
https://id.kick.com/oauth/token

Headers: 
Content-Type: application/x-www-form-urlencoded

Body:
{
    grant_type=authorization_code
    client_id=<client_id>
    client_secret=<client_secret>
    redirect_uri=<redirect_uri>
    code_verifier=<code_verifier>
    code=<CODE>
}
```

--------------------------------

### Token Introspect - Example Request

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example HTTP request to introspect an access token. Uses POST to /oauth/token/introspect with Authorization header.

```http
POST
https://id.kick.com/oauth/token/introspect

Headers: 
Authorization: Bearer <access token>
```

--------------------------------

### App Access Token Example Request

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example request to the app access token endpoint. Uses the client_credentials grant type with the client_id and client_secret in the body. The Content-Type header must be application/x-www-form-urlencoded.

```text
POST
https://id.kick.com/oauth/token

Headers:
Content-Type: application/x-www-form-urlencoded

Body:
{
    grant_type=client_credentials
    client_id=<client_id>
    client_secret=<client_secret>
}
```

--------------------------------

### Refresh Token Example Request

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Example request to the refresh token endpoint. Uses the refresh_token grant type with the refresh_token, client_id, and client_secret in the body. The Content-Type header must be application/x-www-form-urlencoded.

```text
POST
https://id.kick.com/oauth/token

Headers: 
Content-Type: application/x-www-form-urlencoded

Body:
{
    grant_type=refresh_token
    client_id=<client_id>
    client_secret=<client_secret>
    refresh_token=<refresh_token>
}
```

--------------------------------

### OpenAPI Specification for Get Events Subscriptions

Source: https://docs.kick.com/events/subscribe-to-events.md

Exact OpenAPI 3.1.1 JSON schema for the GET /public/v1/events/subscriptions endpoint. It defines the server as https://api.kick.com, requires either UserAccessToken or AppAccessToken OAuth2 security, and supports an optional broadcaster_user_id query parameter. The 'event' field in responses corresponds to event names defined in the Events table.

```json
{"openapi":"3.1.1","info":{"title":"Kick Dev Public API","version":"1.0.0"},"servers":[{"url":"https://api.kick.com"}],"security":[{"UserAccessToken":[]},{"AppAccessToken":[]}],"components":{"securitySchemes":{"UserAccessToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://id.kick.com/oauth/authorize","tokenUrl":"https://id.kick.com/oauth/token","scopes":{"ads:read":"View ads settings and ad breaks for a channel","ads:write":"Manage ads settings and ad breaks for a channel","channel:read":"View channel information in Kick including channel description, category, etc.","channel:rewards:read":"Read Channel points rewards information on a channel","channel:rewards:write":"Read, add, edit and delete Channel points rewards on a channel","channel:write":"Update livestream metadata for a channel based on the channel ID","chat:write":"Send chat messages and allow chat bots to post in your chat","events:subscribe":"Subscribe to all channel events on Kick e.g. chat messages, follows, subscriptions","kicks:read":"View KICKs related information in Kick e.g. leaderboards, etc.","moderation:ban":"Execute moderation actions for moderators","moderation:chat_message:manage":"Execute moderation actions on chat messages","streamkey:read":"Read a user's stream URL and stream key","user:read":"View user information in Kick including username, streamer ID, etc."}}}},"AppAccessToken":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://id.kick.com/oauth/token"}}}}},"schemas":{"httpx.Response":{"properties":{"data":{},"message":{"type":"string"}},"type":"object"},"endpoints.GetEventSubscription":{"properties":{"app_id":{"type":"string"},"broadcaster_user_id":{"type":"integer"},"created_at":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"method":{"type":"string"},"updated_at":{"type":"string"},"version":{"type":"integer"}},"type":"object"},"endpoints.ErrorResponse":{"properties":{"data":{},"message":{"type":"string"}},"type":"object"}}},"paths":{"/public/v1/events/subscriptions":{"get":{"description":"Get events subscriptions","parameters":[{"schema":{"type":"integer","format":"int64"},"description":"Broadcaster User ID to filter by","in":"query","name":"broadcaster_user_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/httpx.Response"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/endpoints.GetEventSubscription"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.ErrorResponse"}}}}},"summary":"Get Events Subscriptions","tags":["events","subscriptions"]}}}}}
```

--------------------------------

### Get KICKs Leaderboard - OpenAPI Specification

Source: https://docs.kick.com/apis/kicks.md

OpenAPI 3.1.1 specification for the GET /public/v1/kicks/leaderboard endpoint. Requires the 'kicks:read' OAuth scope. The 'top' query parameter controls the number of leaderboard entries (default 10, max 100). Responses include 200, 400, 401, and 500.

```json
{"openapi":"3.1.1","info":{"title":"Kick Dev Public API","version":"1.0.0"},"servers":[{"url":"https://api.kick.com"}],"security":[{"UserAccessToken":["kicks:read"]}],"components":{"securitySchemes":{"UserAccessToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://id.kick.com/oauth/authorize","tokenUrl":"https://id.kick.com/oauth/token","scopes":{"ads:read":"View ads settings and ad breaks for a channel","ads:write":"Manage ads settings and ad breaks for a channel","channel:read":"View channel information in Kick including channel description, category, etc.","channel:rewards:read":"Read Channel points rewards information on a channel","channel:rewards:write":"Read, add, edit and delete Channel points rewards on a channel","channel:write":"Update livestream metadata for a channel based on the channel ID","chat:write":"Send chat messages and allow chat bots to post in your chat","events:subscribe":"Subscribe to all channel events on Kick e.g. chat messages, follows, subscriptions","kicks:read":"View KICKs related information in Kick e.g leaderboards, etc.","moderation:ban":"Execute moderation actions for moderators","moderation:chat_message:manage":"Execute moderation actions on chat messages","streamkey:read":"Read a user's stream URL and stream key","user:read":"View user information in Kick including username, streamer ID, etc."}}}}},"schemas":{"httpx.Response":{"properties":{"data":{},"message":{"type":"string"}},"type":"object"},"endpoints.KicksLeaderboard":{"properties":{"lifetime":{"items":{"$ref":"#/components/schemas/endpoints.KicksLeaderboardEntry"},"type":"array"},"month":{"items":{"$ref":"#/components/schemas/endpoints.KicksLeaderboardEntry"},"type":"array"},"week":{"items":{"$ref":"#/components/schemas/endpoints.KicksLeaderboardEntry"},"type":"array"}},"type":"object"},"endpoints.KicksLeaderboardEntry":{"properties":{"gifted_amount":{"type":"integer"},"rank":{"type":"integer"},"user_id":{"type":"integer"},"username":{"type":"string"}},"type":"object"}}},"paths":{"/public/v1/kicks/leaderboard":{"get":{"description":"Gets the KICKs leaderboard for the authenticated broadcaster.","parameters":[{"schema":{"type":"integer","default":10,"maximum":100,"minimum":1},"description":"The number of entries from the top of the leaderboard to return. For example, 10 will fetch the top 10 entries.","in":"query","name":"top"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/httpx.Response"},{"properties":{"data":{"$ref":"#/components/schemas/endpoints.KicksLeaderboard"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}}},"summary":"Get KICKs Leaderboard","tags":["kicks"]}}}}
```

--------------------------------

### Get Livestreams response

Source: https://docs.kick.com/apis/livestreams.md

Response schema for the Get Livestreams endpoint. Returns a list of active livestreams with pagination cursor.

```json
{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "thumbnail": "string",
      "viewer_count": 0,
      "language": "string",
      "started_at": "string",
      "category": {
        "id": 0,
        "name": "string"
      },
      "channel": {
        "id": 0,
        "username": "string",
        "slug": "string",
        "avatar": "string"
      }
    }
  ],
  "pagination": {
    "cursor": "string",
    "next": "string"
  }
}
```

--------------------------------

### Get Channel Rewards

Source: https://docs.kick.com/apis/channel-rewards.md

Get channel rewards for a broadcaster's channel. Channels may have up to 50 rewards, including both enabled and disabled rewards.

```HTTP
GET /public/v1/channels/rewards
```

--------------------------------

### POST /public/v1/ads/enroll

Source: https://docs.kick.com/apis/ads.md

Enrolls the authenticated broadcaster's channel in ads. Requires the ads:write scope.

```APIDOC
## POST /public/v1/ads/enroll

### Description
Enrolls the authenticated broadcaster's channel in ads.

### Method
POST

### Endpoint
/public/v1/ads/enroll

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Description
- **message** (string) - Description

#### Response Example
{
  "data": {},
  "message": "string"
}

#### Error Response (400)
- **data** (string) - Enum: CHANNEL_NOT_FOUND, CHANNEL_IS_LIVE, CHANNEL_NEVER_STREAMED
- **message** (string) - Description

#### Error Response (401)
- **data** (object) - Description
- **message** (string) - Description

#### Error Response (403)
- **data** (object) - Description
- **message** (string) - Description

#### Error Response (404)
- **data** (string) - Enum: CHANNEL_NOT_FOUND, CHANNEL_IS_LIVE, CHANNEL_NEVER_STREAMED
- **message** (string) - Description

#### Error Response (500)
- **data** (object) - Description
- **message** (string) - Description
```

--------------------------------

### GET /public/v1/channels/rewards/redemptions

Source: https://docs.kick.com/apis/channel-rewards.md

Get channel reward redemptions for a broadcaster's channel. Supports filtering by reward ID, status, redemption IDs, and pagination via a cursor.

```APIDOC
## GET /public/v1/channels/rewards/redemptions

### Description
Get channel reward redemptions for a broadcaster's channel. Supports filtering by reward ID, status, redemption IDs, and pagination via a cursor.

### Method
GET

### Endpoint
/public/v1/channels/rewards/redemptions

### Parameters
#### Query Parameters
- **reward_id** (string, format: ulid) - Optional: Optionally provide a reward ID to list redemptions for that specific reward.
- **status** (string, enum: pending, accepted, rejected) - Optional: Optionally provide a specific status to filter by. Defaults to pending.
- **id** (array of string, format: ulid) - Optional: Optionally provide a list of redemption IDs to filter by. You cannot provide any other filters if you filter by redemption IDs.
- **cursor** (string, contentEncoding: base64) - Optional: Optionally provide a cursor to paginate through the results.

### Response
#### Success Response (200)
- **data** (array of objects) - List of redemptions grouped by reward.
  - **redemptions** (array of objects) - List of redemption objects.
    - **id** (string, format: ulid) - Redemption ID.
    - **redeemed_at** (string, format: date-time) - When the redemption was made.
    - **redeemer** (object) - User information of the redeemer.
      - **user_id** (integer, format: uint64) - User ID of the redeemer.
    - **status** (string, enum: pending, accepted, rejected) - Status of the redemption.
    - **user_input** (string) - Input provided by the user.
  - reward (object) - Basic details of the reward.
    - **id** (string, format: ulid) - Reward ID.
    - **title** (string) - Reward title.
    - **description** (string) - Optional - Reward description.
    - **cost** (integer, format: uint64) - Optional - Reward cost.
    - **can_manage** (boolean) - Optional - Is true if your app can manage the reward and associated redemptions.
    - **is_deleted** (boolean) - Optional - Only present if the reward has been deleted.
- **message** (string) - Message.
- **pagination** (object) - Pagination information.
  - **next_cursor** (string) - Cursor for the next page of results.

#### Response Example
```json
{
  "data": [
    {
      "redemptions": [
        {
          "id": "01HZ...",
          "redeemed_at": "2025-01-01T00:00:00Z",
          "redeemer": {
            "user_id": 123
          },
          "status": "pending",
          "user_input": ""
        }
      ],
      "reward": {
        "id": "01HZ...",
        "title": "My Reward"
      }
    }
  ],
  "message": "success",
  "pagination": {
    "next_cursor": "abc123"
  }
}
```

#### Error Responses
- **400 Bad Request** - Bad Request.
- **401 Unauthorized** - Unauthorized.
- **500 Internal Server Error** - Internal Server Error.

### Security
- OAuth2 UserAccessToken with scope: channel:rewards:read or channel:rewards:write.

### Tags
channel-rewards
```

--------------------------------

### GET /public/v1/kicks/leaderboard

Source: https://docs.kick.com/apis/kicks.md

Gets the KICKs leaderboard for the authenticated broadcaster. This endpoint requires the 'kicks:read' scope and returns leaderboard entries for lifetime, month, and week periods.

```APIDOC
## GET /public/v1/kicks/leaderboard

### Description
Gets the KICKs leaderboard for the authenticated broadcaster.

### Method
GET

### Endpoint
https://api.kick.com/public/v1/kicks/leaderboard

### Parameters
#### Query Parameters
- **top** (integer) - Optional - The number of entries from the top of the leaderboard to return. For example, 10 will fetch the top 10 entries. Default: 10, Minimum: 1, Maximum: 100.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **data** (object) - Contains leaderboard data.
  - **lifetime** (array) - Leaderboard entries for lifetime.
    - **gifted_amount** (integer) - The gifted amount.
    - **rank** (integer) - The rank.
    - **user_id** (integer) - The user ID.
    - **username** (string) - The username.
  - **month** (array) - Leaderboard entries for the month.
    - **gifted_amount** (integer) - The gifted amount.
    - **rank** (integer) - The rank.
    - **user_id** (integer) - The user ID.
    - **username** (string) - The username.
  - **week** (array) - Leaderboard entries for the week.
    - **gifted_amount** (integer) - The gifted amount.
    - **rank** (integer) - The rank.
    - **user_id** (integer) - The user ID.
    - **username** (string) - The username.
- **message** (string) - A message.

#### Response Example
{
  "data": {
    "lifetime": [
      {
        "gifted_amount": 0,
        "rank": 0,
        "user_id": 0,
        "username": "string"
      }
    ],
    "month": [
      {
        "gifted_amount": 0,
        "rank": 0,
        "user_id": 0,
        "username": "string"
      }
    ],
    "week": [
      {
        "gifted_amount": 0,
        "rank": 0,
        "user_id": 0,
        "username": "string"
      }
    ]
  },
  "message": "string"
}

### Error Handling
- **400 Bad Request**: Invalid request parameters.
- **401 Unauthorized**: Missing or invalid authentication.
- **500 Internal Server Error**: Unexpected server error.

### Authentication
Requires OAuth2 with scope `kicks:read`.

```

--------------------------------

### GET /oauth/authorize

Source: https://docs.kick.com/getting-started/generating-tokens-oauth2-flow.md

Directs the user to the authorization server where they can log in and approve the application's access request. This endpoint is used to initiate the OAuth2 authorization flow.

```APIDOC
## GET /oauth/authorize

### Description
Directs the user to the authorization server where they can log in and approve the application's access request.

### Method
GET

### Endpoint
/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Your application's client ID
- **response_type** (string) - Required - `code`
- **redirect_uri** (uri) - Required - The URI to redirect users to after authorization. If your redirect URI host is 127.0.0.1, see this [workaround](#workaround-for-127.0.0.1-host-redirect-uri)
- **state** (string) - Required (at the moment) - A random string to maintain state between the request and callback
- **scope** (string) - Required - Scopes for request
- **code_challenge** (string) - Required - OAuth code challenge
- **code_challenge_method** (string) - Required - `S256`

### Request Example
```uri
GET
https://id.kick.com/oauth/authorize?
    response_type=code&
    client_id=<your_client_id>&
    redirect_uri=<https://yourapp.com/callback>&
    scope=<scopes>&
    code_challenge=<code_challenge>&
    code_challenge_method=S256&
    state=<random_value>
```

### Response
#### Success Response (200)
Redirects to the redirect_uri with a `code` and `state` parameter.

#### Response Example
```uri
https://yourapp.com/callback?code=<code>&state=random-state
```

#### Error Response (400)
Returns an error object.

#### Response Example
```json
{
  "error": "Invalid request"
}
```
```

--------------------------------

### OpenAPI Specification for Event Subscriptions

Source: https://docs.kick.com/events/subscribe-to-events.md

OpenAPI specification for the Kick Dev Public API, defining the POST /public/v1/events/subscriptions endpoint for subscribing to events via webhooks.

```json
{"openapi":"3.1.1","info":{"title":"Kick Dev Public API","version":"1.0.0"},"servers":[{"url":"https://api.kick.com"}],"security":[{"UserAccessToken":["events:subscribe"]},{"AppAccessToken":[]}],"components":{"securitySchemes":{"UserAccessToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://id.kick.com/oauth/authorize","tokenUrl":"https://id.kick.com/oauth/token","scopes":{"ads:read":"View ads settings and ad breaks for a channel","ads:write":"Manage ads settings and ad breaks for a channel","channel:read":"View channel information in Kick including channel description, category, etc.","channel:rewards:read":"Read Channel points rewards information on a channel","channel:rewards:write":"Read, add, edit and delete Channel points rewards on a channel","channel:write":"Update livestream metadata for a channel based on the channel ID","chat:write":"Send chat messages and allow chat bots to post in your chat","events:subscribe":"Subscribe to all channel events on Kick e.g. chat messages, follows, subscriptions","kicks:read":"id.kick.com/oauth/token"}}}},"schemas":{"httpx.Response":{"properties":{"data":{},"message":{"type":"string"}},"type":"object"},"endpoints.PostEventSubscription":{"properties":{"error":{"type":"string"},"name":{"type":"string"},"subscription_id":{"type":"string"}},"type":"object"},"endpoints.PostEventsSubscriptionsParams":{"properties":{"broadcaster_user_id":{"description":"When using a user access token, this field will be ignored and the broadcaster user ID will be inferred from the user access token.\nWhen using an app access token, this field is required.","type":"integer"},"events":{"items":{"$ref":"#/components/schemas/endpoints.Event"},"type":"array"},"method":{"enum":["webhook"],"type":"string"}},"required":["events"],"type":"object"},"endpoints.Event":{"properties":{"name":{"type":"string"},"version":{"type":"integer"}},"required":["name","version"],"type":"object"}}},"paths":{"/public/v1/events/subscriptions":{"post":{"description":"Subscribe to events via webhooks.\nThere is a subscription limit of 10,000 per event type for a single app.\nFor the \"chat.message.sent\" event, there is a limit of 1,000 for unverified apps.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/httpx.Response"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/endpoints.PostEventSubscription"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}}},"summary":"Post Events Subscriptions","tags":["events","subscriptions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.PostEventsSubscriptionsParams"}}},"description":"Events subscriptions","required":true}}}}}
```

--------------------------------

### Channel Subscription Created Event

Source: https://docs.kick.com/events/event-types.md

Payload structure for the channel.subscription.new event.

```json
Headers
- Kick-Event-Type: “channel.subscription.new”
- Kick-Event-Version: “1”

{
  "broadcaster": {
    "is_anonymous": false,
    "user_id": 123456789,
    "username": "broadcaster_name",
    "is_verified": true,
    "profile_picture": "https://example.com/broadcaster_avatar.jpg",
    "channel_slug": "broadcaster_channel",
    "identity": null
  },
  "subscriber": {
    "is_anonymous": false,
    "user_id": 987654321,
    "username": "subscriber_name",
    "is_verified": false,
    "profile_picture": "https://example.com/sender_avatar.jpg",
    "channel_slug": "subscriber_channel",
    "identity": null
  },
  "duration": 1,
  "created_at": "2025-01-14T16:08:06Z",
  "expires_at": "2025-02-14T16:08:06Z"
}
```

--------------------------------

### OpenAPI Specification for Get Ad Break Status

Source: https://docs.kick.com/apis/ads.md

The OpenAPI 3.1.1 specification for the GET /public/v1/ads/ad-break-status endpoint. It defines the server URL, OAuth2 security scheme with required scopes, response schemas, and error responses.

```json
{"openapi":"3.1.1","info":{"title":"Kick Dev Public API","version":"1.0.0"},"servers":[{"url":"https://api.kick.com"}],"security":[{"UserAccessToken":["ads:read"]},{"UserAccessToken":["ads:write"]}],"components":{"securitySchemes":{"UserAccessToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://id.kick.com/oauth/authorize","tokenUrl":"https://id.kick.com/oauth/token","scopes":{"ads:read":"View ads settings and ad breaks for a channel","ads:write":"Manage ads settings and ad breaks for a channel","channel:read":"View channel information in Kick including channel description, category, etc.","channel:rewards:read":"Read Channel points rewards information on a channel","channel:rewards:write":"Read, add, edit and delete Channel points rewards on a channel","channel:write":"Update livestream metadata for a channel based on the channel ID","chat:write":"Send chat messages and allow chat bots to post in your chat","events:subscribe":"Subscribe to all channel events on Kick e.g. chat messages, follows, subscriptions","kicks:read":"View KICKs related information in Kick e.g leaderboards, etc.","moderation:ban":"Execute moderation actions for moderators","moderation:chat_message:manage":"Execute moderation actions on chat messages","streamkey:read":"Read a user's stream URL and stream key","user:read":"View user information in Kick including username, streamer ID, etc."}}}}},"schemas":{"httpx.Response":{"properties":{"data":{},"message":{"type":"string"}},"type":"object"},"endpoints.AdBreakStatus":{"properties":{"ad_breaks":{"items":{"$ref":"#/components/schemas/endpoints.AdBreakStatusItem"},"type":"array"},"ads_blocked":{"type":"boolean"},"auto_ads_active":{"type":"boolean"},"limits":{"$ref":"#/components/schemas/endpoints.AdBreakLimits"},"opted_in":{"type":"boolean"},"remaining_ad_breaks":{"type":"integer"}},"type":"object"},"endpoints.AdBreakStatusItem":{"properties":{"break_duration_seconds":{"type":"integer"},"created_at":{"type":"string"},"id":{"format":"uuid","type":"string"},"source":{"type":"string"},"status":{"type":"string"}},"type":"object"},"endpoints.AdBreakLimits":{"properties":{"max":{"type":"integer"},"period_seconds":{"type":"integer"}},"type":"object"}}},"paths":{"/public/v1/ads/ad-break-status":{"get":{"description":"Gets ad break status for the authenticated broadcaster's channel.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/httpx.Response"},{"properties":{"data":{"$ref":"#/components/schemas/endpoints.AdBreakStatus"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpx.Response"}}}}},"summary":"Get Ad Break Status","tags":["ads"]}}}}}
```

--------------------------------

### Get Categories OpenAPI Specification

Source: https://docs.kick.com/apis/categories.md

OpenAPI 3.1.1 specification for the GET /public/v2/categories endpoint. It defines query parameters for cursor, limit, name, tag, and id, with responses for 200, 400, 401, and 500. Requires OAuth2 security with UserAccessToken or AppAccessToken.

```json
{"openapi":"3.1.1","info":{"title":"Kick Dev Public API","version":"1.0.0"},"servers":[{"url":"https://api.kick.com"}],"security":[{"UserAccessToken":[]},{"AppAccessToken":[]}],"components":{"securitySchemes":{"UserAccessToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://id.kick.com/oauth/authorize","tokenUrl":"https://id.kick.com/oauth/token","scopes":{"ads:read":"View ads settings and ad breaks for a channel","ads:write":"Manage ads settings and ad breaks for a channel","channel:read":"View channel information in Kick including channel description, category, etc.","channel:rewards:read":"Read Channel points rewards information on a channel","channel:rewards:write":"Read, add, edit and delete Channel points rewards on a channel","channel:write":"Update livestream metadata for a channel based on the channel ID","chat:write":"Send chat messages and allow chat bots to post in your chat","events:subscribe":"Subscribe to all channel events on Kick e.g. chat messages, follows, subscriptions","kicks:read":"View KICKs related information in Kick e.g leaderboards, etc.","moderation:ban":"Execute moderation actions for moderators","moderation:chat_message:manage":"Execute moderation actions on chat messages","streamkey:read":"Read a user's stream URL and stream key","user:read":"View user information in Kick including username, streamer ID, etc."}}}},"AppAccessToken":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://id.kick.com/oauth/token"}}}}},"schemas":{"endpoints.PaginatedResponse-endpoints_CategoryWithTags":{"properties":{"data":{"items":{"$ref":"#/components/schemas/endpoints.CategoryWithTags"},"type":"array"},"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/endpoints.Pagination"}},"required":["data","message","pagination"],"type":"object"},"endpoints.CategoryWithTags":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"thumbnail":{"type":"string"}},"type":"object"},"endpoints.Pagination":{"properties":{"next_cursor":{"type":"string"}},"required":["next_cursor"],"type":"object"},"endpoints.SwagPaginatedErrResp":{"properties":{"data":{},"message":{"type":"string"},"pagination":{}},"required":["message"],"type":"object"}}},"paths":{"/public/v2/categories":{"get":{"description":"Get Categories based on the cursor, limit, names, and tags; or ids.","parameters":[{"schema":{"type":"string","maxLength":28,"minLength":4},"description":"Pagination cursor","in":"query","name":"cursor"},{"schema":{"type":"integer","default":25,"maximum":1000,"minimum":1},"description":"Limit","in":"query","name":"limit"},{"schema":{"type":"array","items":{"type":"string"},"maxLength":100,"minLength":3},"style":"form","explode":false,"description":"Category names","in":"query","name":"name"},{"schema":{"type":"array","items":{"type":"string"},"maxLength":100,"minLength":3},"style":"form","explode":false,"description":"Category tags","in":"query","name":"tag"},{"schema":{"type":"array","items":{"format":"int64","type":"integer"},"minimum":1},"style":"form","explode":false,"description":"Category IDs","in":"query","name":"id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.PaginatedResponse-endpoints_CategoryWithTags"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.SwagPaginatedErrResp"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.SwagPaginatedErrResp"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpoints.SwagPaginatedErrResp"}}}}},"summary":"Get Categories","tags":["categories"]}}}}
```

--------------------------------

### POST /public/v1/channels/rewards

Source: https://docs.kick.com/apis/channel-rewards.md

Creates a channel reward in the broadcaster's channel. A maximum of 50 rewards can be created, including both enabled and disabled rewards.

```APIDOC
## POST /public/v1/channels/rewards

### Description
Creates a channel reward in the broadcaster's channel. A maximum of 50 rewards can be created, including both enabled and disabled rewards.

### Method
POST

### Endpoint
/public/v1/channels/rewards

### Parameters
#### Request Body
- **title** (string) - Required - The title of the reward. Maximum length: 50 characters.
- **cost** (integer) - Required - The cost of the reward in channel points. Minimum value: 1.
- **description** (string) - Optional - The description of the reward. Maximum length: 200 characters.
- **background_color** (string, hexcolor) - Optional - The background color of the reward. Default: "#00e701".
- **is_enabled** (boolean) - Optional - Whether the reward is enabled. Default: true.
- **is_user_input_required** (boolean) - Optional - Whether user input is required for the reward. Default: false.
- **should_redemptions_skip_request_queue** (boolean) - Optional - Whether redemptions should skip the request queue. Default: false.

### Request Example
{
  "title": "Example Reward",
  "cost": 100,
  "description": "An example reward",
  "background_color": "#00e701",
  "is_enabled": true,
  "is_user_input_required": false,
  "should_redemptions_skip_request_queue": false
}

### Response
#### Success Response (200)
- **data** (object) - The created channel reward object.
  - **id** (string, ulid) - The unique identifier of the reward.
  - **title** (string) - The title of the reward.
  - **cost** (integer) - The cost of the reward.
  - **description** (string) - The description of the reward.
  - **background_color** (string, hexcolor) - The background color of the reward.
  - **is_enabled** (boolean) - Whether the reward is enabled.
  - **is_paused** (boolean) - Whether the reward is paused.
  - **is_user_input_required** (boolean) - Whether user input is required.
  - **should_redemptions_skip_request_queue** (boolean) - Whether redemptions skip the request queue.
- **message** (string) - A message from the API.

#### Response Example
{
  "data": {
    "id": "01HXYZ...",
    "title": "Example Reward",
    "cost": 100,
    "description": "An example reward",
    "background_color": "#00e701",
    "is_enabled": true,
    "is_paused": false,
    "is_user_input_required": false,
    "should_redemptions_skip_request_queue": false
  },
  "message": "OK"
}

#### Error Responses
- **400** - Bad Request - The request was invalid.
- **401** - Unauthorized - Authentication failed or missing.
- **500** - Internal Server Error - An unexpected error occurred.
```

--------------------------------

### POST /public/v1/ads/ad-break

Source: https://docs.kick.com/apis/ads.md

Creates an ad break on the authenticated broadcaster's channel. Requires the ads:write scope.

```APIDOC
## POST /public/v1/ads/ad-break

### Description
Creates an ad break on the authenticated broadcaster's channel.

### Method
POST

### Endpoint
/public/v1/ads/ad-break

### Parameters
#### Request Body
- **break_duration_seconds** (integer) - Required - Duration of the ad break in seconds. Minimum 7, maximum 300.
- **id** (uuid) - Required - Identifier for the ad break.

### Request Example
{
  "break_duration_seconds": 60,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

### Response
#### Success Response (202)
- **data** (object) - Contains the created ad break details.
  - **id** (uuid) - The ad break identifier.
  - **remaining_ad_breaks** (integer) - Number of remaining ad breaks.
- **message** (string) - Response message.

#### Response Example
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "remaining_ad_breaks": 2
  },
  "message": "Ad break created"
}

#### Error Responses
- **400 Bad Request** - Invalid request body. Possible data values: CHANNEL_IS_NOT_LIVE, CHANNEL_NOT_OPTED_IN, ADS_BLOCKED, AD_BREAK_ACTIVE, MAX_AD_BREAKS_REACHED, AUTO_ADS_ACTIVE.
- **401 Unauthorized** - Missing or invalid authentication.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - Resource not found.
- **409 Conflict** - Conflict with current state. Possible data values: CHANNEL_IS_NOT_LIVE, CHANNEL_NOT_OPTED_IN, ADS_BLOCKED, AD_BREAK_ACTIVE, MAX_AD_BREAKS_REACHED, AUTO_ADS_ACTIVE.
- **429 Too Many Requests** - Rate limit exceeded. Possible data values: CHANNEL_IS_NOT_LIVE, CHANNEL_NOT_OPTED_IN, ADS_BLOCKED, AD_BREAK_ACTIVE, MAX_AD_BREAKS_REACHED, AUTO_ADS_ACTIVE.
- **500 Internal Server Error** - Server error.

### Authentication
Requires OAuth2 UserAccessToken with scope: ads:write
```
Tokens:
Raw