gateio-api 0.0.1 → 1.0.2

package/dist/cjs/types/response/subaccount.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=subaccount.js.map

package/dist/cjs/types/response/subaccount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subaccount.js","sourceRoot":"","sources":["../../../../src/types/response/subaccount.ts"],"names":[],"mappings":""}

package/dist/cjs/types/response/unified.d.ts

@@ -0,0 +1,113 @@
+export interface UnifiedAccountInfo {
+    user_id: number;
+    refresh_time: number;
+    locked: boolean;
+    balances: {
+        [key: string]: {
+            available: string;
+            freeze: string;
+            borrowed: string;
+            negative_liab: string;
+            futures_pos_liab: string;
+            equity: string;
+            total_freeze: string;
+            total_liab: string;
+            spot_in_use: string;
+        };
+    };
+    total: string;
+    borrowed: string;
+    total_initial_margin: string;
+    total_margin_balance: string;
+    total_maintenance_margin: string;
+    total_initial_margin_rate: string;
+    total_maintenance_margin_rate: string;
+    total_available_margin: string;
+    unified_account_total: string;
+    unified_account_total_liab: string;
+    unified_account_total_equity: string;
+    leverage: string;
+    spot_order_loss: string;
+    spot_hedge: boolean;
+}
+export interface UnifiedLoan {
+    currency: string;
+    currency_pair: string;
+    amount: string;
+    type: 'platform' | 'margin';
+    create_time: number;
+    update_time: number;
+}
+export interface UnifiedLoanRecord {
+    id: number;
+    type: 'borrow' | 'repay';
+    repayment_type: 'none' | 'manual_repay' | 'auto_repay' | 'cancel_auto_repay';
+    currency_pair: string;
+    currency: string;
+    amount: string;
+    create_time: number;
+}
+export interface UnifiedInterestRecord {
+    currency: string;
+    currency_pair: string;
+    actual_rate: string;
+    interest: string;
+    status: number;
+    type: 'platform' | 'margin';
+    create_time: number;
+}
+export interface UnifiedRiskUnitDetails {
+    user_id: number;
+    spot_hedge: boolean;
+    risk_units: {
+        symbol: string;
+        spot_in_use: string;
+        maintain_margin: string;
+        initial_margin: string;
+        delta: string;
+        gamma: string;
+        theta: string;
+        vega: string;
+    }[];
+}
+export interface UnifiedCurrencyDiscountTiers {
+    currency: string;
+    discount_tiers: {
+        tier: string;
+        discount: string;
+        lower_limit: string;
+        upper_limit: string;
+    }[];
+}
+export interface PortfolioMarginCalculation {
+    maintain_margin_total: string;
+    initial_margin_total: string;
+    calculate_time: number;
+    risk_unit: {
+        symbol: string;
+        spot_in_use: string;
+        maintain_margin: string;
+        initial_margin: string;
+        margin_result: {
+            type: 'original_position' | 'long_delta_original_position' | 'short_delta_original_position';
+            profit_loss_ranges: {
+                price_percentage: string;
+                implied_volatility_percentage: string;
+                profit_loss: string;
+            }[];
+            max_loss: {
+                price_percentage: string;
+                implied_volatility_percentage: string;
+                profit_loss: string;
+            };
+            mr1: string;
+            mr2: string;
+            mr3: string;
+            mr4: string;
+            delta: string;
+            gamma: string;
+            theta: string;
+            vega: string;
+        }[];
+    }[];
+}

package/dist/cjs/types/response/unified.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=unified.js.map

package/dist/cjs/types/response/unified.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unified.js","sourceRoot":"","sources":["../../../../src/types/response/unified.ts"],"names":[],"mappings":""}

package/dist/cjs/types/response/wallet.d.ts

