@hackape/tardis-dev/dist/exchangedetails/exchangedetails.d.ts

Convenient access to tick-level historical and real-time cryptocurrency market data via Node.js

import { Exchange, FilterForExchange } from '../types';
import { MarketInfo } from './marketinfo';
export declare function getExchangeDetails<T extends Exchange>(exchange: T): Promise<ExchangeDetails<T>>;
export declare type SymbolType = 'spot' | 'future' | 'perpetual' | 'option';
export declare type Stats = {
    trades: number;
    bookChanges: number;
};
export declare type DatasetType = 'trades' | 'incremental_book_L2' | 'quotes' | 'derivative_ticker' | 'options_chain';
declare type Datasets = {
    dataTypes: DatasetType[];
    formats: ['csv'];
    exportedFrom: Date;
    exportedUntil: Date;
    stats: Stats;
    symbols: {
        id: string;
        type: SymbolType;
        availableSince: string;
        availableTo: string;
        stats: Stats;
    }[];
};
export declare type ExchangeDetailsBase<T extends Exchange> = {
    id: T;
    name: string;
    filterable: boolean;
    enabled: boolean;
    availableSince: string;
    availableChannels: FilterForExchange[T]['channel'][];
    availableSymbols: {
        id: string;
        type: SymbolType;
        availableSince: string;
        availableTo?: string;
        name?: string;
        market?: MarketInfo;
    }[];
    incidentReports: {
        from: string;
        to: string;
        status: 'resolved' | 'wontfix';
        details: string;
    };
};
declare type ExchangeDetails<T extends Exchange> = (ExchangeDetailsBase<T> & {
    supportsDatasets: false;
}) | (ExchangeDetailsBase<T> & {
    supportsDatasets: true;
    datasets: Datasets;
});
export {};
//# sourceMappingURL=exchangedetails.d.ts.map