REST API v1 · למפתחים · מדריך עיון ל-API
מדריך עיון ל-API: בנק
כל 4 נקודות הקצה של בנק ב-REST API v1 של BotGG: הרשאות, פרמטרים, שדות, שגיאות ודוגמאות מוכנות ב-curl, JavaScript ו-Python.
תיעוד למפתחים
בעמוד הזה
נקודות קצה
הנתיבים יחסיים ל-https://console.botgg.app/api/v1. שלחו את מפתח ה-API בכותרת Authorization: Bearer botgg_…; מזהים הם מחרוזות.
| נקודת קצה | הרשאה | תיאור |
|---|---|---|
GET/guilds/{guildId}/bank/members/{userId} | bank:read | Get a member’s balance |
GET/guilds/{guildId}/bank/members/{userId}/transactions | bank:read | List a member’s transactions |
POST/guilds/{guildId}/bank/members/{userId}/transactions | bank:write | Add to or remove from a member’s balance |
GET/guilds/{guildId}/bank/leaderboard | bank:read | Top balances |
מלבד השגיאות הייחודיות שלה (בהמשך), כל נקודת קצה יכולה להחזיר את השגיאות הכלליות האלה:
Get a member’s balance
GET/guilds/{guildId}/bank/members/{userId}
Members without an account yet get the server’s starting balance.
נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק
| שם | מיקום | סוג | חובה | תיאור |
|---|---|---|---|---|
guildId | נתיב | string | כן | המזהה של השרת שלכם · מזהה דיסקורד (מחרוזת) |
userId | נתיב | string | כן | מזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת) |
תשובה
| שדה | סוג | חובה | תיאור |
|---|---|---|---|
userId | string | כן | |
balance | integer | כן | |
currency | object | כן | |
currency.name | string | כן | |
currency.plural | string | כן | |
currency.emoji | string | null | כן |
{
"userId": "876543210987654321",
"balance": 1350,
"currency": {
"name": "Example",
"plural": "example",
"emoji": "🪙"
}
}דוגמאות
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321" \
-H "Authorization: Bearer $BOTGG_API_KEY"// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)שגיאות
| HTTP | קודים |
|---|---|
| 409 | BANK_DISABLED |
| 503 | SERVICE_UNAVAILABLE |
List a member’s transactions
GET/guilds/{guildId}/bank/members/{userId}/transactions
Newest first. Pass before=<nextCursor> for the next page.
נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק
| שם | מיקום | סוג | חובה | תיאור |
|---|---|---|---|---|
guildId | נתיב | string | כן | המזהה של השרת שלכם · מזהה דיסקורד (מחרוזת) |
userId | נתיב | string | כן | מזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת) |
limit | query | integer | לא | 1–100 · ברירת מחדל 25 |
before | query | integer | לא | לפחות 1 |
תשובה
| שדה | סוג | חובה | תיאור |
|---|---|---|---|
items | array of object | כן | |
items[].id | integer | כן | |
items[].type | string | כן | |
items[].amount | integer | כן | |
items[].balanceAfter | integer | כן | |
items[].reason | string | null | כן | |
items[].counterpartyId | string | null | כן | |
items[].createdAt | string | כן | |
nextCursor | string | null | כן |
{
"items": [
{
"id": 98765,
"type": "example",
"amount": 100,
"balanceAfter": 1350,
"reason": "Tournament prize",
"counterpartyId": "234567890123456789",
"createdAt": "2026-10-07T12:00:00.000Z"
}
],
"nextCursor": "98700"
}דוגמאות
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions?limit=25" \
-H "Authorization: Bearer $BOTGG_API_KEY"// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions?limit=25', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
},
params={
"limit": 25,
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)שגיאות
| HTTP | קודים |
|---|---|
| 409 | BANK_DISABLED |
| 503 | SERVICE_UNAVAILABLE |
Add to or remove from a member’s balance
POST/guilds/{guildId}/bank/members/{userId}/transactions
Same rules as a banker change. Logged in the Bank ledger (type api) and the Bank log channel.
נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק
| שם | מיקום | סוג | חובה | תיאור |
|---|---|---|---|---|
guildId | נתיב | string | כן | המזהה של השרת שלכם · מזהה דיסקורד (מחרוזת) |
userId | נתיב | string | כן | מזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת) |
Idempotency-Key | כותרת | string | לא | לא חובה. שלחו ערך ייחודי (UUID) והשתמשו בו שוב בניסיונות חוזרים — השינוי יקרה פעם אחת בלבד. איך זה עובד |
גוף הבקשה
| שדה | סוג | חובה | תיאור |
|---|---|---|---|
type | string | כן | add = credit, remove = debit אחד מ: add, remove |
amount | integer | כן | 1–1,000,000,000,000 |
reason | string | null | לא | Shown in the Bank ledger and log עד 200 תווים |
תשובה
| שדה | סוג | חובה | תיאור |
|---|---|---|---|
transactionId | integer | כן | |
userId | string | כן | |
type | string | כן | אחד מ: add, remove |
amount | integer | כן | |
previousBalance | integer | כן | |
balance | integer | כן | |
createdAt | string | כן |
{
"transactionId": 98765,
"userId": "876543210987654321",
"type": "add",
"amount": 100,
"previousBalance": 1250,
"balance": 1350,
"createdAt": "2026-10-07T12:00:00.000Z"
}דוגמאות
curl -s -X POST "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions" \
-H "Authorization: Bearer $BOTGG_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"type":"add","amount":100,"reason":"Tournament prize"}'// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(), // reuse it when you retry this request
},
body: JSON.stringify({
type: 'add',
amount: 100,
reason: 'Tournament prize',
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os, uuid
import requests
res = requests.post(
"https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
"Idempotency-Key": str(uuid.uuid4()), # reuse it when you retry this request
},
json={
"type": "add",
"amount": 100,
"reason": "Tournament prize",
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)שגיאות
| HTTP | קודים |
|---|---|
| 400 | INVALID_JSON |
| 404 | MEMBER_NOT_FOUND |
| 409 | BANK_DISABLED, INSUFFICIENT_FUNDS |
| 413 | PAYLOAD_TOO_LARGE |
| 415 | UNSUPPORTED_MEDIA_TYPE |
| 422 | IDEMPOTENCY_KEY_REUSED, BOT_ACCOUNT, BALANCE_LIMIT |
| 503 | SERVICE_UNAVAILABLE |
Top balances
GET/guilds/{guildId}/bank/leaderboard
נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק
| שם | מיקום | סוג | חובה | תיאור |
|---|---|---|---|---|
guildId | נתיב | string | כן | המזהה של השרת שלכם · מזהה דיסקורד (מחרוזת) |
limit | query | integer | לא | 1–100 · ברירת מחדל 10 |
תשובה
| שדה | סוג | חובה | תיאור |
|---|---|---|---|
items | array of object | כן | |
items[].rank | integer | כן | |
items[].userId | string | כן | |
items[].balance | integer | כן | |
currency | object | כן | |
currency.name | string | כן | |
currency.plural | string | כן | |
currency.emoji | string | null | כן |
{
"items": [
{
"rank": 1,
"userId": "876543210987654321",
"balance": 1350
}
],
"currency": {
"name": "Example",
"plural": "example",
"emoji": "🪙"
}
}דוגמאות
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/leaderboard?limit=10" \
-H "Authorization: Bearer $BOTGG_API_KEY"// Node.js 18+ (built-in fetch) — on your server, never in a browser
const res = await fetch('https://console.botgg.app/api/v1/guilds/123456789012345678/bank/leaderboard?limit=10', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.BOTGG_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.error}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://console.botgg.app/api/v1/guilds/123456789012345678/bank/leaderboard",
headers={
"Authorization": f"Bearer {os.environ['BOTGG_API_KEY']}",
},
params={
"limit": 10,
},
timeout=10,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{res.status_code} {data['error']}: {data['message']}")
print(data)שגיאות
| HTTP | קודים |
|---|---|
| 409 | BANK_DISABLED |
| 503 | SERVICE_UNAVAILABLE |