GET /v4/users/:address/protocols/:protocolId/rewards

Authentication7

Block Timestamp3

Campaign Lists6

Campaign Privacy3

Campaigns9

Chains2

Claims5

Config19

Creator9

Credits9

Developer API Keys7

Enums4

GraphQL8

Health8

Historical3

Key Value Store9

Leaves2

Node6

OffchainBilling3

Opportunities14

Overrides2

Programs3

Protocols3

Reallocations1

Referral2

Rewards12

Roots2

Schemas3

SOFR Spread Ratchet2

Templates3

Tokens5

Users11

Volume4

Users

Retrieve claimable rewards for a user scoped to a single protocol. Breakdowns and amounts reflect only campaigns attributed to the requested protocol. The returned proofs and root still claim the full per-token leaf on-chain.

get/v4/users/{address}/protocols/{protocolId}/rewards

Path parameters

addressstring required

User wallet address

protocolIdstring required

Main protocol ID to filter rewards by

Query parameters

chainIdstring[] required

List of chain IDs to query rewards for

string numeric

number

An optional chainId to bypass the cache and check if there was very recently a claim on this chain

testboolean

Include test token rewards

claimableOnlyboolean

Include only claimable rewards (to avoid transferring zero amounts)

string numeric

number

0-indexed pagination for rewards[number].breakdowns. 1000 items per page.

string

showPrivateboolean

When true, decode private campaign IDs instead of returning the zero hash. Requires the caller's identity (JWT, API key owner, or BackOffice) to match the queried address — otherwise returns 403. Also bypasses CDN cache.

Response

Response for status 200

Changes

No recorded changes to this endpoint across all 1 revision of this API.