@compass-labs/api-sdk 2.2.92 → 2.2.93

package/docs/models/components/globalmarketsperpsactivityresponse.md

@@ -1,49 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# GlobalMarketsPerpsApproveBuilderFeeRequest
-
-Request to approve builder fees before trading on the global markets perps DEX.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsApproveBuilderFeeRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsApproveBuilderFeeRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  builder: {
-    address: "0x88806A71D74AD0a510B350545C9AE490912F0888",
-    maxFeeRate: "0.01%",
-  },
-};
-```
-
-## Fields
-
-| Field                                                    | Type                                                     | Required                                                 | Description                                              | Example                                                  |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `owner`                                                  | *string*                                                 | :heavy_check_mark:                                       | User's EOA address                                       | 0x06A9aF046187895AcFc7258450B15397CAc67400               |
-| `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

@@ -1,23 +0,0 @@
-# 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/globalmarketsperpscancelorderrequest.md

@@ -1,24 +0,0 @@
-# GlobalMarketsPerpsCancelOrderRequest
-
-Request to cancel an open order on a global markets perps market.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsCancelOrderRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsCancelOrderRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  asset: "AAPL",
-  orderId: 12345,
-};
-```
-
-## Fields
-
-| Field                                               | Type                                                | Required                                            | Description                                         | Example                                             |
-| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
-| `owner`                                             | *string*                                            | :heavy_check_mark:                                  | Owner of the global markets perps product account   | 0x06A9aF046187895AcFc7258450B15397CAc67400          |
-| `asset`                                             | *string*                                            | :heavy_check_mark:                                  | Asset ticker symbol (e.g. AAPL, GOLD, EUR)          | AAPL                                                |
-| `orderId`                                           | *number*                                            | :heavy_minus_sign:                                  | Hyperliquid order ID to cancel                      | 12345                                               |
-| `clientOrderId`                                     | *number*                                            | :heavy_minus_sign:                                  | Client order ID to cancel (alternative to order_id) |                                                     |

package/docs/models/components/globalmarketsperpscandlesresponse.md

@@ -1,23 +0,0 @@
-# GlobalMarketsPerpsCandlesResponse
-
-OHLCV candle series for a single asset/interval.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsCandlesResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsCandlesResponse = {
-  symbol: "<value>",
-  interval: "<value>",
-  candles: [],
-};
-```
-
-## Fields
-
-| Field                                                    | Type                                                     | Required                                                 | Description                                              |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `symbol`                                                 | *string*                                                 | :heavy_check_mark:                                       | Asset ticker the candles are for (without DEX prefix)    |
-| `interval`                                               | *string*                                                 | :heavy_check_mark:                                       | Candle interval that was requested                       |
-| `candles`                                                | [components.Candle](../../models/components/candle.md)[] | :heavy_check_mark:                                       | Candles ordered oldest → newest                          |

package/docs/models/components/globalmarketsperpscategory.md

@@ -1,15 +0,0 @@
-# GlobalMarketsPerpsCategory
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsCategory } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsCategory = "forex";
-```
-
-## Values
-
-```typescript
-"stock" | "commodity" | "forex"
-```

package/docs/models/components/globalmarketsperpsdepositrequest.md

@@ -1,21 +0,0 @@
-# GlobalMarketsPerpsDepositRequest
-
-Request to deposit USDC from Arbitrum into the user's global markets perps account.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsDepositRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsDepositRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  amount: "100.0",
-};
-```
-
-## Fields
-
-| Field                                                  | Type                                                   | Required                                               | Description                                            | Example                                                |
-| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
-| `owner`                                                | *string*                                               | :heavy_check_mark:                                     | The user's EOA address on Arbitrum                     | 0x06A9aF046187895AcFc7258450B15397CAc67400             |
-| `amount`                                               | *string*                                               | :heavy_check_mark:                                     | USDC amount to deposit (human-readable, e.g. '1000.0') | 100.0                                                  |

package/docs/models/components/globalmarketsperpsdepositresponse.md

