defillama-sdk 0.1.0__py3-none-any.whl

defillama_api/types/tvl.py

@@ -0,0 +1,189 @@
+"""TVL type definitions."""
+
+from typing import Dict, List, Optional, TypedDict, Union
+
+
+class Protocol(TypedDict, total=False):
+    id: str
+    name: str
+    address: Optional[str]
+    symbol: str
+    url: str
+    description: Optional[str]
+    chain: str
+    logo: Optional[str]
+    audits: Optional[str]
+    audit_note: Optional[str]
+    gecko_id: Optional[str]
+    cmcId: Optional[str]
+    category: str
+    chains: List[str]
+    module: Optional[str]
+    twitter: Optional[str]
+    forkedFrom: Optional[List[str]]
+    oracles: Optional[List[str]]
+    listedAt: Optional[int]
+    methodology: Optional[Union[str, Dict[str, str]]]
+    slug: str
+    tvl: float
+    chainTvls: Dict[str, float]
+    change_1h: Optional[float]
+    change_1d: Optional[float]
+    change_7d: Optional[float]
+    tokenBreakdowns: Optional[Dict[str, object]]
+    mcap: Optional[float]
+    referralUrl: Optional[str]
+    parentProtocol: Optional[str]
+    misrepresentedTokens: Optional[bool]
+
+
+class TvlDataPoint(TypedDict):
+    date: int
+    totalLiquidityUSD: float
+
+
+class TokenBalance(TypedDict):
+    date: int
+    tokens: Dict[str, float]
+
+
+class ChainTvlData(TypedDict, total=False):
+    tvl: List[TvlDataPoint]
+    tokensInUsd: Optional[List[TokenBalance]]
+    tokens: Optional[List[TokenBalance]]
+
+
+class CurrentChainTvl(TypedDict):
+    date: int
+    totalLiquidityUSD: float
+
+
+class ProtocolRaise(TypedDict, total=False):
+    date: int
+    amount: float
+    round: str
+    name: Optional[str]
+    chains: Optional[List[str]]
+    sector: Optional[str]
+    category: Optional[str]
+    categoryGroup: Optional[str]
+    leadInvestors: Optional[List[str]]
+    otherInvestors: Optional[List[str]]
+    source: Optional[str]
+    valuation: Optional[float]
+    defillamaId: Optional[Union[str, int]]
+
+
+class ProtocolMetrics(TypedDict, total=False):
+    activeUsers: Optional[int]
+    transactions: Optional[int]
+    gasUsed: Optional[int]
+
+
+class ProtocolDetails(TypedDict, total=False):
+    id: str
+    name: str
+    address: Optional[str]
+    symbol: str
+    url: str
+    description: Optional[str]
+    chain: Optional[str]
+    logo: Optional[str]
+    audits: Optional[str]
+    audit_note: Optional[str]
+    gecko_id: Optional[str]
+    cmcId: Optional[str]
+    category: Optional[str]
+    chains: List[str]
+    module: Optional[str]
+    twitter: Optional[str]
+    forkedFrom: Optional[List[str]]
+    oracles: Optional[List[str]]
+    listedAt: Optional[int]
+    methodology: Optional[Union[str, Dict[str, str]]]
+    slug: Optional[str]
+    tvl: List[TvlDataPoint]
+    tokensInUsd: Optional[List[TokenBalance]]
+    tokens: Optional[List[TokenBalance]]
+    chainTvls: Dict[str, ChainTvlData]
+    currentChainTvls: Dict[str, float]
+    raises: Optional[List[ProtocolRaise]]
+    metrics: Optional[ProtocolMetrics]
+    mcap: Optional[float]
+    isParentProtocol: Optional[bool]
+    otherProtocols: Optional[List[str]]
+    treasury: Optional[str]
+    governanceID: Optional[List[str]]
+    wrongLiquidity: Optional[bool]
+    github: Optional[List[str]]
+    stablecoins: Optional[List[str]]
+    hallmarks: Optional[List[List[Union[int, str]]]]
+
+
+class Chain(TypedDict, total=False):
+    gecko_id: Optional[str]
+    tvl: float
+    tokenSymbol: Optional[str]
+    cmcId: Optional[str]
+    name: str
+    chainId: Optional[int]
+
+
+class HistoricalChainTvl(TypedDict):
+    date: int
+    tvl: float
+
+
+class HistoricalChainsTvl(TypedDict, total=False):
+    date: int
+
+
+class TokenProtocolHolding(TypedDict, total=False):
+    name: str
+    category: str
+    amountUsd: Dict[str, float]
+    misrepresentedTokens: Optional[bool]
+
+
+class TokenTvlSnapshot(TypedDict):
+    tvl: Dict[str, float]
+
+
+class ProtocolInflowsResponse(TypedDict):
+    outflows: float
+    oldTokens: TokenTvlSnapshot
+    currentTokens: TokenTvlSnapshot
+
+
+class ChainAssetBreakdown(TypedDict):
+    total: str
+    breakdown: Dict[str, str]
+
+
+class ChainAsset(TypedDict, total=False):
+    canonical: Optional[ChainAssetBreakdown]
+    ownTokens: Optional[ChainAssetBreakdown]
+    native: Optional[ChainAssetBreakdown]
+    thirdParty: Optional[ChainAssetBreakdown]
+    total: Optional[ChainAssetBreakdown]
+
+
+ChainAssetsResponse = Dict[str, Union[ChainAsset, float, int]]
+
+
+__all__ = [
+    "Protocol",
+    "ProtocolDetails",
+    "Chain",
+    "TvlDataPoint",
+    "TokenBalance",
+    "ChainTvlData",
+    "CurrentChainTvl",
+    "HistoricalChainTvl",
+    "HistoricalChainsTvl",
+    "TokenProtocolHolding",
+    "ProtocolInflowsResponse",
+    "ChainAsset",
+    "ChainAssetBreakdown",
+    "ChainAssetsResponse",
+]

