# Orders

## Get all orders

> Retrieve all orders for the authenticated user with optional filtering by status and order type

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaginatedOrdersResponseDto":{"type":"object","properties":{"data":{"description":"List of orders","type":"array","items":{"$ref":"#/components/schemas/OpenOrderDto"}},"total":{"type":"number","description":"Total number of matching orders"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Items per page"},"totalPages":{"type":"number","description":"Total number of pages"}},"required":["data","total","page","limit","totalPages"]},"OpenOrderDto":{"type":"object","properties":{"orderId":{"type":"string","description":"Order identifier"},"address":{"type":"string","description":"User wallet address"},"clientId":{"type":"string","description":"Client identifier","nullable":true},"positionId":{"type":"string","description":"Associated position identifier","nullable":true},"parameters":{"description":"Order parameters (varies by order type)","oneOf":[{"$ref":"#/components/schemas/MarketOrderParameters"},{"$ref":"#/components/schemas/TriggerOrderParameters"},{"$ref":"#/components/schemas/TwapOrderParameters"},{"$ref":"#/components/schemas/TpSlOrderParameters"},{"$ref":"#/components/schemas/LadderOrderParameters"}]},"orderType":{"type":"string","description":"Order type","enum":["SYNC","MARKET","TRIGGER","TWAP","LADDER","TP","SL","SPOT_MARKET","SPOT_LIMIT","SPOT_TWAP"]},"status":{"type":"string","description":"Order status","enum":["OPEN","PROCESSING","EXECUTED","CANCELLED","FAILED","PARTIALLY_FILLED"]},"longAssets":{"description":"Long assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"shortAssets":{"description":"Short assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"createdAt":{"type":"string","description":"Order creation timestamp","format":"date-time"},"updatedAt":{"type":"string","description":"Last update timestamp","format":"date-time"}},"required":["orderId","address","clientId","positionId","parameters","orderType","status","longAssets","shortAssets","createdAt","updatedAt"]},"MarketOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["usdValue"]},"TriggerOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"triggerType":{"type":"string","description":"Trigger type","enum":["PRICE","PRICE_LIMIT","PRICE_RATIO","WEIGHTED_RATIO","BTC_DOM","CROSS_ASSET_PRICE","PREDICTION_MARKET_OUTCOME","PRICE","PRICE_RATIO","WEIGHTED_RATIO","PERCENTAGE","DOLLAR","POSITION_VALUE"]},"triggerValue":{"description":"Trigger value (price or ratio)","oneOf":[{"type":"number"},{"type":"string"}]},"direction":{"type":"string","description":"Order direction","enum":["MORE_THAN","LESS_THAN"]},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"},"assetName":{"type":"string","description":"Asset name"},"marketCode":{"type":"string","description":"Market code"},"marketName":{"type":"string","description":"Market name"},"marketSource":{"type":"string","description":"Market source","enum":["KALSHI","HYPERLIQUID"]}},"required":["leverage","usdValue","triggerType","triggerValue","direction"]},"TwapOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"duration":{"type":"string","description":"TWAP duration (e.g. 5m, 1h, 24h)"},"intervalSeconds":{"type":"number","description":"Interval between chunks in seconds"},"chunkUsdValue":{"type":"number","description":"Calculated base chunk size in USD"},"randomizeExecution":{"type":"boolean","description":"Whether execution timing is randomized"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["leverage","usdValue","duration","chunkUsdValue"]},"TpSlOrderParameters":{"type":"object","properties":{"triggerType":{"type":"string","description":"TP/SL trigger type","enum":["PERCENTAGE","DOLLAR","POSITION_VALUE","PRICE","PRICE_RATIO","WEIGHTED_RATIO"]},"triggerValue":{"type":"number","description":"Trigger value"},"isTrailing":{"type":"boolean","description":"Whether this is a trailing stop"},"trailingDeltaValue":{"type":"number","description":"Trailing delta value"},"trailingActivationValue":{"type":"number","description":"Trailing activation value"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["triggerType"]},"LadderOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"ratioStart":{"type":"number","description":"Starting ratio"},"ratioEnd":{"type":"number","description":"Ending ratio"},"numberOfLevels":{"type":"number","description":"Number of ladder levels"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["leverage","usdValue","ratioStart","ratioEnd","numberOfLevels"]},"OrderAssetDto":{"type":"object","properties":{"asset":{"type":"string","description":"Asset symbol"},"weight":{"type":"number","description":"Asset weight in order"},"size":{"type":"string","description":"Order size in asset units","nullable":true},"filledSize":{"type":"string","description":"Filled size in asset units","nullable":true}},"required":["asset","weight"]}}},"paths":{"/orders":{"get":{"description":"Retrieve all orders for the authenticated user with optional filtering by status and order type","operationId":"OrdersController_getAllOrders","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (default: 1)","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Items per page (default: 50, max: 100)","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by order status","schema":{"enum":["OPEN","PROCESSING","EXECUTED","CANCELLED","FAILED","PARTIALLY_FILLED"],"type":"string"}},{"name":"orderType","required":false,"in":"query","description":"Filter by order type","schema":{"enum":["SYNC","MARKET","TRIGGER","TWAP","LADDER","TP","SL","SPOT_MARKET","SPOT_LIMIT","SPOT_TWAP"],"type":"string"}}],"responses":{"200":{"description":"Orders retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOrdersResponseDto"}}}}},"summary":"Get all orders","tags":["Orders"]}}}}
```

## DELETE /orders/{orderId}/cancel

> Cancel a pending order

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CancelOrderResponseDto":{"type":"object","properties":{"orderId":{"type":"string","description":"Order identifier","format":"uuid"},"status":{"type":"string","description":"Order status after cancellation"},"cancelledAt":{"type":"string","description":"Cancellation timestamp","format":"date-time"}},"required":["orderId","status","cancelledAt"]}}},"paths":{"/orders/{orderId}/cancel":{"delete":{"operationId":"OrdersController_cancelOrder","parameters":[{"name":"orderId","required":true,"in":"path","description":"Order identifier","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Order cancelled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrderResponseDto"}}}}},"summary":"Cancel a pending order","tags":["Orders"]}}}}
```

