gateio-api 0.0.1 → 1.0.2

package/dist/mjs/types/response/multicollateralLoan.js

@@ -0,0 +1,6 @@
+/**==========================================================================================================================
+ * MULTI COLLATERAL LOAN
+ * ==========================================================================================================================
+ */
+export {};
+//# sourceMappingURL=multicollateralLoan.js.map

package/dist/mjs/types/response/multicollateralLoan.js.map

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

package/dist/mjs/types/response/options.d.ts

@@ -0,0 +1,192 @@
+/**==========================================================================================================================
+ * OPTIONS
+ * ==========================================================================================================================
+ */
+export interface OptionsContract {
+    name: string;
+    tag: string;
+    create_time: number;
+    expiration_time: number;
+    is_call: boolean;
+    strike_price: string;
+    last_price: string;
+    mark_price: string;
+    orderbook_id: number;
+    trade_id: number;
+    trade_size: number;
+    position_size: number;
+    underlying: string;
+    underlying_price: string;
+    multiplier: string;
+    order_price_round: string;
+    mark_price_round: string;
+    maker_fee_rate: string;
+    taker_fee_rate: string;
+    price_limit_fee_rate: string;
+    ref_discount_rate: string;
+    ref_rebate_rate: string;
+    order_price_deviate: string;
+    order_size_min: number;
+    order_size_max: number;
+    orders_limit: number;
+}
+export interface OptionsSettlementHistoryRecord {
+    time: number;
+    contract: string;
+    profit: string;
+    fee: string;
+    strike_price: string;
+    settle_price: string;
+}
+export interface OptionsUserSettlement {
+    time: number;
+    underlying: string;
+    contract: string;
+    strike_price: string;
+    settle_price: string;
+    size: number;
+    settle_profit: string;
+    fee: string;
+    realised_pnl: string;
+}
+export interface OptionsOrderBook {
+    id?: number;
+    current: number;
+    update: number;
+    asks: {
+        p: string;
+        s: number;
+    }[];
+    bids: {
+        p: string;
+        s: number;
+    }[];
+}
+export interface OptionsTicker {
+    name: string;
+    last_price: string;
+    mark_price: string;
+    index_price: string;
+    ask1_size: number;
+    ask1_price: string;
+    bid1_size: number;
+    bid1_price: string;
+    position_size: number;
+    mark_iv: string;
+    bid_iv: string;
+    ask_iv: string;
+    leverage: string;
+    delta: string;
+    gamma: string;
+    vega: string;
+    theta: string;
+    rho: string;
+}
+export interface OptionsCandle {
+    t: number;
+    v?: number;
+    c: string;
+    h: string;
+    l: string;
+    o: string;
+}
+export interface OptionsUnderlyingCandle {
+    t: number;
+    v?: number;
+    c: string;
+    h: string;
+    l: string;
+    o: string;
+    sum: string;
+}
+export interface OptionsTrade {
+    id: number;
+    create_time: number;
+    create_time_ms: number;
+    contract: string;
+    size: number;
+    price: string;
+    is_internal?: boolean;
+}
+export interface OptionsAccount {
+    user: number;
+    total: string;
+    short_enabled: boolean;
+    unrealised_pnl: string;
+    init_margin: string;
+    maint_margin: string;
+    order_margin: string;
+    available: string;
+    point: string;
+    currency: string;
+}
+export interface OptionsAccountChangeRecord {
+    time: number;
+    change: string;
+    balance: string;
+    type: 'dnw' | 'prem' | 'fee' | 'refr' | 'set';
+    text: string;
+}
+export interface OptionsPositionsUnderlying {
+    user: number;
+    underlying: string;
+    underlying_price: string;
+    contract: string;
+    size: number;
+    entry_price: string;
+    mark_price: string;
+    mark_iv: string;
+    realised_pnl: string;
+    unrealised_pnl: string;
+    pending_orders: number;
+    close_order: {
+        id: number;
+        price: string;
+        is_liq: boolean;
+    } | null;
+    delta: string;
+    gamma: string;
+    vega: string;
+    theta: string;
+}
+export interface GetOptionsLiquidationResp {
+    time: number;
+    contract: string;
+    side: 'long' | 'short';
+    pnl: string;
+    text: string;
+    settle_size: string;
+}
+export interface SubmitOptionsOrderResp {
+    id: number;
+    user: number;
+    create_time: number;
+    finish_time: number;
+    finish_as: 'filled' | 'cancelled' | 'liquidated' | 'ioc' | 'auto_deleveraged' | 'reduce_only' | 'position_closed';
+    status: 'open' | 'finished';
+    contract: string;
+    size: number;
+    iceberg: number;
+    price: string;
+    is_close: boolean;
+    is_reduce_only: boolean;
+    is_liq: boolean;
+    tif: 'gtc' | 'ioc' | 'poc';
+    left: number;
+    fill_price: string;
+    text: string;
+    tkfr: string;
+    mkfr: string;
+    refu: number;
+    refr: string;
+}
+export interface OptionsUserHistoryRecord {
+    id: number;
+    create_time: number;
+    contract: string;
+    order_id: number;
+    size: number;
+    price: string;
+    underlying_price: string;
+    role: 'taker' | 'maker';
+}

