nodes/generated

Interface CoinGeckoNodeParameters

Source
interface CoinGeckoNodeParameters {
    baseCurrencies?: unknown[];
    baseCurrency?: string;
    coinId?: string;
    contractAddress?: string;
    contractAddresses?: string;
    date?: string;
    days?:
        | "1"
        | "7"
        | "14"
        | "30"
        | "90"
        | "180"
        | "365"
        | "max";
    limit?: number;
    operation?: | "get"
    | "getAll"
    | "candlestick"
    | "history"
    | "market"
    | "marketChart"
    | "price"
    | "ticker";
    options?: | {
        category?: "decentralized_finance_defi";
        ids?: string;
        order?: | "gecko_asc"
        | "gecko_desc"
        | "id_asc"
        | "id_desc"
        | "market_cap_asc"
        | "market_cap_desc"
        | "volume_asc"
        | "volume_desc";
        price_change_percentage?: (
            | "1h"
            | "24h"
            | "7d"
            | "14d"
            | "30d"
            | "200d"
            | "1y"
        )[];
        sparkline?: boolean;
    }
    | {
        include_24hr_change?: boolean;
        include_24hr_vol?: boolean;
        include_last_updated_at?: boolean;
        include_market_cap?: boolean;
    }
    | {
        exchange_ids?: unknown[];
        include_exchange_logo?: boolean;
        order?: | "volume_desc"
        | "trust_score_desc"
        | "trust_score_asc";
    }
    | { localization?: boolean }
    | {
        community_data?: boolean;
        developer_data?: boolean;
        localization?: boolean;
        market_data?: boolean;
        sparkline?: boolean;
        tickers?: boolean;
    }
    | {
        country_code?: string;
        from_date?: string;
        to_date?: string;
        type?: string;
        upcoming_events_only?: boolean;
    };
    platformId?: "ethereum";
    quoteCurrencies?: unknown[];
    quoteCurrency?: string;
    resource?: "event"
    | "coin";
    returnAll?: boolean;
    searchBy?: "coinId" | "contractAddress";
}

Properties§

§readonly baseCurrencies?: unknown[]

The first currency in the pair. For BTC:ETH this is BTC. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getCoins"}

§readonly baseCurrency?: string

The first currency in the pair. For BTC:ETH this is BTC. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getCoins"}

§readonly coinId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getCoins"}

§readonly contractAddress?: string

Token's contract address

§readonly contractAddresses?: string

The contract address of tokens, comma-separated

§readonly date?: string

The date of data snapshot

§readonly days?: "1" | "7" | "14" | "30" | "90" | "180" | "365" | "max"

Return data for this many days in the past from now

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly operation?:
    | "get"
    | "getAll"
    | "candlestick"
    | "history"
    | "market"
    | "marketChart"
    | "price"
    | "ticker"

Default: "getAll"

§readonly options?:
    | {
        category?: "decentralized_finance_defi";
        ids?: string;
        order?: | "gecko_asc"
        | "gecko_desc"
        | "id_asc"
        | "id_desc"
        | "market_cap_asc"
        | "market_cap_desc"
        | "volume_asc"
        | "volume_desc";
        price_change_percentage?: (
            | "1h"
            | "24h"
            | "7d"
            | "14d"
            | "30d"
            | "200d"
            | "1y"
        )[];
        sparkline?: boolean;
    }
    | {
        include_24hr_change?: boolean;
        include_24hr_vol?: boolean;
        include_last_updated_at?: boolean;
        include_market_cap?: boolean;
    }
    | {
        exchange_ids?: unknown[];
        include_exchange_logo?: boolean;
        order?: | "volume_desc"
        | "trust_score_desc"
        | "trust_score_asc";
    }
    | { localization?: boolean }
    | {
        community_data?: boolean;
        developer_data?: boolean;
        localization?: boolean;
        market_data?: boolean;
        sparkline?: boolean;
        tickers?: boolean;
    }
    | {
        country_code?: string;
        from_date?: string;
        to_date?: string;
        type?: string;
        upcoming_events_only?: boolean;
    }

Default: {}

§readonly platformId?: "ethereum"

The ID of the platform issuing tokens Default: "ethereum"

§readonly quoteCurrencies?: unknown[]

The second currency in the pair. For BTC:ETH this is ETH. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getCurrencies"}

§readonly quoteCurrency?: string

The second currency in the pair. For BTC:ETH this is ETH. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getCurrencies"}

§readonly resource?: "event" | "coin"

Default: "coin"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly searchBy?: "coinId" | "contractAddress"

Search by coin ID or contract address Default: "coinId"