BtApi¶

Enable an optional execution session; the same configuration is idempotent.

Configure before subscribing or submitting orders. Replacing a live session's journal is forbidden. The journal lock is held until close().

Allocate a numeric client reference before the caller binds its order.

Allocation reserves the value locally; only a persisted order intent consumes it. Decimal references also fit CTP's native OrderRef contract.

Return the SDK-owned ledger identity used for typed order requests.

Read session execution evidence without touching a transport adapter.

Resolve locally proven reservation-only cancel unknowns before Store startup.

The SDK execution session checks the durable journal sequence and writes only a local terminal journal event. No venue adapter is consulted.

Resolve only historical unknowns proven rejected by a documented venue code.

Evaluate provider-neutral CTP path evidence without reserving funds.

Durably reserve one CTP path budget in the existing execution journal.

Return SDK-owned, durable account-equity evidence for execution.

The method performs authenticated normalized account and position reads for every configured crypto venue. Before the first baseline it also queries each venue's remote open orders through this public normalized API. It never accepts runner-supplied equity, flatness, or empty-order claims. A first baseline is persisted only when both the initial and commit-time remote open-order sweeps are known empty, all positions are authoritatively known flat, and the execution journal has no active or unknown order.

Explicitly reset a breached loss latch after authoritative flat proof.

The reset re-baselines equity only after two normalized open-order sweeps, normalized flat positions on every configured venue, and a clean durable execution ledger. Any missing or conflicting evidence leaves the persisted latch unchanged.

Run the authenticated risk snapshot without blocking an event loop.

Run the explicit loss-latch reset without blocking an event loop.

Return process-local ingress/coalescing counters without resetting them.

Backfill private state after reconnect and publish one audit status.

Run private reconnect backfill without blocking the caller's loop.

Return the selected transport environment without configuration secrets.

Direct feeds expose their resolved environment through the venue's exchange-data object. A ZMQ client cannot prove the gateway's server-side environment, so it deliberately reports an unverified unknown value.

Poll normalized events and advance configured pending-order reconciliation.

Reconciliation is time based and runs even while market events keep arriving. No placement is retried. Call this without requiring a bar.

Poll a finite batch of normalized events from one exchange.

poll_event(exchange_name) keeps its historical one-event FIFO contract. This batch API is an opt-in path for latency-sensitive consumers which may explicitly coalesce complete market snapshots.

max_raw_items counts items removed from the exchange transport, not normalized events produced by a container. None means the finite Queue.qsize() snapshot observed at the start of a direct-transport call; items appended by producers during the call remain for the next poll. Transports without an inspectable queue use the conservative default batch bound of 100 when None is requested.

Only explicitly named complete snapshot kinds are coalesced. Currently orderbook and tick are supported. Coalescing is per kind and symbol, and only within a contiguous market-data segment. Every other event is a barrier, so order, trade, account and position events are neither discarded nor reordered. Callers must not opt incremental order-book deltas into snapshot coalescing.

根据 exchange_kwargs 初始化并添加交易所。

参数：

Initialize and return the API logger instance.

Add a new exchange to the API instance.

参数：

Get the REST Feed instance for the specified exchange (synchronous API).

ZMQ transport has no direct feed escape hatch and raises CapabilityNotSupportedError instead of returning None.

Deprecated alias for get_request_api.

Collect a sealed approval context from this running deployment.

Runtime package/native hashes, the CTP account/day/generation and the resolved environment are read here; callers cannot establish those identities by copying strings into a mapping. Application material is supplied as raw bytes, paths, or JSON values and hashed by the SDK. deployment_manifest can pin the locally observed runtime hashes, but it cannot replace them.

Verify an independent CTP approval without arming a native gate.

trust_root is deployment-owned key and revocation configuration; context must be the sealed SDK-collected runtime/deployment-manifest identity for non-synthetic sources, including the exact instrument scope and all artifact hashes. A plain mapping is reserved for explicit synthetic_test offline evidence. The method performs no network I/O and never invokes the controlled test issuer or a native CTP write path.

Verify only the versioned recovery-purpose approval contract.

Durably consume a verified approval and return process-local opaque evidence.

Revalidation immediately before consumption observes expiry, current deployment context, and the current trusted revocation snapshot. The existing execution journal must fsync the nonce before this method returns. An ordinary-purpose capability remains ineligible for native arming; a recovery-purpose capability is accepted only by the separate bounded recovery entry point.

Persist approval evidence while retaining a read-only session.

Durably record a newer deployment revocation snapshot.

The SDK does not fetch or infer revocations. A deployment supplies its independently managed trust-root snapshot; this method records it in the same fenced execution journal so a restart cannot roll back to an older version.

Atomically arm CTP only from a core-issued opaque authorization.

Reset managed CTP to reusable read-only state before Stage A.

Issue an SDK-owned recovery plan from two fenced query rounds.

Arm bounded recovery from a redeemed opaque recovery approval.

proof is retained as an audit-only compatibility keyword. It is never interpreted as authority and cannot reach the native bridge.

Arm normal CTP execution from one redeemed entry approval.

The capability must come from redeem_ctp_execution_approval with a signed ctp-execution-entry-approval-v1 artifact whose scope, run material, and strategy identity match this running deployment. The approval is one-shot: every later failure stays conservative and the nonce cannot arm twice in-process.

Confirm settlement once from a separately redeemed entry approval.

