gateio-api 0.0.1 → 1.0.2

package/dist/cjs/types/request/futures.d.ts

@@ -0,0 +1,168 @@
+/**==========================================================================================================================
+ * FUTURES
+ * ==========================================================================================================================
+ */
+export interface GetFuturesOrderBookReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    interval?: string;
+    limit?: number;
+    with_id?: boolean;
+}
+export interface GetFuturesTradesReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    limit?: number;
+    offset?: number;
+    last_id?: string;
+    from?: number;
+    to?: number;
+}
+export interface GetFuturesCandlesReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    from?: number;
+    to?: number;
+    limit?: number;
+    interval?: string;
+}
+export interface GetFuturesStatsReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    from?: number;
+    interval?: string;
+    limit?: number;
+}
+export interface GetLiquidationHistoryReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    from?: number;
+    to?: number;
+    limit?: number;
+}
+export interface GetRiskLimitTiersReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    limit?: number;
+    offset?: number;
+}
+export interface GetFuturesAccountBookReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+    type?: 'dnw' | 'pnl' | 'fee' | 'refr' | 'fund' | 'point_dnw' | 'point_fee' | 'point_refr' | 'bonus_offset';
+}
+export interface GetFuturesPositionsReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    holding?: boolean;
+    limit?: number;
+    offset?: number;
+}
+export interface UpdateDualModePositionMarginReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    change: string;
+    dual_side: 'dual_long' | 'dual_short';
+}
+export interface UpdateDualModePositionLeverageReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    leverage: string;
+    cross_leverage_limit?: string;
+}
+export interface SubmitFuturesOrderReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    size: number;
+    iceberg?: number;
+    price?: string;
+    close?: boolean;
+    reduce_only?: boolean;
+    tif?: string;
+    text?: string;
+    auto_size?: string;
+    stp_act?: string;
+}
+export interface GetFuturesOrdersReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    status: string;
+    limit?: number;
+    offset?: number;
+    last_id?: string;
+}
+export interface DeleteAllFuturesOrdersReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract: string;
+    side?: string;
+}
+export interface GetFuturesOrdersByTimeRangeReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    from?: number;
+    to?: number;
+    limit?: number;
+    offset?: number;
+}
+export interface UpdateFuturesOrderReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    order_id: string;
+    size?: number;
+    price?: string;
+    amend_text?: string;
+}
+export interface GetFuturesTradingHistoryReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    order?: number;
+    limit?: number;
+    offset?: number;
+    last_id?: string;
+}
+export interface GetFuturesPositionHistoryReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+    side?: 'long' | 'short';
+    pnl?: string;
+}
+export interface GetFuturesLiquidationHistoryReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    contract?: string;
+    limit?: number;
+    at?: number;
+}
+export interface SubmitFuturesTriggeredOrderReq {
+    initial: {
+        contract: string;
+        size?: number;
+        price?: string;
+        close?: boolean;
+        tif?: 'gtc' | 'ioc';
+        text?: string;
+        reduce_only?: boolean;
+        auto_size?: string;
+    };
+    trigger: {
+        strategy_type?: 0 | 1;
+        price_type?: 0 | 1 | 2;
+        price?: string;
+        rule?: 1 | 2;
+        expiration?: number;
+    };
+    order_type?: 'close-long-order' | 'close-short-order' | 'close-long-position' | 'close-short-position' | 'plan-close-long-position' | 'plan-close-short-position';
+    settle: 'btc' | 'usdt' | 'usd';
+}
+export interface GetFuturesAutoOrdersReq {
+    settle: 'btc' | 'usdt' | 'usd';
+    status: 'open' | 'finished';
+    contract?: string;
+    limit?: number;
+    offset?: number;
+}

package/dist/cjs/types/request/futures.js

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

package/dist/cjs/types/request/futures.js.map

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

package/dist/cjs/types/request/margin.d.ts

@@ -0,0 +1,47 @@
+/**==========================================================================================================================
+ * MARGIN
+ * ==========================================================================================================================
+ */
+export interface GetMarginBalanceHistoryReq {
+    currency?: string;
+    currency_pair?: string;
+    type?: string;
+    from?: number;
+    to?: number;
+    page?: number;
+    limit?: number;
+}
+export interface GetCrossMarginAccountHistoryReq {
+    currency?: string;
+    from?: number;
+    to?: number;
+    page?: number;
+    limit?: number;
+    type?: string;
+}
+export interface SubmitCrossMarginBorrowLoanReq {
+    currency: string;
+    amount: string;
+    text?: string;
+}
+export interface GetCrossMarginBorrowHistoryReq {
+    status: number;
+    currency?: string;
+    limit?: number;
+    offset?: number;
+    reverse?: boolean;
+}
+export interface GetCrossMarginRepaymentsReq {
+    currency?: string;
+    loan_id?: string;
+    limit?: number;
+    offset?: number;
+    reverse?: boolean;
+}
+export interface GetCrossMarginInterestRecordsReq {
+    currency?: string;
+    page?: number;
+    limit?: number;
+    from?: number;
+    to?: number;
+}

