npm - @compass-labs/api-sdk - Versions diffs - 2.2.52-rc.0 → 2.2.53-rc.0 - Mend

@compass-labs/api-sdk 2.2.52-rc.0 → 2.2.53-rc.0

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.

Files changed (241) hide show

package/dist/esm/sdk/globalmarketsperps.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"globalmarketsperps.js","sourceRoot":"","sources":["../../../src/sdk/globalmarketsperps.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,qDAAqD,EAAE,MAAM,mEAAmE,CAAC;AAC1I,OAAO,EAAE,+CAA+C,EAAE,MAAM,6DAA6D,CAAC;AAC9H,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,wDAAwD,EAAE,MAAM,sEAAsE,CAAC;AAChJ,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,8CAA8C,EAAE,MAAM,4DAA4D,CAAC;AAC5H,OAAO,EAAE,+CAA+C,EAAE,MAAM,6DAA6D,CAAC;AAC9H,OAAO,EAAE,iDAAiD,EAAE,MAAM,+DAA+D,CAAC;AAClI,OAAO,EAAE,6CAA6C,EAAE,MAAM,2DAA2D,CAAC;AAC1H,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,+BAA+B,CACnC,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,iDAAiD,CAClE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,6CAA6C,CAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+CAA+C,CAChE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,8CAA8C,CAC/D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+CAA+C,CAChE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;OASG~~;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mCAAmC,CACvC,OAA8D,EAC9D,OAAwB;QAExB,OAAO,WAAW,CAAC,qDAAqD,CACtE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sCAAsC,CAC1C,OAAiE,EACjE,OAAwB;QAExB,OAAO,WAAW,CAAC,wDAAwD,CACzE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,kDAAkD,CACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1	+ {"version":3,"file":"globalmarketsperps.js","sourceRoot":"","sources":["../../../src/sdk/globalmarketsperps.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,qDAAqD,EAAE,MAAM,mEAAmE,CAAC;AAC1I,OAAO,EAAE,+CAA+C,EAAE,MAAM,6DAA6D,CAAC;AAC9H,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,wDAAwD,EAAE,MAAM,sEAAsE,CAAC;AAChJ,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,8CAA8C,EAAE,MAAM,4DAA4D,CAAC;AAC5H,OAAO,EAAE,+CAA+C,EAAE,MAAM,6DAA6D,CAAC;AAC9H,OAAO,EAAE,iDAAiD,EAAE,MAAM,+DAA+D,CAAC;AAClI,OAAO,EAAE,6CAA6C,EAAE,MAAM,2DAA2D,CAAC;AAC1H,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,+BAA+B,CACnC,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,iDAAiD,CAClE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,6CAA6C,CAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+CAA+C,CAChE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,8CAA8C,CAC/D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+CAA+C,CAChE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mCAAmC,CACvC,OAA8D,EAC9D,OAAwB;QAExB,OAAO,WAAW,CAAC,qDAAqD,CACtE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sCAAsC,CAC1C,OAAiE,EACjE,OAAwB;QAExB,OAAO,WAAW,CAAC,wDAAwD,CACzE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,kDAAkD,CACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/models/components/builder.md ADDED Viewed

@@ -0,0 +1,21 @@
+# Builder
+Builder address + max fee rate the end-user authorizes.
+## Example Usage
+```typescript
+import { Builder } from "@compass-labs/api-sdk/models/components";
+let value: Builder = {
+  address: "7649 Klein Brooks",
+  maxFeeRate: "<value>",
+};
+```
+## Fields
+| Field                                                                                                                                                 | Type                                                                                                                                                  | Required                                                                                                                                              | Description                                                                                                                                           |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `address`                                                                                                                                             | *string*                                                                                                                                              | :heavy_check_mark:                                                                                                                                    | Builder address that receives the fee. The address must hold ≥100 USDC on Hyperliquid perps and must not be the zero address.                         |
+| `maxFeeRate`                                                                                                                                          | *string*                                                                                                                                              | :heavy_check_mark:                                                                                                                                    | Maximum fee rate the end-user authorizes for this builder, in Hyperliquid grammar (e.g. '0.01%'). Must end with '%' and parse to a value in [0, 100]. |

package/docs/models/components/globalmarketsperpsactivitypartialerror.md ADDED Viewed

@@ -0,0 +1,21 @@
+# GlobalMarketsPerpsActivityPartialError
+One section of /activity failed to load.
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsActivityPartialError } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsActivityPartialError = {
+  section: "fills",
+  message: "<value>",
+};
+```
+## Fields
+| Field                                                    | Type                                                     | Required                                                 | Description                                              |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `section`                                                | [components.Section](../../models/components/section.md) | :heavy_check_mark:                                       | N/A                                                      |
+| `message`                                                | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |

package/docs/models/components/globalmarketsperpsactivityresponse.md ADDED Viewed

@@ -0,0 +1,49 @@
+# GlobalMarketsPerpsActivityResponse
+Aggregated HL activity for a single end-user.
+Any section may be ``null`` if its upstream HL call failed — see
+``partial_errors`` for details. ``positions``/``fills``/``open_orders``
+are always either a populated list or ``null``; an empty list means the
+user has no activity of that type, not a failure.
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsActivityResponse } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsActivityResponse = {
+  owner: "<value>",
+  positions: [
+    {
+      asset: "<value>",
+      assetId: 772034,
+      side: "short",
+      size: "<value>",
+      entryPrice: "<value>",
+      markPrice: "<value>",
+      unrealizedPnl: "<value>",
+      leverage: "<value>",
+      marginUsed: "<value>",
+      fundingAccrued: "<value>",
+    },
+  ],
+  accountValue: "<value>",
+  withdrawable: "<value>",
+  fills: [],
+  openOrders: [],
+};
+```
+## Fields
+| Field                                                                                                                    | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| `owner`                                                                                                                  | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | Owner address that was queried (checksummed)                                                                             |
+| `positions`                                                                                                              | [components.GlobalMarketsPerpsPosition](../../models/components/globalmarketsperpsposition.md)[]                         | :heavy_check_mark:                                                                                                       | Open positions (null if the upstream call failed)                                                                        |
+| `accountValue`                                                                                                           | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | Total account value in USDC (null if positions failed)                                                                   |
+| `withdrawable`                                                                                                           | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | Withdrawable USDC balance (null if positions failed)                                                                     |
+| `fills`                                                                                                                  | [components.GlobalMarketsPerpsFill](../../models/components/globalmarketsperpsfill.md)[]                                 | :heavy_check_mark:                                                                                                       | Recent fills (null if the upstream call failed)                                                                          |
+| `openOrders`                                                                                                             | [components.GlobalMarketsPerpsOpenOrder](../../models/components/globalmarketsperpsopenorder.md)[]                       | :heavy_check_mark:                                                                                                       | Resting orders (null if the upstream call failed)                                                                        |
+| `builderApproval`                                                                                                        | [components.GlobalMarketsPerpsBuilderApproval](../../models/components/globalmarketsperpsbuilderapproval.md)             | :heavy_minus_sign:                                                                                                       | Builder approval state — only present when the `builder` query parameter was supplied (null on upstream failure).        |
+| `partialErrors`                                                                                                          | [components.GlobalMarketsPerpsActivityPartialError](../../models/components/globalmarketsperpsactivitypartialerror.md)[] | :heavy_minus_sign:                                                                                                       | One entry per section that failed to load.                                                                               |

