Skip to main content
Glama
bybit-exchange

Bybit MCP Server

Official

getAffiliateUserList

Retrieve the list of direct client users under your affiliate account with optional trading volume, deposit, and commission data for 30-day, 365-day, or custom date ranges using cursor pagination.

Instructions

Query the list of all direct client users under the current affiliate account. Supports cursor-based pagination. Trading volume, deposit amount, and commission data for 30-day, 365-day, and custom date ranges can be returned on demand.

Notes:

  • Must use an API Key with affiliate permission bound to a Master UID.

  • For cursor, pass "" or "0" on the first request; pass the nextPageCursor from the previous response for subsequent pages.

  • need30, need365, and needDeposit default to false; enable as needed to avoid unnecessary performance overhead.

  • When startDate / endDate are provided, the response includes custom-range fields (takerVol, makerVol, tradeVol, tradfiTradeVol, commissionsVol) and omits the 30-day / 365-day fields.

  • The commission map always returns five fixed currencies: BTC, ETH, MNT, USDC, USDT.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cursorNo
sizeNo
needDepositNo
need30No
need365No
startDateNo
endDateNo
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description fully discloses behavioral traits: permission requirements, pagination behavior, default values, conditional field inclusion/exclusion, and fixed currency in commission map. It even advises on performance overhead, leaving no important ambiguity.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured, starting with the core purpose, then pagination, optional data, and finally clear bulleted notes. Every sentence contributes without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 7 parameters, no output schema, and no annotations, the description covers authentication, pagination, parameter interactions, and response behavior comprehensively. It equips an agent with enough detail to invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, but the description extensively explains cursor, need30/need365/needDeposit, and date range parameters. Only 'size' is not explicitly described, though the schema provides its constraints. The description adds significant value beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Query' and the resource 'list of all direct client users under the current affiliate account', making the tool's purpose obvious. However, it does not explicitly differentiate this tool from sibling tools like getAffiliateUserInfo, so a distinction is lacking.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear context for usage: requires affiliate permission, cursor-based pagination details, and conditions for optional parameters. It lacks explicit exclusions or alternative tools but offers strong contextual guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bybit-exchange/trading-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server