gateio-api/dist/cjs/types/websockets/requests.d.ts

Complete & Robust Node.js SDK for Gate.com's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.

import { CHANNEL_ID } from '../../lib/requestUtils.js';
import { WSAPITopic } from './wsAPI.js';
export type WsOperation = 'subscribe' | 'unsubscribe' | 'auth';
export interface WsRequestAuthGate {
    method: 'api_key';
    KEY: string;
    SIGN: string;
}
export interface WsRequestPing {
    time: number;
    channel: 'spot.ping' | 'futures.ping' | 'options.ping' | 'announcement.ping';
}
export interface WsRequestOperationGate<TWSTopic extends string, TWSPayload = any> {
    time: number;
    id?: number;
    channel: TWSTopic;
    auth?: WsRequestAuthGate;
    event?: WsOperation;
    payload?: TWSPayload;
}
export interface WSAPIRequest<TRequestParams = any, TWSChannel extends WSAPITopic = any> {
    time: number;
    id?: number;
    channel: TWSChannel;
    event: 'api';
    payload: {
        req_id: string;
        req_param?: TRequestParams | string;
        req_header: {
            'X-Gate-Channel-Id': typeof CHANNEL_ID;
        };
        api_key?: string;
        signature?: string;
        timestamp?: string;
    };
}