package/docs/models/components/globalmarketsperpsapprovebuilderfeerequest.md CHANGED Viewed

@@ -8,12 +8,17 @@ Request to approve builder fees before trading on the global markets perps DEX.
 import { GlobalMarketsPerpsApproveBuilderFeeRequest } from "@compass-labs/api-sdk/models/components";
 let value: GlobalMarketsPerpsApproveBuilderFeeRequest = {
-  owner: "<value>",
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  builder: {
+    address: "0x88806A71D74AD0a510B350545C9AE490912F0888",
+    maxFeeRate: "0.01%",
+  },
 };
 ```
 ## Fields
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `owner`            | *string*           | :heavy_check_mark: | User's EOA address |
+| Field                                                    | Type                                                     | Required                                                 | Description                                              | Example                                                  |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `owner`                                                  | *string*                                                 | :heavy_check_mark:                                       | User's EOA address                                       | 0x01E62835dd7F52173546A325294762143eE4a882               |
+| `builder`                                                | [components.Builder](../../models/components/builder.md) | :heavy_check_mark:                                       | Builder address + max fee rate the end-user authorizes.  |                                                          |

package/docs/models/components/globalmarketsperpsbuilderapproval.md ADDED Viewed

@@ -0,0 +1,23 @@
+# GlobalMarketsPerpsBuilderApproval
+Current builder-fee approval state for a (user, builder) pair.
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsBuilderApproval } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsBuilderApproval = {
+  builder: "<value>",
+  maxFeeTenthBps: 311008,
+  approved: false,
+};
+```
+## Fields
+| Field                                                                                                                                        | Type                                                                                                                                         | Required                                                                                                                                     | Description                                                                                                                                  |
+| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `builder`                                                                                                                                    | *string*                                                                                                                                     | :heavy_check_mark:                                                                                                                           | Builder address that was queried                                                                                                             |
+| `maxFeeTenthBps`                                                                                                                             | *number*                                                                                                                                     | :heavy_check_mark:                                                                                                                           | Maximum fee rate the user has approved for this builder, in tenths of basis points (10 = 1bp = 0.01%). Zero means the user has not approved. |
+| `approved`                                                                                                                                   | *boolean*                                                                                                                                    | :heavy_check_mark:                                                                                                                           | Convenience flag — true when max_fee_tenth_bps > 0                                                                                           |

