ftx-api-typed/lib/shared-endpoints.d.ts

Node.js/typescript connector for FTX's REST APIs and WebSockets

import { GenericAPIResponse } from './util/requestUtils';
import RequestWrapper from './util/requestWrapper';
export default abstract class SharedEndpoints {
    protected requestWrapper: RequestWrapper;
    /**
     *
     * Market Data Endpoints
     *
     */
    getOrderBook(params: {
        symbol: string;
    }): GenericAPIResponse<any>;
    /**
     * Get latest information for symbol
     */
    getTickers(params?: {
        symbol?: string;
    }): GenericAPIResponse<any>;
    getSymbols(): GenericAPIResponse<any>;
    /**
     * Get liquidated orders
     */
    getLiquidations(params: {
        symbol: string;
        from?: number;
        limit?: number;
        start_time?: number;
        end_time?: number;
    }): GenericAPIResponse<any>;
    /**
     *
     * Market Data : Advanced
     *
     */
    getOpenInterest(params: {
        symbol: string;
        period: string;
        limit?: number;
    }): GenericAPIResponse<any>;
    getLatestBigDeal(params: {
        symbol: string;
        limit?: number;
    }): GenericAPIResponse<any>;
    getLongShortRatio(params: {
        symbol: string;
        period: string;
        limit?: number;
    }): GenericAPIResponse<any>;
    /**
     *
     * Account Data Endpoints
     *
     */
    getApiKeyInfo(): GenericAPIResponse<any>;
    /**
     *
     * Wallet Data Endpoints
     *
     */
    getWalletBalance(params: {
        coin?: string;
    }): GenericAPIResponse<any>;
    getWalletFundRecords(params?: {
        start_date?: string;
        end_date?: string;
        currency?: string;
        coin?: string;
        wallet_fund_type?: string;
        page?: number;
        limit?: number;
    }): GenericAPIResponse<any>;
    getWithdrawRecords(params: {
        start_date?: string;
        end_date?: string;
        coin?: string;
        status?: string;
        page?: number;
        limit?: number;
    }): GenericAPIResponse<any>;
    getAssetExchangeRecords(params?: {
        limit?: number;
        from?: number;
        direction?: string;
    }): GenericAPIResponse<any>;
}