API

The Definitive API lets others build on Definitive’s yield and execution infrastructure. The API streamlines and standardizes multiple DeFi protocols within a single unified strategy interface. Today, with just a few lines of code, wallets, custodians, and aggregators can easily launch a DeFi Earn product for their users with Definitive’s powerful infra as foundational bedrock!

Checkout the API Docs below or view the OpenAI spec at https://api.definitive.fi/docs#/. Reach out to [e-mail] if you'd like to integrate and we can set you up with an API key.

Check out the detailed integration guide here.

Get vaults

GEThttps://api.definitive.fi/v1/vaults

Query parameters

Response

200

OK

Body

application/json

vaultsarray of models.Vault (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "vaults": [
    {
      "address": "text",
      "adminAddress": "text",
      "alias": "text",
      "apy": "text",
      "apyBreakdown": {
        "apr30d": "text",
        "apr7d": "text",
        "apravg": "text",
        "current": "text"
      },
      "baseCurrency": "text",
      "chain": "ethereum",
      "chainId": "text",
      "depositAssets": [
        {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        }
      ],
      "id": "text",
      "llsd": {
        "debtAsset": {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        },
        "debtAssetBorrowUtilization": "text",
        "flashloanProtocol": "stargate",
        "lendingProtocol": "stargate",
        "rewardAssets": [
          {
            "address": "text",
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "ticker": "text"
          }
        ],
        "stakingProtocol": "stargate",
        "yieldAsset": {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        },
        "yieldAssetAPR": "text",
        "yieldAssetSupplyUtilization": "text"
      },
      "lpStaking": {
        "rewardAssets": [
          {
            "address": "text",
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "ticker": "text"
          }
        ]
      },
      "name": "text",
      "protocol": "stargate",
      "protocolOverview": "text",
      "protocolTVL": "text",
      "safeRestingAssets": [
        {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        }
      ],
      "status": "ACTIVE",
      "strategy": "LPSTAKING",
      "strategyAddress": "text",
      "strategyOverview": "text",
      "tags": [
        "text"
      ],
      "totalReturn": "text",
      "tvl": "text",
      "userNAV": "text",
      "withdrawAssets": [
        {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        }
      ]
    }
  ]
}

Get rates

Get rates against a specified quote ticker

GEThttps://api.definitive.fi/v1/rates

Query parameters

Response

200

OK

Body

application/json

quotestring

ratesobject

map of base_ticker:price

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/rates?base_tickers=text&quote_ticker=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "quote": "text"
}

Get vault by ID

GEThttps://api.definitive.fi/v1/vaults/{id}

Path parameters

id*string

vault ID

Query parameters

Response

200

OK

Body

application/json

vaultmodels.Vault (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "vault": {
    "address": "text",
    "adminAddress": "text",
    "alias": "text",
    "apy": "text",
    "apyBreakdown": {
      "apr30d": "text",
      "apr7d": "text",
      "apravg": "text",
      "current": "text"
    },
    "baseCurrency": "text",
    "chain": "ethereum",
    "chainId": "text",
    "depositAssets": [
      {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      }
    ],
    "id": "text",
    "llsd": {
      "debtAsset": {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      },
      "debtAssetBorrowUtilization": "text",
      "flashloanProtocol": "stargate",
      "lendingProtocol": "stargate",
      "rewardAssets": [
        {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        }
      ],
      "stakingProtocol": "stargate",
      "yieldAsset": {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      },
      "yieldAssetAPR": "text",
      "yieldAssetSupplyUtilization": "text"
    },
    "lpStaking": {
      "rewardAssets": [
        {
          "address": "text",
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "ticker": "text"
        }
      ]
    },
    "name": "text",
    "protocol": "stargate",
    "protocolOverview": "text",
    "protocolTVL": "text",
    "safeRestingAssets": [
      {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      }
    ],
    "status": "ACTIVE",
    "strategy": "LPSTAKING",
    "strategyAddress": "text",
    "strategyOverview": "text",
    "tags": [
      "text"
    ],
    "totalReturn": "text",
    "tvl": "text",
    "userNAV": "text",
    "withdrawAssets": [
      {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      }
    ]
  }
}

Request a deposit payload

Request a payload to sign and send to chain

POSThttps://api.definitive.fi/v1/vaults/{id}/deposit/{address}

Path parameters

id*string

vault ID

address*string

user address

Body

application/json

deposit request

depositAmountsobject

A map of the underlying tokens being deposited as address:amount

disableValidationboolean

do not simulate the transaction

slippagestring

Optional. Slippage tolerance when converting underlying to shares

Response

200

OK

Body

application/json

estimatedPriceImpactstring

payload*models.ContractCall (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/deposit/{address}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "estimatedPriceImpact": "text",
  "payload": {
    "data": "text",
    "to": "text",
    "value": "text"
  }
}

Get historical APR

Get the historical APR for a vault

GEThttps://api.definitive.fi/v1/vaults/{id}/historical_apr

Path parameters

id*string

vault ID

Query parameters

Response

200

OK

Body

application/json

historicalAprarray of models.HistoricalAPR (object)

paginationTokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/historical_apr', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "historicalApr": [
    {
      "apr": "text",
      "apr7d": "text",
      "maxAPR": "text",
      "minAPR": "text",
      "ts": "text"
    }
  ],
  "paginationToken": "text"
}

Get historical TVL

Get the historical TVL for a vault

GEThttps://api.definitive.fi/v1/vaults/{id}/historical_tvl

Path parameters

id*string

vault ID

Query parameters

Response

200

OK

Body

application/json

historicalTvlarray of models.HistoricalTVL (object)

paginationTokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/historical_tvl', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "historicalTvl": [
    {
      "amount": {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      },
      "ts": "text",
      "tvl": "text"
    }
  ],
  "paginationToken": "text"
}

Get vault monitors

GEThttps://api.definitive.fi/v1/vaults/{id}/monitors

Path parameters

id*string

vault ID

Response

200

OK

Body

application/json

emergencyStatemodels.EmergencyState (object)

monitorsarray of models.VaultMonitor (object)

safeRestingAssetsarray of models.Asset (object)

assets the vault will hold in the case of a monitor trigger

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/monitors', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "emergencyState": {
    "active": false,
    "ts": "text",
    "unsafeAssets": [
      {
        "address": "text",
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "ticker": "text"
      }
    ]
  },
  "monitors": [
    {
      "base": "text",
      "description": "text",
      "lastStatus": {
        "max": "text",
        "min": "text",
        "target": "text",
        "ts": "text",
        "value": "text"
      },
      "max": "text",
      "min": "text",
      "quote": "text",
      "target": "text",
      "type": "relativeLiquidityMonitor"
    }
  ],
  "safeRestingAssets": [
    {
      "address": "text",
      "chainId": "text",
      "id": "text",
      "image": "text",
      "name": "text",
      "ticker": "text"
    }
  ]
}

Get vault monitor history

Get historical data for a vault monitor

GEThttps://api.definitive.fi/v1/vaults/{id}/monitors/{type}/history

Path parameters

id*string

vault ID

type*enum

monitor type

relativeLiquidityMonitorassetPairMonitorltvMonitorcompoundRewardsMonitor

Query parameters

Response

200

OK

Body

application/json

historyarray of models.MonitorHistory (object)

paginationTokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/monitors/{type}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "history": [
    {
      "max": "text",
      "min": "text",
      "target": "text",
      "ts": "text",
      "value": "text"
    }
  ],
  "paginationToken": "text"
}

Get vault balances by address

GEThttps://api.definitive.fi/v1/vaults/{id}/position/{address}

Path parameters

id*string

vault ID

address*string

user address

Response

200

OK

Body

application/json

balancesarray of models.AssetAmount (object)

depositsarray of models.AssetAmount (object)

feesmodels.AssetAmount (object)

llsdmodels.LLSDPosition (object)

lpStakingmodels.LPStakingPosition (object)

navstring

navBasismodels.Amount (object)

shareConversionsobject

totalReturnmodels.AssetAmount (object)

withdrawalsarray of models.AssetAmount (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/position/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "balances": [
    {
      "address": "text",
      "amount": "text",
      "baseCurrency": {
        "amount": "text",
        "ticker": "text"
      },
      "chainId": "text",
      "id": "text",
      "image": "text",
      "name": "text",
      "notional": "text",
      "ticker": "text"
    }
  ],
  "deposits": [
    {
      "address": "text",
      "amount": "text",
      "baseCurrency": {
        "amount": "text",
        "ticker": "text"
      },
      "chainId": "text",
      "id": "text",
      "image": "text",
      "name": "text",
      "notional": "text",
      "ticker": "text"
    }
  ],
  "fees": {
    "address": "text",
    "amount": "text",
    "baseCurrency": {
      "amount": "text",
      "ticker": "text"
    },
    "chainId": "text",
    "id": "text",
    "image": "text",
    "name": "text",
    "notional": "text",
    "ticker": "text"
  },
  "llsd": {
    "collateral": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ],
    "debt": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ],
    "ltv": "text",
    "unclaimedRewards": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ]
  },
  "lpStaking": {
    "claimedRewards": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ],
    "lpToken": {
      "address": "text",
      "amount": "text",
      "baseCurrency": {
        "amount": "text",
        "ticker": "text"
      },
      "chainId": "text",
      "id": "text",
      "image": "text",
      "name": "text",
      "notional": "text",
      "ticker": "text"
    },
    "lpTokenRepresentation": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ],
    "unclaimedRewards": [
      {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      }
    ]
  },
  "nav": "text",
  "navBasis": {
    "amount": "text",
    "ticker": "text"
  },
  "totalReturn": {
    "address": "text",
    "amount": "text",
    "baseCurrency": {
      "amount": "text",
      "ticker": "text"
    },
    "chainId": "text",
    "id": "text",
    "image": "text",
    "name": "text",
    "notional": "text",
    "ticker": "text"
  },
  "withdrawals": [
    {
      "address": "text",
      "amount": "text",
      "baseCurrency": {
        "amount": "text",
        "ticker": "text"
      },
      "chainId": "text",
      "id": "text",
      "image": "text",
      "name": "text",
      "notional": "text",
      "ticker": "text"
    }
  ]
}