## POST /orders/{orderId}/twap/cancel

> Cancel a TWAP order and all its pending chunks

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CancelTwapResponseDto":{"type":"object","properties":{"orderId":{"type":"string","description":"Order identifier that was cancelled"},"status":{"type":"string","description":"Status of the cancellation operation"},"cancelledAt":{"type":"string","description":"Cancellation timestamp","format":"date-time"}},"required":["orderId","status","cancelledAt"]}}},"paths":{"/orders/{orderId}/twap/cancel":{"post":{"operationId":"OrdersController_cancelTwapOrder","parameters":[{"name":"orderId","required":true,"in":"path","description":"TWAP Order identifier","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"TWAP order cancelled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelTwapResponseDto"}}}}},"summary":"Cancel a TWAP order and all its pending chunks","tags":["Orders"]}}}}
```

## Get all open orders

> Retrieve all open orders (LIMIT, TP, SL) for the authenticated user with detailed order information including target ratios and asset allocations

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OpenOrderDto":{"type":"object","properties":{"orderId":{"type":"string","description":"Order identifier"},"address":{"type":"string","description":"User wallet address"},"clientId":{"type":"string","description":"Client identifier","nullable":true},"positionId":{"type":"string","description":"Associated position identifier","nullable":true},"parameters":{"description":"Order parameters (varies by order type)","oneOf":[{"$ref":"#/components/schemas/MarketOrderParameters"},{"$ref":"#/components/schemas/TriggerOrderParameters"},{"$ref":"#/components/schemas/TwapOrderParameters"},{"$ref":"#/components/schemas/TpSlOrderParameters"},{"$ref":"#/components/schemas/LadderOrderParameters"}]},"orderType":{"type":"string","description":"Order type","enum":["SYNC","MARKET","TRIGGER","TWAP","LADDER","TP","SL","SPOT_MARKET","SPOT_LIMIT","SPOT_TWAP"]},"status":{"type":"string","description":"Order status","enum":["OPEN","PROCESSING","EXECUTED","CANCELLED","FAILED","PARTIALLY_FILLED"]},"longAssets":{"description":"Long assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"shortAssets":{"description":"Short assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"createdAt":{"type":"string","description":"Order creation timestamp","format":"date-time"},"updatedAt":{"type":"string","description":"Last update timestamp","format":"date-time"}},"required":["orderId","address","clientId","positionId","parameters","orderType","status","longAssets","shortAssets","createdAt","updatedAt"]},"MarketOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["usdValue"]},"TriggerOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"triggerType":{"type":"string","description":"Trigger type","enum":["PRICE","PRICE_LIMIT","PRICE_RATIO","WEIGHTED_RATIO","BTC_DOM","CROSS_ASSET_PRICE","PREDICTION_MARKET_OUTCOME","PRICE","PRICE_RATIO","WEIGHTED_RATIO","PERCENTAGE","DOLLAR","POSITION_VALUE"]},"triggerValue":{"description":"Trigger value (price or ratio)","oneOf":[{"type":"number"},{"type":"string"}]},"direction":{"type":"string","description":"Order direction","enum":["MORE_THAN","LESS_THAN"]},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"},"assetName":{"type":"string","description":"Asset name"},"marketCode":{"type":"string","description":"Market code"},"marketName":{"type":"string","description":"Market name"},"marketSource":{"type":"string","description":"Market source","enum":["KALSHI","HYPERLIQUID"]}},"required":["leverage","usdValue","triggerType","triggerValue","direction"]},"TwapOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"duration":{"type":"string","description":"TWAP duration (e.g. 5m, 1h, 24h)"},"intervalSeconds":{"type":"number","description":"Interval between chunks in seconds"},"chunkUsdValue":{"type":"number","description":"Calculated base chunk size in USD"},"randomizeExecution":{"type":"boolean","description":"Whether execution timing is randomized"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["leverage","usdValue","duration","chunkUsdValue"]},"TpSlOrderParameters":{"type":"object","properties":{"triggerType":{"type":"string","description":"TP/SL trigger type","enum":["PERCENTAGE","DOLLAR","POSITION_VALUE","PRICE","PRICE_RATIO","WEIGHTED_RATIO"]},"triggerValue":{"type":"number","description":"Trigger value"},"isTrailing":{"type":"boolean","description":"Whether this is a trailing stop"},"trailingDeltaValue":{"type":"number","description":"Trailing delta value"},"trailingActivationValue":{"type":"number","description":"Trailing activation value"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["triggerType"]},"LadderOrderParameters":{"type":"object","properties":{"leverage":{"type":"number","description":"Leverage multiplier"},"usdValue":{"type":"number","description":"Order value in USD"},"ratioStart":{"type":"number","description":"Starting ratio"},"ratioEnd":{"type":"number","description":"Ending ratio"},"numberOfLevels":{"type":"number","description":"Number of ladder levels"},"reduceOnly":{"type":"boolean","description":"Whether this is a reduce-only order"}},"required":["leverage","usdValue","ratioStart","ratioEnd","numberOfLevels"]},"OrderAssetDto":{"type":"object","properties":{"asset":{"type":"string","description":"Asset symbol"},"weight":{"type":"number","description":"Asset weight in order"},"size":{"type":"string","description":"Order size in asset units","nullable":true},"filledSize":{"type":"string","description":"Filled size in asset units","nullable":true}},"required":["asset","weight"]}}},"paths":{"/orders/open":{"get":{"description":"Retrieve all open orders (LIMIT, TP, SL) for the authenticated user with detailed order information including target ratios and asset allocations","operationId":"OrdersController_getOpenOrders","parameters":[],"responses":{"200":{"description":"Open orders retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OpenOrderDto"}}}}},"404":{"description":"No open orders found"}},"summary":"Get all open orders","tags":["Orders"]}}}}
```

