Algofi
Search…
⌃K

API Documentation

Documentation for the Algofi API.

Asset Endpoint

Returns a total list of assets on Algofi DEX
asset_id (int): unique identifier for the asset
name (string): asset name
unit_name (string): asset unit name
decimals (int): number of decimals in asset
tvl (float): TVL of asset on Algofi DEX
day_volume (float): daily volume on Algofi DEX
price (float): dollar price of asset
day_price_change (float): percent daily change in price on Algofi DEX in decimal
verified (boolean): if asset has been verified by AlgoExplorer API

Pool Endpoint

Returns a total list of pools on Algofi DEX
app_id (int): application id of the pool contract,
asset1_id (int): unique identifier for asset 1,
asset2_id: unique identifier for asset 2,
lp_asset_id: unique identifier for the liquidity pool token,
type (string): type of pool,
asset_1_balance (int): balance of asset 1 in pool in base units,
asset_2_balance (int): balance of asset 2 in pool in base units,
lp_circulation (int): circulation of lp token in base units,
tvl (float): dollar TVL of pool,
fees_usd: {
day (float): dollar daily fees,
week (float): dollar weekly fees
},
asset_1_volume: {
day (int): asset 1 daily volume in base units,
week (int): asset 1 weekly volume in base units
},
asset_2_volume: {
day (int): asset 2 daily volume in base units,
week (int): asset weekly volume in base units
},
volume_usd: {
day (float): dollar daily volume,
week (float): dollar weekly volume
},
apr: percent apr of pool (e.g. dollar fees / dollar tvl)

LP Token Endpoint

Returns a total list of LP tokens on Algofi DEX
asset_id (int): unique identifier for liquidity pool token,
name (string): name of liquidity pool token,
unit_name (string): unit name of lp token,
decimals (int): number of decimals in lp tokem,
price (float): dollar price of lp token

V1 Vault Endpoint

Returns a snapshot of information about the V1 Vault
block (int): block of the snapshot,
active_vaults (int) number of active vaults,
vaulted_algos (float): number of vaulted algos,
eligible_vaults (int): number of eligible vaults,
committed_algos (float): number of commited algos

V2 Vault Endpoint

Returns a snapshot of information about the V2 Vault
block (int): block of the snapshot,
active_vaults (int) number of active vaults,
vaulted_algos (float): number of vaulted algos,
eligible_vaults (int): number of eligible vaults,
committed_algos (float): number of commited algos

Protocol Stats Endpoint

Returns a snapshot of information about the total Protocol TVL / Volume
v1_lending: {
supply (int): dollar supply amount on Algofi v1 lending protocol,
borrow (int): dollar borrow amount on Algofi v1 lending protocol
},
v2_lending: {
supply (float): dollar supply amount on Algofi v2 lending protocol,
borrow (float): dollar borrow amount on Algofi v2 lending protocol
},
amm: {
tvl (int): dollar tvl on Algofi DEX,
volume: {
day (int): dollar daily volume on Algofi DEX,
week (int): dollar daily volume on Algofi DEX
}
},
day_change (float): percent daily change in TVL on Algofi protocol
}

CoinMarketCap Asset Data Endpoint

List of Assets (Prices / TVL) on Algofi DEX for CoinMarketCap
id (int): asset_id (int): unique identifier for asset,
name (string): name of asset,
unit_name (string): unit name of asset,
decimals (int): number of decimals in asset
tvl (float): tvl of asset on Algofi DEX in native token,
volume (float): daily volume of asset in native token,
price (float): dollar price of asset,
price_change (float): percent daily price change in asset on Algofi DEX

Algofi Governance Delegate Snapshot Endpoint

List of Algofi Governance delegates and associated data
delegate (string): storage account for delegate,
delegate_address (string): primary account for delegate,
nfd (string): non-fungible domain (if exists for delegate_address) from nf.domains,
delegator_count (int): number of delegators,
delegate_vebank (int): amount of vebank delegated to delegate