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:readGet a member’s balance
GET/guilds/{guildId}/bank/members/{userId}/transactionsbank:readList a member’s transactions
POST/guilds/{guildId}/bank/members/{userId}/transactionsbank:writeAdd to or remove from a member’s balance
GET/guilds/{guildId}/bank/leaderboardbank:readTop balances

מלבד השגיאות הייחודיות שלה (בהמשך), כל נקודת קצה יכולה להחזיר את השגיאות הכלליות האלה:

Get a member’s balance

GET/guilds/{guildId}/bank/members/{userId}

הרשאה: bank:read

Members without an account yet get the server’s starting balance.

נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)
userIdנתיבstringכןמזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת)

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
userIdstringכן
balanceintegerכן
currencyobjectכן
currency.namestringכן
currency.pluralstringכן
currency.emojistring | nullכן
תשובה · 200
{
  "userId": "876543210987654321",
  "balance": 1350,
  "currency": {
    "name": "Example",
    "plural": "example",
    "emoji": "🪙"
  }
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// 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);
Python (requests)
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קודים
409BANK_DISABLED
503SERVICE_UNAVAILABLE

List a member’s transactions

GET/guilds/{guildId}/bank/members/{userId}/transactions

הרשאה: bank:read

Newest first. Pass before=<nextCursor> for the next page.

נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)
userIdנתיבstringכןמזהה הדיסקורד של החבר/ה · מזהה דיסקורד (מחרוזת)
limitqueryintegerלא1–100 · ברירת מחדל 25
beforequeryintegerלאלפחות 1

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
itemsarray of objectכן
items[].idintegerכן
items[].typestringכן
items[].amountintegerכן
items[].balanceAfterintegerכן
items[].reasonstring | nullכן
items[].counterpartyIdstring | nullכן
items[].createdAtstringכן
nextCursorstring | nullכן
תשובה · 200
{
  "items": [
    {
      "id": 98765,
      "type": "example",
      "amount": 100,
      "balanceAfter": 1350,
      "reason": "Tournament prize",
      "counterpartyId": "234567890123456789",
      "createdAt": "2026-10-07T12:00:00.000Z"
    }
  ],
  "nextCursor": "98700"
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/members/876543210987654321/transactions?limit=25" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// 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);
Python (requests)
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קודים
409BANK_DISABLED
503SERVICE_UNAVAILABLE

Add to or remove from a member’s balance

POST/guilds/{guildId}/bank/members/{userId}/transactions

הרשאה: bank:writeIdempotency-Key

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) והשתמשו בו שוב בניסיונות חוזרים — השינוי יקרה פעם אחת בלבד. איך זה עובד

גוף הבקשה

גוף הבקשה
שדהסוגחובהתיאור
typestringכןadd = credit, remove = debit
אחד מ: add, remove
amountintegerכן1–1,000,000,000,000
reasonstring | nullלאShown in the Bank ledger and log
עד 200 תווים

תשובה

שדות התשובה · 201
שדהסוגחובהתיאור
transactionIdintegerכן
userIdstringכן
typestringכןאחד מ: add, remove
amountintegerכן
previousBalanceintegerכן
balanceintegerכן
createdAtstringכן
תשובה · 201
{
  "transactionId": 98765,
  "userId": "876543210987654321",
  "type": "add",
  "amount": 100,
  "previousBalance": 1250,
  "balance": 1350,
  "createdAt": "2026-10-07T12:00:00.000Z"
}

דוגמאות

curl
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"}'
JavaScript (fetch)
// 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);
Python (requests)
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)

שגיאות

Top balances

GET/guilds/{guildId}/bank/leaderboard

הרשאה: bank:read

נדרש שהפיצ׳ר הזה יהיה מופעל בשרת: בנק

פרמטרים
שםמיקוםסוגחובהתיאור
guildIdנתיבstringכןהמזהה של השרת שלכם · מזהה דיסקורד (מחרוזת)
limitqueryintegerלא1–100 · ברירת מחדל 10

תשובה

שדות התשובה · 200
שדהסוגחובהתיאור
itemsarray of objectכן
items[].rankintegerכן
items[].userIdstringכן
items[].balanceintegerכן
currencyobjectכן
currency.namestringכן
currency.pluralstringכן
currency.emojistring | nullכן
תשובה · 200
{
  "items": [
    {
      "rank": 1,
      "userId": "876543210987654321",
      "balance": 1350
    }
  ],
  "currency": {
    "name": "Example",
    "plural": "example",
    "emoji": "🪙"
  }
}

דוגמאות

curl
curl -s "https://console.botgg.app/api/v1/guilds/123456789012345678/bank/leaderboard?limit=10" \
  -H "Authorization: Bearer $BOTGG_API_KEY"
JavaScript (fetch)
// 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);
Python (requests)
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קודים
409BANK_DISABLED
503SERVICE_UNAVAILABLE

מוכנים לשדרג את השרת?

מוסיפים את BotGG בחינם ומפעילים יכולות בקונסולת הווב.