package/dist/cjs/types/request/margin.js

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

package/dist/cjs/types/request/margin.js.map

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

package/dist/cjs/types/request/marginuni.d.ts

@@ -0,0 +1,29 @@
+/**==========================================================================================================================
+ * MARGIN UNI
+ * ==========================================================================================================================
+ */
+export interface GetMarginUNILoansReq {
+    currency_pair?: string;
+    currency?: string;
+    page?: number;
+    limit?: number;
+}
+export interface GetMarginUNILoanRecordsReq {
+    type?: 'borrow' | 'repay';
+    currency?: string;
+    currency_pair?: string;
+    page?: number;
+    limit?: number;
+}
+export interface GetMarginUNIInterestRecordsReq {
+    currency_pair?: string;
+    currency?: string;
+    page?: number;
+    limit?: number;
+    from?: number;
+    to?: number;
+}
+export interface GetMarginUNIMaxBorrowReq {
+    currency: string;
+    currency_pair: string;
+}

package/dist/cjs/types/request/marginuni.js

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

package/dist/cjs/types/request/marginuni.js.map

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

package/dist/cjs/types/request/multicollateralLoan.d.ts

@@ -0,0 +1,55 @@
+/**==========================================================================================================================
+ * MULTI COLLATERAL LOAN
+ * ==========================================================================================================================
+ */
+export interface SubmitMultiLoanOrderReq {
+    order_id?: string;
+    order_type?: string;
+    fixed_type?: string;
+    fixed_rate?: string;
+    auto_renew?: boolean;
+    auto_repay?: boolean;
+    borrow_currency: string;
+    borrow_amount: string;
+    collateral_currencies?: {
+        currency?: string;
+        amount?: string;
+    }[];
+}
+export interface GetMultiLoanOrdersReq {
+    page?: number;
+    limit?: number;
+    sort?: string;
+    order_type?: string;
+}
+export interface RepayMultiLoanReq {
+    order_id: number;
+    repay_items: {
+        currency?: string;
+        amount?: string;
+        repaid_all?: boolean;
+    }[];
+}
+export interface GetMultiLoanRepayRecordsReq {
+    type: 'repay' | 'liquidate';
+    borrow_currency?: string;
+    page?: number;
+    limit?: number;
+    from?: number;
+    to?: number;
+}
+export interface UpdateMultiLoanReq {
+    order_id: number;
+    type: 'append' | 'redeem';
+    collaterals?: {
+        currency?: string;
+        amount?: string;
+    }[];
+}
+export interface GetMultiLoanAdjustmentRecordsReq {
+    page?: number;
+    limit?: number;
+    from?: number;
+    to?: number;
+    collateral_currency?: string;
+}

package/dist/cjs/types/request/multicollateralLoan.js

@@ -0,0 +1,7 @@
+"use strict";
+/**==========================================================================================================================
+ * MULTI COLLATERAL LOAN
+ * ==========================================================================================================================
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=multicollateralLoan.js.map

package/dist/cjs/types/request/multicollateralLoan.js.map

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

package/dist/cjs/types/request/options.d.ts

@@ -0,0 +1,81 @@
+/**==========================================================================================================================
+ * OPTIONS
+ * ==========================================================================================================================
+ */
+export interface GetOptionsSettlementHistoryReq {
+    underlying: string;
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+}
+export interface GetOptionsMySettlementsReq {
+    underlying: string;
+    contract?: string;
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+}
+export interface GetOptionsOrderBookReq {
+    contract: string;
+    interval?: '0' | '0.1' | '0.01';
+    limit?: number;
+    with_id?: boolean;
+}
+export interface GetOptionsCandlesReq {
+    contract: string;
+    limit?: number;
+    from?: number;
+    to?: number;
+    interval?: '1m' | '5m' | '15m' | '30m' | '1h';
+}
+export interface GetOptionsUnderlyingCandlesReq {
+    underlying: string;
+    limit?: number;
+    from?: number;
+    to?: number;
+    interval?: '1m' | '5m' | '15m' | '30m' | '1h';
+}
+export interface GetOptionsTradesReq {
+    contract?: string;
+    type?: 'C' | 'P';
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+}
+export interface GetOptionsAccountChangeReq {
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+    type?: 'dnw' | 'prem' | 'fee' | 'refr' | 'set';
+}
+export interface SubmitOptionsOrderReq {
+    contract: string;
+    size: number;
+    iceberg?: number;
+    price?: string;
+    close?: boolean;
+    reduce_only?: boolean;
+    tif?: 'gtc' | 'ioc' | 'poc';
+    text?: string;
+}
+export interface GetOptionsOrdersReq {
+    contract?: string;
+    underlying?: string;
+    status: 'open' | 'finished';
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+}
+export interface GetOptionsPersonalHistoryReq {
+    underlying: string;
+    contract?: string;
+    limit?: number;
+    offset?: number;
+    from?: number;
+    to?: number;
+}