package/docs/models/components/globalmarketsperpsfill.md ADDED Viewed

@@ -0,0 +1,33 @@
+# GlobalMarketsPerpsFill
+A single fill (executed trade) from HL `userFills`.
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsFill } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsFill = {
+  asset: "<value>",
+  side: "sell",
+  price: "428.45",
+  size: "<value>",
+  fee: "<value>",
+  orderId: 891891,
+  timeMs: 85491,
+};
+```
+## Fields
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `asset`                                                                                        | *string*                                                                                       | :heavy_check_mark:                                                                             | Asset ticker symbol (xyz prefix stripped)                                                      |
+| `side`                                                                                         | [components.GlobalMarketsPerpsFillSide](../../models/components/globalmarketsperpsfillside.md) | :heavy_check_mark:                                                                             | Order side                                                                                     |
+| `price`                                                                                        | *string*                                                                                       | :heavy_check_mark:                                                                             | Fill price                                                                                     |
+| `size`                                                                                         | *string*                                                                                       | :heavy_check_mark:                                                                             | Fill size in contracts                                                                         |
+| `fee`                                                                                          | *string*                                                                                       | :heavy_check_mark:                                                                             | Total fee paid (USDC)                                                                          |
+| `builderFee`                                                                                   | *string*                                                                                       | :heavy_minus_sign:                                                                             | Portion of fee routed to the builder address (USDC)                                            |
+| `closedPnl`                                                                                    | *string*                                                                                       | :heavy_minus_sign:                                                                             | Realized PnL closed by this fill (USDC)                                                        |
+| `orderId`                                                                                      | *number*                                                                                       | :heavy_check_mark:                                                                             | HL order id (oid) this fill belongs to                                                         |
+| `timeMs`                                                                                       | *number*                                                                                       | :heavy_check_mark:                                                                             | Fill timestamp (ms since epoch)                                                                |

package/docs/models/components/globalmarketsperpsfillside.md ADDED Viewed

@@ -0,0 +1,17 @@
+# GlobalMarketsPerpsFillSide
+Order side
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsFillSide } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsFillSide = "buy";
+```
+## Values
+```typescript
+"buy" | "sell"
+```

package/docs/models/components/globalmarketsperpslimitorderrequest.md CHANGED Viewed

