@tapline/client 0.1.0 → 0.2.0

package/dist/cjs/services/geckoterminal/types.d.ts

@@ -0,0 +1,1453 @@
+export type CandlestickCurrency = "usd" | "token";
+export type CandlestickResolution = "1" | "5" | "15" | "60" | "120" | "240" | "720" | "1D";
+export interface CandlesticksParams {
+    /** Denomination of the bar prices. */
+    currency?: CandlestickCurrency;
+    /** Unix timestamp for the start of the window. */
+    from_timestamp: number;
+    /** Quote bars in the other token of the pair. */
+    is_inverted?: boolean;
+    /** GeckoTerminal numeric pair id, from the pool's `pairs` relationship. */
+    pair_id: string;
+    /** GeckoTerminal numeric pool id, as returned in a pool resource's `id`. */
+    pool_id: string;
+    /** Bar width in minutes, or `1D`. */
+    resolution?: CandlestickResolution;
+    /** Unix timestamp for the end of the window. */
+    to_timestamp: number;
+}
+export interface CandlesticksResponse {
+    data: CandlesticksResponseData[];
+    meta: Record<string, string>;
+}
+export interface CandlesticksResponseData {
+    c: number;
+    dt: string;
+    h: number;
+    l: number;
+    o: number;
+    v: number;
+}
+export interface DexAttributes {
+    analytics_pool_page_url?: string | null;
+    analytics_token_page_url?: string | null;
+    identifier?: string;
+    image_url: string;
+    is_bonding_curve?: boolean;
+    is_launchpad?: boolean;
+    name: string;
+    no_reserves?: boolean;
+    url?: string;
+}
+export interface DexLinkServiceAttributes {
+    category: string;
+    image_url: string;
+    name: string;
+    priority: number | null;
+    sub_category: string;
+    url: string;
+}
+export interface DexLinkServiceResource {
+    attributes: DexLinkServiceAttributes;
+    id: string;
+    type: string;
+}
+export interface DexMetricAttributes {
+    pools_count: number;
+    rank_by_volume: number | null;
+    reserve_in_usd: string;
+    swap_count_24h: number;
+    swap_volume_percent_change_24h: number | string;
+    swap_volume_usd_24h: string;
+    swap_volume_usd_48h_24h: string;
+    tokens_count: number;
+}
+export interface DexMetricResource {
+    attributes: DexMetricAttributes;
+    id: string;
+    type: string;
+}
+export interface DexRelationships {
+    dex_metric?: ResourceLinkage;
+    network: ResourceLinkage;
+}
+export interface DexResource {
+    attributes: DexAttributes;
+    id: string;
+    relationships: DexRelationships;
+    type: string;
+}
+export interface DexesParams {
+    /** Restrict results to one network identifier. */
+    network?: string | null;
+    /** 1-based result page. */
+    page?: number | null;
+}
+export interface DexesResponse {
+    data: DexResource[];
+    included: (DexMetricResource | NetworkResource)[];
+    links: DexesResponseLinks;
+}
+export interface DexesResponseLinks {
+    first: string;
+    last: DexesResponseLinksLast;
+    next: string | null;
+    prev: string | null;
+}
+export interface DexesResponseLinksLast {
+    href: string;
+    meta: DexesResponseLinksLastMeta;
+}
+export interface DexesResponseLinksLastMeta {
+    series: string[];
+}
+export interface ErrorDetail {
+    ctx?: Record<string, unknown> | null;
+    input?: unknown | null;
+    loc?: (string | number)[] | null;
+    msg?: string | null;
+    type?: string | null;
+}
+export interface ErrorResponse {
+    code: PublicError;
+    details?: ErrorDetail[] | null;
+    domain?: string | null;
+    message: string;
+    request_id: string;
+}
+export interface ExplorerAttributes {
+    coin_url: string;
+    holders_url: string;
+    logo_url: string;
+    name: string;
+    rank: number | null;
+    tx_url: string;
+    url: string;
+}
+export interface ExplorerResource {
+    attributes: ExplorerAttributes;
+    id: string;
+    type: string;
+}
+export interface GlobalStatAttributes {
+    dexes_count: number;
+    eth_gas_oracle: GlobalStatAttributesEthGasOracle;
+    fng_stats: GlobalStatAttributesFngStats;
+    networks_count: number;
+    pools_count: number;
+    tokens_count: number;
+}
+export interface GlobalStatAttributesEthGasOracle {
+    fast_gas_price: number;
+    gas_used_ratio: string;
+    last_block: number;
+    propose_gas_price: number;
+    safe_gas_price: number;
+    suggest_base_fee: number;
+    updated_at: string;
+}
+export interface GlobalStatAttributesFngStats {
+    next_update_at: string;
+    value: number;
+    value_classification: string;
+}
+export interface GlobalStatResource {
+    attributes: GlobalStatAttributes;
+    id: string;
+    type: string;
+}
+export interface GlobalStatsResponse {
+    data: GlobalStatResource;
+}
+export type HolderHistoryPeriod = "1W" | "1M" | "all";
+export interface LatestPoolsParams {
+    /** 1-based result page. */
+    page?: number;
+    /** Only include pools created within this many hours. */
+    pool_creation_hours_ago_lte?: number;
+}
+export interface LatestPoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | PoolMetricResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: LatestPoolsResponseMeta;
+}
+export interface LatestPoolsResponseLinks {
+    first: string;
+    last: LatestPoolsResponseLinksLast;
+    next: string | null;
+    prev: string | null;
+}
+export interface LatestPoolsResponseLinksLast {
+    meta: LatestPoolsResponseLinksLastMeta;
+}
+export interface LatestPoolsResponseLinksLastMeta {
+    series: (number | string)[];
+}
+export interface LatestPoolsResponseMeta {
+    sort: string;
+}
+export interface NetworkAttributes {
+    cg_network_id?: string | null;
+    chain_id?: number | null;
+    explorer_coin_url?: string;
+    explorer_logo_url?: string;
+    explorer_tx_url?: string;
+    explorer_url?: string;
+    identifier: string;
+    image_url?: string;
+    is_new?: boolean;
+    name?: string;
+    native_currency_address?: string;
+    native_currency_symbol?: string;
+    pool_reserve_threshold?: string;
+    supports_top_holders?: boolean;
+}
+export interface NetworkLatestPoolsParams {
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** 1-based result page. */
+    page?: number;
+    /** Only include pools created within this many hours. */
+    pool_creation_hours_ago_lte?: number;
+}
+export interface NetworkLatestPoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | PoolMetricResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: NetworkLatestPoolsResponseMeta;
+}
+export interface NetworkLatestPoolsResponseMeta {
+    network: string;
+    sort: string;
+}
+export interface NetworkLinkServiceAttributes {
+    category: string;
+    image_url: string;
+    name: string;
+    priority: number | null;
+    sub_category: string | null;
+    url: string;
+}
+export interface NetworkLinkServiceResource {
+    attributes: NetworkLinkServiceAttributes;
+    id: string;
+    type: string;
+}
+export interface NetworkMetricAttributes {
+    dexes_count?: number;
+    latest_pools_count: number;
+    pools_count?: number;
+    rank_by_liquidity?: number;
+    reserve_in_usd?: string;
+    swap_count_24h?: number;
+    swap_volume_percent_change_24h?: string;
+    swap_volume_usd_24h?: string;
+    swap_volume_usd_48h_24h?: string;
+    tokens_count?: number;
+    trending_pools_count?: number;
+}
+export interface NetworkMetricResource {
+    attributes: NetworkMetricAttributes;
+    id: string;
+    type: string;
+}
+export interface NetworkPoolScreenerRequest {
+    /** Buy tax percentage. */
+    buy_tax?: RangeFilter | null;
+    /** Buy count over the chosen window. */
+    buys?: TimeframedRangeFilter | null;
+    /** Restrict to a single DEX on this network, by identifier. */
+    dex?: string | null;
+    /** Restrict to these DEX identifiers. */
+    dexes?: string[] | null;
+    /** Fully diluted valuation in USD. */
+    fdv_in_usd?: RangeFilter | null;
+    /** Only pools above GeckoTerminal's GT score threshold. */
+    good_gt_score?: boolean | null;
+    /** Only pools whose token declares social links. */
+    has_social?: boolean | null;
+    /** Number of token holders. */
+    holder_count?: RangeFilter | null;
+    /** Pool liquidity in USD. */
+    liquidity?: RangeFilter | null;
+    /** Market cap in USD. */
+    mc_in_usd?: RangeFilter | null;
+    /** Restrict to these network identifiers. */
+    networks?: string[] | null;
+    /** Exclude tokens flagged as honeypots. */
+    no_honeypot?: boolean | null;
+    /** Only pools whose token is listed on CoinGecko. */
+    on_coingecko?: boolean | null;
+    /** 1-based result page. */
+    page?: number;
+    /** Pool age in hours. */
+    pool_creation_hours_ago?: RangeFilter | null;
+    /** Sell tax percentage. */
+    sell_tax?: RangeFilter | null;
+    /** Sell count over the chosen window. */
+    sells?: TimeframedRangeFilter | null;
+    /** Ranking applied before pagination. Omit for GeckoTerminal's default. */
+    sort?: PoolSort | null;
+    /** Share of supply held by the ten largest holders. */
+    top_10_holders_percentage?: RangeFilter | null;
+    /** Transaction count over the chosen window. */
+    tx_count?: TimeframedRangeFilter | null;
+    /** 24h traded volume in USD. */
+    volume_24h?: RangeFilter | null;
+}
+export interface NetworkPoolsParams {
+    /** GeckoTerminal network identifier. */
+    network: string;
+}
+export interface NetworkPoolsResponse {
+    data: PoolResource[];
+    included: (DexMetricResource | DexResource | NetworkResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: LatestPoolsResponseMeta;
+}
+export interface NetworkRankingsParams {
+    /** 1-based result page. */
+    page?: number;
+}
+export interface NetworkRankingsResponse {
+    data: NetworkResource[];
+    included: NetworkMetricResource[];
+    links: LatestPoolsResponseLinks;
+}
+export interface NetworkRelationships {
+    explorers?: ResourceLinkageList;
+    network_metric?: ResourceLinkage;
+}
+export interface NetworkResource {
+    attributes: NetworkAttributes;
+    id: string;
+    relationships: NetworkRelationships;
+    type: string;
+}
+export interface NetworksParams {
+    /** Ordering applied to the chain list, e.g. `-24h_volume`. */
+    sort?: string | null;
+}
+export interface NetworksResponse {
+    data: NetworkResource[];
+}
+export interface PairAttributes {
+    base_address: string;
+    base_name: string;
+    base_price_in_currency: string;
+    base_price_in_quote: string;
+    base_price_in_usd: string;
+    base_price_in_usd_percent_change: number;
+    base_symbol: string;
+    base_token_id: string;
+    data_24h: PairAttributesData24h;
+    name: string;
+    price_change_data: PairAttributesPriceChangeData;
+    quote_address: string;
+    quote_name: string;
+    quote_price_in_base: string;
+    quote_price_in_currency: string;
+    quote_price_in_usd: string;
+    quote_price_in_usd_percent_change: number;
+    quote_symbol: string;
+    quote_token_id: string;
+    swap_count: number;
+    transaction_data: PairAttributesTransactionData;
+    volume_data: PairAttributesVolumeData;
+    volume_in_currency: string;
+    volume_in_usd: string;
+}
+export interface PairAttributesData24h {
+    buys: number;
+    sells: number;
+    total_in_usd: number;
+}
+export interface PairAttributesPriceChangeData {
+    last_172800_s: PairAttributesPriceChangeDataEntry;
+    last_1800_s: PairAttributesPriceChangeDataEntry;
+    last_21600_s: PairAttributesPriceChangeDataEntry;
+    last_300_s: PairAttributesPriceChangeDataEntry;
+    last_3600_s: PairAttributesPriceChangeDataEntry;
+    last_43200_s: PairAttributesPriceChangeDataEntry;
+    last_7200_s: PairAttributesPriceChangeDataEntry;
+    last_86400_s: PairAttributesPriceChangeDataEntry;
+    last_900_s: PairAttributesPriceChangeDataEntry;
+}
+export interface PairAttributesPriceChangeDataEntry {
+    base_token_percentage: number;
+    base_token_usd: number;
+    prices: PairAttributesPriceChangeDataEntryPrices;
+    quote_token_percentage: number;
+    quote_token_usd: number;
+}
+export interface PairAttributesPriceChangeDataEntryPrices {
+    base_token_high_price_in_usd?: number;
+    base_token_high_price_timestamp?: string;
+    base_token_last_price_in_usd?: number;
+    base_token_low_price_in_usd?: number;
+    base_token_low_price_timestamp?: string;
+    base_token_start_price_in_usd?: number;
+    quote_token_high_price_in_usd?: number;
+    quote_token_high_price_timestamp?: string;
+    quote_token_last_price_in_usd?: number;
+    quote_token_low_price_in_usd?: number;
+    quote_token_low_price_timestamp?: string;
+    quote_token_start_price_in_usd?: number;
+}
+export interface PairAttributesTransactionData {
+    last_172800_s: PairAttributesTransactionDataEntry;
+    last_1800_s: PairAttributesTransactionDataEntry;
+    last_21600_s: PairAttributesTransactionDataEntry;
+    last_300_s: PairAttributesTransactionDataEntry;
+    last_3600_s: PairAttributesTransactionDataEntry;
+    last_43200_s: PairAttributesTransactionDataEntry;
+    last_7200_s: PairAttributesTransactionDataEntry;
+    last_86400_s: PairAttributesTransactionDataEntry;
+    last_900_s: PairAttributesTransactionDataEntry;
+}
+export interface PairAttributesTransactionDataEntry {
+    buys: number;
+    sells: number;
+}
+export interface PairAttributesVolumeData {
+    last_172800_s: PairAttributesVolumeDataEntry;
+    last_1800_s: PairAttributesVolumeDataEntry;
+    last_21600_s: PairAttributesVolumeDataEntry;
+    last_300_s: PairAttributesVolumeDataEntry;
+    last_3600_s: PairAttributesVolumeDataEntry;
+    last_43200_s: PairAttributesVolumeDataEntry;
+    last_7200_s: PairAttributesVolumeDataEntry;
+    last_86400_s: PairAttributesVolumeDataEntry;
+    last_900_s: PairAttributesVolumeDataEntry;
+}
+export interface PairAttributesVolumeDataEntry {
+    buys_in_currency_token: number;
+    buys_in_usd: number;
+    sells_in_currency_token: number;
+    sells_in_usd: number;
+    total_in_base_token: number;
+    total_in_currency_token: number;
+    total_in_quote_token: number;
+    total_in_usd: number;
+}
+export interface PairRelationships {
+    pool: ResourceLinkage;
+}
+export interface PairResource {
+    attributes: PairAttributes;
+    id: string;
+    relationships: PairRelationships;
+    type: string;
+}
+export interface PastTokensDeveloperDetailAttributes {
+    past_tokens: PastTokensDeveloperDetailAttributesPastTokens[] | string[];
+    past_tokens_count: number;
+}
+export interface PastTokensDeveloperDetailAttributesPastTokens {
+    address: string;
+    fdv_in_usd: number;
+    market_cap_in_usd: number | null;
+    name: string;
+    symbol: string;
+    token_image_url: string;
+    top_pool_address: string;
+}
+export interface PastTokensDeveloperDetailResource {
+    attributes: PastTokensDeveloperDetailAttributes;
+    id: string;
+    type: string;
+}
+export interface PoolAttributes {
+    address: string;
+    aggregated_network_metrics?: PoolAttributesAggregatedNetworkMetrics;
+    api_address?: string;
+    balancer_pool_id?: string | null;
+    base_token_id: string;
+    from_volume_in_usd?: string;
+    fully_diluted_valuation?: string;
+    graduated_pool_address?: string | null;
+    graduation_percentage?: number | null;
+    gt_score?: number;
+    gt_score_details?: PoolAttributesGtScoreDetails;
+    high_low_price_data_by_token_id?: Record<string, PoolAttributesHighLowPriceDataByTokenIdEntry>;
+    historical_data?: PoolAttributesHistoricalData;
+    holder_count?: number | null;
+    is_nsfw?: boolean;
+    is_pool_address_explorable?: boolean;
+    is_stale_pool?: boolean | null;
+    is_suspicious_chart?: boolean | null;
+    latest_swap_timestamp?: string;
+    name?: string;
+    net_volume_data_24h?: PoolAttributesNetVolumeData24h;
+    pool_created_at: string;
+    pool_fee?: string | null;
+    pool_reports_count?: number;
+    price_in_target_token?: string;
+    price_in_usd?: string;
+    price_percent_change: string | null;
+    price_percent_changes?: PoolAttributesPricePercentChanges;
+    price_sparkline_7d?: number[] | null;
+    reserve_in_usd?: string | null;
+    reserve_threshold_met?: boolean;
+    risk_flags?: string[];
+    security_indicators?: string[];
+    security_indicators_data?: PoolAttributesSecurityIndicatorsData;
+    sentiment_votes?: PoolAttributesSentimentVotes;
+    suggested_pools_by_liquidity?: PoolAttributesSuggestedPoolsByLiquidity;
+    swap_count_24h?: number;
+    swap_url?: string;
+    tagged_token_id?: string;
+    to_volume_in_usd?: string;
+    token_reserves?: Record<string, PoolAttributesTokenReservesEntry>;
+    token_value_data?: Record<string, PoolAttributesTokenValueDataEntry>;
+    token_weightages?: Record<string, string> | null;
+    trending_narrative?: string | null;
+}
+export interface PoolAttributesAggregatedNetworkMetrics {
+    total_swap_count_24h: number;
+    total_swap_volume_percent_change_24h: string;
+    total_swap_volume_usd_24h: string;
+    total_swap_volume_usd_48h_24h: string;
+}
+export interface PoolAttributesGtScoreDetails {
+    creation: number;
+    holders: number;
+    info: number;
+    pool: number;
+    transactions: number;
+}
+export interface PoolAttributesHighLowPriceDataByTokenIdEntry {
+    high_price_in_usd_24h: number;
+    high_price_timestamp_24h: string;
+    low_price_in_usd_24h: number;
+    low_price_timestamp_24h: string;
+}
+export interface PoolAttributesHistoricalData {
+    last_15m: PoolAttributesHistoricalDataEntry;
+    last_1h: PoolAttributesHistoricalDataEntry;
+    last_24h: PoolAttributesHistoricalDataEntry;
+    last_30m: PoolAttributesHistoricalDataEntry;
+    last_5m: PoolAttributesHistoricalDataEntry;
+    last_6h: PoolAttributesHistoricalDataEntry;
+}
+export interface PoolAttributesHistoricalDataEntry {
+    buy_swaps_count: number;
+    buy_volume_in_usd?: string;
+    buyers_count: number;
+    net_volume_in_usd?: string;
+    price_in_usd: string | null;
+    sell_swaps_count: number;
+    sell_volume_in_usd?: string;
+    sellers_count: number;
+    swaps_count: number;
+    volume_in_usd: string;
+}
+export interface PoolAttributesNetVolumeData24h {
+    buy_volume_in_usd: string;
+    net_volume_in_usd: string;
+    sell_volume_in_usd: string;
+}
+export interface PoolAttributesPricePercentChanges {
+    last_15m: string | null;
+    last_1h: string | null;
+    last_24h: string | null;
+    last_30m: string | null;
+    last_5m: string | null;
+    last_6h: string | null;
+}
+export interface PoolAttributesSecurityIndicatorsData {
+    bundler_percentage: number | null;
+    buy_tax: number | null;
+    cluster_percentage: number | null;
+    developer_holding_percentage: number | null;
+    early_buyers_percentage: number | null;
+    freezable: boolean | null;
+    gt_score: number | null;
+    holder_count: number | null;
+    honeypot: boolean | null;
+    is_liquidity_locked: boolean | null;
+    mintable: boolean | null;
+    pool_created_at: string;
+    sell_tax: number | null;
+    top_10_holders_percentage: number | null;
+}
+export interface PoolAttributesSentimentVotes {
+    down_percentage: number;
+    total: number;
+    up_percentage: number;
+}
+export interface PoolAttributesSuggestedPoolsByLiquidity {
+    by_base_token_address: string[];
+    by_base_token_symbol: PoolAttributesSuggestedPoolsByLiquidityByBaseTokenSymbol[];
+}
+export interface PoolAttributesSuggestedPoolsByLiquidityByBaseTokenSymbol {
+    address: string;
+    dex_identifier: string;
+    dex_name: string;
+    name: string;
+    network_identifier: string;
+}
+export interface PoolAttributesTokenReservesEntry {
+    reserves: string;
+    reserves_in_usd: number;
+}
+export interface PoolAttributesTokenValueDataEntry {
+    fdv_in_usd: number | null;
+    market_cap_in_usd: number | null;
+    market_cap_to_holders_ratio: number | null;
+}
+export type PoolFilterTimeframe = "5m" | "1h" | "6h" | "24h";
+export interface PoolLockedLiquidityAttributes {
+    final_unlock_timestamp: string | null;
+    locked_percent: number;
+    next_unlock_percent: number | null;
+    next_unlock_timestamp: string | null;
+    source: string;
+    url: string;
+}
+export interface PoolLockedLiquidityResource {
+    attributes: PoolLockedLiquidityAttributes;
+    id: string;
+    type: string;
+}
+export interface PoolMetricAttributes {
+    currency_token_id: number;
+    currency_token_symbol: string;
+    dex_id: number;
+    from_token_address: string;
+    from_token_id: number;
+    from_token_name: string;
+    from_token_symbol: string;
+    from_volume: string;
+    from_volume_in_currency_token: string;
+    from_volume_in_usd: string;
+    historical_data: Record<string, PoolMetricAttributesHistoricalDataEntry>;
+    pool_id: number;
+    price: string;
+    reserve_in_currency_token: string;
+    reserve_in_usd: string;
+    swap_count_24h: number;
+    to_token_address: string;
+    to_token_id: number;
+    to_token_name: string;
+    to_token_symbol: string;
+    to_volume: string;
+    to_volume_in_currency_token: string;
+    to_volume_in_usd: string;
+}
+export interface PoolMetricAttributesHistoricalDataEntry {
+    last_172800_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_1800_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_21600_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_300_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_3600_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_43200_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_7200_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_86400_s: PoolMetricAttributesHistoricalDataEntryEntry;
+    last_900_s: PoolMetricAttributesHistoricalDataEntryEntry;
+}
+export interface PoolMetricAttributesHistoricalDataEntryEntry {
+    buy_swaps_count: number;
+    buy_volume_in_usd: string;
+    buyers_count: number;
+    net_volume_in_usd: string;
+    price_in_usd: string | null;
+    sell_swaps_count: number;
+    sell_volume_in_usd: string;
+    sellers_count: number;
+    swaps_count: number;
+    volume_in_usd: string;
+}
+export interface PoolMetricResource {
+    attributes: PoolMetricAttributes;
+    id: string;
+    type: string;
+}
+export interface PoolParams {
+    /** On-chain pool address. */
+    address: string;
+    /** Index of the token to quote the pool in. */
+    base_token?: number;
+    /** GeckoTerminal network identifier. */
+    network: string;
+}
+export interface PoolRelatedPoolsParams {
+    /** On-chain pool address. */
+    address: string;
+    /** GeckoTerminal network identifier. */
+    network: string;
+}
+export interface PoolRelatedPoolsResponse {
+    data: RelatedPoolResource[];
+    included: (DexResource | NetworkResource | TokenResource)[];
+}
+export interface PoolRelationships {
+    dex?: ResourceLinkage;
+    pairs?: ResourceLinkageList;
+    pool_metric?: ResourceLinkage;
+    tokens: ResourceLinkageList;
+}
+export interface PoolResource {
+    attributes: PoolAttributes;
+    id: string;
+    relationships: PoolRelationships;
+    type: string;
+}
+export interface PoolResponse {
+    data: PoolResource;
+    included: (DexLinkServiceResource | DexResource | ExplorerResource | NetworkLinkServiceResource | NetworkResource | PairResource | PoolLockedLiquidityResource | TagResource | TokenDeveloperDetailResource | TokenResource | TokenSecurityMetricResource)[];
+}
+export interface PoolScreenerRequest {
+    /** Buy tax percentage. */
+    buy_tax?: RangeFilter | null;
+    /** Buy count over the chosen window. */
+    buys?: TimeframedRangeFilter | null;
+    /** Restrict to these DEX identifiers. */
+    dexes?: string[] | null;
+    /** Fully diluted valuation in USD. */
+    fdv_in_usd?: RangeFilter | null;
+    /** Only pools above GeckoTerminal's GT score threshold. */
+    good_gt_score?: boolean | null;
+    /** Only pools whose token declares social links. */
+    has_social?: boolean | null;
+    /** Number of token holders. */
+    holder_count?: RangeFilter | null;
+    /** Pool liquidity in USD. */
+    liquidity?: RangeFilter | null;
+    /** Market cap in USD. */
+    mc_in_usd?: RangeFilter | null;
+    /** Restrict to these network identifiers. */
+    networks?: string[] | null;
+    /** Exclude tokens flagged as honeypots. */
+    no_honeypot?: boolean | null;
+    /** Only pools whose token is listed on CoinGecko. */
+    on_coingecko?: boolean | null;
+    /** 1-based result page. */
+    page?: number;
+    /** Pool age in hours. */
+    pool_creation_hours_ago?: RangeFilter | null;
+    /** Sell tax percentage. */
+    sell_tax?: RangeFilter | null;
+    /** Sell count over the chosen window. */
+    sells?: TimeframedRangeFilter | null;
+    /** Ranking applied before pagination. Omit for GeckoTerminal's default. */
+    sort?: PoolSort | null;
+    /** Share of supply held by the ten largest holders. */
+    top_10_holders_percentage?: RangeFilter | null;
+    /** Transaction count over the chosen window. */
+    tx_count?: TimeframedRangeFilter | null;
+    /** 24h traded volume in USD. */
+    volume_24h?: RangeFilter | null;
+}
+export interface PoolSenderSwapsParams {
+    /** On-chain pool address. */
+    address: string;
+    /** Unix timestamp for the start of the window. */
+    from_timestamp: number;
+    /** Tag swaps made by the token's developer wallet. */
+    include_developer?: boolean;
+    /** Quote prices in the other token of the pair. */
+    inverted?: boolean;
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** Pair id from the pool's `pairs` relationship. */
+    pair_id: string;
+    /** Restrict swaps to one sender wallet address. */
+    sender?: string | null;
+    /** Unix timestamp for the end of the window. */
+    to_timestamp: number;
+}
+export interface PoolSenderSwapsResponse {
+    data: SenderSwapResource[];
+}
+export type PoolSort = "-5m_trend_score" | "-1h_trend_score" | "-6h_trend_score" | "-24h_trend_score" | "-24h_transactions" | "-24h_volume" | "-pool_creation_date" | "-24h_price_percent_change" | "-6h_price_percent_change" | "-1h_price_percent_change" | "-5m_price_percent_change" | "fdv" | "-fdv" | "liquidity" | "-liquidity" | "mc" | "-mc";
+export interface PoolSwapsParams {
+    /** On-chain pool address. */
+    address: string;
+    /** Quote prices in the other token of the pair. */
+    inverted?: boolean;
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** Return swaps older than this cursor. */
+    page_after?: string | null;
+    /** Return swaps newer than this cursor. */
+    page_before?: string | null;
+    /** Pair id from the pool's `pairs` relationship. */
+    pair_id: string;
+    /** Restrict swaps to one sender wallet address. */
+    sender?: string | null;
+}
+export interface PoolSwapsResponse {
+    data: SwapResource[];
+    included: TokenResource[];
+    links: PoolSwapsResponseLinks;
+    meta?: PoolSwapsResponseMeta;
+}
+export interface PoolSwapsResponseLinks {
+    next: string;
+    prev: string;
+}
+export interface PoolSwapsResponseMeta {
+    next_limit: number;
+}
+export interface PoolTokenInfoSnapshotsParams {
+    /** On-chain pool address. */
+    address: string;
+    /** GeckoTerminal network identifier. */
+    network: string;
+}
+export interface PoolTokenInfoSnapshotsResponse {
+    data: TokenResource[];
+}
+export interface PoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: LatestPoolsResponseMeta;
+}
+export type PublicError = "blocked" | "concurrency_exceeded" | "timeout" | "extraction_failed" | "upstream_blocked" | "upstream_unavailable" | "upstream_response_invalid" | "invalid_url_scheme" | "invalid_url_host" | "unauthenticated" | "forbidden" | "resource_forbidden" | "not_found" | "rate_limited" | "invalid_request" | "invalid_cursor" | "insufficient_credits" | "internal_error";
+export interface RangeFilter {
+    /** Inclusive lower bound. */
+    gte?: number | null;
+    /** Inclusive upper bound. */
+    lte?: number | null;
+}
+export interface RelatedPoolAttributes {
+    address: string;
+    liquidity: string;
+    pool_fee: string | null;
+    token_id: string;
+    volume_in_usd_24h: string;
+}
+export interface RelatedPoolRelationships {
+    dex: ResourceLinkage;
+    tokens: ResourceLinkageList;
+}
+export interface RelatedPoolResource {
+    attributes: RelatedPoolAttributes;
+    id: string;
+    relationships: RelatedPoolRelationships;
+    type: string;
+}
+export interface ResourceIdentifier {
+    id: string;
+    type: string;
+}
+export interface ResourceLinkage {
+    data: ResourceIdentifier | null;
+}
+export interface ResourceLinkageList {
+    data: ResourceIdentifier[];
+}
+export interface RevivalRadarPoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | TokenResource)[];
+    meta: RevivalRadarPoolsResponseMeta;
+}
+export interface RevivalRadarPoolsResponseMeta {
+    sections: RevivalRadarPoolsResponseMetaSections;
+}
+export interface RevivalRadarPoolsResponseMetaSections {
+    revived: string[];
+    reviving: string[];
+    sunsetting: string[];
+}
+export interface SearchAttributes {
+    dexes: string[];
+    networks: SearchAttributesNetworks[] | string[];
+    pairs: string[];
+    pools: SearchAttributesPools[] | string[];
+    tags: SearchAttributesTags[] | string[];
+}
+export interface SearchAttributesNetworks {
+    identifier: string;
+    image_url: string;
+    name: string;
+    pools_count: number;
+    rank_by_volume_usd_24h: number;
+    swap_count_24h: number;
+    swap_volume_usd_24h: string;
+    type: string;
+}
+export interface SearchAttributesPools {
+    address: string;
+    api_address: string;
+    dex: TrendAttributesNewPoolsDex;
+    fdv_in_usd: string;
+    from_volume_in_usd: string;
+    gt_score: number;
+    market_cap_in_usd: string;
+    network: TrendAttributesNewPoolsNetwork;
+    on_coingecko: boolean;
+    pool_creation_date: string;
+    pool_id: number;
+    price_in_usd: string;
+    price_percent_change: string;
+    reserve_in_usd: string;
+    to_volume_in_usd: string;
+    tokens: SearchAttributesPoolsTokens[];
+    type: string;
+    volume_percent_change_24h: string;
+}
+export interface SearchAttributesPoolsTokens {
+    address: string;
+    holder_count: number;
+    image_url: string;
+    is_base_token: boolean;
+    is_verified: boolean;
+    name: string;
+    symbol: string;
+}
+export interface SearchAttributesTags {
+    identifier: string;
+    name: string;
+    type: string;
+}
+export interface SearchParams {
+    /** Free-text query matched against tokens, pools, categories, chains and DEXes. */
+    query: string;
+}
+export interface SearchResource {
+    attributes: SearchAttributes;
+    id: string;
+    type: string;
+}
+export interface SearchResponse {
+    data: SearchResource;
+}
+export interface SearchTrendAttributes {
+    search_items: SearchTrendAttributesSearchItems[];
+}
+export interface SearchTrendAttributesSearchItems {
+    base_token_image_url: string;
+    base_token_name: string;
+    base_token_symbol: string;
+    dex_identifier: string;
+    dex_image_url: string;
+    is_verified: boolean;
+    name: string;
+    network_identifier: string;
+    network_image_url: string;
+    on_coingecko: boolean;
+    pool_address: string;
+    pool_api_address: string;
+    price_percent_change: string;
+    reserve_in_usd: string;
+    type: string;
+    volume_in_usd_24h: string;
+}
+export interface SearchTrendResource {
+    attributes: SearchTrendAttributes;
+    id: string;
+    type: string;
+}
+export interface SearchTrendsResponse {
+    data: SearchTrendResource;
+}
+export interface SenderSwapAttributes {
+    action: string;
+    by: string;
+    swap_total_in_usd: string;
+    timestamp: string;
+}
+export interface SenderSwapResource {
+    attributes: SenderSwapAttributes;
+    id: string;
+    type: string;
+}
+export interface SwapAttributes {
+    from_token_amount: string;
+    from_token_total_in_usd: string;
+    price_from: string;
+    price_from_in_currency_token: string;
+    price_from_in_usd: string;
+    price_to: string;
+    price_to_in_currency_token: string;
+    price_to_in_usd: string;
+    timestamp: string;
+    to_token_amount: string;
+    to_token_total_in_usd: string;
+    tx_from_address: string;
+    tx_hash: string;
+}
+export interface SwapRelationships {
+    from_token: ResourceLinkage;
+    to_token: ResourceLinkage;
+}
+export interface SwapResource {
+    attributes: SwapAttributes;
+    id: string;
+    relationships: SwapRelationships;
+    type: string;
+}
+export interface TagAttributes {
+    buy_count_24h?: number;
+    description?: string | null;
+    fdv_in_usd?: string;
+    icon_url: string | null;
+    identifier: string;
+    name: string;
+    pool_trend_rank: number | null;
+    reserve_in_usd?: string;
+    sell_count_24h?: number;
+    swap_count_24h?: number;
+    swap_volume_usd_24h?: number;
+    volume_percent_changes?: TagAttributesVolumePercentChanges;
+}
+export interface TagAttributesVolumePercentChanges {
+    last_12h: string;
+    last_1h: string;
+    last_24h: string;
+    last_6h: string;
+}
+export interface TagNetworkPoolsParams {
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** 1-based result page. */
+    page?: number;
+    /** Category slug, as returned by the tags endpoint. */
+    tag: string;
+}
+export interface TagNetworkPoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: LatestPoolsResponseMeta;
+}
+export interface TagPoolsParams {
+    /** 1-based result page. */
+    page?: number;
+    /** Category slug, as returned by the tags endpoint. */
+    tag: string;
+}
+export interface TagPoolsResponse {
+    data: PoolResource[];
+    included: (DexResource | NetworkResource | TokenResource)[];
+    links: LatestPoolsResponseLinks;
+    meta: LatestPoolsResponseMeta;
+}
+export interface TagRelationships {
+    top_tokens?: ResourceLinkageList;
+}
+export interface TagResource {
+    attributes: TagAttributes;
+    id: string;
+    relationships: TagRelationships;
+    type: string;
+}
+export interface TagsParams {
+    /** 1-based result page. */
+    page?: number;
+}
+export interface TagsResponse {
+    data: TagResource[];
+    included: TokenResource[];
+    links: TagsResponseLinks;
+}
+export interface TagsResponseLinks {
+    first: string;
+    last: TagsResponseLinksLast;
+    next: string;
+    prev: string | null;
+}
+export interface TagsResponseLinksLast {
+    href: string;
+    meta: LatestPoolsResponseLinksLastMeta;
+}
+export interface ThemeAttributes {
+    pools: ThemeAttributesPools[];
+    pools_count: number;
+    tag: ThemeAttributesTag;
+}
+export interface ThemeAttributesPools {
+    base_token_id: string;
+    network_identifier: string;
+    pool_address: string;
+    tagged_token_id: string;
+    tokens: ThemeAttributesPoolsTokens[];
+}
+export interface ThemeAttributesPoolsTokens {
+    id: string;
+    image_url: string;
+    symbol: string;
+}
+export interface ThemeAttributesTag {
+    description?: string;
+    id: string;
+    identifier: string;
+    name: string;
+    swap_count_24h: number;
+    swap_volume_usd_24h?: number;
+}
+export interface ThemeResource {
+    attributes: ThemeAttributes;
+    id: string;
+    type: string;
+}
+export interface TimeframedRangeFilter {
+    /** Inclusive lower bound. */
+    gte?: number | null;
+    /** Inclusive upper bound. */
+    lte?: number | null;
+    /** Window the trade counts are measured over. */
+    timeframe?: PoolFilterTimeframe;
+}
+export interface TokenAttributes {
+    address?: string;
+    banner_image_url?: string;
+    cg_coin_id?: string | null;
+    circulating_supply?: number;
+    cto?: string | null;
+    decimals?: number;
+    description?: TokenAttributesDescription;
+    image_url?: string;
+    is_verified?: boolean;
+    links?: TokenAttributesLinks;
+    market_cap_in_usd?: number | null;
+    metadata_updated_at?: string | null;
+    name?: string;
+    on_coingecko?: boolean | null;
+    on_pump_fun?: boolean | null;
+    supports_bubblemaps?: boolean;
+    supports_bubblemaps_v2?: boolean;
+    symbol?: string;
+    token_info_snapshots?: TokenAttributesTokenInfoSnapshots[];
+    top_traders_enabled?: boolean;
+    verified_at?: string | null;
+}
+export interface TokenAttributesDescription {
+    en?: string;
+}
+export interface TokenAttributesLinks {
+    discord_url?: string | null;
+    facebook_handle?: string | null;
+    github_repo_name?: string | null;
+    instagram_handle?: string | null;
+    medium_handle?: string | null;
+    subreddit_handle?: string | null;
+    telegram_handle?: string | null;
+    tiktok_handle?: string | null;
+    twitter_handle?: string | null;
+    warpcast_url?: string | null;
+    websites?: string[];
+    youtube_handle?: string | null;
+    zora_url?: string | null;
+}
+export interface TokenAttributesTokenInfoSnapshots {
+    description: TokenAttributesDescription;
+    links: TokenAttributesTokenInfoSnapshotsLinks;
+    timestamp: string | null;
+    type: string;
+}
+export interface TokenAttributesTokenInfoSnapshotsLinks {
+    discord_url?: string | null;
+    facebook_handle?: string | null;
+    github_repo_name?: string | null;
+    instagram_handle?: string | null;
+    medium_handle?: string | null;
+    subreddit_handle?: string | null;
+    telegram_handle?: string | null;
+    tiktok_handle?: string | null;
+    twitter_handle?: string | null;
+    warpcast_url?: string | null;
+    websites?: string[];
+    youtube_handle?: string | null;
+    zora_url?: string | null;
+}
+export interface TokenDeveloperDetailAttributes {
+    address: string;
+    holding_amount: string;
+    holding_percentage: number;
+    label: string | null;
+    realized_pnl_amount: string | null;
+    realized_pnl_percentage: number | null;
+    unrealized_pnl_amount: string | null;
+    unrealized_pnl_percentage: number | null;
+}
+export interface TokenDeveloperDetailResource {
+    attributes: TokenDeveloperDetailAttributes;
+    id: string;
+    relationships: TokenSecurityMetricRelationships;
+    type: string;
+}
+export interface TokenDeveloperPastTokensParams {
+    /** Id of a `token_developer_detail` resource embedded in a pool response. */
+    developer_detail_id: string;
+}
+export interface TokenDeveloperPastTokensResponse {
+    data: PastTokensDeveloperDetailResource;
+}
+export interface TokenHistoricalHoldersParams {
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** Look-back window for the snapshot series. */
+    period?: HolderHistoryPeriod;
+    /** On-chain token address. */
+    token_address: string;
+}
+export interface TokenHistoricalHoldersResponse {
+    data: TokenHoldersSnapshotResource[];
+}
+export interface TokenHoldersDetailAttributes {
+    explorer_coin_url: string;
+    explorer_holder_url: string;
+    source: string | null;
+    top_holders: TokenHoldersDetailAttributesTopHolders[];
+}
+export interface TokenHoldersDetailAttributesTopHolders {
+    amount: number;
+    average_buy_in_usd: number | null;
+    entity_name: string | null;
+    entity_type: string | null;
+    is_liquidity_pool: boolean | null;
+    label: string | null;
+    owner_percent: number;
+    realized_pnl: number | null;
+    realized_pnl_percentage: number | null;
+    total_buy_count: number | null;
+    total_sell_count: number | null;
+    unrealized_pnl: number | null;
+    unrealized_pnl_percentage: number | null;
+    value_in_usd: number;
+    wallet_address: string;
+}
+export interface TokenHoldersDetailResource {
+    attributes: TokenHoldersDetailAttributes;
+    id: string;
+    type: string;
+}
+export interface TokenHoldersSnapshotAttributes {
+    holder_count: number;
+    timestamp: string;
+}
+export interface TokenHoldersSnapshotResource {
+    attributes: TokenHoldersSnapshotAttributes;
+    id: string;
+    type: string;
+}
+export interface TokenRelationships {
+    tags?: ResourceLinkageList;
+}
+export interface TokenResource {
+    attributes: TokenAttributes;
+    id: string;
+    relationships: TokenRelationships;
+    type: string;
+}
+export interface TokenSecurityMetricAttributes {
+    defi_scanner_data: Record<string, string | null>;
+    defi_scanner_updated_at: string | null;
+    go_plus_token_security_data: TokenSecurityMetricAttributesGoPlusTokenSecurityData;
+    go_plus_token_security_updated_at: string | null;
+    holder_count: number;
+    honeypot_scanner_data: TokenSecurityMetricAttributesHoneypotScannerData;
+    honeypot_scanner_updated_at: string | null;
+    insightx_security_data: TokenSecurityMetricAttributesInsightxSecurityData;
+    insightx_updated_at: string | null;
+    soul_scanner_data: TokenSecurityMetricAttributesSoulScannerData;
+    soul_scanner_updated_at: string | null;
+}
+export interface TokenSecurityMetricAttributesGoPlusTokenSecurityData {
+    anti_whale_modifiable?: string;
+    buy_tax?: string;
+    can_take_back_ownership?: string;
+    cannot_buy?: string;
+    cannot_sell_all?: string;
+    creator_address?: string;
+    creator_balance?: string;
+    creator_percent?: string;
+    external_call?: string;
+    hidden_owner?: string;
+    holder_count?: string;
+    is_anti_whale?: string;
+    is_blacklisted?: string;
+    is_honeypot?: string;
+    is_in_dex?: string;
+    is_mintable?: string;
+    is_open_source?: string;
+    is_proxy?: string;
+    is_whitelisted?: string;
+    owner_address?: string;
+    owner_balance?: string;
+    owner_change_balance?: string;
+    owner_percent?: string;
+    personal_slippage_modifiable?: string;
+    selfdestruct?: string;
+    sell_tax?: string;
+    slippage_modifiable?: string;
+    top_10_holders_percent?: string | null;
+    trading_cooldown?: string;
+    transfer_pausable?: string;
+    trust_list?: string;
+}
+export interface TokenSecurityMetricAttributesHoneypotScannerData {
+    holder_count?: number;
+    honeypot?: string;
+}
+export interface TokenSecurityMetricAttributesInsightxSecurityData {
+    bundlers_pct?: number;
+    cluster_pct?: number;
+    dev_pct?: number;
+    insiders_pct?: number;
+    snipers_pct?: number;
+    top10_pct?: number;
+}
+export interface TokenSecurityMetricAttributesSoulScannerData {
+    freezeable?: string;
+    mintable?: string;
+}
+export interface TokenSecurityMetricRelationships {
+    token: ResourceLinkage;
+}
+export interface TokenSecurityMetricResource {
+    attributes: TokenSecurityMetricAttributes;
+    id: string;
+    relationships: TokenSecurityMetricRelationships;
+    type: string;
+}
+export interface TokenTopHoldersParams {
+    /** GeckoTerminal network identifier. */
+    network: string;
+    /** On-chain token address. */
+    token_address: string;
+}
+export interface TokenTopHoldersResponse {
+    data: TokenHoldersDetailResource;
+}
+export interface TokenTopTradersParams {
+    /** GeckoTerminal numeric token id, as returned in a token resource's `id`. */
+    token_id: string;
+}
+export interface TokenTopTradersResponse {
+    data: WalletTokenResource[];
+    included: string[];
+}
+export interface TrendAttributes {
+    new_pools: TrendAttributesNewPools[];
+    top_gainers_pairs: TrendAttributesTopGainersPairs[];
+}
+export interface TrendAttributesNewPools {
+    address: string;
+    api_address: string;
+    dex: TrendAttributesNewPoolsDex;
+    network: TrendAttributesNewPoolsNetwork;
+    pair_id: string | null;
+    pool: TrendAttributesNewPoolsPool;
+    pool_created_at: string;
+    price_change: string;
+    price_in_usd: string;
+    price_percent_change: string;
+    token_id: string | null;
+    tokens: TrendAttributesNewPoolsTokens[];
+    type: string;
+}
+export interface TrendAttributesNewPoolsDex {
+    identifier: string;
+    image_url: string;
+    name: string;
+}
+export interface TrendAttributesNewPoolsNetwork {
+    identifier: string;
+    image_url: string;
+    name: string;
+}
+export interface TrendAttributesNewPoolsPool {
+    pairs_count: number;
+}
+export interface TrendAttributesNewPoolsTokens {
+    image_url: string;
+    is_base_token: boolean;
+    name: string;
+    symbol: string;
+}
+export interface TrendAttributesTopGainersPairs {
+    address: string;
+    api_address: string;
+    dex: TrendAttributesNewPoolsDex;
+    network: TrendAttributesNewPoolsNetwork;
+    pair_id: number;
+    pool: TrendAttributesNewPoolsPool;
+    price_change: number;
+    price_in_usd: string;
+    price_percent_change: number;
+    token_id: string | null;
+    tokens: TrendAttributesNewPoolsTokens[];
+    type: string;
+}
+export interface TrendResource {
+    attributes: TrendAttributes;
+    id: string;
+    type: string;
+}
+export interface TrendingLinkAttributes {
+    name: string;
+    path: string;
+}
+export interface TrendingLinkResource {
+    attributes: TrendingLinkAttributes;
+    id: string;
+    type: string;
+}
+export interface TrendingLinksResponse {
+    data: TrendingLinkResource[];
+}
+export interface TrendingThemesParams {
+    /** Restrict results to one DEX identifier. */
+    dex?: string | null;
+    /** Return GeckoTerminal's extended theme list rather than the top few. */
+    more_themes?: boolean;
+    /** Restrict results to one network identifier. */
+    network?: string | null;
+}
+export interface TrendingThemesResponse {
+    data: ThemeResource[];
+}
+export interface TrendsParams {
+    /** Restrict results to one DEX identifier. */
+    dex?: string | null;
+    /** Restrict results to one network identifier. */
+    network?: string | null;
+}
+export interface TrendsResponse {
+    data: TrendResource;
+}
+export interface WalletTokenAttributes {
+    average_buy_in_usd: string;
+    average_sell_in_usd: string;
+    balance: string | null;
+    explorer_holder_url: string;
+    realized_pnl: string;
+    realized_pnl_percentage: number | null;
+    total_buy_amount: string;
+    total_buy_count: number;
+    total_buy_in_usd: string;
+    total_buys: number;
+    total_sell_amount: string;
+    total_sell_count: number;
+    total_sell_in_usd: string;
+    total_sells: number;
+    unrealized_pnl: string | null;
+    unrealized_pnl_percentage: number | null;
+    wallet_address: string;
+}
+export interface WalletTokenParams {
+    /** GeckoTerminal numeric token id, as returned in a token resource's `id`. */
+    token_id: string;
+    /** Wallet address to scope the token position to. */
+    wallet_address: string;
+}
+export interface WalletTokenRelationships {
+    address_label: ResourceLinkage;
+}
+export interface WalletTokenResource {
+    attributes: WalletTokenAttributes;
+    id: string;
+    relationships: WalletTokenRelationships;
+    type: string;
+}
+export interface WalletTokenResponse {
+    data: WalletTokenResource[];
+    included: string[];
+}
+//# sourceMappingURL=types.d.ts.map