defillama_api/types/volumes.py

@@ -0,0 +1,147 @@
+"""Volume type definitions."""
+
+from typing import Dict, List, Optional, Tuple, TypedDict, Literal
+
+
+class VolumeOverviewOptions(TypedDict, total=False):
+    excludeTotalDataChart: Optional[bool]
+    excludeTotalDataChartBreakdown: Optional[bool]
+    dataType: Optional[Literal["dailyVolume", "totalVolume"]]
+
+
+class VolumeSummaryOptions(TypedDict, total=False):
+    dataType: Optional[Literal["dailyVolume", "totalVolume"]]
+
+
+class VolumeProtocol(TypedDict, total=False):
+    defillamaId: str
+    name: str
+    displayName: str
+    module: str
+    category: str
+    logo: str
+    chains: List[str]
+    protocolType: str
+    methodologyURL: str
+    methodology: Optional[object]
+    total24h: Optional[float]
+    total48hto24h: Optional[float]
+    total7d: Optional[float]
+    total14dto7d: Optional[float]
+    total30d: Optional[float]
+    total60dto30d: Optional[float]
+    total1y: Optional[float]
+    totalAllTime: Optional[float]
+    average1y: Optional[float]
+    monthlyAverage1y: Optional[float]
+    change_1d: Optional[float]
+    change_7d: Optional[float]
+    change_1m: Optional[float]
+    change_7dover7d: Optional[float]
+    change_30dover30d: Optional[float]
+    breakdown24h: Optional[Dict[str, Dict[str, float]]]
+    breakdown30d: Optional[Dict[str, Dict[str, float]]]
+    parentProtocol: Optional[str]
+    slug: str
+
+
+VolumeChartBreakdownDataPoint = Tuple[int, Dict[str, float]]
+VolumeNestedChartBreakdownDataPoint = Tuple[int, Dict[str, Dict[str, float]]]
+
+
+class VolumeOverviewResponse(TypedDict, total=False):
+    totalDataChart: List[Tuple[int, float]]
+    totalDataChartBreakdown: List[VolumeChartBreakdownDataPoint]
+    breakdown24h: Optional[Dict[str, Dict[str, float]]]
+    breakdown30d: Optional[Dict[str, Dict[str, float]]]
+    chain: Optional[str]
+    allChains: List[str]
+    total24h: float
+    total48hto24h: float
+    total7d: float
+    total14dto7d: float
+    total30d: float
+    total60dto30d: float
+    total1y: float
+    change_1d: float
+    change_7d: float
+    change_1m: float
+    change_7dover7d: float
+    change_30dover30d: float
+    total7DaysAgo: float
+    total30DaysAgo: float
+    totalAllTime: float
+    protocols: List[VolumeProtocol]
+
+
+class VolumeSummaryResponse(TypedDict, total=False):
+    id: str
+    name: str
+    url: str
+    description: str
+    logo: str
+    gecko_id: Optional[str]
+    cmcId: Optional[str]
+    chains: List[str]
+    twitter: Optional[str]
+    treasury: Optional[str]
+    governanceID: Optional[List[str]]
+    github: Optional[List[str]]
+    symbol: Optional[str]
+    address: Optional[str]
+    linkedProtocols: Optional[List[str]]
+    childProtocols: Optional[List[str]]
+    defillamaId: str
+    displayName: str
+    module: str
+    category: str
+    methodologyURL: Optional[str]
+    methodology: Optional[object]
+    forkedFrom: Optional[List[str]]
+    audits: Optional[str]
+    audit_links: Optional[List[str]]
+    parentProtocol: Optional[str]
+    previousNames: Optional[List[str]]
+    hallmarks: Optional[List[List[object]]]
+    slug: str
+    protocolType: str
+    total24h: Optional[float]
+    total48hto24h: Optional[float]
+    total7d: Optional[float]
+    total30d: Optional[float]
+    totalAllTime: Optional[float]
+    totalDataChart: List[Tuple[int, float]]
+    totalDataChartBreakdown: List[VolumeNestedChartBreakdownDataPoint]
+    hasLabelBreakdown: bool
+    change_1d: Optional[float]
+
+
+DexOverviewOptions = VolumeOverviewOptions
+DexOverviewResponse = VolumeOverviewResponse
+DexSummaryOptions = VolumeSummaryOptions
+DexSummaryResponse = VolumeSummaryResponse
+OptionsOverviewOptions = VolumeOverviewOptions
+OptionsOverviewResponse = VolumeOverviewResponse
+OptionsSummaryResponse = VolumeSummaryResponse
+DerivativesOverviewResponse = VolumeOverviewResponse
+DerivativesSummaryResponse = VolumeSummaryResponse
+
+
+__all__ = [
+    "VolumeOverviewOptions",
+    "VolumeSummaryOptions",
+    "VolumeProtocol",
+    "VolumeOverviewResponse",
+    "VolumeSummaryResponse",
+    "VolumeChartBreakdownDataPoint",
+    "VolumeNestedChartBreakdownDataPoint",
+    "DexOverviewOptions",
+    "DexOverviewResponse",
+    "DexSummaryOptions",
+    "DexSummaryResponse",
+    "OptionsOverviewOptions",
+    "OptionsOverviewResponse",
+    "OptionsSummaryResponse",
+    "DerivativesOverviewResponse",
+    "DerivativesSummaryResponse",
+]

