bybit-api/lib/types/shared.d.ts

Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.

import { ContractClient } from '../contract-client';
import { InverseClient } from '../inverse-client';
import { LinearClient } from '../linear-client';
import { RestClientV5 } from '../rest-client-v5';
import { SpotClient } from '../spot-client';
import { SpotClientV3 } from '../spot-client-v3';
import { UnifiedMarginClient } from '../unified-margin-client';
import { USDCOptionClient } from '../usdc-option-client';
import { USDCPerpetualClient } from '../usdc-perpetual-client';
export type RESTClient = InverseClient | LinearClient | SpotClient | SpotClientV3 | USDCOptionClient | USDCPerpetualClient | UnifiedMarginClient | ContractClient | RestClientV5;
export type numberInString = string;
export type OrderSide = 'Buy' | 'Sell';
export type KlineInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d' | '1w' | '1M';
export type KlineIntervalV3 = '1' | '3' | '5' | '15' | '30' | '60' | '120' | '240' | '360' | '720' | 'D' | 'W' | 'M';
export interface APIResponse<T> {
    ret_code: number;
    ret_msg: 'OK' | string;
    ext_code: string | null;
    ext_info: string | null;
    result: T;
}
export interface APIRateLimit {
    /** Remaining requests to this endpoint before the next reset */
    remainingRequests: number;
    /** Max requests for this endpoint per rollowing window (before next reset) */
    maxRequests: number;
    /**
     * Timestamp when the rate limit resets if you have exceeded your current maxRequests.
     * Otherwise, this is approximately your current timestamp.
     */
    resetAtTimestamp: number;
}
export interface APIResponseV3<T> {
    retCode: number;
    retMsg: 'OK' | string;
    result: T;
    /**
     * These are per-UID per-endpoint rate limits, automatically parsed from response headers if available.
     *
     * Note:
     * - this is primarily for V5 (or newer) APIs.
     * - these rate limits are per-endpoint per-account, so will not appear for public API calls
     */
    rateLimitApi?: APIRateLimit;
}
export type APIResponseV3WithTime<T> = APIResponseV3<T> & {
    time: number;
};
export interface APIResponseWithTime<T = {}> extends APIResponse<T> {
    /** UTC timestamp */
    time_now: numberInString;
}
/**
 * Request Parameter Types
 */
export interface SymbolParam {
    symbol: string;
}
export interface SymbolLimitParam<TLimit = number> {
    symbol: string;
    limit?: TLimit;
}
export interface SymbolPeriodLimitParam<TLimit = number> {
    symbol: string;
    period: string;
    limit?: TLimit;
}
export interface SymbolFromLimitParam {
    symbol: string;
    from?: number;
    limit?: number;
}
export interface SymbolIntervalFromLimitParam {
    symbol: string;
    interval: string;
    from: number;
    limit?: number;
}
export interface CoinParam {
    coin: string;
}
export interface WalletFundRecordsReq {
    start_date?: string;
    end_date?: string;
    currency?: string;
    coin?: string;
    wallet_fund_type?: string;
    page?: number;
    limit?: number;
}
export interface WithdrawRecordsReq {
    start_date?: string;
    end_date?: string;
    coin?: string;
    status?: string;
    page?: number;
    limit?: number;
}
export interface AssetExchangeRecordsReq {
    limit?: number;
    from?: number;
    direction?: string;
}
/**
 * Response types
 */
export interface LeverageFilter {
    min_leverage: numberInString;
    max_leverage: numberInString;
    leverage_step: numberInString;
}
export interface PriceFilter {
    min_price: numberInString;
    max_price: numberInString;
    tick_size: numberInString;
}
export interface LotSizeFilter {
    max_trading_qty: number;
    min_trading_qty: number;
    qty_step: number;
}
export interface SymbolInfo {
    name: string;
    alias: string;
    status: 'Trading' | string;
    base_currency: string;
    quote_currency: string;
    price_scale: number;
    taker_fee: numberInString;
    maker_fee: numberInString;
    leverage_filter: LeverageFilter;
    price_filter: PriceFilter;
    lot_size_filter: LotSizeFilter;
}