@@ -20,13 +20,14 @@ let value: GlobalMarketsPerpsLimitOrderRequest = {
 ## Fields
-| Field                                                                | Type                                                                 | Required                                                             | Description                                                          | Example                                                              |
-| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `owner`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Owner of the global markets perps product account                    | 0x01E62835dd7F52173546A325294762143eE4a882                           |
-| `asset`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Asset ticker symbol (e.g. AAPL, GOLD, EUR)                           | AAPL                                                                 |
-| `side`                                                               | *string*                                                             | :heavy_check_mark:                                                   | Order side: 'buy' or 'sell'                                          | buy                                                                  |
-| `size`                                                               | *string*                                                             | :heavy_check_mark:                                                   | Number of contracts (human-readable)                                 | 10.0                                                                 |
-| `price`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Limit price (human-readable)                                         | 190.00                                                               |
-| `timeInForce`                                                        | *string*                                                             | :heavy_minus_sign:                                                   | Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only) | gtc                                                                  |
-| `reduceOnly`                                                         | *boolean*                                                            | :heavy_minus_sign:                                                   | If true, order can only reduce an existing position                  | false                                                                |
-| `clientOrderId`                                                      | *number*                                                             | :heavy_minus_sign:                                                   | Optional client order ID for idempotency (uint128)                   |                                                                      |
+| Field                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Owner of the global markets perps product account                                                                                                                                                                                                               | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                                                                                                                                                      |
+| `asset`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Asset ticker symbol (e.g. AAPL, GOLD, EUR)                                                                                                                                                                                                                      | AAPL                                                                                                                                                                                                                                                            |
+| `side`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Order side: 'buy' or 'sell'                                                                                                                                                                                                                                     | buy                                                                                                                                                                                                                                                             |
+| `size`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Number of contracts (human-readable)                                                                                                                                                                                                                            | 10.0                                                                                                                                                                                                                                                            |
+| `price`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Limit price (human-readable)                                                                                                                                                                                                                                    | 190.00                                                                                                                                                                                                                                                          |
+| `timeInForce`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only)                                                                                                                                                                                            | gtc                                                                                                                                                                                                                                                             |
+| `reduceOnly`                                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                              | If true, order can only reduce an existing position                                                                                                                                                                                                             | false                                                                                                                                                                                                                                                           |
+| `clientOrderId`                                                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Optional client order ID for idempotency (uint128)                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                 |
+| `builder`                                                                                                                                                                                                                                                       | [components.Builder](../../models/components/builder.md)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Optional builder fee. When provided, the order action carries the builder address and fee — the end-user must have already approved this builder via /approve_builder_fee up to at least this rate. Omit (or pass null) to place the order with no builder fee. |                                                                                                                                                                                                                                                                 |

package/docs/models/components/globalmarketsperpsmarketorderrequest.md CHANGED Viewed

