Sign in
Opportunities

Get Opportunity by ID

Changed on

Returns a single active opportunity by its id. Deposit/withdrawal availability is reported in meta.

get/v2/opportunities/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring uuid nullable required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Opportunity unique identifier

Response

OK

descriptionstring

Opportunity detailed description

estimatedAprnumber

Estimated APR (sum of active incentive yields)

featuredboolean

Whether opportunity is featured

idstring uuid nullable
minDepositAmountUsdnumber

Minimum deposit amount in USD

minWithdrawAmountnumber

Minimum withdraw amount in receipt-token units

namestring

Opportunity display name

slugstring

URL-friendly identifier

tvlnumber

Total Value Locked in USD

typestring

Opportunity type (e.g. lending, vault)

Example response

{
  "curator": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  },
  "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "incentives": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes