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

orderIdstring · uuidRequired

Order identifier

Example: 550e8400-e29b-41d4-a716-446655440004

statusstringRequired

Order status after cancellation

Example: CANCELLED

cancelledAtstring · date-timeRequired

Cancellation timestamp

Example: 2023-07-14T10:35:00Z

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

orderIdstringRequired

Order identifier that was cancelled

Example: a1b2c3d4e5f67890abcdef1234567890

statusstringRequired

Status of the cancellation operation

Example: CANCELLED

cancelledAtstring · date-timeRequired

Cancellation timestamp

Example: 2023-07-14T10:35:00Z

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

orderIdstringRequired

Order identifier

Example: ord-123

addressstringRequired

User wallet address

Example: 0x1234...abcd

clientIdobject · nullableRequired

Client identifier

Example: client-123

positionIdobject · nullableRequired

Associated position identifier

Example: pos-456

parametersobjectRequired

Order parameters (varies by order type)

Example: {"leverage":3,"usdValue":2000,"reduceOnly":false}

orderTypestring · enumRequired

Order type

Example: TRIGGERPossible values:

statusstring · enumRequired

Order status

Example: OPENPossible values:

createdAtstring · date-timeRequired

Order creation timestamp

Example: 2024-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2024-01-01T00:00:00.000Z

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

orderIdstringRequired

TWAP order identifier

Example: ord-twap-456

positionIdstring · nullableRequired

Associated position ID (for close orders)

Example: pos-789

addressstringRequired

User wallet address

Example: 0x1234...abcd

orderTypestringRequired

Order type (TWAP)

Example: TWAP

statusstring · enumRequired

Overall order status

Example: EXECUTINGPossible values:

totalUsdValuenumberRequired

Total order value in USD

Example: 5000

filledUsdValuenumberRequired

USD value already filled

Example: 2500

remainingUsdValuenumberRequired

USD value remaining to fill

Example: 2500

twapDurationstringRequired

TWAP duration setting

Example: 4h

twapIntervalSecondsobject · nullableOptional

TWAP interval in seconds (effective)

Example: 30

twapChunkUsdValueobject · nullableOptional

Base USD value per TWAP chunk

Example: 100

randomizeExecutionbooleanRequired

Whether execution timing is randomized

Example: true

reduceOnlybooleanRequired

Is this a reduce-only order (close position)

Example: false

estimatedCompletionTimestring · date-time · nullableRequired

Estimated completion time

Example: 2024-01-01T04:00:00.000Z

actualCompletionTimestring · date-time · nullableRequired

Actual completion time

Example: 2024-01-01T04:02:30.000Z

remainingChunksnumberRequired

Number of chunks remaining to execute

Example: 5

createdAtstring · date-timeRequired

Order creation timestamp

Example: 2024-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2024-01-01T00:30:00.000Z

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

orderIdstringRequired

Unique identifier for the initial order

Example: a1b2c3d4e5f67890abcdef1234567891

statusstring · enumRequired

Current status of the position/order

Example: EXECUTEDPossible values:

createdAtstring · date-timeRequired

Creation timestamp

Example: 2023-07-14T10:30:00Z

assetstringRequired

Spot Asset

Example: USDH

hyperliquidResultobjectOptional

Raw response from Hyperliquid

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": {}
}