@coinset/zaif/dist/api/public/currency_pairs.d.ts

Zaif API client for Node.js

import type { ZaifPair } from '../../shared/types/currency';
import type { PublicAPI } from '../../shared/types';
declare type CurrencyPairsOptions = {
    pair: ZaifPair | 'all';
};
declare type CurrencyPairsResponse = CurrencyPairInfo[];
declare type CurrencyPairInfo = {
    id: number;
    name: string;
    title: string;
    currency_pair: string;
    description: string;
    is_token: boolean;
    event_number: number;
    item_unit_min: number;
    item_unit_step: number;
    aux_unit_min: number;
    aux_unit_step: number;
    seq: number;
    aux_japanese: string;
    item_japanese: string;
    aux_unit_point: number;
};
/**
 * @throws `Error`
 *
 * @see https://zaif-api-document.readthedocs.io/ja/latest/PublicAPI.html#id12
 * @beta
 */
declare const fetchCurrencyPairs: PublicAPI<CurrencyPairsOptions, CurrencyPairsResponse>;
export { fetchCurrencyPairs };
export type { CurrencyPairsOptions, CurrencyPairsResponse };
//# sourceMappingURL=currency_pairs.d.ts.map