Get historical NAV

Get historical NAV of a vault for an address

GEThttps://api.definitive.fi/v1/vaults/{id}/position/{address}/historical_nav

Path parameters

id*string

vault ID

address*string

user address

Query parameters

Response

200

OK

Body

application/json

historicalNavarray of models.HistoricalNav (object)

paginationTokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/position/{address}/historical_nav', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "historicalNav": [
    {
      "amount": {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      },
      "nav": "text",
      "totalReturn": {
        "address": "text",
        "amount": "text",
        "baseCurrency": {
          "amount": "text",
          "ticker": "text"
        },
        "chainId": "text",
        "id": "text",
        "image": "text",
        "name": "text",
        "notional": "text",
        "ticker": "text"
      },
      "ts": "text"
    }
  ],
  "paginationToken": "text"
}

Get transaction history

Get transaction history of a vault for an address

GEThttps://api.definitive.fi/v1/vaults/{id}/position/{address}/transaction_history

Path parameters

id*string

vault ID

address*string

user address

Response

200

OK

Body

application/json

transactionsarray of models.Transaction (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/position/{address}/transaction_history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "transactions": [
    {
      "deposit": {
        "assets": "text",
        "shares": "text"
      },
      "depositUnderlying": {
        "amounts": [
          {
            "address": "text",
            "amount": "text",
            "baseCurrency": {
              "amount": "text",
              "ticker": "text"
            },
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "notional": "text",
            "ticker": "text"
          }
        ],
        "shares": "text"
      },
      "mint": {
        "amounts": [
          {
            "address": "text",
            "amount": "text",
            "baseCurrency": {
              "amount": "text",
              "ticker": "text"
            },
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "notional": "text",
            "ticker": "text"
          }
        ],
        "shares": "text"
      },
      "redeem": {
        "amounts": [
          {
            "address": "text",
            "amount": "text",
            "baseCurrency": {
              "amount": "text",
              "ticker": "text"
            },
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "notional": "text",
            "ticker": "text"
          }
        ],
        "shares": "text"
      },
      "rewardClaim": {
        "feeAmount": {
          "address": "text",
          "amount": "text",
          "baseCurrency": {
            "amount": "text",
            "ticker": "text"
          },
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "notional": "text",
          "ticker": "text"
        },
        "fromAmounts": [
          {
            "address": "text",
            "amount": "text",
            "baseCurrency": {
              "amount": "text",
              "ticker": "text"
            },
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "notional": "text",
            "ticker": "text"
          }
        ],
        "percentClaim": "text",
        "toAmount": {
          "address": "text",
          "amount": "text",
          "baseCurrency": {
            "amount": "text",
            "ticker": "text"
          },
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "notional": "text",
          "ticker": "text"
        }
      },
      "transactionId": "text",
      "transfer": {
        "amount": "text",
        "from": "text",
        "to": "text"
      },
      "ts": "text",
      "type": "DEPOSIT",
      "withdraw": {
        "assets": "text",
        "shares": "text"
      },
      "withdrawOneUnderlying": {
        "amount": {
          "address": "text",
          "amount": "text",
          "baseCurrency": {
            "amount": "text",
            "ticker": "text"
          },
          "chainId": "text",
          "id": "text",
          "image": "text",
          "name": "text",
          "notional": "text",
          "ticker": "text"
        },
        "shares": "text"
      },
      "withdrawUnderlying": {
        "amounts": [
          {
            "address": "text",
            "amount": "text",
            "baseCurrency": {
              "amount": "text",
              "ticker": "text"
            },
            "chainId": "text",
            "id": "text",
            "image": "text",
            "name": "text",
            "notional": "text",
            "ticker": "text"
          }
        ],
        "shares": "text"
      }
    }
  ]
}

Get addresses in vault

Get all address with funds deposited in the vault

GEThttps://api.definitive.fi/v1/vaults/{id}/users

Path parameters

id*string

vault ID

Response

200

OK

Body

application/json

addressesarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "addresses": [
    "text"
  ]
}

Request a withdrawal payload

Request a payload to sign and send to chain

POSThttps://api.definitive.fi/v1/vaults/{id}/withdraw/{address}

Path parameters

id*string

vault ID

address*string

user address

Body

application/json

withdrawal request

additionalFeePctstring

Optional. Specify additional withdrawal fee percentage.

slippagestring

Optional. Slippage tolerance when converting underlying to shares

withdrawAmount*string

Specify number of shares to withdraw.

withdrawOneAddressstring

Optional. Specify if the request is for one underlying asset.

Response

200

OK

Body

application/json

estimatedPriceImpactstring

payload*models.ContractCall (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.definitive.fi/v1/vaults/{id}/withdraw/{address}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "withdrawAmount": "text"
    }),
});
const data = await response.json();

Response

200

{
  "estimatedPriceImpact": "text",
  "payload": {
    "data": "text",
    "to": "text",
    "value": "text"
  }
}