@@ -19,11 +19,12 @@ let value: GlobalMarketsPerpsMarketOrderRequest = {
 ## Fields
-| Field                                               | Type                                                | Required                                            | Description                                         | Example                                             |
-| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
-| `owner`                                             | *string*                                            | :heavy_check_mark:                                  | Owner of the global markets perps product account   | 0x01E62835dd7F52173546A325294762143eE4a882          |
-| `asset`                                             | *string*                                            | :heavy_check_mark:                                  | Asset ticker symbol (e.g. AAPL, GOLD, EUR)          | AAPL                                                |
-| `side`                                              | *string*                                            | :heavy_check_mark:                                  | Order side: 'buy' or 'sell'                         | buy                                                 |
-| `size`                                              | *string*                                            | :heavy_check_mark:                                  | Number of contracts (human-readable)                | 10.0                                                |
-| `slippagePercent`                                   | *number*                                            | :heavy_minus_sign:                                  | Max slippage percentage for price protection        | 1                                                   |
-| `reduceOnly`                                        | *boolean*                                           | :heavy_minus_sign:                                  | If true, order can only reduce an existing position | false                                               |
+| Field                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Owner of the global markets perps product account                                                                                                                                                                                                               | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                                                                                                                                                      |
+| `asset`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Asset ticker symbol (e.g. AAPL, GOLD, EUR)                                                                                                                                                                                                                      | AAPL                                                                                                                                                                                                                                                            |
+| `side`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Order side: 'buy' or 'sell'                                                                                                                                                                                                                                     | buy                                                                                                                                                                                                                                                             |
+| `size`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Number of contracts (human-readable)                                                                                                                                                                                                                            | 10.0                                                                                                                                                                                                                                                            |
+| `slippagePercent`                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Max slippage percentage for price protection                                                                                                                                                                                                                    | 1                                                                                                                                                                                                                                                               |
+| `reduceOnly`                                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                              | If true, order can only reduce an existing position                                                                                                                                                                                                             | false                                                                                                                                                                                                                                                           |
+| `builder`                                                                                                                                                                                                                                                       | [components.Builder](../../models/components/builder.md)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                              | Optional builder fee. When provided, the order action carries the builder address and fee — the end-user must have already approved this builder via /approve_builder_fee up to at least this rate. Omit (or pass null) to place the order with no builder fee. |                                                                                                                                                                                                                                                                 |

package/docs/models/components/globalmarketsperpsopenorder.md ADDED Viewed

@@ -0,0 +1,31 @@
+# GlobalMarketsPerpsOpenOrder
+A single resting order from HL `openOrders`.
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsOpenOrder } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsOpenOrder = {
+  asset: "<value>",
+  side: "buy",
+  limitPrice: "<value>",
+  size: "<value>",
+  orderId: 617836,
+  timeMs: 778957,
+  reduceOnly: false,
+};
+```
+## Fields
+| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
+| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| `asset`                                                                                                  | *string*                                                                                                 | :heavy_check_mark:                                                                                       | Asset ticker symbol (xyz prefix stripped)                                                                |
+| `side`                                                                                                   | [components.GlobalMarketsPerpsOpenOrderSide](../../models/components/globalmarketsperpsopenorderside.md) | :heavy_check_mark:                                                                                       | Order side                                                                                               |
+| `limitPrice`                                                                                             | *string*                                                                                                 | :heavy_check_mark:                                                                                       | Limit price                                                                                              |
+| `size`                                                                                                   | *string*                                                                                                 | :heavy_check_mark:                                                                                       | Order size in contracts                                                                                  |
+| `orderId`                                                                                                | *number*                                                                                                 | :heavy_check_mark:                                                                                       | HL order id (oid)                                                                                        |
+| `timeMs`                                                                                                 | *number*                                                                                                 | :heavy_check_mark:                                                                                       | Order timestamp (ms since epoch)                                                                         |
+| `reduceOnly`                                                                                             | *boolean*                                                                                                | :heavy_check_mark:                                                                                       | True if order can only reduce position                                                                   |

package/docs/models/components/globalmarketsperpsopenorderside.md ADDED Viewed

@@ -0,0 +1,17 @@
+# GlobalMarketsPerpsOpenOrderSide
+Order side
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsOpenOrderSide } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsOpenOrderSide = "buy";
+```
+## Values
+```typescript
+"buy" | "sell"
+```

package/docs/models/components/globalmarketsperpsposition.md CHANGED Viewed

