Skip to main content
GET
/
strategies
/
{id}
Get strategy details
curl --request GET \
  --url https://api.deframe.io/strategies/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "Aave-USDC-ethereum",
  "protocol": "Aave",
  "network": "ethereum",
  "networkId": "1",
  "asset": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "assetName": "USDC",
  "assetDecimals": 6,
  "underlyingAsset": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "underlyingDecimals": 6,
  "availableActions": [
    "lend",
    "withdraw"
  ],
  "paused": false,
  "apy": 0.0525,
  "inceptionApy": 0.0485,
  "avgApy": 0.0502,
  "fee": "0",
  "performanceFeeBps": "0",
  "isDefault": false,
  "metadata": {},
  "logourl": "<string>",
  "implementationSelector": "<string>",
  "startDate": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain from your Deframe dashboard.

Path Parameters

​
id
string
required

Strategy ID or slug

Query Parameters

​
wallet
string

User wallet address. When provided, the response includes position data specific to this address. Ethereum address (EVM-compatible)

Example:

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

Response

Strategy details retrieved

DeFi yield strategy details

​
id
string
required

Composite identifier in the format {protocol}-{assetName}-{network}

Example:

"Aave-USDC-ethereum"

​
protocol
string
required
Example:

"Aave"

​
network
string
required
Example:

"ethereum"

​
networkId
string
required

Chain ID as a string

Example:

"1"

​
asset
string
required

Token contract address

Example:

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

​
assetName
string
required

Human-readable token name

Example:

"USDC"

​
assetDecimals
number
required

Token decimal places

Example:

6

​
underlyingAsset
string
required

Underlying token contract address

Example:

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

​
underlyingDecimals
number
required

Underlying token decimal places

Example:

6

​
availableActions
enum<string>[]
required

Actions available for this strategy

Available options:
lend,
withdraw,
request-withdraw,
quick-withdraw,
claim-airdrop
Example:
["lend", "withdraw"]
​
paused
boolean
required
Example:

false

​
apy
number

Annual Percentage Yield as a decimal (e.g., 0.0417 = 4.17%). Enriched at response time from on-chain data.

Example:

0.0525

​
inceptionApy
number

APY since the strategy launched

Example:

0.0485

​
avgApy
number

Time-weighted average APY

Example:

0.0502

​
fee
string

Fee in basis points (e.g., "0" = 0.00%). Configured per customer. See Fees for the full fee structure.

Example:

"0"

​
performanceFeeBps
string

Performance fee in basis points, charged on profits at withdrawal. See Fees.

Example:

"0"

​
isDefault
boolean

Whether this is a default strategy

Example:

false

​
metadata
object

Customer-specific metadata (may include logo URL, price, etc.)

​
logourl
string | null

Strategy logo URL (extracted from metadata for convenience)

​
implementationSelector
string

Internal implementation identifier

​
startDate
string<date-time>

Strategy inception date