import { U128 } from "../../polyester/type/v1/u128_pb.js"; import { AccountCode, TransferCode } from "../../ledger/v1/catalog_pb.js"; import { BatchReplaceAdmissionStatus, FeeAsset, ModifyActionTaken, OrderType, SelfTradePreventionMode, Side, StopLossPolicy, TakeProfitPolicy, TimeInForce, TrailingStopPolicy } from "./orders_pb.js"; import { Message } from "@bufbuild/protobuf"; import { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2"; import { Timestamp } from "@bufbuild/protobuf/wkt"; declare namespace orders_read_pb_d_exports { export { AttachedRisk, AttachedRiskLegState, AttachedRiskLegStateSchema, AttachedRiskLegState_Status, AttachedRiskLegState_StatusSchema, AttachedRiskSchema, AttachedRiskStopLoss, AttachedRiskStopLossSchema, AttachedRiskTakeProfit, AttachedRiskTakeProfitSchema, AttachedRiskTrailingStop, AttachedRiskTrailingStopSchema, BatchReplacePhase, BatchReplacePhaseSchema, BatchReplaceStatusItem, BatchReplaceStatusItemSchema, GetBatchReplaceStatusRequest, GetBatchReplaceStatusRequestSchema, GetBatchReplaceStatusResponse, GetBatchReplaceStatusResponseSchema, GetOpenOrdersRequest, GetOpenOrdersRequestSchema, GetOpenOrdersResponse, GetOpenOrdersResponseSchema, GetOrderHistoryRequest, GetOrderHistoryRequestSchema, GetOrderHistoryResponse, GetOrderHistoryResponseSchema, GetOrderRequest, GetOrderRequestSchema, GetOrderResponse, GetOrderResponseSchema, GetUserTradesRequest, GetUserTradesRequestSchema, GetUserTradesResponse, GetUserTradesResponseSchema, Order, OrderLineage, OrderLineageSchema, OrderOrigin, OrderOriginSchema, OrderOriginScope, OrderOriginScopeSchema, OrderSchema, OrderStatus, OrderStatusSchema, OrderTransfer, OrderTransferSchema, OrderTriggerType, OrderTriggerTypeSchema, OrdersReadService, UserTrade, UserTradeSchema, file_orders_v1_orders_read }; } /** * Describes the file orders/v1/orders_read.proto. */ declare const file_orders_v1_orders_read: GenFile; /** * OrderOrigin explains why an order exists and where it came from. * * Population rules: * - direct/manual orders: scope=DIRECT; trigger fields unset/unspecified. * - attached children: scope=ATTACHED_RISK; parent_order_id is set. * - standalone trigger children: scope=STANDALONE_TRIGGER. * - child_seq is set for multi-child strategies (for example TWAP/LADDER). * * @generated from message orders.v1.OrderOrigin */ type OrderOrigin = Message<"orders.v1.OrderOrigin"> & { /** * Broad class describing how the order was created. * * @generated from field: orders.v1.OrderOriginScope scope = 1; */ scope: OrderOriginScope; /** * Trigger strategy that created this order, or unspecified for direct orders. * * @generated from field: orders.v1.OrderTriggerType trigger_type = 2; */ triggerType: OrderTriggerType; /** * Trigger identifier when the order was created by a trigger. * * @generated from field: optional fixed64 trigger_id = 3; */ triggerId?: bigint | undefined; /** * Parent order ID for attached-risk child orders. * * @generated from field: optional fixed64 parent_order_id = 4; */ parentOrderId?: bigint | undefined; /** * Child sequence number for multi-child trigger strategies. Zero when not applicable. * * @generated from field: uint32 child_seq = 5; */ childSeq: number; }; /** * Describes the message orders.v1.OrderOrigin. * Use `create(OrderOriginSchema)` to create a new message. */ declare const OrderOriginSchema: GenMessage; /** * AttachedRiskLegState provides runtime linkage/state for one attached-risk leg. * * @generated from message orders.v1.AttachedRiskLegState */ type AttachedRiskLegState = Message<"orders.v1.AttachedRiskLegState"> & { /** * Current runtime lifecycle status for this attached-risk leg. * * @generated from field: orders.v1.AttachedRiskLegState.Status status = 1; */ status: AttachedRiskLegState_Status; /** * Time the leg was armed, in nanoseconds since epoch (UTC). Zero if not armed. * * @generated from field: uint64 armed_ts_ns = 2; */ armedTsNs: bigint; /** * Time the leg reached a terminal state, in nanoseconds since epoch (UTC). Zero if not terminal. * * @generated from field: uint64 terminal_ts_ns = 3; */ terminalTsNs: bigint; /** * Trigger identifier for this attached-risk leg. * * @generated from field: optional fixed64 trigger_id = 4; */ triggerId?: bigint | undefined; /** * Child order ID created by this leg after it fires. * * @generated from field: optional fixed64 child_order_id = 5; */ childOrderId?: bigint | undefined; }; /** * Describes the message orders.v1.AttachedRiskLegState. * Use `create(AttachedRiskLegStateSchema)` to create a new message. */ declare const AttachedRiskLegStateSchema: GenMessage; /** * Runtime lifecycle for an attached-risk trigger leg. * * @generated from enum orders.v1.AttachedRiskLegState.Status */ declare enum AttachedRiskLegState_Status { /** * Attached-risk leg status was not provided. * * @generated from enum value: STATUS_UNSPECIFIED = 0; */ STATUS_UNSPECIFIED = 0, /** * No leg configured on the parent order. * * @generated from enum value: NOT_CONFIGURED = 1; */ NOT_CONFIGURED = 1, /** * Trigger persisted, waiting for admission/arming. * * @generated from enum value: CREATED = 2; */ CREATED = 2, /** * Trigger is actively armed. * * @generated from enum value: ARMED = 3; */ ARMED = 3, /** * Trigger is executing runtime work (for example multi-step workflows). * * @generated from enum value: RUNNING = 4; */ RUNNING = 4, /** * Trigger finished successfully. * * @generated from enum value: COMPLETED = 5; */ COMPLETED = 5, /** * Trigger was canceled. * * @generated from enum value: CANCELED = 6; */ CANCELED = 6, /** * Trigger failed. * * @generated from enum value: FAILED = 7; */ FAILED = 7, /** * Trigger is paused. * * @generated from enum value: PAUSED = 8; */ PAUSED = 8 } /** * Describes the enum orders.v1.AttachedRiskLegState.Status. */ declare const AttachedRiskLegState_StatusSchema: GenEnum; /** * AttachedRiskTakeProfit carries both take-profit config and runtime state. * * @generated from message orders.v1.AttachedRiskTakeProfit */ type AttachedRiskTakeProfit = Message<"orders.v1.AttachedRiskTakeProfit"> & { /** * Take-profit policy configured on the parent order. * * @generated from field: orders.v1.TakeProfitPolicy policy = 1; */ policy?: TakeProfitPolicy | undefined; /** * Runtime state for the take-profit leg. * * @generated from field: orders.v1.AttachedRiskLegState state = 2; */ state?: AttachedRiskLegState | undefined; }; /** * Describes the message orders.v1.AttachedRiskTakeProfit. * Use `create(AttachedRiskTakeProfitSchema)` to create a new message. */ declare const AttachedRiskTakeProfitSchema: GenMessage; /** * AttachedRiskStopLoss carries both stop-loss config and runtime state. * * @generated from message orders.v1.AttachedRiskStopLoss */ type AttachedRiskStopLoss = Message<"orders.v1.AttachedRiskStopLoss"> & { /** * Stop-loss policy configured on the parent order. * * @generated from field: orders.v1.StopLossPolicy policy = 1; */ policy?: StopLossPolicy | undefined; /** * Runtime state for the stop-loss leg. * * @generated from field: orders.v1.AttachedRiskLegState state = 2; */ state?: AttachedRiskLegState | undefined; }; /** * Describes the message orders.v1.AttachedRiskStopLoss. * Use `create(AttachedRiskStopLossSchema)` to create a new message. */ declare const AttachedRiskStopLossSchema: GenMessage; /** * AttachedRiskTrailingStop carries both trailing-stop config and runtime state. * * @generated from message orders.v1.AttachedRiskTrailingStop */ type AttachedRiskTrailingStop = Message<"orders.v1.AttachedRiskTrailingStop"> & { /** * Trailing-stop policy configured on the parent order. * * @generated from field: orders.v1.TrailingStopPolicy policy = 1; */ policy?: TrailingStopPolicy | undefined; /** * Runtime state for the trailing-stop leg. * * @generated from field: orders.v1.AttachedRiskLegState state = 2; */ state?: AttachedRiskLegState | undefined; }; /** * Describes the message orders.v1.AttachedRiskTrailingStop. * Use `create(AttachedRiskTrailingStopSchema)` to create a new message. */ declare const AttachedRiskTrailingStopSchema: GenMessage; /** * AttachedRisk is the single parent-side view for attached-risk configuration * and runtime status. * * @generated from message orders.v1.AttachedRisk */ type AttachedRisk = Message<"orders.v1.AttachedRisk"> & { /** * Take-profit leg, if configured or if state exists. * * @generated from field: orders.v1.AttachedRiskTakeProfit take_profit = 1; */ takeProfit?: AttachedRiskTakeProfit | undefined; /** * Stop-loss leg, if configured or if state exists. * * @generated from field: orders.v1.AttachedRiskStopLoss stop_loss = 2; */ stopLoss?: AttachedRiskStopLoss | undefined; /** * Trailing-stop leg, if configured or if state exists. * * @generated from field: orders.v1.AttachedRiskTrailingStop trailing_stop = 3; */ trailingStop?: AttachedRiskTrailingStop | undefined; /** * True when the take-profit and stop leg are linked as one-cancels-the-other. * * @generated from field: bool oco = 4; */ oco: boolean; }; /** * Describes the message orders.v1.AttachedRisk. * Use `create(AttachedRiskSchema)` to create a new message. */ declare const AttachedRiskSchema: GenMessage; /** * OrderLineage identifies a logical order and one of its accepted generations. * * @generated from message orders.v1.OrderLineage */ type OrderLineage = Message<"orders.v1.OrderLineage"> & { /** * Stable logical-order ID: the first generation's public order ID. * Replace preserves this ID; an independent new order starts a new lineage. * * @generated from field: fixed64 id = 1; */ id: bigint; /** * One-based replacement generation, distinct from per-order state version. * * @generated from field: uint32 generation = 2; */ generation: number; }; /** * Describes the message orders.v1.OrderLineage. * Use `create(OrderLineageSchema)` to create a new message. */ declare const OrderLineageSchema: GenMessage; /** * Order is the Connect-facing order view with compact binary fields. * * @generated from message orders.v1.Order */ type Order = Message<"orders.v1.Order"> & { /** * Public order identifier as fixed64. * * @generated from field: fixed64 order_id = 1; */ orderId: bigint; /** * Trading symbol numeric identifier. * * @generated from field: uint32 symbol_id = 3; */ symbolId: number; /** * Client-provided, account-scoped identifier for correlation, lookup, and * cancellation. Empty when none was supplied. * * @generated from field: string client_order_id = 4; */ clientOrderId: string; /** * Order side. * * @generated from field: orders.v1.Side side = 5; */ side: Side; /** * Current order lifecycle status. * * @generated from field: orders.v1.OrderStatus status = 6; */ status: OrderStatus; /** * Order type. * * @generated from field: orders.v1.OrderType order_type = 7; */ orderType: OrderType; /** * Time-in-force policy. * * @generated from field: orders.v1.TimeInForce time_in_force = 8; */ timeInForce: TimeInForce; /** * Self-trade prevention mode. * * @generated from field: orders.v1.SelfTradePreventionMode self_trade_prevention_mode = 9; */ selfTradePreventionMode: SelfTradePreventionMode; /** * Fee asset selected for fills. * * @generated from field: orders.v1.FeeAsset fee_asset = 10; */ feeAsset: FeeAsset; /** * True if the order was submitted as post-only (maker-only). * * @generated from field: bool post_only = 11; */ postOnly: boolean; /** * Current accepted total order quantity, updated by successful modifies, * scaled by the pair's base_quantity_scale from GetSpotConfig for symbol_id. * * @generated from field: int64 orig_qty_scaled = 12; */ origQtyScaled: bigint; /** * Cumulative filled quantity across the lineage through this generation, * scaled by the pair's base_quantity_scale from GetSpotConfig for symbol_id. * * @generated from field: int64 cum_qty_scaled = 13; */ cumQtyScaled: bigint; /** * Cumulative filled base quantity inherited from predecessors when this * replacement was accepted, scaled by the pair's base_quantity_scale from * GetSpotConfig for symbol_id. Zero for the original order and immutable * within a generation. cum_qty_scaled minus this value is the quantity * executed by this generation, not the quantity new to a client session. * * @generated from field: int64 inherited_cum_qty_scaled = 33; */ inheritedCumQtyScaled: bigint; /** * Remaining working quantity scaled by the pair's base_quantity_scale from * GetSpotConfig for symbol_id. Zero for terminal orders. * * @generated from field: int64 leaves_qty_scaled = 20; */ leavesQtyScaled: bigint; /** * Average execution price across the lineage through this generation, * in quote units scaled by 1e9. Zero if no fills. * * @generated from field: int64 avg_price_ticks = 14; */ avgPriceTicks: bigint; /** * Limit price in quote units scaled by 1e9. Zero for MARKET orders. * * @generated from field: int64 price_ticks = 15; */ priceTicks: bigint; /** * Creation timestamp in nanoseconds since epoch (UTC). * * @generated from field: uint64 created_ts_ns = 16; */ createdTsNs: bigint; /** * Terminal timestamp in nanoseconds since epoch (UTC). Zero for open orders. * * @generated from field: uint64 terminal_ts_ns = 17; */ terminalTsNs: bigint; /** * Terminal reason code for canceled/rejected orders. Zero for non-terminal orders. * * @generated from field: uint32 terminal_reason_code = 18; */ terminalReasonCode: number; /** * Stable string for terminal_reason_code (e.g. "POST_ONLY_CROSS", "USER_REQUEST"). * Empty for non-terminal orders. * * @generated from field: string terminal_reason = 19; */ terminalReason: string; /** * Attached risk controls + runtime state on the parent order. * Empty when no attached risk exists. * * @generated from field: orders.v1.AttachedRisk attached_risk = 21; */ attachedRisk?: AttachedRisk | undefined; /** * Runtime lineage metadata (why the order exists and what generated it). * * @generated from field: orders.v1.OrderOrigin origin = 22; */ origin?: OrderOrigin | undefined; /** * Optional client-side reference price used for MARKET slippage protection, * in quote units scaled by 1e9. * * @generated from field: int64 market_client_ref_price_ticks = 23; */ marketClientRefPriceTicks: bigint; /** * Non-negative MARKET maximum absolute price delta in Q9 execution-price ticks * (1 tick = 1e-9 quote units). Zero means no absolute cap is configured. * * @generated from field: int64 market_max_slippage_ticks = 24; */ marketMaxSlippageTicks: bigint; /** * Optional MARKET max slippage in basis points (1 bp = 0.01%). * * @generated from field: int32 market_max_slippage_bps = 25; */ marketMaxSlippageBps: number; /** * Per-order state version. Starts at 1 and increases for every published * state change. Use this field to reconcile API and realtime updates. * * @generated from field: uint32 version = 26; */ version: number; /** * Batch-replace identity that admitted this order. Zero for other origins. * * @generated from field: fixed64 batch_request_id = 27; */ batchRequestId: bigint; /** * Submitted hard all-in quote debit limit, scaled by the pair's * quote_quantity_scale from GetSpotConfig. Present only when that sizing * method was submitted. * * @generated from field: optional int64 submitted_max_quote_debit_scaled = 28; */ submittedMaxQuoteDebitScaled?: bigint | undefined; /** * Logical-order identity and requested generation. Always populated by order reads. * * @generated from field: orders.v1.OrderLineage lineage = 31; */ lineage?: OrderLineage | undefined; /** * Exact UTC expiry time for GTD orders, within the supported signed * Unix-nanosecond range from 1677-09-21T00:12:43.145224193Z through * 2262-04-11T23:47:16.854775807Z. Omitted for all other time-in-force policies. * The order cannot execute when the current time equals this value. * * @generated from field: google.protobuf.Timestamp expire_at = 32; */ expireAt?: Timestamp | undefined; }; /** * Describes the message orders.v1.Order. * Use `create(OrderSchema)` to create a new message. */ declare const OrderSchema: GenMessage; /** * UserTrade is the Connect-facing per-user trade fill view. * * @generated from message orders.v1.UserTrade */ type UserTrade = Message<"orders.v1.UserTrade"> & { /** * Trading symbol numeric identifier. * * @generated from field: uint32 symbol_id = 2; */ symbolId: number; /** * Match identifier (monotonic per symbol). * * @generated from field: uint64 match_id = 3; */ matchId: bigint; /** * Order identifier as fixed64. * * @generated from field: fixed64 order_id = 4; */ orderId: bigint; /** * Fill side. * * @generated from field: orders.v1.Side side = 5; */ side: Side; /** * True if this fill was maker-side. * * @generated from field: bool is_maker = 6; */ isMaker: boolean; /** * Execution price in quote units scaled by 1e9. * * @generated from field: int64 price_ticks = 7; */ priceTicks: bigint; /** * Executed quantity scaled by the pair's base_quantity_scale from * GetSpotConfig for symbol_id. * * @generated from field: int64 qty_scaled = 8; */ qtyScaled: bigint; /** * Exact fee magnitude in fixed 18-decimal units of fee_asset. * * @generated from field: polyester.type.v1.U128 fee_amount_e18 = 9; */ feeAmountE18?: U128 | undefined; /** * Fee asset charged or credited for this fill. * * @generated from field: orders.v1.FeeAsset fee_asset = 10; */ feeAsset: FeeAsset; /** * Exact referral share magnitude in fixed 18-decimal units of fee_asset. * * @generated from field: polyester.type.v1.U128 referral_share_amount_e18 = 12; */ referralShareAmountE18?: U128 | undefined; /** * Execution timestamp in nanoseconds since epoch. * * @generated from field: uint64 ts_ns = 13; */ tsNs: bigint; /** * Whether this fill earned a rebate instead of paying a fee. * * @generated from field: bool fee_is_rebate = 14; */ feeIsRebate: boolean; /** * Logical-order identity and the generation that executed this fill. * Always populated by execution reads; order_id retains its original identity. * * @generated from field: orders.v1.OrderLineage lineage = 17; */ lineage?: OrderLineage | undefined; }; /** * Describes the message orders.v1.UserTrade. * Use `create(UserTradeSchema)` to create a new message. */ declare const UserTradeSchema: GenMessage; /** * OrderTransfer is the Connect-facing minimal per-leg transfer view. * * @generated from message orders.v1.OrderTransfer */ type OrderTransfer = Message<"orders.v1.OrderTransfer"> & { /** * Match identifier that linked this transfer to an execution, scoped by symbol_id. * * @generated from field: uint64 match_id = 1; */ matchId: bigint; /** * Market of the execution; together with match_id identifies its match. * * @generated from field: uint32 symbol_id = 10; */ symbolId: number; /** * Asset identifier for the transferred asset. * * @generated from field: uint32 asset_id = 2; */ assetId: number; /** * Transfer amount at fixed 18-decimal ledger scale. * * @generated from field: polyester.type.v1.U128 amount_e18 = 3; */ amountE18?: U128 | undefined; /** * True when the transfer debits the account; false when it credits the account. * * @generated from field: bool is_debit = 5; */ isDebit: boolean; /** * Product reason for this transfer leg. * * @generated from field: ledger.v1.TransferCode transfer_code = 6; */ transferCode: TransferCode; /** * Account bucket affected by this transfer leg. * * @generated from field: ledger.v1.AccountCode account_code = 7; */ accountCode: AccountCode; /** * Transfer timestamp in nanoseconds since epoch (UTC). * * @generated from field: uint64 ts_ns = 8; */ tsNs: bigint; /** * Transfer transaction identifier. * * @generated from field: string tx_id = 9; */ txId: string; }; /** * Describes the message orders.v1.OrderTransfer. * Use `create(OrderTransferSchema)` to create a new message. */ declare const OrderTransferSchema: GenMessage; /** * GetOpenOrdersRequest lists currently non-terminal orders for an account. * * @generated from message orders.v1.GetOpenOrdersRequest */ type GetOpenOrdersRequest = Message<"orders.v1.GetOpenOrdersRequest"> & { /** * Target sub-account numeric ID. When omitted, uses caller's root account. * * @generated from field: optional fixed64 subaccount_id = 1; */ subaccountId?: bigint | undefined; /** * Optional filter by symbol_id values. Empty means all symbols. * * @generated from field: repeated uint32 symbol_id = 2; */ symbolId: number[]; /** * Optional side filter. * * @generated from field: orders.v1.Side side = 3; */ side: Side; /** * Max number of orders to return (1-1000, default 100). * * @generated from field: optional uint32 limit = 10; */ limit?: number | undefined; /** * Opaque keyset cursor from a previous response. The cursor is exclusive and * bound to the authenticated account, sub-account scope, filters, and sort * order. * * @generated from field: string page_token = 11; */ pageToken: string; /** * Include attached-risk policy details in each order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk = 12; */ includeAttachedRisk?: boolean | undefined; /** * Include attached-risk state details in each order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk_state = 13; */ includeAttachedRiskState?: boolean | undefined; /** * Optional trigger identifier. When set, returns only child orders created by * that trigger. * * @generated from field: optional fixed64 trigger_id = 14; */ triggerId?: bigint | undefined; }; /** * Describes the message orders.v1.GetOpenOrdersRequest. * Use `create(GetOpenOrdersRequestSchema)` to create a new message. */ declare const GetOpenOrdersRequestSchema: GenMessage; /** * GetOpenOrdersResponse returns open orders and an optional next-page cursor. * * @generated from message orders.v1.GetOpenOrdersResponse */ type GetOpenOrdersResponse = Message<"orders.v1.GetOpenOrdersResponse"> & { /** * Open orders ordered newest-first. * * @generated from field: repeated orders.v1.Order orders = 1; */ orders: Order[]; /** * Opaque cursor for the next page. Empty when no more results exist. * * @generated from field: string next_page_token = 2; */ nextPageToken: string; }; /** * Describes the message orders.v1.GetOpenOrdersResponse. * Use `create(GetOpenOrdersResponseSchema)` to create a new message. */ declare const GetOpenOrdersResponseSchema: GenMessage; /** * GetOrderHistoryRequest lists terminal orders for an account. * * @generated from message orders.v1.GetOrderHistoryRequest */ type GetOrderHistoryRequest = Message<"orders.v1.GetOrderHistoryRequest"> & { /** * Target sub-account numeric ID. When omitted, uses caller's root account. * * @generated from field: optional fixed64 subaccount_id = 1; */ subaccountId?: bigint | undefined; /** * Optional filter by symbol_id values. Empty means all symbols. * * @generated from field: repeated uint32 symbol_id = 2; */ symbolId: number[]; /** * Optional side filter. * * @generated from field: orders.v1.Side side = 3; */ side: Side; /** * Optional status filter. * * @generated from field: orders.v1.OrderStatus status = 4; */ status: OrderStatus; /** * Inclusive start of the time range, in nanoseconds since epoch (UTC). * * @generated from field: optional uint64 start_ts_ns = 10; */ startTsNs?: bigint | undefined; /** * Inclusive end of the time range, in nanoseconds since epoch (UTC). * * @generated from field: optional uint64 end_ts_ns = 11; */ endTsNs?: bigint | undefined; /** * Max number of orders to return (1-1000, default 100). * * @generated from field: optional uint32 limit = 12; */ limit?: number | undefined; /** * Opaque keyset cursor from a previous response. The cursor is exclusive and * bound to the authenticated account, sub-account scope, filters, time range, * and sort order. * * @generated from field: string page_token = 13; */ pageToken: string; /** * Include attached-risk policy details in each order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk = 14; */ includeAttachedRisk?: boolean | undefined; /** * Include attached-risk state details in each order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk_state = 15; */ includeAttachedRiskState?: boolean | undefined; /** * Optional trigger identifier. When set, returns only child orders created by * that trigger. * * @generated from field: optional fixed64 trigger_id = 16; */ triggerId?: bigint | undefined; }; /** * Describes the message orders.v1.GetOrderHistoryRequest. * Use `create(GetOrderHistoryRequestSchema)` to create a new message. */ declare const GetOrderHistoryRequestSchema: GenMessage; /** * GetOrderHistoryResponse returns historical orders and an optional next-page cursor. * * @generated from message orders.v1.GetOrderHistoryResponse */ type GetOrderHistoryResponse = Message<"orders.v1.GetOrderHistoryResponse"> & { /** * Historical orders ordered newest-first. * * @generated from field: repeated orders.v1.Order orders = 1; */ orders: Order[]; /** * Opaque cursor for the next page. Empty when no more results exist. * * @generated from field: string next_page_token = 2; */ nextPageToken: string; }; /** * Describes the message orders.v1.GetOrderHistoryResponse. * Use `create(GetOrderHistoryResponseSchema)` to create a new message. */ declare const GetOrderHistoryResponseSchema: GenMessage; /** * GetUserTradesRequest lists trade fills for an account. * * @generated from message orders.v1.GetUserTradesRequest */ type GetUserTradesRequest = Message<"orders.v1.GetUserTradesRequest"> & { /** * Target sub-account numeric ID. When omitted, uses caller's root account. * * @generated from field: optional fixed64 subaccount_id = 1; */ subaccountId?: bigint | undefined; /** * Optional filter by symbol_id. * * @generated from field: uint32 symbol_id = 2; */ symbolId: number; /** * Optional side filter. * * @generated from field: orders.v1.Side side = 3; */ side: Side; /** * Inclusive start of the time range, in nanoseconds since epoch (UTC). * * @generated from field: optional uint64 start_ts_ns = 10; */ startTsNs?: bigint | undefined; /** * Inclusive end of the time range, in nanoseconds since epoch (UTC). * * @generated from field: optional uint64 end_ts_ns = 11; */ endTsNs?: bigint | undefined; /** * Max number of trades to return (1-1000, default 100). * * @generated from field: optional uint32 limit = 12; */ limit?: number | undefined; /** * Opaque keyset cursor from a previous response. The cursor is exclusive and * bound to the authenticated account, sub-account scope, filters, time range, * and sort order. * * @generated from field: string page_token = 13; */ pageToken: string; /** * Return only durable fills whose per-symbol match ID is greater than this * value. Subscribe to the execution WebSocket before calling this method and * de-duplicate overlapping results by (symbol_id, match_id, order_id). * * @generated from field: optional uint64 after_match_id = 14; */ afterMatchId?: bigint | undefined; /** * Optional execution scope. Omitting it returns all matching account fills. * order_id and lineage_id are mutually exclusive. * * @generated from oneof orders.v1.GetUserTradesRequest.execution_scope */ executionScope: { /** * Exactly this physical order's executions; never includes predecessors. * * @generated from field: fixed64 order_id = 15; */ value: bigint; case: "orderId"; } | { /** * Executions across this logical order's accepted generations. * * @generated from field: fixed64 lineage_id = 16; */ value: bigint; case: "lineageId"; } | { case: undefined; value?: undefined; }; /** * Inclusive generation ceiling; requires lineage_id. * Does not freeze an actively filling generation. * * @generated from field: optional uint32 through_generation = 17; */ throughGeneration?: number | undefined; /** * Include account settlement legs linked to matches on this page. * Legs may repeat across pages when two fills share a match; deduplicate by tx_id. * * @generated from field: bool include_transfers = 18; */ includeTransfers: boolean; }; /** * Describes the message orders.v1.GetUserTradesRequest. * Use `create(GetUserTradesRequestSchema)` to create a new message. */ declare const GetUserTradesRequestSchema: GenMessage; /** * GetUserTradesResponse returns user trade fills and an optional next-page cursor. * * @generated from message orders.v1.GetUserTradesResponse */ type GetUserTradesResponse = Message<"orders.v1.GetUserTradesResponse"> & { /** * Trades ordered by timestamp, symbol, match and physical order, descending. * Projection is eventual: an empty page is not proof of order-state reconciliation. * * @generated from field: repeated orders.v1.UserTrade trades = 1; */ trades: UserTrade[]; /** * Opaque cursor for the next page. Empty when no more results exist. * * @generated from field: string next_page_token = 2; */ nextPageToken: string; /** * Settlement legs for matches represented on this page, when requested. * * @generated from field: repeated orders.v1.OrderTransfer transfers = 3; */ transfers: OrderTransfer[]; }; /** * Describes the message orders.v1.GetUserTradesResponse. * Use `create(GetUserTradesResponseSchema)` to create a new message. */ declare const GetUserTradesResponseSchema: GenMessage; /** * GetOrderRequest retrieves one physical order and a bounded page of its lineage executions. * * @generated from message orders.v1.GetOrderRequest */ type GetOrderRequest = Message<"orders.v1.GetOrderRequest"> & { /** * Target sub-account numeric ID. When omitted, uses caller's root account. * * @generated from field: optional fixed64 subaccount_id = 1; */ subaccountId?: bigint | undefined; /** * Order lookup key. Exactly one identifier is required. * * @generated from oneof orders.v1.GetOrderRequest.key */ key: { /** * Public order ID (base58-encoded fixed64 on REST). * * @generated from field: fixed64 order_id = 2; */ value: bigint; case: "orderId"; } | { /** * Client order ID. When provided, server resolves latest matching order for the account. * * @generated from field: string client_order_id = 3; */ value: string; case: "clientOrderId"; } | { case: undefined; value?: undefined; }; /** * Include attached-risk policy details in response.order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk = 10; */ includeAttachedRisk?: boolean | undefined; /** * Include attached-risk state details in response.order (defaults to false when unset). * * @generated from field: optional bool include_attached_risk_state = 11; */ includeAttachedRiskState?: boolean | undefined; /** * Include a page of lineage trades and their settlement transfers (default true). * Set false for state-only polling; limit and page_token must then be omitted. * * @generated from field: optional bool include_execution_history = 12; */ includeExecutionHistory?: boolean | undefined; /** * Maximum executions to return (1-1000, default 100). * * @generated from field: optional uint32 limit = 13; */ limit?: number | undefined; /** * Execution cursor from this order's previous response. Use order_id rather * than a reused client_order_id to keep the requested generation stable. * * @generated from field: string page_token = 14; */ pageToken: string; }; /** * Describes the message orders.v1.GetOrderRequest. * Use `create(GetOrderRequestSchema)` to create a new message. */ declare const GetOrderRequestSchema: GenMessage; /** * GetOrderResponse returns order details and a bounded execution page. * Order state, trades and transfers are eventually consistent; * one page's execution quantities need not equal the order's cumulative quantity. * * @generated from message orders.v1.GetOrderResponse */ type GetOrderResponse = Message<"orders.v1.GetOrderResponse"> & { /** * Requested order, if found. * * @generated from field: orders.v1.Order order = 1; */ order?: Order | undefined; /** * Lineage executions through the requested generation, newest first, retaining * original executing order IDs. Omitted when execution history is disabled. * * @generated from field: repeated orders.v1.UserTrade trades = 2; */ trades: UserTrade[]; /** * Account settlement legs for matches on this page. Deduplicate by tx_id when * multiple execution pages contain legs of the same match. * * @generated from field: repeated orders.v1.OrderTransfer transfers = 3; */ transfers: OrderTransfer[]; /** * Cursor for the next execution page. Empty when no further rows are visible; * this is not a settlement or order-state reconciliation watermark. * * @generated from field: string next_page_token = 6; */ nextPageToken: string; }; /** * Describes the message orders.v1.GetOrderResponse. * Use `create(GetOrderResponseSchema)` to create a new message. */ declare const GetOrderResponseSchema: GenMessage; /** * GetBatchReplaceStatusRequest retrieves one admitted batch by server identity. * * @generated from message orders.v1.GetBatchReplaceStatusRequest */ type GetBatchReplaceStatusRequest = Message<"orders.v1.GetBatchReplaceStatusRequest"> & { /** * Target sub-account numeric ID. When omitted, uses caller's root account. * * @generated from field: optional fixed64 subaccount_id = 1; */ subaccountId?: bigint | undefined; /** * Server-issued batch identity from BatchReplaceOrders. * * @generated from field: fixed64 batch_request_id = 2; */ batchRequestId: bigint; }; /** * Describes the message orders.v1.GetBatchReplaceStatusRequest. * Use `create(GetBatchReplaceStatusRequestSchema)` to create a new message. */ declare const GetBatchReplaceStatusRequestSchema: GenMessage; /** * BatchReplaceStatusItem is the index-stable execution status for one replacement. * * @generated from message orders.v1.BatchReplaceStatusItem */ type BatchReplaceStatusItem = Message<"orders.v1.BatchReplaceStatusItem"> & { /** * Zero-based item index from the write request. * * @generated from field: uint32 item_index = 1; */ itemIndex: number; /** * Current recoverable phase. * * @generated from field: orders.v1.BatchReplacePhase phase = 2; */ phase: BatchReplacePhase; /** * Original order targeted by the replacement. * * @generated from field: fixed64 old_order_id = 3; */ oldOrderId: bigint; /** * Assigned successor order ID. Zero for cancel-only outcomes or rejection before assignment. * * @generated from field: fixed64 replacement_order_id = 4; */ replacementOrderId: bigint; /** * Current successor status, or original order status for a cancel-only outcome, when available. * * @generated from field: orders.v1.OrderStatus order_status = 5; */ orderStatus: OrderStatus; /** * Stable rejection or terminal error code. Empty when none. * * @generated from field: string code = 6; */ code: string; /** * Latest status timestamp in nanoseconds since epoch. * * @generated from field: uint64 updated_ts_ns = 7; */ updatedTsNs: bigint; /** * REPLACED admits a successor. AMENDED is cancel-only: no successor exists and * order_status describes old_order_id. Unspecified for rejected items. * * @generated from field: orders.v1.ModifyActionTaken action_taken = 8; */ actionTaken: ModifyActionTaken; }; /** * Describes the message orders.v1.BatchReplaceStatusItem. * Use `create(BatchReplaceStatusItemSchema)` to create a new message. */ declare const BatchReplaceStatusItemSchema: GenMessage; /** * GetBatchReplaceStatusResponse returns durable batch and per-item finality. * * @generated from message orders.v1.GetBatchReplaceStatusResponse */ type GetBatchReplaceStatusResponse = Message<"orders.v1.GetBatchReplaceStatusResponse"> & { /** * Server-issued batch identity. * * @generated from field: fixed64 batch_request_id = 1; */ batchRequestId: bigint; /** * Aggregate admission status returned by the write receipt. * * @generated from field: orders.v1.BatchReplaceAdmissionStatus admission_status = 2; */ admissionStatus: BatchReplaceAdmissionStatus; /** * Per-item statuses in request order. * * @generated from field: repeated orders.v1.BatchReplaceStatusItem items = 3; */ items: BatchReplaceStatusItem[]; /** * Number of admitted items. * * @generated from field: uint32 accepted_count = 4; */ acceptedCount: number; /** * Number of rejected items. * * @generated from field: uint32 rejected_count = 5; */ rejectedCount: number; /** * Server acceptance timestamp in nanoseconds since epoch. * * @generated from field: uint64 accepted_ts_ns = 6; */ acceptedTsNs: bigint; /** * Latest batch status timestamp in nanoseconds since epoch. * * @generated from field: uint64 updated_ts_ns = 7; */ updatedTsNs: bigint; }; /** * Describes the message orders.v1.GetBatchReplaceStatusResponse. * Use `create(GetBatchReplaceStatusResponseSchema)` to create a new message. */ declare const GetBatchReplaceStatusResponseSchema: GenMessage; /** * OrderStatus is specific to the read API (write API uses simple "accepted" status string). * * @generated from enum orders.v1.OrderStatus */ declare enum OrderStatus { /** * Order status was not provided. * * @generated from enum value: ORDER_STATUS_UNSPECIFIED = 0; */ ORDER_STATUS_UNSPECIFIED = 0, /** * Accepted and submitted for execution, but not yet confirmed as working. * * @generated from enum value: PENDING = 1; */ PENDING = 1, /** * Cancel requested; may still be working until cancel is confirmed. * * @generated from enum value: PENDING_CANCEL = 2; */ PENDING_CANCEL = 2, /** * Accepted and actively working (resting and/or matching). * * @generated from enum value: WORKING = 3; */ WORKING = 3, /** * Fully filled (no remaining quantity). * * @generated from enum value: FILLED = 4; */ FILLED = 4, /** * Canceled and no longer working. * * @generated from enum value: CANCELED = 5; */ CANCELED = 5, /** * Rejected and never entered the working state. * * @generated from enum value: REJECTED = 6; */ REJECTED = 6 } /** * Describes the enum orders.v1.OrderStatus. */ declare const OrderStatusSchema: GenEnum; /** * BatchReplacePhase is the recoverable execution phase for one replacement. * * @generated from enum orders.v1.BatchReplacePhase */ declare enum BatchReplacePhase { /** * Phase is unavailable. * * @generated from enum value: BATCH_REPLACE_PHASE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** * The operation was admitted and handed to execution, including cancel-only outcomes. * * @generated from enum value: BATCH_REPLACE_PHASE_ADMITTED = 1; */ ADMITTED = 1, /** * The successor order is active. * * @generated from enum value: BATCH_REPLACE_PHASE_WORKING = 2; */ WORKING = 2, /** * The replacement was rejected. * * @generated from enum value: BATCH_REPLACE_PHASE_REJECTED = 3; */ REJECTED = 3, /** * The successor, or original order for a cancel-only outcome, reached a terminal state. * * @generated from enum value: BATCH_REPLACE_PHASE_TERMINAL = 4; */ TERMINAL = 4 } /** * Describes the enum orders.v1.BatchReplacePhase. */ declare const BatchReplacePhaseSchema: GenEnum; /** * OrderOriginScope captures broad origin classes for an order. * * @generated from enum orders.v1.OrderOriginScope */ declare enum OrderOriginScope { /** * Order origin scope was not provided. * * @generated from enum value: ORDER_ORIGIN_SCOPE_UNSPECIFIED = 0; */ ORDER_ORIGIN_SCOPE_UNSPECIFIED = 0, /** * User/manual order (non-trigger path). * * @generated from enum value: DIRECT = 1; */ DIRECT = 1, /** * Child generated by attached TP/SL/Trailing risk on a parent order. * * @generated from enum value: ATTACHED_RISK = 2; */ ATTACHED_RISK = 2, /** * Child generated by a standalone trigger (STOP/TWAP/LADDER...). * * @generated from enum value: STANDALONE_TRIGGER = 3; */ STANDALONE_TRIGGER = 3, /** * System-managed automation, such as liquidation or account-protection actions. * * @generated from enum value: SYSTEM = 4; */ SYSTEM = 4 } /** * Describes the enum orders.v1.OrderOriginScope. */ declare const OrderOriginScopeSchema: GenEnum; /** * OrderTriggerType captures the trigger strategy that generated the order. * * @generated from enum orders.v1.OrderTriggerType */ declare enum OrderTriggerType { /** * Trigger type was not provided or the order was not generated by a trigger. * * @generated from enum value: ORDER_TRIGGER_TYPE_UNSPECIFIED = 0; */ ORDER_TRIGGER_TYPE_UNSPECIFIED = 0, /** * Order was generated by a stop-loss trigger. * * @generated from enum value: STOP_LOSS = 1; */ STOP_LOSS = 1, /** * Order was generated by a take-profit trigger. * * @generated from enum value: TAKE_PROFIT = 2; */ TAKE_PROFIT = 2, /** * Order was generated by a trailing-stop trigger. * * @generated from enum value: TRAILING_STOP = 3; */ TRAILING_STOP = 3, /** * Order was generated by a time-weighted execution trigger. * * @generated from enum value: TWAP = 4; */ TWAP = 4, /** * Order was generated by a ladder execution trigger. * * @generated from enum value: LADDER = 5; */ LADDER = 5 } /** * Describes the enum orders.v1.OrderTriggerType. */ declare const OrderTriggerTypeSchema: GenEnum; /** * @generated from service orders.v1.OrdersReadService */ declare const OrdersReadService: GenService<{ /** * Retrieve non-terminal orders for an account. * Supports optional subaccount, trigger, symbol, and side filters with cursor pagination. * * @generated from rpc orders.v1.OrdersReadService.GetOpenOrders */ getOpenOrders: { methodKind: "unary"; input: typeof GetOpenOrdersRequestSchema; output: typeof GetOpenOrdersResponseSchema; }; /** * Retrieve terminal order history for an account. * Supports optional subaccount, trigger, symbol, side, status, and time-range filters with cursor pagination. * * @generated from rpc orders.v1.OrdersReadService.GetOrderHistory */ getOrderHistory: { methodKind: "unary"; input: typeof GetOrderHistoryRequestSchema; output: typeof GetOrderHistoryResponseSchema; }; /** * Retrieve per-user trade fills for an account. * Supports exact physical-order or logical-lineage scope, an inclusive generation * cutoff, and subaccount, symbol, side and time filters with cursor pagination. * * @generated from rpc orders.v1.OrdersReadService.GetUserTrades */ getUserTrades: { methodKind: "unary"; input: typeof GetUserTradesRequestSchema; output: typeof GetUserTradesResponseSchema; }; /** * Retrieve order state and a bounded page of its lineage executions by order or client order ID. * Use GetUserTrades for paginated execution history and optional settlement legs. * Recent accepted orders may wait briefly for read availability; retry UNAVAILABLE with the same lookup key. * * @generated from rpc orders.v1.OrdersReadService.GetOrder */ getOrder: { methodKind: "unary"; input: typeof GetOrderRequestSchema; output: typeof GetOrderResponseSchema; }; /** * Retrieve durable execution status for one admitted batch replacement. * * @generated from rpc orders.v1.OrdersReadService.GetBatchReplaceStatus */ getBatchReplaceStatus: { methodKind: "unary"; input: typeof GetBatchReplaceStatusRequestSchema; output: typeof GetBatchReplaceStatusResponseSchema; }; }>; //#endregion export { AttachedRisk, AttachedRiskLegState, AttachedRiskLegStateSchema, AttachedRiskLegState_Status, AttachedRiskLegState_StatusSchema, AttachedRiskSchema, AttachedRiskStopLoss, AttachedRiskStopLossSchema, AttachedRiskTakeProfit, AttachedRiskTakeProfitSchema, AttachedRiskTrailingStop, AttachedRiskTrailingStopSchema, BatchReplacePhase, BatchReplacePhaseSchema, BatchReplaceStatusItem, BatchReplaceStatusItemSchema, GetBatchReplaceStatusRequest, GetBatchReplaceStatusRequestSchema, GetBatchReplaceStatusResponse, GetBatchReplaceStatusResponseSchema, GetOpenOrdersRequest, GetOpenOrdersRequestSchema, GetOpenOrdersResponse, GetOpenOrdersResponseSchema, GetOrderHistoryRequest, GetOrderHistoryRequestSchema, GetOrderHistoryResponse, GetOrderHistoryResponseSchema, GetOrderRequest, GetOrderRequestSchema, GetOrderResponse, GetOrderResponseSchema, GetUserTradesRequest, GetUserTradesRequestSchema, GetUserTradesResponse, GetUserTradesResponseSchema, Order, OrderLineage, OrderLineageSchema, OrderOrigin, OrderOriginSchema, OrderOriginScope, OrderOriginScopeSchema, OrderSchema, OrderStatus, OrderStatusSchema, OrderTransfer, OrderTransferSchema, OrderTriggerType, OrderTriggerTypeSchema, OrdersReadService, UserTrade, UserTradeSchema, file_orders_v1_orders_read, orders_read_pb_d_exports }; //# sourceMappingURL=orders_read_pb.d.ts.map