@stable_sea/sdk 0.2.9 → 0.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -534,10 +534,10 @@ export interface paths {
534
534
  get: operations["orders.list"];
535
535
  put?: never;
536
536
  /**
537
- * Place a fund order
538
- * @description Creates a fund order for the authenticated business and returns it as `pending`. Execution is asynchronous and uses the same authorization checks and trading engine as Terminal. Retrieve the order to follow it through `executing` to `filled` or `failed`.
537
+ * Place an order
538
+ * @description Creates an order for the authenticated business and returns it as `pending`. BTC orders require both `investments:write` and `investments:btc_write` and use standard settlement. The BTC quote is indicative; execution uses the current native price and fees. Execution is asynchronous and uses the same authorization checks and trading engine as Terminal. Retrieve the order to follow it through `executing` to `filled` or `failed`.
539
539
  *
540
- * The quoted price is checked against the NAV at execution. Price changes and insufficient express liquidity can cause execution to fail. The failed order includes a reason. While the quote remains valid, an express refusal can be submitted as a new standard order.
540
+ * Fund orders check the quoted NAV at execution. Price changes and insufficient express liquidity can cause execution to fail. The failed order includes a reason. While the quote remains valid, an express refusal can be submitted as a new standard order.
541
541
  *
542
542
  * Use a Live key with the production URL or a Test key with the sandbox URL. A credential environment this host does not serve returns `environment_not_served` before an order or idempotency record is created.
543
543
  */
@@ -628,8 +628,8 @@ export interface paths {
628
628
  cookie?: never;
629
629
  };
630
630
  /**
631
- * Price a fund trade
632
- * @description Returns a price to include when placing a fund order. Quotes are calculated on request, have no ID and cannot be retrieved later.
631
+ * Price a trade
632
+ * @description Returns an indicative price for BTC or a fund. Quotes have no ID and cannot be retrieved later. BTC prices use the latest unexpired native quote; reading one does not extend its expiry. Calculated BTC quote amounts are rounded to at most 18 decimal places. Actual trade amounts are determined at execution. BTC quotes include `platform_fee_usdc`, `fee_bps`, `net_usdc` and the `net_estimated_quantity` after the buy fee. `minimum_amount_usd` states the BTC order minimum. A BTC quote does not guarantee the execution price. Fund orders include the quoted NAV.
633
633
  *
634
634
  * `express` describes the commission, order limit, estimated quantity and settlement estimate for express settlement. These terms do not guarantee available liquidity. An express order may fail at execution; while the quote remains valid, you can submit a new standard order using the same quoted price. Standard settlement changes the commission and delivered quantity, not the quoted price.
635
635
  */
@@ -1361,7 +1361,7 @@ export interface components {
1361
1361
  }[];
1362
1362
  /** @description Human-readable explanation. Use code or type for programmatic handling. */
1363
1363
  message?: string;
1364
- /** @description RFC 6901 JSON Pointer to the first offending field (validation errors). */
1364
+ /** @description RFC 6901 JSON Pointer to the first offending field, on a validation error or a coded error about one field. */
1365
1365
  param?: string;
1366
1366
  /** @description Correlates with the Request-Id response header. */
1367
1367
  request_id?: string;
@@ -1668,23 +1668,25 @@ export interface components {
1668
1668
  /** @enum {string} */
1669
1669
  state: "pending" | "executing" | "filled" | "failed";
1670
1670
  symbol: string;
1671
+ /** @description The booked transaction, or null before a movement is committed. Retrieve it with money:read to follow settlement. A filled order means booked, not settled. */
1672
+ transaction_id: string | null;
1671
1673
  };
1672
1674
  OrderCreateInput: {
1673
- /** @description The trade size as a decimal string: USD on a buy, shares on a sell. Must be positive. */
1675
+ /** @description The trade size as a decimal string: USD on a buy, asset units on a sell. Must be positive. */
1674
1676
  amount: string;
1675
1677
  /**
1676
1678
  * @description Which side to trade.
1677
1679
  * @enum {string}
1678
1680
  */
1679
1681
  direction: "buy" | "sell";
1680
- /** @description The price_per_unit from GET /v1/quotes. Execution verifies it against the NAV the trade runs at, so a stale echo is refused rather than filled. */
1682
+ /** @description The price_per_unit from GET /v1/quotes. Fund execution checks the NAV; BTC uses an indicative price and executes at the current native price. */
1681
1683
  quoted_price: string;
1682
1684
  /**
1683
1685
  * @description Settlement mode. Express (instant) carries a commission the standard path does not; see the express terms on GET /v1/quotes. Express draws on a shared reserve, so an express order can be refused at execution and the order reaches a failed state naming why — re-place it as standard against the same unexpired quote.
1684
1686
  * @enum {string}
1685
1687
  */
1686
1688
  settlement: "standard" | "instant";
1687
- /** @description The fund ticker to trade, e.g. WTGXX. */
1689
+ /** @description The asset ticker, such as BTC or WTGXX. BTC also requires investments:btc_write. */
1688
1690
  symbol: string;
1689
1691
  };
1690
1692
  OrderList: {
@@ -1820,9 +1822,19 @@ export interface components {
1820
1822
  /** Format: date-time */
1821
1823
  expires_ts: string;
1822
1824
  express?: components["schemas"]["QuoteExpress"];
1825
+ /** @description Native BTC platform fee rate, in basis points. */
1826
+ fee_bps?: number | null;
1823
1827
  livemode: boolean;
1828
+ /** @description Minimum BTC order notional in USD, before the platform fee. */
1829
+ minimum_amount_usd?: string;
1830
+ /** @description Estimated BTC received after the buy fee. Omitted on sells. */
1831
+ net_estimated_quantity?: string | null;
1832
+ /** @description USDC allocated to a BTC buy, or estimated sell proceeds, after the fee. */
1833
+ net_usdc?: string;
1824
1834
  /** @enum {string} */
1825
1835
  object: "quote";
1836
+ /** @description Estimated native BTC platform fee in USDC. */
1837
+ platform_fee_usdc?: string;
1826
1838
  price_per_unit: string;
1827
1839
  symbol: string;
1828
1840
  };
@@ -3834,11 +3846,11 @@ export interface operations {
3834
3846
  "quotes.quote": {
3835
3847
  parameters: {
3836
3848
  query: {
3837
- /** @description The fund ticker to price, e.g. WTGXX. */
3849
+ /** @description The asset ticker to price, such as BTC or WTGXX. */
3838
3850
  symbol: string;
3839
3851
  /** @description Which side to price. */
3840
3852
  direction: "buy" | "sell";
3841
- /** @description The trade size as a decimal string: USD on a buy, shares on a sell. Must be positive. */
3853
+ /** @description The trade size as a decimal string: USD on a buy, asset units on a sell. Must be positive. */
3842
3854
  amount: string;
3843
3855
  };
3844
3856
  header?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stable_sea/sdk",
3
- "version": "0.2.9",
3
+ "version": "0.2.10",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
6
  "files": [