Skip to main content
GET
/
referrers
Get referrer fee totals
curl --request GET \
  --url https://data-api.forka.st/referrers
[
  {
    "exchange": "0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e",
    "receiver": "0x8e0d7a3d9f66f1e6b7a5c0b0b8b0c3e0f1a2b3c4",
    "tokenId": "0",
    "totalAmount": "184250000",
    "updatedAt": 1735560942
  },
  {
    "exchange": "0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e",
    "receiver": "0x8e0d7a3d9f66f1e6b7a5c0b0b8b0c3e0f1a2b3c4",
    "tokenId": "35298173513404621577479069037847775250424943719108005377003027356519523123136",
    "totalAmount": "7400000",
    "updatedAt": 1735560120
  }
]
GET https://data-api.forka.st/referrers returns aggregated fee totals for an address you treat as a referrer. Results are grouped by exchange and tokenId, ordered by updatedAt (desc).

Filters and pagination

  • address is required and should be the receiver wallet.
  • exchange scopes to a single CTFExchange/NegRisk address (lowercased).
  • tokenId is a decimal string; 0 refers to collateral fees, other values refer to ERC1155 outcome tokens.
  • limit defaults to 100 (max 500); offset defaults to 0.

Amount semantics

  • totalAmount is returned as raw base units; divide by 1e6 for UI display.
  • Empty results return [].

Query Parameters

address
string
required

Receiver address to aggregate referrer fees for.

Example:

"0x8e0d7a3d9f66f1e6b7a5c0b0b8b0c3e0f1a2b3c4"

exchange
string

CTFExchange/NegRisk address to scope results to (lowercased).

Example:

"0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e"

tokenId
string

Decimal token ID (0 for collateral).

Example:

"0"

limit
integer
default:100

Maximum number of rows to return (max 500).

Required range: 0 <= x <= 500
offset
integer
default:0

Number of rows to skip.

Required range: x >= 0

Response

Referrer totals returned.

exchange
string

0x-prefixed EVM address (40 hex chars).

Example:

"0x56687bf447db6ffa42ffe2204a05edaa20f55839"

receiver
string

0x-prefixed EVM address (40 hex chars).

Example:

"0x56687bf447db6ffa42ffe2204a05edaa20f55839"

tokenId
string
totalAmount
string
updatedAt
integer<int64>