package/dist/mjs/types/response/options.js

@@ -0,0 +1,6 @@
+/**==========================================================================================================================
+ * OPTIONS
+ * ==========================================================================================================================
+ */
+export {};
+//# sourceMappingURL=options.js.map

package/dist/mjs/types/response/options.js.map

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

package/dist/mjs/types/response/rebate.d.ts

@@ -0,0 +1,40 @@
+export interface AgencyTransactionHistoryRecord {
+    transaction_time: number;
+    user_id: number;
+    group_name: string;
+    fee: string;
+    fee_asset: string;
+    currency_pair: string;
+    amount: string;
+    amount_asset: string;
+    source: string;
+}
+export interface AgencyCommissionHistoryRecord {
+    commission_time: number;
+    user_id: number;
+    group_name: string;
+    commission_amount: string;
+    commission_asset: string;
+    source: string;
+}
+export interface BrokerCommissionHistoryRecord {
+    commission_time: number;
+    user_id: number;
+    group_name: string;
+    amount: string;
+    fee: string;
+    fee_asset: string;
+    rebate_fee: string;
+    source: string;
+    currency_pair: string;
+}
+export interface BrokerTransactionHistoryRecord {
+    transaction_time: number;
+    user_id: number;
+    group_name: string;
+    fee: string;
+    currency_pair: string;
+    amount: string;
+    fee_asset: string;
+    source: string;
+}

package/dist/mjs/types/response/rebate.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rebate.js.map

package/dist/mjs/types/response/rebate.js.map

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

package/dist/mjs/types/response/shared.d.ts

@@ -0,0 +1,5 @@
+export interface APIResponse<TData = {}> {
+    success: boolean;
+    data: TData;
+    timestamp: number;
+}

package/dist/mjs/types/response/shared.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shared.js.map

package/dist/mjs/types/response/shared.js.map

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

package/dist/mjs/types/response/spot.d.ts

