defillama-sdk 0.1.0__py3-none-any.whl

defillama_api/types/emissions.py

@@ -0,0 +1,154 @@
+"""Emission type definitions."""
+
+from typing import Dict, List, Optional, TypedDict, Union
+
+
+class EmissionEvent(TypedDict, total=False):
+    description: str
+    timestamp: int
+    noOfTokens: List[float]
+    category: str
+    unlockType: str
+    rateDurationDays: Optional[int]
+
+
+class NextEvent(TypedDict):
+    date: int
+    toUnlock: float
+
+
+class EmissionToken(TypedDict, total=False):
+    token: str
+    sources: List[str]
+    protocolId: str
+    name: str
+    circSupply: float
+    circSupply30d: float
+    totalLocked: float
+    maxSupply: float
+    gecko_id: str
+    events: List[EmissionEvent]
+    unlockEvents: Optional[List[object]]
+    nextEvent: Optional[NextEvent]
+    unlocksPerDay: Optional[float]
+    mcap: float
+
+
+class UnlockDataPoint(TypedDict):
+    timestamp: int
+    unlocked: float
+    rawEmission: float
+    burned: float
+
+
+class EmissionCategoryData(TypedDict):
+    label: str
+    data: List[UnlockDataPoint]
+
+
+TokenAllocationBreakdown = Dict[str, float]
+
+
+class TokenAllocationBySection(TypedDict):
+    current: Dict[str, float]
+    final: Dict[str, float]
+    progress: Dict[str, float]
+
+
+class TokenAllocation(TypedDict, total=False):
+    current: TokenAllocationBreakdown
+    final: TokenAllocationBreakdown
+    progress: TokenAllocationBreakdown
+    bySection: Optional[TokenAllocationBySection]
+
+
+class EmissionDocumentedData(TypedDict):
+    data: List[EmissionCategoryData]
+    tokenAllocation: TokenAllocation
+
+
+class CliffAllocation(TypedDict):
+    recipient: str
+    category: str
+    unlockType: str
+    amount: float
+
+
+class LinearAllocation(TypedDict):
+    recipient: str
+    category: str
+    unlockType: str
+    previousRatePerWeek: float
+    newRatePerWeek: float
+    endTimestamp: int
+
+
+class UnlockEventSummary(TypedDict, total=False):
+    totalTokensCliff: Optional[float]
+    netChangeInWeeklyRate: Optional[float]
+    totalNewWeeklyRate: Optional[float]
+
+
+class UnlockEventItem(TypedDict):
+    timestamp: int
+    cliffAllocations: List[CliffAllocation]
+    linearAllocations: List[LinearAllocation]
+    summary: UnlockEventSummary
+
+
+class EmissionMetadata(TypedDict, total=False):
+    token: str
+    sources: List[str]
+    protocolIds: List[str]
+    events: List[EmissionEvent]
+    notes: List[str]
+    total: Optional[float]
+    chain: Optional[str]
+    unlockEvents: List[UnlockEventItem]
+
+
+class SupplyMetrics(TypedDict, total=False):
+    maxSupply: Optional[float]
+    adjustedSupply: Optional[float]
+    tbdAmount: Optional[float]
+    incentiveAmount: Optional[float]
+    nonIncentiveAmount: Optional[float]
+
+
+class EmissionBody(TypedDict, total=False):
+    documentedData: EmissionDocumentedData
+    metadata: EmissionMetadata
+    name: str
+    gecko_id: str
+    defillamaIds: List[str]
+    categories: Dict[str, List[str]]
+    protocolCategory: str
+    chainName: str
+    pId: str
+    unlockUsdChart: List[object]
+    supplyMetrics: SupplyMetrics
+
+
+class EmissionDetailResponse(TypedDict):
+    body: EmissionBody
+    lastModified: str
+
+
+__all__ = [
+    "EmissionEvent",
+    "NextEvent",
+    "EmissionToken",
+    "UnlockDataPoint",
+    "EmissionCategoryData",
+    "TokenAllocationBreakdown",
+    "TokenAllocationBySection",
+    "TokenAllocation",
+    "EmissionDocumentedData",
+    "CliffAllocation",
+    "LinearAllocation",
+    "UnlockEventItem",
+    "EmissionMetadata",
+    "SupplyMetrics",
+    "EmissionBody",
+    "EmissionDetailResponse",
+]

defillama_api/types/etfs.py