@@ -23,16 +23,16 @@ let value: GlobalMarketsPerpsPosition = {
 ## Fields
-| Field                                              | Type                                               | Required                                           | Description                                        |
-| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
-| `asset`                                            | *string*                                           | :heavy_check_mark:                                 | Asset ticker symbol                                |
-| `assetId`                                          | *number*                                           | :heavy_check_mark:                                 | Hyperliquid asset index                            |
-| `side`                                             | [components.Side](../../models/components/side.md) | :heavy_check_mark:                                 | Position side: 'long' or 'short'                   |
-| `size`                                             | *string*                                           | :heavy_check_mark:                                 | Position size in contracts                         |
-| `entryPrice`                                       | *string*                                           | :heavy_check_mark:                                 | Average entry price                                |
-| `markPrice`                                        | *string*                                           | :heavy_check_mark:                                 | Current mark price                                 |
-| `liquidationPrice`                                 | *string*                                           | :heavy_minus_sign:                                 | Estimated liquidation price                        |
-| `unrealizedPnl`                                    | *string*                                           | :heavy_check_mark:                                 | Unrealized PnL in USD                              |
-| `leverage`                                         | *string*                                           | :heavy_check_mark:                                 | Current leverage                                   |
-| `marginUsed`                                       | *string*                                           | :heavy_check_mark:                                 | Margin used for this position in USD               |
-| `fundingAccrued`                                   | *string*                                           | :heavy_check_mark:                                 | Cumulative funding payments (negative = paid)      |
+| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `asset`                                                                                                | *string*                                                                                               | :heavy_check_mark:                                                                                     | Asset ticker symbol                                                                                    |
+| `assetId`                                                                                              | *number*                                                                                               | :heavy_check_mark:                                                                                     | Hyperliquid asset index                                                                                |
+| `side`                                                                                                 | [components.GlobalMarketsPerpsPositionSide](../../models/components/globalmarketsperpspositionside.md) | :heavy_check_mark:                                                                                     | Position side: 'long' or 'short'                                                                       |
+| `size`                                                                                                 | *string*                                                                                               | :heavy_check_mark:                                                                                     | Position size in contracts                                                                             |
+| `entryPrice`                                                                                           | *string*                                                                                               | :heavy_check_mark:                                                                                     | Average entry price                                                                                    |
+| `markPrice`                                                                                            | *string*                                                                                               | :heavy_check_mark:                                                                                     | Current mark price                                                                                     |
+| `liquidationPrice`                                                                                     | *string*                                                                                               | :heavy_minus_sign:                                                                                     | Estimated liquidation price                                                                            |
+| `unrealizedPnl`                                                                                        | *string*                                                                                               | :heavy_check_mark:                                                                                     | Unrealized PnL in USD                                                                                  |
+| `leverage`                                                                                             | *string*                                                                                               | :heavy_check_mark:                                                                                     | Current leverage                                                                                       |
+| `marginUsed`                                                                                           | *string*                                                                                               | :heavy_check_mark:                                                                                     | Margin used for this position in USD                                                                   |
+| `fundingAccrued`                                                                                       | *string*                                                                                               | :heavy_check_mark:                                                                                     | Cumulative funding payments (negative = paid)                                                          |

package/docs/models/components/globalmarketsperpspositionside.md ADDED Viewed

@@ -0,0 +1,17 @@
+# GlobalMarketsPerpsPositionSide
+Position side: 'long' or 'short'
+## Example Usage
+```typescript
+import { GlobalMarketsPerpsPositionSide } from "@compass-labs/api-sdk/models/components";
+let value: GlobalMarketsPerpsPositionSide = "short";
+```
+## Values
+```typescript
+"long" | "short"
+```

package/docs/models/components/section.md ADDED Viewed

@@ -0,0 +1,15 @@
+# Section
+## Example Usage
+```typescript
+import { Section } from "@compass-labs/api-sdk/models/components";
+let value: Section = "builder_approval";
+```
+## Values
+```typescript
+"positions" | "fills" | "open_orders" | "builder_approval"
+```

package/docs/models/operations/v2globalmarketsperpsactivityrequest.md ADDED Viewed

@@ -0,0 +1,18 @@
+# V2GlobalMarketsPerpsActivityRequest
+## Example Usage
+```typescript
+import { V2GlobalMarketsPerpsActivityRequest } from "@compass-labs/api-sdk/models/operations";
+let value: V2GlobalMarketsPerpsActivityRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+};
+```
+## Fields
+| Field                                                                                                                                 | Type                                                                                                                                  | Required                                                                                                                              | Description                                                                                                                           | Example                                                                                                                               |
+| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                               | *string*                                                                                                                              | :heavy_check_mark:                                                                                                                    | End-user EOA whose activity should be fetched.                                                                                        | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                            |
+| `builder`                                                                                                                             | *string*                                                                                                                              | :heavy_minus_sign:                                                                                                                    | Optional builder address. When provided, the response includes the current builder-fee approval state for this (owner, builder) pair. |                                                                                                                                       |