member.points

GET · api v1

The member's points balance and where the points came from.

رصيد نقاط العضو ومصادرها.

Parameters

NameTypeRequiredDescription
targetTargetrequiredWho to read about: { source = 7 } for an online player, { discord = "..." } or { code = "P-12" }.
factionstringrequiredThe in-game job name linked to the قطاع, e.g. "police".

Returns (res.data)

NameTypeDescription
balancenumberCurrent balance.
this_periodnumberPoints earned in the current period.
by_sourcetable[]{ source, label, points }

Possible errors

Notes

Example

local res = exports.OrcaBot_V3:Get('member.points', { target = { source = src }, faction = 'police' })

Example output

{
  "ok": true,
  "data": {
    "balance": 140,
    "this_period": 35,
    "by_source": [
      {
        "source": "reports",
        "label": "التقارير",
        "points": 25
      },
      {
        "source": "events",
        "label": "الفعاليات",
        "points": 10
      }
    ]
  },
  "meta": {
    "action": "member.points",
    "method": "GET",
    "api": 1
  }
}