/** * CoinGecko API V3 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * OpenAPI spec version: 3.0.0 * * * NOTE: This file is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the file manually. */ import { Configuration } from './configuration'; /** * * @export */ export declare const COLLECTION_FORMATS: { csv: string; ssv: string; tsv: string; pipes: string; }; /** * * @export * @interface FetchAPI */ export interface FetchAPI { (url: string, init?: any): Promise; } /** * * @export * @interface FetchArgs */ export interface FetchArgs { url: string; options: any; } /** * * @export * @class BaseAPI */ export declare class BaseAPI { protected basePath: string; protected fetch: FetchAPI; protected configuration: Configuration; constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI); } /** * * @export * @class RequiredError * @extends {Error} */ export declare class RequiredError extends Error { field: string; name: 'RequiredError'; constructor(field: string, msg?: string); } /** * CoinsApi - fetch parameter creator * @export */ export declare const CoinsApiFetchParamCreator: () => { /** * Get current data (name, price, market, ... including exchange tickers) for a coin.

**IMPORTANT**: Ticker object is limited to 100 items, to get more tickers, use `/coins/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide) * @summary Get current data (name, price, market, ... including exchange tickers) for a coin * @param {string} id pass the coin id (can be obtained from /coins) eg. bitcoin * @param {string} [localization] Include all localized languages in response (true/false) <b>[default: true]</b> * @param {boolean} [tickers] Include tickers data (true/false) <b>[default: true]</b> * @param {boolean} [marketData] Include market_data (true/false) <b>[default: true]</b> * @param {boolean} [communityData] Include community_data data (true/false) <b>[default: true]</b> * @param {boolean} [developerData] Include developer_data data (true/false) <b>[default: true]</b> * @param {boolean} [sparkline] Include sparkline 7 days data (eg. true, false) <b>[default: false]</b> * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsIdGet(id: string, localization?: string | undefined, tickers?: boolean | undefined, marketData?: boolean | undefined, communityData?: boolean | undefined, developerData?: boolean | undefined, sparkline?: boolean | undefined, options?: any): FetchArgs; /** * Use this to obtain all the coins' id in order to make API calls * @summary List all supported coins id, name and symbol (no pagination required) * @param {boolean} [includePlatform] flag to include platform contract addresses (eg. 0x.... for Ethereum based tokens). valid values: true, false * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsListGet(includePlatform?: boolean | undefined, options?: any): FetchArgs; }; /** * CoinsApi - functional programming interface * @export */ export declare const CoinsApiFp: (configuration?: Configuration | undefined) => { /** * Get current data (name, price, market, ... including exchange tickers) for a coin.

**IMPORTANT**: Ticker object is limited to 100 items, to get more tickers, use `/coins/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide) * @summary Get current data (name, price, market, ... including exchange tickers) for a coin * @param {string} id pass the coin id (can be obtained from /coins) eg. bitcoin * @param {string} [localization] Include all localized languages in response (true/false) <b>[default: true]</b> * @param {boolean} [tickers] Include tickers data (true/false) <b>[default: true]</b> * @param {boolean} [marketData] Include market_data (true/false) <b>[default: true]</b> * @param {boolean} [communityData] Include community_data data (true/false) <b>[default: true]</b> * @param {boolean} [developerData] Include developer_data data (true/false) <b>[default: true]</b> * @param {boolean} [sparkline] Include sparkline 7 days data (eg. true, false) <b>[default: false]</b> * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsIdGet(id: string, localization?: string | undefined, tickers?: boolean | undefined, marketData?: boolean | undefined, communityData?: boolean | undefined, developerData?: boolean | undefined, sparkline?: boolean | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise; /** * Use this to obtain all the coins' id in order to make API calls * @summary List all supported coins id, name and symbol (no pagination required) * @param {boolean} [includePlatform] flag to include platform contract addresses (eg. 0x.... for Ethereum based tokens). valid values: true, false * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsListGet(includePlatform?: boolean | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise; }; /** * CoinsApi - factory interface * @export */ export declare const CoinsApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => { /** * Get current data (name, price, market, ... including exchange tickers) for a coin.

**IMPORTANT**: Ticker object is limited to 100 items, to get more tickers, use `/coins/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide) * @summary Get current data (name, price, market, ... including exchange tickers) for a coin * @param {string} id pass the coin id (can be obtained from /coins) eg. bitcoin * @param {string} [localization] Include all localized languages in response (true/false) <b>[default: true]</b> * @param {boolean} [tickers] Include tickers data (true/false) <b>[default: true]</b> * @param {boolean} [marketData] Include market_data (true/false) <b>[default: true]</b> * @param {boolean} [communityData] Include community_data data (true/false) <b>[default: true]</b> * @param {boolean} [developerData] Include developer_data data (true/false) <b>[default: true]</b> * @param {boolean} [sparkline] Include sparkline 7 days data (eg. true, false) <b>[default: false]</b> * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsIdGet(id: string, localization?: string | undefined, tickers?: boolean | undefined, marketData?: boolean | undefined, communityData?: boolean | undefined, developerData?: boolean | undefined, sparkline?: boolean | undefined, options?: any): Promise; /** * Use this to obtain all the coins' id in order to make API calls * @summary List all supported coins id, name and symbol (no pagination required) * @param {boolean} [includePlatform] flag to include platform contract addresses (eg. 0x.... for Ethereum based tokens). valid values: true, false * @param {*} [options] Override http request option. * @throws {RequiredError} */ coinsListGet(includePlatform?: boolean | undefined, options?: any): Promise; }; /** * CoinsApi - object-oriented interface * @export * @class CoinsApi * @extends {BaseAPI} */ export declare class CoinsApi extends BaseAPI { /** * Get current data (name, price, market, ... including exchange tickers) for a coin.

**IMPORTANT**: Ticker object is limited to 100 items, to get more tickers, use `/coins/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide) * @summary Get current data (name, price, market, ... including exchange tickers) for a coin * @param {string} id pass the coin id (can be obtained from /coins) eg. bitcoin * @param {string} [localization] Include all localized languages in response (true/false) <b>[default: true]</b> * @param {boolean} [tickers] Include tickers data (true/false) <b>[default: true]</b> * @param {boolean} [marketData] Include market_data (true/false) <b>[default: true]</b> * @param {boolean} [communityData] Include community_data data (true/false) <b>[default: true]</b> * @param {boolean} [developerData] Include developer_data data (true/false) <b>[default: true]</b> * @param {boolean} [sparkline] Include sparkline 7 days data (eg. true, false) <b>[default: false]</b> * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoinsApi */ coinsIdGet(id: string, localization?: string, tickers?: boolean, marketData?: boolean, communityData?: boolean, developerData?: boolean, sparkline?: boolean, options?: any): Promise; /** * Use this to obtain all the coins' id in order to make API calls * @summary List all supported coins id, name and symbol (no pagination required) * @param {boolean} [includePlatform] flag to include platform contract addresses (eg. 0x.... for Ethereum based tokens). valid values: true, false * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoinsApi */ coinsListGet(includePlatform?: boolean, options?: any): Promise; } /** * SearchApi - fetch parameter creator * @export */ export declare const SearchApiFetchParamCreator: () => { /** * Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first * @summary Search for coins, categories and markets on CoinGecko * @param {string} query Search string * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchGet(query: string, options?: any): FetchArgs; }; /** * SearchApi - functional programming interface * @export */ export declare const SearchApiFp: (configuration?: Configuration | undefined) => { /** * Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first * @summary Search for coins, categories and markets on CoinGecko * @param {string} query Search string * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchGet(query: string, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise; }; /** * SearchApi - factory interface * @export */ export declare const SearchApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => { /** * Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first * @summary Search for coins, categories and markets on CoinGecko * @param {string} query Search string * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchGet(query: string, options?: any): Promise; }; /** * SearchApi - object-oriented interface * @export * @class SearchApi * @extends {BaseAPI} */ export declare class SearchApi extends BaseAPI { /** * Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first * @summary Search for coins, categories and markets on CoinGecko * @param {string} query Search string * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SearchApi */ searchGet(query: string, options?: any): Promise; }