defillama_api/types/yields.py

@@ -0,0 +1,170 @@
+"""Yield type definitions."""
+
+from typing import List, Optional, TypedDict
+
+
+class YieldPoolPredictions(TypedDict, total=False):
+    predictedClass: Optional[str]
+    predictedProbability: Optional[float]
+    binnedConfidence: Optional[float]
+
+
+class YieldPool(TypedDict, total=False):
+    pool: str
+    chain: str
+    project: str
+    symbol: str
+    tvlUsd: float
+    apy: Optional[float]
+    apyBase: Optional[float]
+    apyReward: Optional[float]
+    rewardTokens: Optional[List[str]]
+    underlyingTokens: Optional[List[str]]
+    poolMeta: Optional[str]
+    exposure: Optional[str]
+    il7d: Optional[float]
+    apyBase7d: Optional[float]
+    apyPct1D: Optional[float]
+    apyPct7D: Optional[float]
+    apyPct30D: Optional[float]
+    stablecoin: bool
+    ilRisk: Optional[str]
+    predictions: Optional[YieldPoolPredictions]
+    mu: Optional[float]
+    sigma: Optional[float]
+    count: Optional[float]
+    outlier: Optional[bool]
+    volumeUsd1d: Optional[float]
+    volumeUsd7d: Optional[float]
+    apyMean30d: Optional[float]
+    apyBaseInception: Optional[float]
+
+
+class YieldPoolsResponse(TypedDict):
+    status: str
+    data: List[YieldPool]
+
+
+YieldPoolOld = TypedDict(
+    "YieldPoolOld",
+    {
+        **YieldPool.__annotations__,
+        "pool_old": str,
+        "timestamp": str,
+        "url": str,
+        "return": Optional[float],
+        "apyMeanExpanding": Optional[float],
+        "apyStdExpanding": Optional[float],
+        "project_factorized": int,
+        "chain_factorized": int,
+    },
+    total=False,
+)
+
+
+class YieldPoolsOldResponse(TypedDict):
+    status: str
+    data: List[YieldPoolOld]
+
+
+class YieldChartDataPoint(TypedDict, total=False):
+    timestamp: str
+    tvlUsd: float
+    apy: Optional[float]
+    apyBase: Optional[float]
+    apyReward: Optional[float]
+    il7d: Optional[float]
+    apyBase7d: Optional[float]
+
+
+class YieldChartResponse(TypedDict):
+    status: str
+    data: List[YieldChartDataPoint]
+
+
+class BorrowPool(YieldPool, total=False):
+    apyBaseBorrow: Optional[float]
+    apyRewardBorrow: Optional[float]
+    totalSupplyUsd: Optional[float]
+    totalBorrowUsd: Optional[float]
+    debtCeilingUsd: Optional[float]
+    ltv: Optional[float]
+    borrowable: Optional[bool]
+    mintedCoin: Optional[str]
+    borrowFactor: Optional[float]
+
+
+class BorrowPoolsResponse(TypedDict):
+    status: str
+    data: List[BorrowPool]
+
+
+class LendBorrowChartDataPoint(TypedDict, total=False):
+    timestamp: str
+    totalSupplyUsd: Optional[float]
+    totalBorrowUsd: Optional[float]
+    debtCeilingUsd: Optional[float]
+    apyBase: Optional[float]
+    apyBaseBorrow: Optional[float]
+    apyReward: Optional[float]
+    apyRewardBorrow: Optional[float]
+
+
+class LendBorrowChartResponse(TypedDict):
+    status: str
+    data: List[LendBorrowChartDataPoint]
+
+
+class PerpPool(TypedDict, total=False):
+    perp_id: str
+    timestamp: str
+    marketplace: str
+    market: str
+    baseAsset: str
+    fundingRate: Optional[float]
+    fundingRatePrevious: Optional[float]
+    fundingTimePrevious: Optional[int]
+    openInterest: Optional[float]
+    indexPrice: Optional[float]
+    fundingRate7dAverage: Optional[float]
+    fundingRate7dSum: Optional[float]
+    fundingRate30dAverage: Optional[float]
+    fundingRate30dSum: Optional[float]
+
+
+class PerpsResponse(TypedDict):
+    status: str
+    data: List[PerpPool]
+
+
+class LsdRate(TypedDict, total=False):
+    name: str
+    symbol: str
+    address: str
+    type: Optional[str]
+    expectedRate: Optional[float]
+    marketRate: Optional[float]
+    ethPeg: Optional[float]
+    fee: Optional[float]
+
+
+LsdRatesResponse = List[LsdRate]
+
+
+__all__ = [
+    "YieldPoolPredictions",
+    "YieldPool",
+    "YieldPoolsResponse",
+    "YieldPoolOld",
+    "YieldPoolsOldResponse",
+    "YieldChartDataPoint",
+    "YieldChartResponse",
+    "BorrowPool",
+    "BorrowPoolsResponse",
+    "LendBorrowChartDataPoint",
+    "LendBorrowChartResponse",
+    "PerpPool",
+    "PerpsResponse",
+    "LsdRate",
+    "LsdRatesResponse",
+]