@@ -1,56 +0,0 @@
-# GlobalMarketsPerpsDepositResponse
-
-EIP-2612 permit data the user signs to authorize a USDC bridge deposit.
-
-After signing, submit the signature to /v2/global_markets_perps/deposit/sponsor_prepare
-to get a ready-to-broadcast Arbitrum tx that calls Bridge2.batchedDepositWithPermit.
-The integrator's sponsor wallet broadcasts that tx — Compass does not broadcast.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsDepositResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsDepositResponse = {
-  permit: {
-    domain: {
-      name: "<value>",
-      version: "<value>",
-      chainId: 499115,
-      verifyingContract: "<value>",
-    },
-    types: {
-      eip712Domain: [
-        {
-          name: "<value>",
-          type: "<value>",
-        },
-      ],
-      permit: [
-        {
-          name: "<value>",
-          type: "<value>",
-        },
-      ],
-    },
-    primaryType: "Permit",
-    message: {
-      owner: "<value>",
-      spender: "<value>",
-      value: "<value>",
-      nonce: "<value>",
-      deadline: "<value>",
-    },
-  },
-  amountRaw: 287851,
-  destination: "<value>",
-};
-```
-
-## Fields
-
-| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `permit`                                                                                                       | [components.PermitTypedDataResponseOutput](../../models/components/permittypeddataresponseoutput.md)           | :heavy_check_mark:                                                                                             | Response containing EIP-712 typed data for ERC-20 Permit signing.                                              |
-| `amountRaw`                                                                                                    | *number*                                                                                                       | :heavy_check_mark:                                                                                             | USDC amount in raw 6-decimal units. Pass this and the signature to /deposit/sponsor_prepare.                   |
-| `destination`                                                                                                  | *string*                                                                                                       | :heavy_check_mark:                                                                                             | Address that will be credited on Hyperliquid (equals the deposit owner EOA — HL keys accounts by EVM address). |

package/docs/models/components/globalmarketsperpsdepositsponsorpreparerequest.md

@@ -1,32 +0,0 @@
-# GlobalMarketsPerpsDepositSponsorPrepareRequest
-
-Take a user's signed EIP-2612 USDC permit and build an Arbitrum tx
-that calls Bridge2.batchedDepositWithPermit.
-
-The customer broadcasts the returned tx from their own sponsor wallet —
-Compass does not hold gas keys (non-custodial).
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsDepositSponsorPrepareRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsDepositSponsorPrepareRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  amountRaw: 100000000,
-  deadline: 1747097383,
-  signature:
-    "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
-  sender: "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
-};
-```
-
-## Fields
-
-| Field                                                                                                                                | Type                                                                                                                                 | Required                                                                                                                             | Description                                                                                                                          | Example                                                                                                                              |
-| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
-| `owner`                                                                                                                              | *string*                                                                                                                             | :heavy_check_mark:                                                                                                                   | The user's EOA address on Arbitrum (the permit signer).                                                                              | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                           |
-| `amountRaw`                                                                                                                          | *number*                                                                                                                             | :heavy_check_mark:                                                                                                                   | USDC amount in raw 6-decimal units, as returned by /deposit.                                                                         | 100000000                                                                                                                            |
-| `deadline`                                                                                                                           | *number*                                                                                                                             | :heavy_check_mark:                                                                                                                   | Permit deadline (unix seconds), as returned in the permit.message from /deposit.                                                     | 1747097383                                                                                                                           |
-| `signature`                                                                                                                          | *string*                                                                                                                             | :heavy_check_mark:                                                                                                                   | The user's EIP-2612 permit signature (65-byte hex, 0x-prefixed or raw).                                                              | 0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 |
-| `sender`                                                                                                                             | *string*                                                                                                                             | :heavy_check_mark:                                                                                                                   | Sponsor wallet address that will broadcast the returned tx (used for `from` and nonce).                                              | 0x4A83b4413CF41C3244027e1590E35a0F48403F0c                                                                                           |

package/docs/models/components/globalmarketsperpsdepositsponsorprepareresponse.md

@@ -1,33 +0,0 @@
-# GlobalMarketsPerpsDepositSponsorPrepareResponse
-
-Fully-encoded Arbitrum tx that completes a HL Bridge2 deposit.
-
-Broadcast `transaction` from the `sender` wallet supplied in the request.
-After the receipt confirms, verify a USDC `Transfer` event was emitted —
-Bridge2 can silently no-op without reverting.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsDepositSponsorPrepareResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsDepositSponsorPrepareResponse = {
-  transaction: {
-    chainId: "<id>",
-    data: "<value>",
-    from: "<value>",
-    gas: "<value>",
-    to: "<value>",
-    value: "<value>",
-    nonce: "<value>",
-    maxFeePerGas: "<value>",
-    maxPriorityFeePerGas: "<value>",
-  },
-};
-```
-
-## Fields
-
-| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | N/A                                                                              |

package/docs/models/components/globalmarketsperpsenableunifiedaccountrequest.md

@@ -1,19 +0,0 @@
-# GlobalMarketsPerpsEnableUnifiedAccountRequest
-
-Request to enable unified account mode on Hyperliquid.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsEnableUnifiedAccountRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsEnableUnifiedAccountRequest = {
-  owner: "<value>",
-};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `owner`            | *string*           | :heavy_check_mark: | User's EOA address |

package/docs/models/components/globalmarketsperpsenableunifiedaccountresponse.md

@@ -1,25 +0,0 @@
-# GlobalMarketsPerpsEnableUnifiedAccountResponse
-
-Returned by the enable_unified_account endpoint.
-
-If the account is already in unified mode, typed_data/action/nonce are null.
-If not, they contain the EIP-712 payload the user must sign.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsEnableUnifiedAccountResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsEnableUnifiedAccountResponse = {
-  mode: "<value>",
-};
-```
-
-## Fields
-
-| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `mode`                                                                | *string*                                                              | :heavy_check_mark:                                                    | Current account abstraction mode (e.g. 'default', 'unifiedAccount')   |
-| `typedData`                                                           | Record<string, *any*>                                                 | :heavy_minus_sign:                                                    | EIP-712 typed data for wallet signing, or null if already unified     |
-| `action`                                                              | Record<string, *any*>                                                 | :heavy_minus_sign:                                                    | Raw Hyperliquid action (passed back to the execute endpoint), or null |
-| `nonce`                                                               | *number*                                                              | :heavy_minus_sign:                                                    | Timestamp-based nonce, or null if no action needed                    |