@@ -0,0 +1,37 @@
+"""ETF type definitions."""
+
+from typing import Dict, TypedDict, Literal
+
+
+class EtfOverviewItem(TypedDict):
+    ticker: str
+    timestamp: int
+    asset: str
+    issuer: str
+    etf_name: str
+    custodian: str
+    pct_fee: float
+    url: str
+    flows: float
+    aum: float
+    volume: float
+
+
+class EtfHistoryItem(TypedDict):
+    gecko_id: str
+    day: str
+    total_flow_usd: float
+
+
+FdvPeriod = Literal["7", "30", "ytd", "365"]
+
+
+FdvPerformanceItem = Dict[str, float]
+
+
+__all__ = [
+    "EtfOverviewItem",
+    "EtfHistoryItem",
+    "FdvPeriod",
+    "FdvPerformanceItem",
+]

defillama_api/types/fees.py

@@ -0,0 +1,217 @@
+"""Fees type definitions."""
+
+from typing import Dict, List, Optional, Tuple, TypedDict
+
+from ..constants.dimensions import FeeDataType
+
+
+class FeesOverviewOptions(TypedDict, total=False):
+    excludeTotalDataChart: Optional[bool]
+    excludeTotalDataChartBreakdown: Optional[bool]
+    dataType: Optional[FeeDataType]
+
+
+class FeesSummaryOptions(TypedDict, total=False):
+    dataType: Optional[FeeDataType]
+
+
+class FeesChartOptions(TypedDict, total=False):
+    dataType: Optional[FeeDataType]
+
+
+class FeesProtocol(TypedDict, total=False):
+    id: str
+    defillamaId: str
+    name: str
+    displayName: str
+    module: str
+    category: str
+    logo: str
+    chains: List[str]
+    protocolType: str
+    methodologyURL: str
+    methodology: Dict[str, str]
+    total24h: Optional[float]
+    total48hto24h: Optional[float]
+    total7d: Optional[float]
+    total14dto7d: Optional[float]
+    total30d: Optional[float]
+    total60dto30d: Optional[float]
+    total1y: Optional[float]
+    totalAllTime: Optional[float]
+    total7DaysAgo: Optional[float]
+    total30DaysAgo: Optional[float]
+    average1y: Optional[float]
+    monthlyAverage1y: 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
+
+
+class FeesOverviewResponse(TypedDict, total=False):
+    totalDataChart: List[Tuple[int, float]]
+    totalDataChartBreakdown: List["ChartBreakdownDataPoint"]
+    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[FeesProtocol]
+
+
+class FeesSummaryChildProtocol(TypedDict, total=False):
+    name: str
+    defillamaId: str
+    displayName: str
+    methodologyURL: Optional[str]
+    methodology: Optional[Dict[str, str]]
+    defaultChartView: Optional[str]
+    breakdownMethodology: Optional[str]
+
+
+class FeesSummaryResponse(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[FeesSummaryChildProtocol]]
+    defillamaId: str
+    displayName: str
+    module: Optional[str]
+    category: Optional[str]
+    methodologyURL: Optional[str]
+    methodology: Optional[Dict[str, str]]
+    forkedFrom: Optional[List[str]]
+    audits: Optional[str]
+    audit_links: Optional[List[str]]
+    parentProtocol: Optional[str]
+    previousNames: Optional[List[str]]
+    hallmarks: Optional[List[List[object]]]
+    defaultChartView: Optional[str]
+    doublecounted: Optional[bool]
+    breakdownMethodology: Optional[str]
+    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["NestedChartBreakdownDataPoint"]
+    hasLabelBreakdown: bool
+    change_1d: Optional[float]
+
+
+ChartDataPoint = Tuple[int, float]
+ChartBreakdownDataPoint = Tuple[int, Dict[str, float]]
+NestedChartBreakdownDataPoint = Tuple[int, Dict[str, Dict[str, float]]]
+
+
+class FeesChartResponse(TypedDict):
+    data: List[ChartDataPoint]
+
+
+class FeesChartBreakdownResponse(TypedDict):
+    data: List[ChartBreakdownDataPoint]
+
+
+class FeesMetricsResponse(TypedDict, total=False):
+    total24h: float
+    total7d: float
+    total30d: float
+    total1y: Optional[float]
+    change_1d: float
+    change_7d: float
+    change_1m: float
+    protocols: List[FeesProtocol]
+    allChains: List[str]
+
+
+class FeesMetricsByProtocolResponse(TypedDict, total=False):
+    id: str
+    name: str
+    address: Optional[str]
+    symbol: Optional[str]
+    url: str
+    description: str
+    chain: str
+    logo: str
+    audits: str
+    audit_note: Optional[str]
+    gecko_id: Optional[str]
+    cmcId: Optional[str]
+    category: Optional[str]
+    chains: List[str]
+    module: Optional[str]
+    twitter: Optional[str]
+    audit_links: Optional[List[str]]
+    github: Optional[List[str]]
+    dimensions: Optional[Dict[str, object]]
+    methodology: Optional[Dict[str, str]]
+    misrepresentedTokens: Optional[bool]
+    doublecounted: Optional[bool]
+    defillamaId: str
+    displayName: str
+    methodologyURL: Optional[str]
+    forkedFrom: Optional[List[str]]
+    governanceID: Optional[List[str]]
+    treasury: Optional[str]
+    parentProtocol: Optional[str]
+    previousNames: Optional[List[str]]
+    hallmarks: Optional[List[List[object]]]
+    defaultChartView: Optional[str]
+    breakdownMethodology: Optional[str]
+    slug: str
+    protocolType: str
+    total24h: Optional[float]
+    total48hto24h: Optional[float]
+    total7d: Optional[float]
+    total30d: Optional[float]
+    totalAllTime: Optional[float]
+    hasLabelBreakdown: bool
+
+
+__all__ = [
+    "FeesOverviewOptions",
+    "FeesSummaryOptions",
+    "FeesChartOptions",
+    "FeesProtocol",
+    "FeesOverviewResponse",
+    "FeesSummaryChildProtocol",
+    "FeesSummaryResponse",
+    "ChartDataPoint",
+    "ChartBreakdownDataPoint",
+    "NestedChartBreakdownDataPoint",
+    "FeesChartResponse",
+    "FeesChartBreakdownResponse",
+    "FeesMetricsResponse",
+    "FeesMetricsByProtocolResponse",
+]

