Yield

Get Yield Sweep

Retrieve a yield sweep (deposit or withdrawal) by its ID.

get/v1/ethereum_yield_sweep/{id}

Request

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

Path parameters

idstring required

The yield sweep ID.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Yield sweep retrieved successfully.

idstring required

Unique identifier for the yield sweep.

wallet_idstring required

The ID of the wallet involved in the sweep.

vault_idstring required

The ID of the vault involved in the sweep.

type'deposit' | 'withdraw' required

Type of yield sweep.

status'pending' | 'confirmed' | 'failed' required

Status of a yield sweep.

asset_amountstring nullable required

The amount of underlying assets involved. Set after the sweep is confirmed on-chain.

share_amountstring nullable required

The amount of vault shares involved. Set after the sweep is confirmed on-chain.

created_atnumber required

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

updated_atnumber required

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

Example response

{
  "id": "cm7oxq1el000e11o8iwp7d0d0",
  "wallet_id": "fmfdj6yqly31huorjqzq38zc",
  "vault_id": "cm7oxq1el000e11o8iwp7d0d0",
  "type": "deposit",
  "status": "pending",
  "asset_amount": "1000000",
  "share_amount": "987654321",
  "created_at": 1631573050000,
  "updated_at": 1631573050000
}

Changes

No recorded changes to this operation across all 60 revisions of this API.