The settlement confirmation is the one terminal write a still market-data-only session may perform: without it the account can never reach the confirmed state ordinary arming requires. The caller must redeem an independently signed ctp-execution-entry-approval-v1 artifact bound to this session's account/day/generation; the capability is one-shot for settlement and independent of its entry arming use.

Prove flatness with a fresh query barrier and revoke recovery writes.

Idempotently revoke execution while retaining read-only CTP access.

Return CTP auth/login/settlement evidence without exposing the native client.

Run one typed, completion-aware CTP read query.

Verify an account/day server record and promote only that live session.

Fail closed: public callers cannot authorize a terminal CTP write.

A settlement confirmation is not a read preflight action. This iteration has no production core signer, so state hashes, a managed capability, and this public method itself are deliberately insufficient to issue the independent one-shot native settlement authorization.

Get the data queue for the specified exchange.

The data queue receives market data and order updates from WebSocket streams.

参数：

返回：

通过 ExchangeRegistry 查找订阅处理函数，无需硬编码交易所类型

获取事件总线实例

Push a simulated ticker update into the event bus and optional exchange queue.

列出所有已添加的交易所

Release transports and the execution lock, including on close failure.

Close all exchange feeds (WebSocket streams + HTTP clients).

列出所有已注册可用的交易所

获取最新行情 :param exchange_name: 交易所标识, 如 "BINANCE___SWAP" :param symbol: 交易对, 如 "BTC-USDT"

获取深度数据 :param exchange_name: 交易所标识 :param symbol: 交易对 :param count: 深度档数

获取K线数据 :param exchange_name: 交易所标识 :param symbol: 交易对 :param period: K线周期, 如 "1m", "5m", "1H", "1D" :param count: K线数量

Read native instrument metadata through the direct transport.

Returns the feed's native response unchanged. Binance exchange info includes symbols[].filters; OKX instruments include ctVal, ctValCcy, lotSz, minSz and tickSz. Callers must use these fields to distinguish base-asset quantities from contract quantities. The forwarding protocol does not currently support this operation.

Read perpetual funding data, preserving the feed-native response and units.

Return strict Decimal quantity/price rules while preserving legacy reads.

Read account fee rates as an explicit available/unavailable snapshot.

Read the next funding settlement as a Decimal typed snapshot.

Return a conservative typed preflight for OKX or Binance perpetuals.

Run the same typed readiness contract without blocking the event loop.

Read account mode and explicit trading permission without changing either.

OKX exposes this operation as get_config; its native data entries include posMode and API-key permissions. Binance USD-M futures exposes dualSidePosition and canTrade together through its read-only account-configuration endpoint.

Read the native position mode without modifying it.

Binance returns dualSidePosition. OKX reports posMode inside its account configuration response. Neither format is normalized to a boolean, and unsupported feeds fail explicitly.

Set and read back an account-wide perpetual position mode.

The public contract accepts only net and dual_side. A provider acknowledgement is insufficient: the method reads the position mode back from the account and returns only after the requested value is observed. An uncertain outcome invalidates the local mode cache and blocks normalized placements until a fresh normalized read verifies it.

Inspect perpetual order prerequisites without submitting an order.

quantity_native is an OKX contract count or Binance base-asset quantity. A result with ready=True still carries execution_unproven=True because only an exchange order response can prove execution access.

下单。

标准形式（v1）：make_order(exchange_name, OrderRequest(...))。 兼容形式：make_order(exchange_name, symbol, volume, price, "buy-limit")； 仅当 order_type 能推导 side（side-type）时兼容，裸 limit/market 无法推导 side 时抛 LegacyOrderApiError。

撤单 :param exchange_name: 交易所标识 :param symbol: 交易对 :param order_id: 订单ID

撤销所有订单 :param exchange_name: 交易所标识 :param symbol: 交易对 (None 表示所有品种)

查询订单 :param exchange_name: 交易所标识 :param symbol: 交易对 :param order_id: 订单ID

查询挂单 :param exchange_name: 交易所标识 :param symbol: 交易对 (None 表示所有品种)

查询账户成交/成交明细，用于获取真实手续费。

Different exchange feeds expose private fills as get_deals. Keep the unified facade thin so callers can pass through exchange-specific arguments such as limit, count, start_time or end_time.

查询成交记录。

Some venues use this for public recent trades, while gateway adapters may map it to account fills. Callers that require real account fees should prefer :meth:get_deals when the feed supports it.

查询余额 :param exchange_name: 交易所标识 :param symbol: 币种 (None 表示全部)

查询账户信息 :param exchange_name: 交易所标识 :param symbol: 币种

查询持仓 :param exchange_name: 交易所标识 :param symbol: 交易对 (None 表示所有品种)

Return a read-only capability report for the given exchange.

Reconcile a ZMQ command after :class:CommandResultUnknownError.

Direct feeds have no shared forwarding receipt store, so callers must use their native venue query semantics in that transport mode.

从所有已连接的交易所获取行情 :param symbol: 交易对 :return: dict {exchange_name: ticker_data 或 Exception}

从所有已连接的交易所查询余额 :return: dict {exchange_name: balance_data 或 Exception}

Aggregate normalized accounts only when all values share a currency.

A supplied snapshot avoids issuing the same account requests twice. No currency conversion or partial-success aggregation is implied.

从所有已连接的交易所查询持仓 :return: dict {exchange_name: position_data 或 Exception}

撤销所有已连接交易所的所有订单 :return: dict {exchange_name: result 或 Exception}