defillama_api/types/prices.py

@@ -0,0 +1,99 @@
+"""Price type definitions."""
+
+from typing import Dict, List, Optional, TypedDict
+
+
+class CoinPrice(TypedDict, total=False):
+    decimals: Optional[int]
+    symbol: str
+    price: float
+    timestamp: int
+    confidence: Optional[float]
+
+
+class CoinPricesResponse(TypedDict):
+    coins: Dict[str, CoinPrice]
+
+
+class BatchHistoricalPricePoint(TypedDict, total=False):
+    timestamp: int
+    price: float
+    confidence: Optional[float]
+
+
+class BatchHistoricalCoinData(TypedDict, total=False):
+    prices: List[BatchHistoricalPricePoint]
+    symbol: Optional[str]
+    decimals: Optional[int]
+    confidence: Optional[float]
+
+
+class BatchHistoricalResponse(TypedDict):
+    coins: Dict[str, BatchHistoricalCoinData]
+
+
+class ChartPricePoint(TypedDict):
+    timestamp: int
+    price: float
+
+
+class CoinChartData(TypedDict, total=False):
+    prices: List[ChartPricePoint]
+    symbol: str
+    confidence: Optional[float]
+    decimals: Optional[int]
+
+
+class ChartResponse(TypedDict):
+    coins: Dict[str, CoinChartData]
+
+
+class PercentageResponse(TypedDict):
+    coins: Dict[str, float]
+
+
+class FirstPriceData(TypedDict):
+    price: float
+    timestamp: int
+    symbol: str
+
+
+class FirstPriceResponse(TypedDict):
+    coins: Dict[str, FirstPriceData]
+
+
+class BlockInfo(TypedDict):
+    height: int
+    timestamp: int
+
+
+class ChartOptions(TypedDict, total=False):
+    start: Optional[int]
+    end: Optional[int]
+    span: Optional[int]
+    period: Optional[str]
+    searchWidth: Optional[str]
+
+
+class PercentageOptions(TypedDict, total=False):
+    timestamp: Optional[int]
+    lookForward: Optional[bool]
+    period: Optional[str]
+
+
+__all__ = [
+    "CoinPrice",
+    "CoinPricesResponse",
+    "BatchHistoricalPricePoint",
+    "BatchHistoricalCoinData",
+    "BatchHistoricalResponse",
+    "ChartPricePoint",
+    "CoinChartData",
+    "ChartResponse",
+    "PercentageResponse",
+    "FirstPriceData",
+    "FirstPriceResponse",
+    "BlockInfo",
+    "ChartOptions",
+    "PercentageOptions",
+]

defillama_api/types/stablecoins.py