## Get TWAP orders with monitoring data

> Retrieve list of TWAP orders with detailed execution progress, chunk status, and fill information

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TwapMonitoringDto":{"type":"object","properties":{"orderId":{"type":"string","description":"TWAP order identifier"},"positionId":{"type":"string","description":"Associated position ID (for close orders)","nullable":true},"address":{"type":"string","description":"User wallet address"},"orderType":{"type":"string","description":"Order type (TWAP)"},"longAssets":{"description":"Long assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"shortAssets":{"description":"Short assets in the order","type":"array","items":{"$ref":"#/components/schemas/OrderAssetDto"}},"status":{"type":"string","description":"Overall order status","enum":["OPEN","EXECUTING","COMPLETED","PARTIALLY_COMPLETED","FAILED","CANCELLED"]},"totalUsdValue":{"type":"number","description":"Total order value in USD"},"filledUsdValue":{"type":"number","description":"USD value already filled"},"remainingUsdValue":{"type":"number","description":"USD value remaining to fill"},"twapDuration":{"type":"string","description":"TWAP duration setting"},"twapIntervalSeconds":{"type":"number","description":"TWAP interval in seconds (effective)","nullable":true},"twapChunkUsdValue":{"type":"number","description":"Base USD value per TWAP chunk","nullable":true},"randomizeExecution":{"type":"boolean","description":"Whether execution timing is randomized"},"reduceOnly":{"type":"boolean","description":"Is this a reduce-only order (close position)"},"chunks":{"description":"Breakdown of each execution chunk","type":"array","items":{"$ref":"#/components/schemas/TwapChunkStatusDto"}},"estimatedCompletionTime":{"type":"string","description":"Estimated completion time","format":"date-time","nullable":true},"actualCompletionTime":{"type":"string","description":"Actual completion time","format":"date-time","nullable":true},"remainingChunks":{"type":"number","description":"Number of chunks remaining to execute"},"createdAt":{"type":"string","description":"Order creation timestamp","format":"date-time"},"updatedAt":{"type":"string","description":"Last update timestamp","format":"date-time"}},"required":["orderId","positionId","address","orderType","longAssets","shortAssets","status","totalUsdValue","filledUsdValue","remainingUsdValue","twapDuration","randomizeExecution","reduceOnly","chunks","estimatedCompletionTime","actualCompletionTime","remainingChunks","createdAt","updatedAt"]},"OrderAssetDto":{"type":"object","properties":{"asset":{"type":"string","description":"Asset symbol"},"weight":{"type":"number","description":"Asset weight in order"},"size":{"type":"string","description":"Order size in asset units","nullable":true},"filledSize":{"type":"string","description":"Filled size in asset units","nullable":true}},"required":["asset","weight"]},"TwapChunkStatusDto":{"type":"object","properties":{"chunkId":{"type":"string","description":"TWAP chunk identifier"},"chunkIndex":{"type":"number","description":"Chunk index in sequence"},"scheduledTime":{"type":"string","description":"Scheduled execution time","format":"date-time"},"executedTime":{"type":"string","description":"Actual execution time","format":"date-time","nullable":true},"status":{"type":"string","description":"Chunk execution status","enum":["PENDING","SCHEDULED","EXECUTING","COMPLETED","FAILED","CANCELLED"]},"chunkSize":{"type":"number","description":"Planned chunk size in USD"},"fills":{"description":"Individual fills in this chunk","type":"array","items":{"$ref":"#/components/schemas/ChunkFillDto"}},"errorMessage":{"type":"string","description":"Error message if chunk failed","nullable":true}},"required":["chunkId","chunkIndex","scheduledTime","executedTime","status","chunkSize","fills","errorMessage"]},"ChunkFillDto":{"type":"object","properties":{"fillId":{"type":"string","description":"Fill identifier"},"assetName":{"type":"string","description":"Asset name"},"price":{"type":"number","description":"Fill price"},"size":{"type":"number","description":"Fill size"},"executedAt":{"type":"string","description":"Fill execution timestamp","format":"date-time"}},"required":["fillId","assetName","price","size","executedAt"]}}},"paths":{"/orders/twap":{"get":{"description":"Retrieve list of TWAP orders with detailed execution progress, chunk status, and fill information","operationId":"OrdersController_getTwapOrders","parameters":[],"responses":{"200":{"description":"TWAP orders with monitoring data retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TwapMonitoringDto"}}}}},"404":{"description":"No TWAP orders found"}},"summary":"Get TWAP orders with monitoring data","tags":["Orders"]}}}}
```

## POST /orders/spot

> Execute a spot order

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SpotOrderRequestDto":{"type":"object","properties":{"asset":{"type":"string","description":"Asset to buy"},"isBuy":{"type":"boolean","description":"To buy/sell Asset"},"amount":{"type":"number","description":"Asset size to buy","minimum":0.1}},"required":["asset","isBuy","amount"]},"SpotOrderResponseDto":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier for the initial order"},"status":{"type":"string","description":"Current status of the position/order","enum":["OPEN","PROCESSING","EXECUTED","CANCELLED","FAILED","PARTIALLY_FILLED"]},"createdAt":{"type":"string","description":"Creation timestamp","format":"date-time"},"asset":{"type":"string","description":"Spot Asset"},"hyperliquidResult":{"type":"object","description":"Raw response from Hyperliquid"}},"required":["orderId","status","createdAt","asset"]}}},"paths":{"/orders/spot":{"post":{"operationId":"OrdersController_spotOrder","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotOrderRequestDto"}}}},"responses":{"200":{"description":"Spot order executed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotOrderResponseDto"}}}}},"summary":"Execute a spot order","tags":["Orders"]}}}}
```

