Skip to main content
GET
Get trader rewards

Authorizations

Authorization
string
header
required

Pass your Orbscan API key as a Bearer token, formatted as Bearer <your_api_key>.

Path Parameters

address
string
required

Trader address, 0x + 40 hex chars.

Example:

"0x0484e64092ba4108c2786b61e6fc052d3bf41b1a"

Query Parameters

types
string

Comma-separated activity types (e.g. ?types=YIELD,MAKER_REBATE). Case-insensitive. Supported values: YIELD, MAKER_REBATE, TAKER_REBATE, REFERRAL_REWARD, REWARD.

Example:

"YIELD,MAKER_REBATE"

fromTimestamp
integer<int64>

Inclusive lower timestamp (Unix seconds).

toTimestamp
integer<int64>

Inclusive upper timestamp (Unix seconds).

limit
integer
default:20

Page size. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from the previous response's nextCursor. Omit for the first page.

Response

Successful response

message
string
Example:

"OK"

status_code
string
Example:

"1"

data
object