Yield

Get Yield Reward Claim

Changed on

Retrieve a yield reward claim transaction by its ID.

get/v1/ethereum_yield_claim/{id}

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/ethereum_yield_claim/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

The yield claim transaction ID.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Yield reward claim retrieved successfully.

idstring required

Privy transaction record ID for the claim operation.

caip2string required

An EVM CAIP-2 chain identifier (e.g., "eip155:4217" for Tempo, "eip155:8453" for Base).

status'broadcasted' | 'confirmed' | 'execution_reverted' | 'failed' | 'replaced' | 'finalized' | 'provider_error' | 'pending' required

The current status of the claim transaction.

created_atnumber required

Unix timestamp of when the claim was created, in milliseconds.

updated_atnumber required

Unix timestamp of when the claim was last updated, in milliseconds.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "caip2": "eip155:8453",
  "status": "pending",
  "rewards": [
    {
      "token_address": "0x1234567890abcdef1234567890abcdef12345678",
      "token_symbol": "MORPHO",
      "amount": "115631364898103632676"
    }
  ],
  "created_at": 1631573050000,
  "updated_at": 1631573050000
}

Changes

  • c10a42ebeddbRevision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

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

    • info

      removed the broadcasted enum value from the response property for the response status

    • info

      removed the confirmed enum value from the response property for the response status

    • info

      removed the execution_reverted enum value from the response property for the response status

    • info

      removed the failed enum value from the response property for the response status

    • info

      removed the finalized enum value from the response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the provider_error enum value from the response property for the response status

    • info

      removed the replaced enum value from the response property for the response status