Users

Changed on

Active opportunities for a user — LIVE status with rewards still claimable or pending. Aggregated by opportunity and sorted by APR descending. Settled amounts reflect recent distribution state and may be up to 30 minutes behind; pending amounts are computed live. withStoringIds=true additionally returns the storingIds backing each opportunity, for mapping the caller's on-chain positions (analytics positions route).

get/v4/users/{address}/rewards/active-opportunities

Request

  • Base URL: https://api.merkl.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.merkl.xyz/v4/users/{address}/rewards/active-opportunities
  • Auth: apiKey (a scheme the document does not define)

Path parameters

addressstring required

User address

Query parameters

chainIdstring[]

Filter by chain IDs

tokensstring[]

Filter by reward token addresses

protocolsstring[]

Filter by main protocol IDs

tagsstring[]

Filter by opportunity tags (whitelabel scoping)

isTestboolean

Include test token rewards

isPreTGEboolean

When true, restrict to preTGE (PRETGE) token rewards

withStoringIdsboolean

Also return the storingIds backing each opportunity (LIVE root campaigns' full sub-campaign trees), so callers can fetch and map their on-chain positions through the analytics positions route. Off by default so existing consumers keep the endpoint's original latency.

Response

Response for status 200

Changes

  • b7784c9a78b9Revision changes
    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the / response property allOf list for the response status

    • info

      the //// response's property pattern was changed from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ for the status