Kyntix Logo
Developer Hub & Gateway

Kyntix API Documentation

Integrate your storefronts, fetch live Discord bot statistics, or manage automated orders. Our REST API is secured, performant, and built for modern scale.

Authentication & Headers

Private and administrative routes require you to authenticate using a centralized API Key. You must pass this key as an HTTP header on every request.

Required Header
X-API-Key: YOUR_API_KEY_HERE
GET /api/bot-status

Fetches the real-time status of the Kyntix Discord bot, including whether it is currently online and its network latency (ping) in milliseconds.

Interactive Explorer

Integration Snippet

import requests res = requests.get("https://api.kyntix.xyz/api/bot-status") print(res.json())
fetch("https://api.kyntix.xyz/api/bot-status") .then(res => res.json()) .then(data => console.log(data));
GET /api/commands

Returns a list of all application slash commands configured in the bot, along with their names and functional descriptions.

Interactive Explorer

Integration Snippet

import requests res = requests.get("https://api.kyntix.xyz/api/commands") print(res.json())
fetch("https://api.kyntix.xyz/api/commands") .then(res => res.json()) .then(data => console.log(data));
GET /api/command-usage

Retrieves cumulative statistics of how many times each slash command has been executed by users since the bot's initialization.

Interactive Explorer

GET /api/admin/dashboard-stats

Retrieve general dashboard metrics like total member count, active giveaway counts, pending tickets, coupons status, and bot system stats.

Security Details

Requires authorization. Requests must contain a valid X-API-Key or an active dashboard session cookie.

Integration Snippet

import requests headers = { "X-API-Key": "YOUR_API_KEY_HERE" } res = requests.get("https://api.kyntix.xyz/api/admin/dashboard-stats", headers=headers) print(res.json())
fetch("https://api.kyntix.xyz/api/admin/dashboard-stats", { headers: { "X-API-Key": "YOUR_API_KEY_HERE" } }) .then(res => res.json()) .then(data => console.log(data));
POST /api/admin/giveaways/start

Triggers the Discord bot to start a new giveaway campaign instantly in the specified channel.

Request Body Parameters

Parameter Type Requirement Description
channel_id string Required The Discord Channel ID where the giveaway will be sent.
prize string Required The description of the prize (e.g., "1x Nitro Classic").
duration string Required Duration format, e.g. "10m" (minutes), "2h" (hours), "1d" (days).
winners number Optional The number of winners to draw (Defaults to 1).
Toast Message