Skip to main content
GET
/
v1
/
affiliate
/
referees
Get referees
curl --request GET \
  --url https://api.testnet.arcus.xyz/v1/affiliate/referees
{
  "referees": [
    {
      "address": "<string>",
      "code": "<string>",
      "boundAt": 123,
      "tier": 2,
      "rollingVolume": 123,
      "commissionBps": 123,
      "kickbackBps": 123,
      "feesEarned": 123
    }
  ],
  "nextCursor": "<string>"
}

Query Parameters

​
address
string
required

Ethereum address of the affiliate. 20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase a–f after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
​
from
integer<int64>

Start boundAt filter (epoch ms, inclusive).

Required range: x >= 0
​
to
integer<int64>

End boundAt filter (epoch ms, inclusive).

Required range: x >= 0
​
limit
integer
default:1000

Maximum rows to return. Default and maximum are both 1000; requests above the maximum are silently clamped.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque cursor returned as nextCursor from the previous page. Encodes (boundAt, tier, address) and avoids duplicate/skip behavior for rows with identical timestamps.

Response

List of referees.

​
referees
object[]
​
nextCursor
string

Opaque cursor for the next page, encoded from the last returned row's (boundAt, tier, address). Omitted when there is no next page.