## GET /orders/triggers

> Get prediction triggers (Hyperliquid + BTC dominance)

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TriggersResponseDto":{"type":"object","properties":{"triggers":{"type":"array","items":{"$ref":"#/components/schemas/TriggerDto"}}},"required":["triggers"]},"TriggerDto":{"type":"object","properties":{"id":{"type":"string","description":"Raw market ticker / outcome id"},"category":{"type":"string","enum":["prediction_market","btcdom"]},"source":{"type":"string","enum":["kalshi","hyperliquid","coingecko"]},"oracle":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OracleValueDto"}]},"metadata":{"description":"Category-specific metadata","oneOf":[{"$ref":"#/components/schemas/MarketTriggerMetaDto"},{"$ref":"#/components/schemas/BtcDomMetaDto"}]}},"required":["id","category","source","metadata"]},"OracleValueDto":{"type":"object","properties":{"value":{"type":"number","description":"Latest oracle value"},"unit":{"type":"string","description":"Unit of the oracle value","enum":["cent","percent"]}},"required":["value","unit"]},"MarketTriggerMetaDto":{"type":"object","properties":{"kind":{"type":"string","enum":["prediction_market","btcdom"]},"type":{"type":"string","enum":["binary","multi"]},"title":{"type":"string"},"status":{"type":"string","enum":["open","closed","settled"],"nullable":true},"expiryTime":{"type":"string","nullable":true,"description":"ISO 8601 expiry time"},"imageUrl":{"type":"string","nullable":true},"popularity":{"type":"number","nullable":true,"description":"Kalshi total volume"},"outcomes":{"type":"array","items":{"$ref":"#/components/schemas/TriggerOutcomeDto"}}},"required":["kind","type","title","outcomes"]},"TriggerOutcomeDto":{"type":"object","properties":{"id":{"type":"string","description":"Tradeable outcome ticker"},"label":{"type":"string","description":"Outcome label"},"oracle":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OracleValueDto"}]},"yesSubtitle":{"type":"string","nullable":true},"noSubtitle":{"type":"string","nullable":true}},"required":["id","label"]},"BtcDomMetaDto":{"type":"object","properties":{"kind":{"type":"string","enum":["prediction_market","btcdom"]},"btcDominance":{"type":"number"},"ethDominance":{"type":"number"},"totalMarketCapUsd":{"type":"number"},"marketCapChange24hPercent":{"type":"number"},"updatedAt":{"type":"number","description":"Unix timestamp from CoinGecko"}},"required":["kind","btcDominance","ethDominance","totalMarketCapUsd","marketCapChange24hPercent","updatedAt"]}}},"paths":{"/orders/triggers":{"get":{"operationId":"OrdersController_getTriggers","parameters":[{"name":"category","required":false,"in":"query","schema":{"default":"all","type":"string","enum":["prediction_market","btcdom","all"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggersResponseDto"}}}}},"summary":"Get prediction triggers (Hyperliquid + BTC dominance)","tags":["Orders"]}}}}
```

## GET /orders/triggers/kalshi

> Get Kalshi prediction market triggers (paginated)

```json
{"openapi":"3.0.0","info":{"title":"Pear Protocol Trading API","version":"1.0.0"},"servers":[{"url":"https://hl-v2.pearprotocol.io","description":"Production (Mainnet)"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"KalshiTriggersResponseDto":{"type":"object","properties":{"triggers":{"type":"array","items":{"$ref":"#/components/schemas/TriggerDto"}},"nextCursor":{"type":"string","nullable":true}},"required":["triggers"]},"TriggerDto":{"type":"object","properties":{"id":{"type":"string","description":"Raw market ticker / outcome id"},"category":{"type":"string","enum":["prediction_market","btcdom"]},"source":{"type":"string","enum":["kalshi","hyperliquid","coingecko"]},"oracle":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OracleValueDto"}]},"metadata":{"description":"Category-specific metadata","oneOf":[{"$ref":"#/components/schemas/MarketTriggerMetaDto"},{"$ref":"#/components/schemas/BtcDomMetaDto"}]}},"required":["id","category","source","metadata"]},"OracleValueDto":{"type":"object","properties":{"value":{"type":"number","description":"Latest oracle value"},"unit":{"type":"string","description":"Unit of the oracle value","enum":["cent","percent"]}},"required":["value","unit"]},"MarketTriggerMetaDto":{"type":"object","properties":{"kind":{"type":"string","enum":["prediction_market","btcdom"]},"type":{"type":"string","enum":["binary","multi"]},"title":{"type":"string"},"status":{"type":"string","enum":["open","closed","settled"],"nullable":true},"expiryTime":{"type":"string","nullable":true,"description":"ISO 8601 expiry time"},"imageUrl":{"type":"string","nullable":true},"popularity":{"type":"number","nullable":true,"description":"Kalshi total volume"},"outcomes":{"type":"array","items":{"$ref":"#/components/schemas/TriggerOutcomeDto"}}},"required":["kind","type","title","outcomes"]},"TriggerOutcomeDto":{"type":"object","properties":{"id":{"type":"string","description":"Tradeable outcome ticker"},"label":{"type":"string","description":"Outcome label"},"oracle":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OracleValueDto"}]},"yesSubtitle":{"type":"string","nullable":true},"noSubtitle":{"type":"string","nullable":true}},"required":["id","label"]},"BtcDomMetaDto":{"type":"object","properties":{"kind":{"type":"string","enum":["prediction_market","btcdom"]},"btcDominance":{"type":"number"},"ethDominance":{"type":"number"},"totalMarketCapUsd":{"type":"number"},"marketCapChange24hPercent":{"type":"number"},"updatedAt":{"type":"number","description":"Unix timestamp from CoinGecko"}},"required":["kind","btcDominance","ethDominance","totalMarketCapUsd","marketCapChange24hPercent","updatedAt"]}}},"paths":{"/orders/triggers/kalshi":{"get":{"operationId":"OrdersController_getKalshiTriggers","parameters":[{"name":"category","required":false,"in":"query","description":"Kalshi category (Crypto, Politics, etc.)","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"Search term","schema":{"type":"string"}},{"name":"cursor","required":false,"in":"query","description":"Pagination cursor","schema":{"type":"string"}},{"name":"pageSize","required":false,"in":"query","description":"Page size","schema":{"default":50,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KalshiTriggersResponseDto"}}}}},"summary":"Get Kalshi prediction market triggers (paginated)","tags":["Orders"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pearprotocol.io/api-integration/api-specification/orders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.