@@ -0,0 +1,159 @@
+"""Stablecoin type definitions."""
+
+from typing import Dict, List, Optional, TypedDict
+
+
+class PeggedAsset(TypedDict, total=False):
+    peggedUSD: Optional[float]
+    peggedVAR: Optional[float]
+    peggedEUR: Optional[float]
+    peggedJPY: Optional[float]
+    peggedCNY: Optional[float]
+    peggedUAH: Optional[float]
+    peggedARS: Optional[float]
+    peggedGBP: Optional[float]
+    peggedCAD: Optional[float]
+    peggedAUD: Optional[float]
+    peggedSGD: Optional[float]
+    peggedCHF: Optional[float]
+    peggedREAL: Optional[float]
+    peggedRUB: Optional[float]
+    peggedMXN: Optional[float]
+    peggedPHP: Optional[float]
+    peggedTRY: Optional[float]
+
+
+class StablecoinChainCirculating(TypedDict):
+    current: PeggedAsset
+    circulatingPrevDay: PeggedAsset
+    circulatingPrevWeek: PeggedAsset
+    circulatingPrevMonth: PeggedAsset
+
+
+class Stablecoin(TypedDict, total=False):
+    id: str
+    name: str
+    symbol: str
+    gecko_id: Optional[str]
+    pegType: str
+    pegMechanism: str
+    circulating: PeggedAsset
+    circulatingPrevDay: PeggedAsset
+    circulatingPrevWeek: PeggedAsset
+    circulatingPrevMonth: PeggedAsset
+    chainCirculating: Dict[str, StablecoinChainCirculating]
+    chains: List[str]
+    price: Optional[float]
+    priceSource: Optional[str]
+
+
+class StablecoinsResponse(TypedDict):
+    peggedAssets: List[Stablecoin]
+
+
+class StablecoinChartDataPoint(TypedDict, total=False):
+    date: str
+    totalCirculating: PeggedAsset
+    totalUnreleased: Optional[PeggedAsset]
+    totalCirculatingUSD: PeggedAsset
+    totalMintedToL2: Optional[PeggedAsset]
+
+
+class StablecoinChainDataPoint(TypedDict):
+    date: str
+    totalCirculating: PeggedAsset
+    totalCirculatingUSD: PeggedAsset
+
+
+class StablecoinTokenInfo(TypedDict):
+    name: str
+    address: str
+
+
+class StablecoinChainBreakdown(TypedDict, total=False):
+    tokens: Optional[List[StablecoinTokenInfo]]
+    circulating: PeggedAsset
+    circulatingPrevDay: PeggedAsset
+    circulatingPrevWeek: PeggedAsset
+    circulatingPrevMonth: PeggedAsset
+    bridgedTo: Optional[str]
+    minted: Optional[str]
+    bridgeInfo: Optional[Dict[str, Dict[str, str]]]
+
+
+class StablecoinDetails(TypedDict, total=False):
+    id: str
+    name: str
+    address: str
+    symbol: str
+    url: str
+    description: str
+    mintRedeemDescription: Optional[str]
+    onCoinGecko: str
+    gecko_id: Optional[str]
+    cmcId: Optional[str]
+    pegType: str
+    pegMechanism: str
+    priceSource: Optional[str]
+    auditLinks: Optional[List[str]]
+    twitter: Optional[str]
+    wiki: Optional[str]
+    price: Optional[float]
+    tokens: List["StablecoinSupplyPoint"]
+    chainBalances: Dict[str, "StablecoinChainBalanceHistory"]
+    currentChainBalances: Dict[str, PeggedAsset]
+
+
+class StablecoinChainMcap(TypedDict, total=False):
+    gecko_id: Optional[str]
+    totalCirculatingUSD: PeggedAsset
+    tokenSymbol: Optional[str]
+    name: str
+
+
+class StablecoinPricePoint(TypedDict):
+    date: int
+    prices: Dict[str, Optional[float]]
+
+
+class StablecoinSupplyPoint(TypedDict):
+    date: int
+    circulating: PeggedAsset
+
+
+class StablecoinChainBalanceTokenPoint(StablecoinSupplyPoint, total=False):
+    bridgedTo: Optional[PeggedAsset]
+
+
+class StablecoinChainBalanceHistory(TypedDict):
+    tokens: List[StablecoinChainBalanceTokenPoint]
+
+
+class StablecoinDominanceGreatestMcap(TypedDict):
+    gecko_id: str
+    symbol: str
+    mcap: float
+
+
+class StablecoinDominanceDataPoint(TypedDict):
+    date: str
+    totalCirculatingUSD: PeggedAsset
+    greatestMcap: StablecoinDominanceGreatestMcap
+
+
+__all__ = [
+    "PeggedAsset",
+    "Stablecoin",
+    "StablecoinsResponse",
+    "StablecoinChartDataPoint",
+    "StablecoinChainDataPoint",
+    "StablecoinTokenInfo",
+    "StablecoinChainBreakdown",
+    "StablecoinDetails",
+    "StablecoinChainMcap",
+    "StablecoinPricePoint",
+    "StablecoinSupplyPoint",
+    "StablecoinChainBalanceTokenPoint",
+    "StablecoinChainBalanceHistory",
+    "StablecoinDominanceDataPoint",
+]