@coinset/bitflyer/dist/api/public/ticker.d.ts

Bitflyer API client for Node.js

import type { BitflyerPair } from '../../shared/types/currency';
import type { PublicAPI, Reviver } from '../../shared/types/fetch';
import type { State } from '../../shared/types';
declare type TickerOptions = {
    productCode: BitflyerPair;
};
declare type TickerResponse = {
    product_code: BitflyerPair;
    state: State;
    timestamp: Date;
    tick_id: number;
    best_bid: number;
    best_ask: number;
    best_bid_size: number;
    best_ask_size: number;
    total_bid_depth: number;
    total_ask_depth: number;
    market_bid_size: number;
    market_ask_size: number;
    ltp: number;
    volume: number;
    volume_by_product: number;
};
declare const reviver: Reviver;
/**
 * @throws `Error`
 *
 * @see https://lightning.bitflyer.com/docs?lang=en#ticker
 * @beta
 */
declare const fetchTicker: PublicAPI<TickerOptions, TickerResponse>;
export { fetchTicker, reviver };
export type { TickerOptions, TickerResponse };
//# sourceMappingURL=ticker.d.ts.map