@grvt/client 1.5.5 → 1.6.0

package/interfaces/codegen/data.interface.d.ts

@@ -1,251 +1,30 @@
-export declare enum EBridgeType {
-    XY = "XY",
-    RHINO = "RHINO"
-}
-export declare enum EBrokerTag {
-    UNSPECIFIED = "UNSPECIFIED",
-    COIN_ROUTES = "COIN_ROUTES",
-    ALERTATRON = "ALERTATRON",
-    ORIGAMI = "ORIGAMI"
-}
-export declare enum ECancelStatus {
-    EXPIRED = "EXPIRED",
-    DROPPED_DUPLICATE = "DROPPED_DUPLICATE"
-}
-export declare enum ECandlestickInterval {
-    CI_1_M = "CI_1_M",
-    CI_3_M = "CI_3_M",
-    CI_5_M = "CI_5_M",
-    CI_15_M = "CI_15_M",
-    CI_30_M = "CI_30_M",
-    CI_1_H = "CI_1_H",
-    CI_2_H = "CI_2_H",
-    CI_4_H = "CI_4_H",
-    CI_6_H = "CI_6_H",
-    CI_8_H = "CI_8_H",
-    CI_12_H = "CI_12_H",
-    CI_1_D = "CI_1_D",
-    CI_3_D = "CI_3_D",
-    CI_5_D = "CI_5_D",
-    CI_1_W = "CI_1_W",
-    CI_2_W = "CI_2_W",
-    CI_3_W = "CI_3_W",
-    CI_4_W = "CI_4_W"
-}
-export declare enum ECandlestickType {
-    TRADE = "TRADE",
-    MARK = "MARK",
-    INDEX = "INDEX",
-    MID = "MID"
-}
-export declare enum EEpochBadgeType {
-    CHAMPION = "CHAMPION",
-    LEGEND = "LEGEND",
-    VETERAN = "VETERAN",
-    ELITE = "ELITE",
-    MASTER = "MASTER",
-    EXPERT = "EXPERT",
-    WARRIOR = "WARRIOR",
-    SERGEANT = "SERGEANT",
-    RANGER = "RANGER",
-    CHALLENGER = "CHALLENGER",
-    APPRENTICE = "APPRENTICE",
-    ROOKIE = "ROOKIE"
-}
-export declare enum EInstrumentSettlementPeriod {
-    PERPETUAL = "PERPETUAL",
-    DAILY = "DAILY",
-    WEEKLY = "WEEKLY",
-    MONTHLY = "MONTHLY",
-    QUARTERLY = "QUARTERLY"
-}
-export declare enum EKind {
-    PERPETUAL = "PERPETUAL",
-    FUTURE = "FUTURE",
-    CALL = "CALL",
-    PUT = "PUT"
-}
-export declare enum EMarginType {
-    SIMPLE_CROSS_MARGIN = "SIMPLE_CROSS_MARGIN",
-    PORTFOLIO_CROSS_MARGIN = "PORTFOLIO_CROSS_MARGIN"
-}
-export declare enum EOrderRejectReason {
-    UNSPECIFIED = "UNSPECIFIED",
-    CLIENT_CANCEL = "CLIENT_CANCEL",
-    CLIENT_BULK_CANCEL = "CLIENT_BULK_CANCEL",
-    CLIENT_SESSION_END = "CLIENT_SESSION_END",
-    MARKET_CANCEL = "MARKET_CANCEL",
-    IOC_CANCEL = "IOC_CANCEL",
-    AON_CANCEL = "AON_CANCEL",
-    FOK_CANCEL = "FOK_CANCEL",
-    EXPIRED = "EXPIRED",
-    FAIL_POST_ONLY = "FAIL_POST_ONLY",
-    FAIL_REDUCE_ONLY = "FAIL_REDUCE_ONLY",
-    MM_PROTECTION = "MM_PROTECTION",
-    SELF_TRADE_PROTECTION = "SELF_TRADE_PROTECTION",
-    SELF_MATCHED_SUBACCOUNT = "SELF_MATCHED_SUBACCOUNT",
-    OVERLAPPING_CLIENT_ORDER_ID = "OVERLAPPING_CLIENT_ORDER_ID",
-    BELOW_MARGIN = "BELOW_MARGIN",
-    LIQUIDATION = "LIQUIDATION",
-    INSTRUMENT_INVALID = "INSTRUMENT_INVALID",
-    INSTRUMENT_DEACTIVATED = "INSTRUMENT_DEACTIVATED",
-    SYSTEM_FAILOVER = "SYSTEM_FAILOVER",
-    UNAUTHORISED = "UNAUTHORISED",
-    SESSION_KEY_EXPIRED = "SESSION_KEY_EXPIRED",
-    SUB_ACCOUNT_NOT_FOUND = "SUB_ACCOUNT_NOT_FOUND",
-    NO_TRADE_PERMISSION = "NO_TRADE_PERMISSION",
-    UNSUPPORTED_TIME_IN_FORCE = "UNSUPPORTED_TIME_IN_FORCE",
-    MULTI_LEGGED_ORDER = "MULTI_LEGGED_ORDER",
-    EXCEED_MAX_POSITION_SIZE = "EXCEED_MAX_POSITION_SIZE",
-    EXCEED_MAX_SIGNATURE_EXPIRATION = "EXCEED_MAX_SIGNATURE_EXPIRATION",
-    MARKET_ORDER_WITH_LIMIT_PRICE = "MARKET_ORDER_WITH_LIMIT_PRICE",
-    CLIENT_CANCEL_ON_DISCONNECT_TRIGGERED = "CLIENT_CANCEL_ON_DISCONNECT_TRIGGERED",
-    OCO_COUNTER_PART_TRIGGERED = "OCO_COUNTER_PART_TRIGGERED",
-    REDUCE_ONLY_LIMIT = "REDUCE_ONLY_LIMIT",
-    CLIENT_REPLACE = "CLIENT_REPLACE",
-    DERISK_MUST_BE_IOC = "DERISK_MUST_BE_IOC",
-    DERISK_MUST_BE_REDUCE_ONLY = "DERISK_MUST_BE_REDUCE_ONLY",
-    DERISK_NOT_SUPPORTED = "DERISK_NOT_SUPPORTED",
-    INVALID_ORDER_TYPE = "INVALID_ORDER_TYPE",
-    CURRENCY_NOT_DEFINED = "CURRENCY_NOT_DEFINED"
-}
-export declare enum EOrderStatus {
-    PENDING = "PENDING",
-    OPEN = "OPEN",
-    FILLED = "FILLED",
-    REJECTED = "REJECTED",
-    CANCELLED = "CANCELLED"
-}
-export declare enum EQueryMainAccountLeaderboardOrderBy {
-    PNL = "PNL",
-    TRADING_VOLUME = "TRADING_VOLUME"
-}
-export declare enum ERewardEpochStatus {
-    PAST = "PAST",
-    CURRENT = "CURRENT",
-    FUTURE = "FUTURE"
-}
-export declare enum ERewardProgramType {
-    ECOSYSTEM = "ECOSYSTEM",
-    TRADER = "TRADER",
-    LP = "LP"
-}
-export declare enum ESource {
-    WEB = "WEB",
-    MOBILE = "MOBILE",
-    API = "API",
-    LIQUIDATOR = "LIQUIDATOR"
-}
-export declare enum ESubAccountTradeInterval {
-    SAT_1_MO = "SAT_1_MO",
-    SAT_1_D = "SAT_1_D",
-    SAT_1_H = "SAT_1_H",
-    SAT_4_H = "SAT_4_H"
-}
-export declare enum ETimeInForce {
-    GOOD_TILL_TIME = "GOOD_TILL_TIME",
-    ALL_OR_NONE = "ALL_OR_NONE",
-    IMMEDIATE_OR_CANCEL = "IMMEDIATE_OR_CANCEL",
-    FILL_OR_KILL = "FILL_OR_KILL",
-    RETAIL_PRICE_IMPROVEMENT = "RETAIL_PRICE_IMPROVEMENT"
-}
-export declare enum ETimeInterval {
-    INTERVAL_1_D = "INTERVAL_1_D",
-    INTERVAL_7_D = "INTERVAL_7_D",
-    INTERVAL_30_D = "INTERVAL_30_D",
-    INTERVAL_90_D = "INTERVAL_90_D",
-    INTERVAL_LIFETIME = "INTERVAL_LIFETIME"
-}
-export declare enum ETransactionType {
-    UNSPECIFIED_1 = "UNSPECIFIED_1",
-    UNSPECIFIED_2 = "UNSPECIFIED_2",
-    UNSPECIFIED_3 = "UNSPECIFIED_3",
-    CREATE_ACCOUNT = "CREATE_ACCOUNT",
-    CREATE_SUB_ACCOUNT = "CREATE_SUB_ACCOUNT",
-    SET_ACCOUNT_MULTI_SIG_THRESHOLD = "SET_ACCOUNT_MULTI_SIG_THRESHOLD",
-    ADD_ACCOUNT_SIGNER = "ADD_ACCOUNT_SIGNER",
-    REMOVE_ACCOUNT_SIGNER = "REMOVE_ACCOUNT_SIGNER",
-    ADD_WITHDRAWAL_ADDRESS = "ADD_WITHDRAWAL_ADDRESS",
-    REMOVE_WITHDRAWAL_ADDRESS = "REMOVE_WITHDRAWAL_ADDRESS",
-    ADD_TRANSFER_ACCOUNT = "ADD_TRANSFER_ACCOUNT",
-    REMOVE_TRANSFER_ACCOUNT = "REMOVE_TRANSFER_ACCOUNT",
-    SET_SUB_ACCOUNT_MARGIN_TYPE = "SET_SUB_ACCOUNT_MARGIN_TYPE",
-    ADD_SUB_ACCOUNT_SIGNER = "ADD_SUB_ACCOUNT_SIGNER",
-    REMOVE_SUB_ACCOUNT_SIGNER = "REMOVE_SUB_ACCOUNT_SIGNER",
-    ADD_SESSION_KEY = "ADD_SESSION_KEY",
-    REMOVE_SESSION_KEY = "REMOVE_SESSION_KEY",
-    DEPOSIT = "DEPOSIT",
-    WITHDRAWAL = "WITHDRAWAL",
-    TRANSFER = "TRANSFER",
-    MARK_PRICE_TICK = "MARK_PRICE_TICK",
-    SETTLEMENT_PRICE_TICK = "SETTLEMENT_PRICE_TICK",
-    FUNDING_TICK = "FUNDING_TICK",
-    INTEREST_RATE_TICK = "INTEREST_RATE_TICK",
-    SCHEDULE_CONFIG = "SCHEDULE_CONFIG",
-    SET_CONFIG = "SET_CONFIG",
-    TRADE = "TRADE",
-    ADD_RECOVERY_ADDRESS = "ADD_RECOVERY_ADDRESS",
-    REMOVE_RECOVERY_ADDRESS = "REMOVE_RECOVERY_ADDRESS",
-    RECOVER_ADDRESS = "RECOVER_ADDRESS",
-    SETTLE_START = "SETTLE_START",
-    SETTLE_INSTRUMENTS = "SETTLE_INSTRUMENTS",
-    SETTLE_SOCIALISED_LOSS = "SETTLE_SOCIALISED_LOSS",
-    SETTLE_END = "SETTLE_END",
-    SCHEDULE_SIMPLE_CROSS_MAINTENANCE_MARGIN_TIERS = "SCHEDULE_SIMPLE_CROSS_MAINTENANCE_MARGIN_TIERS",
-    SET_SIMPLE_CROSS_MAINTENANCE_MARGIN_TIERS = "SET_SIMPLE_CROSS_MAINTENANCE_MARGIN_TIERS",
-    INITIALIZE_CONFIG = "INITIALIZE_CONFIG",
-    CREATE_ACCOUNT_WITH_SUB_ACCOUNT = "CREATE_ACCOUNT_WITH_SUB_ACCOUNT",
-    VAULT_CREATE = "VAULT_CREATE",
-    VAULT_UPDATE = "VAULT_UPDATE",
-    VAULT_DELIST = "VAULT_DELIST",
-    VAULT_CLOSE = "VAULT_CLOSE",
-    VAULT_INVEST = "VAULT_INVEST",
-    VAULT_BURN_LP_TOKEN = "VAULT_BURN_LP_TOKEN",
-    VAULT_REDEEM = "VAULT_REDEEM",
-    VAULT_MANAGEMENT_FEE_TICK = "VAULT_MANAGEMENT_FEE_TICK",
-    ADD_CURRENCY = "ADD_CURRENCY",
-    SET_DERISK_TO_MAINTENANCE_MARGIN_RATIO = "SET_DERISK_TO_MAINTENANCE_MARGIN_RATIO"
-}
-export declare enum ETransferType {
-    UNSPECIFIED = "UNSPECIFIED",
-    STANDARD = "STANDARD",
-    FAST_ARB_DEPOSIT = "FAST_ARB_DEPOSIT",
-    FAST_ARB_WITHDRAWAL = "FAST_ARB_WITHDRAWAL",
-    NON_NATIVE_BRIDGE_DEPOSIT = "NON_NATIVE_BRIDGE_DEPOSIT",
-    NON_NATIVE_BRIDGE_WITHDRAWAL = "NON_NATIVE_BRIDGE_WITHDRAWAL"
-}
-export declare enum ETriggerBy {
-    UNSPECIFIED = "UNSPECIFIED",
-    INDEX = "INDEX",
-    LAST = "LAST",
-    MID = "MID",
-    MARK = "MARK"
-}
-export declare enum ETriggerType {
-    UNSPECIFIED = "UNSPECIFIED",
-    TAKE_PROFIT = "TAKE_PROFIT",
-    STOP_LOSS = "STOP_LOSS"
-}
-export declare enum EVaultInvestorAction {
-    UNSPECIFIED = "UNSPECIFIED",
-    VAULT_INVEST = "VAULT_INVEST",
-    VAULT_BURN_LP_TOKEN = "VAULT_BURN_LP_TOKEN",
-    VAULT_REDEEM = "VAULT_REDEEM"
-}
-export declare enum EVaultRedemptionReqAgeCategory {
-    NORMAL = "NORMAL",
-    URGENT = "URGENT",
-    OVERDUE = "OVERDUE",
-    PRE_MIN = "PRE_MIN"
-}
-export declare enum EVaultType {
-    PRIME = "PRIME",
-    LAUNCH_PAD = "LAUNCH_PAD"
-}
-export declare enum EVenue {
-    ORDERBOOK = "ORDERBOOK",
-    RFQ = "RFQ"
-}
+import type { EBridgeType } from './enums/bridge-type.ts';
+import type { EBrokerTag } from './enums/broker-tag.ts';
+import type { ECancelStatus } from './enums/cancel-status.ts';
+import type { ECandlestickInterval } from './enums/candlestick-interval.ts';
+import type { ECandlestickType } from './enums/candlestick-type.ts';
+import type { EClusterConfigType } from './enums/cluster-config-type.ts';
+import type { EEpochBadgeType } from './enums/epoch-badge-type.ts';
+import type { EInstrumentSettlementPeriod } from './enums/instrument-settlement-period.ts';
+import type { EKind } from './enums/kind.ts';
+import type { EMarginType } from './enums/margin-type.ts';
+import type { EOrderRejectReason } from './enums/order-reject-reason.ts';
+import type { EOrderStatus } from './enums/order-status.ts';
+import type { EQueryMainAccountLeaderboardOrderBy } from './enums/query-main-account-leaderboard-order-by.ts';
+import type { ERewardEpochStatus } from './enums/reward-epoch-status.ts';
+import type { ERewardProgramType } from './enums/reward-program-type.ts';
+import type { ESource } from './enums/source.ts';
+import type { ESubAccountTradeInterval } from './enums/sub-account-trade-interval.ts';
+import type { ETimeInForce } from './enums/time-in-force.ts';
+import type { ETimeInterval } from './enums/time-interval.ts';
+import type { ETransactionType } from './enums/transaction-type.ts';
+import type { ETransferType } from './enums/transfer-type.ts';
+import type { ETriggerBy } from './enums/trigger-by.ts';
+import type { ETriggerType } from './enums/trigger-type.ts';
+import type { EVaultInvestorAction } from './enums/vault-investor-action.ts';
+import type { EVaultRedemptionReqAgeCategory } from './enums/vault-redemption-req-age-category.ts';
+import type { EVaultType } from './enums/vault-type.ts';
+import type { EVenue } from './enums/venue.ts';
 export interface IAPISettlementPrice {
     base?: string;
     quote?: string;
@@ -338,6 +117,11 @@ export interface IApiCategoryAffinityScoreRequest {
 export interface IApiCategoryAffinityScoreResponse {
     result?: IUserCategoryAffinityScore[];
 }
+export interface IApiClusterConfig {
+    config_type?: EClusterConfigType;
+    config_name?: string;
+    config_json_value?: string;
+}
 export interface IApiCreateBulkOrdersRequest {
     orders?: IOrder[];
 }
@@ -472,6 +256,9 @@ export interface IApiGetAllInstrumentsResponse {
 export interface IApiGetClientTiersResponse {
     tiers?: IClientTier[];
 }
+export interface IApiGetClusterConfigsResponse {
+    results?: IApiClusterConfig[];
+}
 export interface IApiGetCurrencyRequest {
 }
 export interface IApiGetCurrencyResponse {
@@ -578,6 +365,11 @@ export interface IApiGetOrderRequest {
 export interface IApiGetOrderResponse {
     result?: IOrder;
 }
+export interface IApiGetPriceProtectionBandsResponse {
+    enabled?: boolean;
+    default_band?: IPriceProtectionBand;
+    asset_specific?: IAssetSpecificPriceProtectionBand[];
+}
 export interface IApiGetTraderStatResponse {
     total_fee?: string;
 }
@@ -742,6 +534,8 @@ export interface IApiQueryTradingPerformanceTrendResponse {
 }
 export interface IApiQueryVaultInvestorHistoryRequest {
     vault_id?: string;
+    start_time?: string;
+    end_time?: string;
 }
 export interface IApiQueryVaultInvestorHistoryResponse {
     result?: IApiVaultInvestorHistory[];
@@ -749,6 +543,8 @@ export interface IApiQueryVaultInvestorHistoryResponse {
 export interface IApiQueryVaultManagerInvestorHistoryRequest {
     vault_id?: string;
     only_own_investments?: boolean;
+    start_time?: string;
+    end_time?: string;
 }
 export interface IApiQueryVaultManagerInvestorHistoryResponse {
     result?: IApiVaultInvestorHistory[];
@@ -818,6 +614,11 @@ export interface IApiSetInitialLeverageRequest {
 export interface IApiSetInitialLeverageResponse {
     success?: boolean;
 }
+export interface IApiSetPriceProtectionBandsRequest {
+    enabled?: boolean;
+    default_band?: IPriceProtectionBand;
+    asset_specific?: IAssetSpecificPriceProtectionBand[];
+}
 export interface IApiSettlementPriceRequest {
     base?: string;
     quote?: string;
@@ -1104,6 +905,10 @@ export interface IAssetMaxQty {
     max_buy_qty?: string;
     max_sell_qty?: string;
 }
+export interface IAssetSpecificPriceProtectionBand {
+    asset?: string;
+    band?: IPriceProtectionBand;
+}
 export interface ICancelStatusFeed {
     sub_account_id?: string;
     client_order_id?: string;
@@ -1167,6 +972,8 @@ export interface IDetailedAggregatedAccountSummary {
     spot_balances?: ISpotBalance[];
     vault_investments?: IVaultInvestment[];
     funding_account_balance?: string;
+    total_sub_account_balance?: string;
+    total_vault_investments_balance?: string;
 }
 export interface IECNToBrokerFeed {
     order_id?: string;
@@ -1521,6 +1328,10 @@ export interface IPreOrderCheckResult {
     reason?: string;
     settle_currency?: string;
 }
+export interface IPriceProtectionBand {
+    high_centi_beeps?: string;
+    low_centi_beeps?: string;
+}
 export interface IQueryAccountSummaryRequest {
     time_interval?: ETimeInterval;
     main_account_id?: string;
@@ -1582,7 +1393,7 @@ export interface IQueryTradingPerformanceTrendRequest {
     time_interval?: ETimeInterval;
 }
 export interface IQueryTradingPerformanceTrendResponse {
-    result?: ITradingPerformancePoint[];
+    result?: ITradingPerformanceTrendPoint[];
     next?: string;
 }
 export interface IQueryVaultInvestorHistoryRequest {
@@ -1636,6 +1447,10 @@ export interface ISnapFundingAccountSummary {
     main_account_id?: string;
     total_equity?: string;
     spot_balances?: ISpotBalance[];
+    vault_investments?: IVaultInvestment[];
+    funding_account_balance?: string;
+    total_sub_account_balance?: string;
+    total_vault_investments_balance?: string;
 }
 export interface ISnapSubAccountSummary {
     event_time?: string;
@@ -1755,12 +1570,35 @@ export interface ITraderMetric {
     total_fee?: string;
     total_point?: number;
 }
+export interface ITradingPerformance {
+    sub_account_id?: string;
+    total_fee?: string;
+    total_trade_volume?: string;
+    num_traded?: string;
+    positive_fee?: string;
+    realized_pnl?: string;
+    unrealized_pnl?: string;
+    is_unrealized_pnl_snapshotted?: boolean;
+    last_start_interval?: string;
+    funding_payment_amount?: string;
+}
 export interface ITradingPerformancePoint {
     start_interval?: string;
     trading_volume?: string;
     realized_pnl?: string;
     unrealized_pnl?: string;
 }
+export interface ITradingPerformanceTrendPoint {
+    start_interval?: string;
+    total_fee?: string;
+    total_trade_volume?: string;
+    num_traded?: string;
+    positive_fee?: string;
+    realized_pnl?: string;
+    unrealized_pnl?: string;
+    is_unrealized_pnl_snapshotted?: boolean;
+    funding_payment_amount?: string;
+}
 export interface ITransferHistory {
     tx_id?: string;
     from_account_id?: string;