Skip to main content
POST
/
accounts
/
{account_id}
/
plan
/
claim-rewards
Plan Claim Rewards
curl --request POST \
  --url https://api.example.com/accounts/{account_id}/plan/claim-rewards

​
Plan Claim Rewards

Creates a plan to claim earned protocol rewards (e.g., COMP tokens from Compound). Returns a plan ID and an EIP-712 digest that must be signed to authorize execution.

​
Request

POST /accounts/:account_id/plan/claim-rewards

​
Path parameters

ParameterTypeDescription
account_idstringThe sub-account ID

​
Body parameters

ParameterTypeRequiredDescription
assetstringYesReward asset to claim (e.g., "COMP")

​
Examples

curl -X POST https://prime-api.legend.xyz/accounts/acc_2o0yiljtp378/plan/claim-rewards \
  -H "Authorization: Bearer $LEGEND_QUERY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "asset": "COMP"
  }'
Response (201 Created)
{
  "plan_id": "pln_71mcui082png",
  "details": {
    "quark_operation_actions": [...],
    "eip712_data": {
      "digest": "0x8a3f...b7c2",
      "domain_separator": "0x...",
      "hash_struct": "0x..."
    }
  },
  "expires_at": "2025-06-15T10:32:00Z"
}

​
Response fields

FieldTypeDescription
plan_idstringUnique identifier for this plan (pln_ prefix)
detailsobjectTransaction details including EIP-712 signing data
details.eip712_data.digeststringThe hash to sign with the account’s signer key
expires_atstringISO 8601 timestamp — plan must be executed before this time

​
Errors

StatusCodeDescription
400invalid_paramsMissing required parameters
400plan_failedCould not generate a valid plan (e.g., no rewards to claim)
400no_walletAccount has no wallets
408timeoutFolio computation timed out

​
Notes

  • Plans expire after 2 minutes. Sign and execute via Execute Plan before expiry.
  • The resulting activity will have action_type: "CLAIM_REWARDS" in its metadata.