@@ -0,0 +1,181 @@
+export interface CurrencyChain {
+    chain: string;
+    name_cn: string;
+    name_en: string;
+    contract_address: string;
+    is_disabled: number;
+    is_deposit_disabled: number;
+    is_withdraw_disabled: number;
+    decimal: string;
+}
+export interface CreateDepositAddressResp {
+    currency: string;
+    address: string;
+    multichain_addresses: {
+        chain: string;
+        address: string;
+        payment_id: string;
+        payment_name: string;
+        obtain_failed: number;
+    }[];
+}
+export interface SubAccountTransferRecord {
+    currency: string;
+    sub_account: string;
+    direction: 'to' | 'from';
+    amount: string;
+    uid: string;
+    client_order_id: string;
+    timest: string;
+    source: string;
+    sub_account_type: 'spot' | 'futures' | 'cross_margin' | 'delivery';
+}
+export interface WithdrawalStatus {
+    currency: string;
+    name: string;
+    name_cn: string;
+    deposit: string;
+    withdraw_percent: string;
+    withdraw_fix: string;
+    withdraw_day_limit: string;
+    withdraw_amount_mini: string;
+    withdraw_day_limit_remain: string;
+    withdraw_eachtime_limit: string;
+    withdraw_fix_on_chains: {
+        [key: string]: string;
+    };
+    withdraw_percent_on_chains: {
+        [key: string]: string;
+    };
+}
+export interface SubAccountMarginBalance {
+    currency_pair: string;
+    locked: boolean;
+    risk: string;
+    base: {
+        currency: string;
+        available: string;
+        locked: string;
+        borrowed: string;
+        interest: string;
+    };
+    quote: {
+        currency: string;
+        available: string;
+        locked: string;
+        borrowed: string;
+        interest: string;
+    };
+}
+export interface SubAccountFuturesBalancesResp {
+    uid: string;
+    available: {
+        [key: string]: {
+            total: string;
+            unrealised_pnl: string;
+            position_margin: string;
+            order_margin: string;
+            available: string;
+            point: string;
+            currency: string;
+            in_dual_mode: boolean;
+            enable_credit: boolean;
+            position_initial_margin: string;
+            maintenance_margin: string;
+            bonus: string;
+            enable_evolved_classic: boolean;
+            history: {
+                dnw: string;
+                pnl: string;
+                fee: string;
+                refr: string;
+                fund: string;
+                point_dnw: string;
+                point_fee: string;
+                point_refr: string;
+                bonus_dnw: string;
+                bonus_offset: string;
+            };
+        };
+    };
+}
+export interface SubAccountCrossMarginBalancesResp {
+    uid: string;
+    available: {
+        user_id: number;
+        locked: boolean;
+        balances: {
+            [key: string]: {
+                available: string;
+                freeze: string;
+                borrowed: string;
+                interest: string;
+            };
+        };
+        total: string;
+        borrowed: string;
+        borrowed_net: string;
+        net: string;
+        leverage: string;
+        interest: string;
+        risk: string;
+        total_initial_margin: string;
+        total_margin_balance: string;
+        total_maintenance_margin: string;
+        total_initial_margin_rate: string;
+        total_maintenance_margin_rate: string;
+        total_available_margin: string;
+    };
+}
+export interface SavedAddress {
+    currency: string;
+    chain: string;
+    address: string;
+    name: string;
+    tag: string;
+    verified: string;
+}
+export interface TradingFees {
+    user_id: number;
+    taker_fee: string;
+    maker_fee: string;
+    gt_discount: boolean;
+    gt_taker_fee: string;
+    gt_maker_fee: string;
+    loan_fee: string;
+    point_type: string;
+    futures_taker_fee: string;
+    futures_maker_fee: string;
+    delivery_taker_fee: string;
+    delivery_maker_fee: string;
+    debit_fee: number;
+}
+export interface GetBalancesResp {
+    total: {
+        amount: string;
+        currency: string;
+        unrealised_pnl?: string;
+        borrowed?: string;
+    };
+    details: {
+        [key: string]: {
+            amount: string;
+            currency: string;
+            unrealised_pnl?: string;
+            borrowed?: string;
+        };
+    };
+}
+export interface SmallBalanceRecord {
+    currency: string;
+    available_balance: string;
+    estimated_as_btc: string;
+    convertible_to_gt: string;
+}
+export interface SmallBalanceHistoryRecord {
+    id: string;
+    currency: string;
+    amount: string;
+    gt_amount: string;
+    create_time: number;
+}

package/dist/cjs/types/response/wallet.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=wallet.js.map

package/dist/cjs/types/response/wallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../../../src/types/response/wallet.ts"],"names":[],"mappings":""}

package/dist/cjs/types/response/withdrawal.d.ts

@@ -0,0 +1,12 @@
+export interface WithdrawalRecord {
+    id: string;
+    txid: string;
+    withdraw_order_id: string;
+    timestamp: string;
+    amount: string;
+    currency: string;
+    address: string;
+    memo?: string;
+    status: 'DONE' | 'CANCEL' | 'REQUEST' | 'MANUAL' | 'BCODE' | 'EXTPEND' | 'FAIL' | 'INVALID' | 'VERIFY' | 'PROCES' | 'PEND' | 'DMOVE' | 'SPLITPEND';
+    chain: string;
+}

package/dist/cjs/types/response/withdrawal.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=withdrawal.js.map

package/dist/cjs/types/response/withdrawal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal.js","sourceRoot":"","sources":["../../../../src/types/response/withdrawal.ts"],"names":[],"mappings":""}

package/dist/cjs/types/shared.d.ts

@@ -0,0 +1,16 @@
+export type GateBaseUrlKey = 'live' | 'futuresLiveAlternative' | 'futuresTestnet';
+export interface CurrencyPair {
+    id?: string;
+    base?: string;
+    quote?: string;
+    fee?: string;
+    min_base_amount?: string;
+    min_quote_amount?: string;
+    max_base_amount?: string;
+    max_quote_amount?: string;
+    amount_precision?: number;
+    precision?: number;
+    trade_status?: 'untradable' | 'buyable' | 'sellable' | 'tradable';
+    sell_start?: number;
+    buy_start?: number;
+}

package/dist/cjs/types/shared.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/dist/cjs/types/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../src/types/shared.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Event args for subscribing/unsubscribing
+ */
+/** General configuration for the WebsocketClient */
+export interface WSClientConfigurableOptions {
+    /** Your API key */
+    apiKey?: string;
+    /** Your API secret */
+    apiSecret?: string;
+    useTestnet?: boolean;
+    /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
+    recvWindow?: number;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    requestOptions?: {};
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+    /**
+     * If you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason.
+     */
+    reauthWSAPIOnReconnect?: boolean;
+}
+/**
+ * WS configuration that's always defined, regardless of user configuration
+ * (usually comes from defaults if there's no user-provided values)
+ */
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    recvWindow: number;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    reauthWSAPIOnReconnect: boolean;
+}

package/dist/cjs/types/websockets/client.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Event args for subscribing/unsubscribing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=client.js.map

package/dist/cjs/types/websockets/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/types/websockets/client.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/dist/cjs/types/websockets/events.d.ts

@@ -0,0 +1,5 @@
+export interface WsDataEvent<TData = any, TWSKey = string> {
+    data: TData;
+    table: string;
+    wsKey: TWSKey;
+}

package/dist/cjs/types/websockets/events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/cjs/types/websockets/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../src/types/websockets/events.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/requests.d.ts

@@ -0,0 +1,36 @@
+import { CHANNEL_ID } from '../../lib/requestUtils';
+import { WSAPITopic } from './wsAPI';
+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;
+    };
+}

package/dist/cjs/types/websockets/requests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=requests.js.map

package/dist/cjs/types/websockets/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../../src/types/websockets/requests.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/wsAPI.d.ts