package/docs/models/components/globalmarketsperpsensureleveragerequest.md

@@ -1,21 +0,0 @@
-# GlobalMarketsPerpsEnsureLeverageRequest
-
-Request to check and set leverage to 1x cross on a global markets perps asset.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsEnsureLeverageRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsEnsureLeverageRequest = {
-  owner: "<value>",
-  asset: "<value>",
-};
-```
-
-## Fields
-
-| Field                            | Type                             | Required                         | Description                      |
-| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
-| `owner`                          | *string*                         | :heavy_check_mark:               | User's EOA address               |
-| `asset`                          | *string*                         | :heavy_check_mark:               | Asset ticker (e.g. 'AAPL', 'CL') |

package/docs/models/components/globalmarketsperpsensureleverageresponse.md

@@ -1,25 +0,0 @@
-# GlobalMarketsPerpsEnsureLeverageResponse
-
-Returned by the ensure_leverage endpoint.
-
-If the asset is already at 1x cross leverage, typed_data/action/nonce are null.
-If not (or no position exists), they contain the EIP-712 payload the user must sign.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsEnsureLeverageResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsEnsureLeverageResponse = {
-  leverageOk: false,
-};
-```
-
-## Fields
-
-| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `leverageOk`                                                          | *boolean*                                                             | :heavy_check_mark:                                                    | True if leverage is already 1x cross, false if update needed          |
-| `typedData`                                                           | Record<string, *any*>                                                 | :heavy_minus_sign:                                                    | EIP-712 typed data for wallet signing, or null if already 1x cross    |
-| `action`                                                              | Record<string, *any*>                                                 | :heavy_minus_sign:                                                    | Raw Hyperliquid action (passed back to the execute endpoint), or null |
-| `nonce`                                                               | *number*                                                              | :heavy_minus_sign:                                                    | Timestamp-based nonce, or null if no action needed                    |

package/docs/models/components/globalmarketsperpsexecuterequest.md

@@ -1,27 +0,0 @@
-# GlobalMarketsPerpsExecuteRequest
-
-Submit a signed Hyperliquid action for execution.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsExecuteRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsExecuteRequest = {
-  action: {
-    "key": "<value>",
-    "key1": "<value>",
-  },
-  nonce: 117197,
-  signature: "<value>",
-};
-```
-
-## Fields
-
-| Field                                        | Type                                         | Required                                     | Description                                  |
-| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
-| `action`                                     | Record<string, *any*>                        | :heavy_check_mark:                           | Raw Hyperliquid action from the prepare step |
-| `nonce`                                      | *number*                                     | :heavy_check_mark:                           | Nonce from the prepare step                  |
-| `signature`                                  | *string*                                     | :heavy_check_mark:                           | User's EIP-712 signature (hex, 65 bytes)     |
-| `vaultAddress`                               | *string*                                     | :heavy_minus_sign:                           | Optional vault address                       |

package/docs/models/components/globalmarketsperpsexecuteresponse.md

@@ -1,20 +0,0 @@
-# GlobalMarketsPerpsExecuteResponse
-
-Returned after submitting a signed action to the Hyperliquid exchange.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsExecuteResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsExecuteResponse = {
-  status: "<value>",
-};
-```
-
-## Fields
-
-| Field                                            | Type                                             | Required                                         | Description                                      |
-| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
-| `status`                                         | *string*                                         | :heavy_check_mark:                               | 'ok' or 'error'                                  |
-| `response`                                       | Record<string, *any*>                            | :heavy_minus_sign:                               | Hyperliquid response data (order statuses, etc.) |

package/docs/models/components/globalmarketsperpsfill.md

@@ -1,33 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,33 +0,0 @@
-# GlobalMarketsPerpsLimitOrderRequest
-
-Request to place a limit order on a global markets perps market.
-
-## Example Usage
-
-```typescript
-import { GlobalMarketsPerpsLimitOrderRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: GlobalMarketsPerpsLimitOrderRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  asset: "AAPL",
-  side: "buy",
-  size: "10.0",
-  price: "190.00",
-  timeInForce: "gtc",
-  reduceOnly: false,
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                                         |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `owner`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                              | Owner of the global markets perps product account                                                                                                                                                                                                               | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                                      |
-| `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. |                                                                                                                                                                                                                                                                 |