@@ -0,0 +1,224 @@
+/**==========================================================================================================================
+ * SPOT
+ * ==========================================================================================================================
+ */
+export interface SpotCurrency {
+    currency: string;
+    delisted: boolean;
+    withdraw_disabled: boolean;
+    withdraw_delayed: boolean;
+    deposit_disabled: boolean;
+    trade_disabled: boolean;
+    fixed_rate: string;
+    chain: string;
+}
+export interface SpotTicker {
+    currency_pair: string;
+    last: string;
+    lowest_ask: string;
+    highest_bid: string;
+    change_percentage: string;
+    change_utc0: string;
+    change_utc8: string;
+    base_volume: string;
+    quote_volume: string;
+    high_24h: string;
+    low_24h: string;
+    etf_net_value: string;
+    etf_pre_net_value: string | null;
+    etf_pre_timestamp: number | null;
+    etf_leverage: string | null;
+}
+export interface SpotOrderBook {
+    id?: number;
+    current: number;
+    update: number;
+    asks: [string, string][];
+    bids: [string, string][];
+}
+export interface SpotTrade {
+    id: string;
+    create_time: string;
+    create_time_ms: string;
+    currency_pair: string;
+    side: 'buy' | 'sell';
+    role: 'taker' | 'maker';
+    amount: string;
+    price: string;
+    order_id: string;
+    fee: string;
+    fee_currency: string;
+    point_fee: string;
+    gt_fee: string;
+    amend_text: string;
+    sequence_id: string;
+    text: string;
+}
+export type SpotCandle = [
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    boolean
+];
+export interface SpotFeeRates {
+    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;
+    currency_pair: string;
+    debit_fee: number;
+}
+export interface SpotAccount {
+    currency: string;
+    available: string;
+    locked: string;
+    update_id: number;
+}
+export interface SpotAccountBook {
+    id: string;
+    time: number;
+    currency: string;
+    change: string;
+    balance: string;
+    type: string;
+    text: string;
+}
+export interface SubmitSpotBatchOrdersResp {
+    order_id: string;
+    amend_text: string;
+    text: string;
+    succeeded: boolean;
+    label: string;
+    message: string;
+    id: string;
+    create_time: string;
+    update_time: string;
+    create_time_ms: number;
+    update_time_ms: number;
+    status: 'open' | 'closed' | 'cancelled';
+    currency_pair: string;
+    type: 'limit' | 'market';
+    account: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    side: 'buy' | 'sell';
+    amount: string;
+    price: string;
+    time_in_force: 'gtc' | 'ioc' | 'poc' | 'fok';
+    iceberg: string;
+    auto_repay: boolean;
+    left: string;
+    filled_amount: string;
+    fill_price: string;
+    filled_total: string;
+    avg_deal_price: string;
+    fee: string;
+    fee_currency: string;
+    point_fee: string;
+    gt_fee: string;
+    gt_discount: boolean;
+    rebated_fee: string;
+    rebated_fee_currency: string;
+    stp_id: number;
+    stp_act: 'cn' | 'co' | 'cb' | '-';
+    finish_as: 'open' | 'filled' | 'cancelled' | 'ioc' | 'stp';
+}
+export interface SpotOrder {
+    id?: string;
+    text?: string;
+    amend_text?: string;
+    create_time?: string;
+    update_time?: string;
+    create_time_ms?: number;
+    update_time_ms?: number;
+    status?: 'open' | 'closed' | 'cancelled';
+    currency_pair: string;
+    type?: 'limit' | 'market';
+    account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
+    side: 'buy' | 'sell';
+    amount: string;
+    price?: string;
+    time_in_force?: 'gtc' | 'ioc' | 'poc' | 'fok';
+    iceberg?: string;
+    auto_borrow?: boolean;
+    auto_repay?: boolean;
+    left?: string;
+    filled_amount?: string;
+    fill_price?: string;
+    filled_total?: string;
+    avg_deal_price?: string;
+    fee?: string;
+    fee_currency?: string;
+    point_fee?: string;
+    gt_fee?: string;
+    gt_maker_fee?: string;
+    gt_taker_fee?: string;
+    gt_discount?: boolean;
+    rebated_fee?: string;
+    rebated_fee_currency?: string;
+    stp_id?: number;
+    stp_act?: 'cn' | 'co' | 'cb' | '-';
+    finish_as?: 'open' | 'filled' | 'cancelled' | 'ioc' | 'stp';
+    action_mode?: 'ACK' | 'RESULT' | 'FULL';
+}
+export interface SpotPriceTriggeredOrder {
+    trigger: {
+        price: string;
+        rule: '>=' | '<=';
+        expiration: number;
+    };
+    put: {
+        type?: 'limit' | 'market';
+        side: 'buy' | 'sell';
+        price: string;
+        amount: string;
+        account: 'normal' | 'margin' | 'cross_margin';
+        time_in_force?: 'gtc' | 'ioc';
+        text?: string;
+    };
+    id?: number;
+    user?: number;
+    market: string;
+    ctime?: number;
+    ftime?: number;
+    fired_order_id?: number;
+    status?: 'open' | 'cancelled' | 'finish' | 'failed' | 'expired';
+    reason?: string;
+}
+export interface GetSpotOpenOrdersResp {
+    currency_pair: string;
+    total: number;
+    orders: SpotOrder[];
+}
+export interface DeleteSpotBatchOrdersResp {
+    currency_pair: string;
+    id: string;
+    succeeded: boolean;
+    label: string;
+    message: string;
+    account: string;
+}
+export interface SpotHistoricTradeRecord {
+    id: string;
+    create_time: string;
+    create_time_ms: string;
+    currency_pair: string;
+    side: 'buy' | 'sell';
+    role: 'taker' | 'maker';
+    amount: string;
+    price: string;
+    order_id: string;
+    fee: string;
+    fee_currency: string;
+    point_fee: string;
+    gt_fee: string;
+    amend_text: string;
+    sequence_id: string;
+    text: string;
+}

package/dist/mjs/types/response/spot.js

@@ -0,0 +1,6 @@
+/**==========================================================================================================================
+ * SPOT
+ * ==========================================================================================================================
+ */
+export {};
+//# sourceMappingURL=spot.js.map

package/dist/mjs/types/response/spot.js.map

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

package/dist/mjs/types/response/subaccount.d.ts

@@ -0,0 +1,40 @@
+export interface SubAccount {
+    remark?: string;
+    login_name: string;
+    password?: string;
+    email?: string;
+    state: number;
+    type: number;
+    user_id: number;
+    create_time: number;
+}
+export interface CreatedSubAccountAPIKey {
+    user_id: string;
+    mode?: number;
+    name?: string;
+    perms?: {
+        name?: 'wallet' | 'spot' | 'futures' | 'delivery' | 'earn' | 'options' | 'account' | 'unified' | 'loan';
+        read_only?: boolean;
+    }[];
+    ip_whitelist?: string[];
+    key: string;
+    state: number;
+    created_at: number;
+    updated_at: number;
+    last_access: number;
+}
+export interface SubAccountAPIKey {
+    user_id?: string;
+    mode?: number;
+    name?: string;
+    perms?: {
+        name?: 'wallet' | 'spot' | 'futures' | 'delivery' | 'earn' | 'options' | 'account' | 'unified' | 'loan';
+        read_only?: boolean;
+    }[];
+    ip_whitelist?: string[];
+    key?: string;
+    state?: number;
+    created_at?: number;
+    updated_at?: number;
+    last_access?: number;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=subaccount.js.map

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

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

package/dist/mjs/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/mjs/types/response/unified.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=unified.js.map

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

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