@@ -0,0 +1,101 @@
+import { WsKey } from '../../lib/websocket/websocket-util';
+import { GetFuturesOrdersReq, SubmitFuturesOrderReq, UpdateFuturesOrderReq } from '../request/futures';
+import { CancelSpotBatchOrdersReq, DeleteSpotOrderReq, GetSpotOrderReq, SubmitSpotOrderReq, UpdateSpotOrderReq } from '../request/spot';
+export type SpotWSAPITopic = 'spot.login' | 'spot.order_place' | 'spot.order_cancel' | 'spot.order_cancel_ids' | 'spot.order_cancel_cp' | 'spot.order_amend' | 'spot.order_status';
+export type FuturesWSAPITopic = 'futures.login' | 'futures.order_place' | 'futures.order_batch_place' | 'futures.order_cancel' | 'futures.order_cancel_cp' | 'futures.order_amend' | 'futures.order_list' | 'futures.order_status';
+export type WSAPITopic = SpotWSAPITopic | FuturesWSAPITopic;
+export interface WsAPIWsKeyTopicMap {
+    spotV4: SpotWSAPITopic;
+    perpFuturesUSDTV4: FuturesWSAPITopic;
+    perpFuturesBTCV4: FuturesWSAPITopic;
+    deliveryFuturesUSDTV4: FuturesWSAPITopic;
+    deliveryFuturesBTCV4: FuturesWSAPITopic;
+}
+export interface WsAPITopicRequestParamMap {
+    'spot.login': undefined;
+    'futures.login': undefined;
+    'spot.order_place': SubmitSpotOrderReq;
+    'spot.order_cancel': DeleteSpotOrderReq;
+    'spot.order_cancel_ids': CancelSpotBatchOrdersReq[];
+    'spot.order_cancel_cp': DeleteSpotOrderReq[];
+    'spot.order_amend': UpdateSpotOrderReq;
+    'spot.order_status': GetSpotOrderReq;
+    'futures.order_place': Omit<SubmitFuturesOrderReq, 'settle'>;
+    'futures.order_batch_place': Omit<SubmitFuturesOrderReq, 'settle'>[];
+    'futures.order_cancel': {
+        order_id: string;
+    };
+    'futures.order_cancel_cp': {
+        contract: string;
+        side?: 'ask' | 'bid';
+    };
+    'futures.order_amend': Omit<UpdateFuturesOrderReq, 'settle'>;
+    'futures.order_list': Omit<GetFuturesOrdersReq, 'settle'>;
+    'futures.order_status': {
+        order_id: string;
+    };
+}
+export type WsAPITopicRequestParams = WsAPITopicRequestParamMap[keyof WsAPITopicRequestParamMap];
+export interface WSAPIResponseHeader<TChannel extends WSAPITopic> {
+    /** String timestamp as ms */
+    response_time: string;
+    /** Status of WS API call. "200" if successful, else exception is thrown */
+    status: '200' | string;
+    channel: TChannel;
+    event: 'api';
+    client_id: string;
+}
+export interface WSAPILoginResponse {
+    api_key: string;
+    uid: string;
+}
+export interface WSAPIOrderStatusResponse {
+    left: string;
+    update_time: string;
+    amount: string;
+    create_time: string;
+    price: string;
+    finish_as: string;
+    time_in_force: string;
+    currency_pair: string;
+    type: string;
+    account: string;
+    side: string;
+    amend_text: string;
+    text: string;
+    status: string;
+    iceberg: string;
+    avg_deal_price: string;
+    filled_total: string;
+    id: string;
+    fill_price: string;
+    update_time_ms: number;
+    create_time_ms: number;
+}
+export type WSAPIResponseData = WSAPILoginResponse | WSAPIOrderStatusResponse;
+export interface WsAPITopicResponseMap<TResponseType extends object = object> {
+    'spot.login': WSAPIResponse<WSAPILoginResponse, 'spot.login'>;
+    'futures.login': WSAPIResponse<WSAPILoginResponse, 'futures.login'>;
+    'spot.order_place': WSAPIResponse<TResponseType, 'spot.order_place'>;
+    'spot.order_cancel': WSAPIResponse<TResponseType, 'spot.order_cancel'>;
+    'spot.order_cancel_ids': WSAPIResponse<TResponseType, 'spot.order_cancel_ids'>;
+    'spot.order_cancel_cp': WSAPIResponse<TResponseType, 'spot.order_cancel_cp'>;
+    'spot.order_amend': WSAPIResponse<TResponseType, 'spot.order_amend'>;
+    'spot.order_status': WSAPIResponse<WSAPIOrderStatusResponse, 'spot.order_status'>;
+    'futures.order_place': WSAPIResponse<TResponseType[], 'futures.order_place'>;
+    'futures.order_batch_place': WSAPIResponse<TResponseType[], 'futures.order_batch_place'>;
+    'futures.order_cancel': WSAPIResponse<TResponseType, 'futures.order_cancel'>;
+    'futures.order_cancel_cp': WSAPIResponse<TResponseType, 'futures.order_cancel_cp'>;
+    'futures.order_amend': WSAPIResponse<TResponseType, 'futures.order_amend'>;
+    'futures.order_list': WSAPIResponse<TResponseType[], 'futures.order_list'>;
+    'futures.order_status': WSAPIResponse<WSAPIOrderStatusResponse, 'futures.order_status'>;
+}
+export interface WSAPIResponse<TResponseData extends object = WSAPIResponseData | object, TChannel extends WSAPITopic = WSAPITopic> {
+    wsKey: WsKey;
+    header: WSAPIResponseHeader<TChannel>;
+    data: {
+        result: TResponseData;
+    };
+    /** Auto-generated */
+    request_id: string;
+}

package/dist/cjs/types/websockets/wsAPI.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// export interface WsAPIResponseMap<TChannel extends WSAPITopic = WSAPITopic> {
+//   'spot.login': WSAPIResponse<WSAPILoginResponse, TChannel>;
+//   'futures.login': WSAPIResponse<WSAPILoginResponse, TChannel>;
+//   string: object;
+// }
+//# sourceMappingURL=wsAPI.js.map

package/dist/cjs/types/websockets/wsAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":";;AAiKA,gFAAgF;AAChF,+DAA+D;AAC/D,kEAAkE;AAClE,oBAAoB;AACpB,IAAI"}