package/dist/cjs/types/request/options.js

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

package/dist/cjs/types/request/options.js.map

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

package/dist/cjs/types/request/rebate.d.ts

@@ -0,0 +1,26 @@
+export interface GetAgencyTransactionHistoryReq {
+    currency_pair?: string;
+    user_id?: number;
+    from?: number;
+    to?: number;
+    limit?: number;
+    offset?: number;
+}
+export interface GetAgencyCommissionHistoryReq {
+    currency?: string;
+    user_id?: number;
+    from?: number;
+    to?: number;
+    limit?: number;
+    offset?: number;
+}
+export interface GetBrokerCommissionHistoryReq {
+    limit?: number;
+    offset?: number;
+    user_id?: number;
+}
+export interface GetBrokerTransactionHistoryReq {
+    limit?: number;
+    offset?: number;
+    user_id?: number;
+}

package/dist/cjs/types/request/rebate.js

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

package/dist/cjs/types/request/rebate.js.map

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

package/dist/cjs/types/request/spot.d.ts

@@ -0,0 +1,115 @@
+/**==========================================================================================================================
+ * SPOT
+ * ==========================================================================================================================
+ */
+export interface GetSpotOrderBookReq {
+    currency_pair: string;
+    interval?: string;
+    limit?: number;
+    with_id?: boolean;
+}
+export interface GetSpotTradesReq {
+    currency_pair: string;
+    limit?: number;
+    last_id?: string;
+    reverse?: boolean;
+    from?: number;
+    to?: number;
+    page?: number;
+}
+export interface GetSpotCandlesReq {
+    currency_pair: string;
+    limit?: number;
+    from?: number;
+    to?: number;
+    interval?: '10s' | '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '8h' | '1d' | '7d' | '30d';
+}
+export interface GetSpotAccountBookReq {
+    currency?: string;
+    from?: number;
+    to?: number;
+    page?: number;
+    limit?: number;
+    type?: string;
+}
+export interface SubmitSpotClosePosCrossDisabledReq {
+    text?: string;
+    currency_pair: string;
+    amount: string;
+    price: string;
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}
+export interface GetSpotOrdersReq {
+    currency_pair: string;
+    status: 'open' | 'finished';
+    page?: number;
+    limit?: number;
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    from?: number;
+    to?: number;
+    side?: 'buy' | 'sell';
+}
+export interface CancelSpotBatchOrdersReq {
+    currency_pair: string;
+    id: string;
+    account?: 'cross_margin';
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}
+export interface DeleteSpotOrderReq {
+    order_id: string;
+    currency_pair: string;
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}
+export interface GetSpotOrderReq {
+    order_id: string;
+    currency_pair: string;
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+}
+export interface GetSpotTradingHistoryReq {
+    currency_pair?: string;
+    limit?: number;
+    page?: number;
+    order_id?: string;
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    from?: number;
+    to?: number;
+}
+export interface UpdateSpotBatchOrdersReq {
+    order_id?: string;
+    currency_pair?: string;
+    amount?: string;
+    price?: string;
+    amend_text?: string;
+}
+export interface GetSpotAutoOrdersReq {
+    status: 'open' | 'finished';
+    market?: string;
+    account?: 'normal' | 'margin' | 'cross_margin';
+    limit?: number;
+    offset?: number;
+}
+export interface SubmitSpotOrderReq {
+    side: 'buy' | 'sell';
+    amount: string;
+    text?: string;
+    currency_pair: string;
+    type?: 'limit' | 'market';
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    price?: string;
+    time_in_force?: 'gtc' | 'ioc' | 'poc' | 'fok';
+    iceberg?: string;
+    auto_borrow?: boolean;
+    auto_repay?: boolean;
+    stp_act?: string;
+    action_mode?: string;
+}
+export interface UpdateSpotOrderReq {
+    order_id: string;
+    currency_pair: string;
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    amount?: string;
+    price?: string;
+    amend_text?: string;
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}

package/dist/cjs/types/request/spot.js

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

package/dist/cjs/types/request/spot.js.map

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

package/dist/cjs/types/request/subaccount.d.ts

@@ -0,0 +1,19 @@
+export interface CreateSubAccountReq {
+    login_name: string;
+    remark?: string;
+    password?: string;
+    email?: string;
+}
+export interface CreateSubAccountApiKeyReq {
+    user_id: number;
+    mode?: number;
+    name?: string;
+    perms?: {
+        name?: 'wallet' | 'spot' | 'futures' | 'delivery' | 'earn' | 'options' | 'account' | 'unified' | 'loan';
+        read_only?: boolean;
+    }[];
+    ip_whitelist?: string[];
+}
+export type UpdateSubAccountApiKeyReq = {
+    key: string;
+} & CreateSubAccountApiKeyReq;

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

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

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

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