Orders

Cancel a pending order

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstring · uuidRequired

Order identifier

Responses

200

Order cancelled successfully

application/json

delete

/orders/{orderId}/cancel

HTTPcURLJavaScriptPython

DELETE /orders/{orderId}/cancel HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Order cancelled successfully

{
  "orderId": "550e8400-e29b-41d4-a716-446655440004",
  "status": "CANCELLED",
  "cancelledAt": "2023-07-14T10:35:00Z"
}

Cancel a TWAP order and all its pending chunks

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstring · uuidRequired

TWAP Order identifier

Responses

200

TWAP order cancelled successfully

application/json

post

/orders/{orderId}/twap/cancel

HTTPcURLJavaScriptPython

POST /orders/{orderId}/twap/cancel HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

TWAP order cancelled successfully

{
  "orderId": "a1b2c3d4e5f67890abcdef1234567890",
  "status": "CANCELLED",
  "cancelledAt": "2023-07-14T10:35:00Z"
}

Get all open orders

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Open orders retrieved successfully

application/json

404

No open orders found

get

/orders/open

HTTPcURLJavaScriptPython

GET /orders/open HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "orderId": "ord-123",
    "address": "0x1234...abcd",
    "clientId": "client-123",
    "positionId": "pos-456",
    "parameters": {
      "leverage": 3,
      "usdValue": 2000,
      "reduceOnly": false
    },
    "orderType": "TRIGGER",
    "status": "OPEN",
    "longAssets": [
      {
        "asset": "BTC",
        "weight": 0.7
      }
    ],
    "shortAssets": [
      {
        "asset": "BTC",
        "weight": 0.7
      }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]

Get TWAP orders with monitoring data

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

TWAP orders with monitoring data retrieved successfully

application/json

404

No TWAP orders found

get

/orders/twap

HTTPcURLJavaScriptPython

GET /orders/twap HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "orderId": "ord-twap-456",
    "positionId": "pos-789",
    "address": "0x1234...abcd",
    "orderType": "TWAP",
    "longAssets": [
      {
        "asset": "BTC",
        "weight": 0.7
      }
    ],
    "shortAssets": [
      {
        "asset": "BTC",
        "weight": 0.7
      }
    ],
    "status": "EXECUTING",
    "totalUsdValue": 5000,
    "filledUsdValue": 2500,
    "remainingUsdValue": 2500,
    "twapDuration": "4h",
    "twapIntervalSeconds": 30,
    "twapChunkUsdValue": 100,
    "randomizeExecution": true,
    "reduceOnly": false,
    "chunks": [
      {
        "chunkId": "chunk-123",
        "chunkIndex": 0,
        "scheduledTime": "2024-01-01T00:05:00.000Z",
        "executedTime": "2024-01-01T00:05:15.000Z",
        "status": "COMPLETED",
        "chunkSize": 500,
        "fills": [
          {
            "fillId": "fill-123",
            "assetName": "BTC",
            "price": 45000.5,
            "size": 0.05,
            "executedAt": "2024-01-01T00:05:00.000Z"
          }
        ],
        "errorMessage": "Insufficient liquidity"
      }
    ],
    "estimatedCompletionTime": "2024-01-01T04:00:00.000Z",
    "actualCompletionTime": "2024-01-01T04:02:30.000Z",
    "remainingChunks": 5,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:30:00.000Z"
  }
]

Execute a spot order

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assetstringRequired

Asset to buy

Example: USDH

isBuybooleanRequired

To buy/sell Asset

Example: true

amountnumber · min: 0.1Required

Asset size to buy

Example: 1.5

Responses

200

Spot order executed successfully

application/json

post

/orders/spot

HTTPcURLJavaScriptPython

POST /orders/spot HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "asset": "USDH",
  "isBuy": true,
  "amount": 1.5
}

200

Spot order executed successfully

{
  "orderId": "a1b2c3d4e5f67890abcdef1234567891",
  "status": "EXECUTED",
  "createdAt": "2023-07-14T10:30:00Z",
  "asset": "USDH",
  "hyperliquidResult": {}
}