Close Position - Tide API Documentation

Close Position

curl --request POST \
  --url https://api.tide.ag/api/trade/position/close \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "symbol": "<string>",
  "size": "<string>",
  "credentials": {
    "lighter": {
      "apiKeyPrivateKey": "<string>",
      "accountIndex": 123
    },
    "aster": {
      "apiKey": "<string>",
      "apiSecret": "<string>",
      "walletAddress": "<string>"
    },
    "hyperliquid": {
      "privateKey": "<string>"
    },
    "pacifica": {
      "apiKey": "<string>",
      "apiSecret": "<string>",
      "walletAddress": "<string>"
    }
  },
  "limitPrice": "<string>"
}
'

{
  "success": true,
  "data": {
    "order": {
      "orderId": "<string>",
      "symbol": "<string>",
      "price": "<string>",
      "quantity": "<string>",
      "filledQuantity": "<string>",
      "averagePrice": "<string>",
      "timestamp": 123,
      "clientOrderId": "<string>",
      "reduceOnly": true,
      "triggerPrice": "<string>"
    },
    "routing": {},
    "execution": {}
  }
}

POST

api

trade

position

Close Position

curl --request POST \
  --url https://api.tide.ag/api/trade/position/close \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "symbol": "<string>",
  "size": "<string>",
  "credentials": {
    "lighter": {
      "apiKeyPrivateKey": "<string>",
      "accountIndex": 123
    },
    "aster": {
      "apiKey": "<string>",
      "apiSecret": "<string>",
      "walletAddress": "<string>"
    },
    "hyperliquid": {
      "privateKey": "<string>"
    },
    "pacifica": {
      "apiKey": "<string>",
      "apiSecret": "<string>",
      "walletAddress": "<string>"
    }
  },
  "limitPrice": "<string>"
}
'

{
  "success": true,
  "data": {
    "order": {
      "orderId": "<string>",
      "symbol": "<string>",
      "price": "<string>",
      "quantity": "<string>",
      "filledQuantity": "<string>",
      "averagePrice": "<string>",
      "timestamp": 123,
      "clientOrderId": "<string>",
      "reduceOnly": true,
      "triggerPrice": "<string>"
    },
    "routing": {},
    "execution": {}
  }
}

Close an existing position using a reduce-only order. The router mirrors the behaviour of the open endpoint—scanning all supported venues for the best exit price unless you force a specific exchange.

Features

Reduce-only safety: Guarantees the API only decreases exposure
Smart venue selection: Routes exits to the venue with the best available price
Partial or full closes: Specify any size up to the total position
Consistent payloads: Response structure matches the open position endpoint for easy reconciliation

Use Cases

Automate take-profit or stop-loss workflows across multiple exchanges
Build UI flows for one-click position unwinds
Implement partial de-risking strategies using precise quantities
Maintain audit trails with routing and execution metadata in a single response

Request

Method: POST
Endpoint: /api/trade/position/close
Authentication: Required

Request Fields

Field	Type	Required	Description
`symbol`	string	✅	Asset symbol being closed
`direction`	string	✅	Direction of the position you are closing (`LONG` or `SHORT`)
`size`	string	✅	Quantity to close (must not exceed open position size)
`orderType`	string	❌	`MARKET` by default; `LIMIT` supported when `limitPrice` is supplied
`limitPrice`	string	❌	Required when `orderType` is `LIMIT`
`preferredExchange`	string	❌	Force close on a specific venue
`credentials`	object	✅	Exchange credentials required for execution

The response mirrors the Open Position endpoint, returning execution, routing, and position data so you can reconcile final fills.

Usage Tips

Reduce-only semantics ensure the API never increases exposure while closing.
Provide credentials only for venues you wish to use; missing credentials remove that venue from routing consideration.
For partial closes, set size to the exact quantity you want to reduce.

Combine /api/trade/position/open and /api/trade/position/close in your workflow to ladder into and out of positions while keeping routing logic centralized.

Hyperliquid - Close Single Position

Close a specific open position for a given symbol on Hyperliquid.

Endpoint

POST /api/hyperliquid/:walletId/positions/close/:symbol

Path Parameters

Parameter	Type	Required	Description
`walletId`	string	Yes	Wallet ID (UUID)
`symbol`	string	Yes	Asset symbol (e.g., “BTC”)

Headers

Header	Value	Required
`x-wallet-id`	Wallet ID (UUID)	Yes
`Content-Type`	application/json	Yes

Request Body

{
  "userId": "ee337309-3e77-4278-b21a-4681468168ba",
  "symbol": "BTC-PERP",
  "side": "BUY",
  "type": "MARKET",
  "quantity": "0.1",
  "price": "1",
  "reduceOnly": true
}

Request Parameters

Field	Type	Required	Description
`userId`	string	Yes	User’s wallet ID
`symbol`	string	Yes	Trading pair (e.g., “BTC-PERP”)
`side`	string	Yes	”BUY” or “SELL” (opposite of position)
`type`	string	Yes	”MARKET” or “LIMIT”
`quantity`	string	Yes	Quantity to close
`price`	string	Yes	Price for the order
`reduceOnly`	boolean	Yes	Must be `true` for closing positions

Example Request

curl -X POST https://api.tide.ag/api/hyperliquid/a1e82339-29f8-41a6-a468-ce8d268a3261/positions/close/BTC \
  -H "x-wallet-id: a1e82339-29f8-41a6-a468-ce8d268a3261" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "ee337309-3e77-4278-b21a-4681468168ba",
    "symbol": "BTC-PERP",
    "side": "BUY",
    "type": "MARKET",
    "quantity": "0.1",
    "price": "1",
    "reduceOnly": true
  }'

Success Response

{
  "success": true,
  "data": {
    "closeId": "c2394ab3",
    "status": "submitted",
    "timestamp": 1698840000000
  }
}

Hyperliquid - Close All Positions

Close all open positions for the wallet on Hyperliquid.

Endpoint

POST /api/hyperliquid/:walletId/positions/close-all

Path Parameters

Parameter	Type	Required	Description
`walletId`	string	Yes	Wallet ID (UUID)

Headers

Header	Value	Required
`x-wallet-id`	Wallet ID (UUID)	Yes
`Content-Type`	application/json	Yes

Request Body

Same schema as close-single-symbol.

Example Request

curl -X POST https://api.tide.ag/api/hyperliquid/a1e82339-29f8-41a6-a468-ce8d268a3261/positions/close-all \
  -H "x-wallet-id: a1e82339-29f8-41a6-a468-ce8d268a3261" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "a1e82339-29f8-41a6-a468-ce8d268a3261",
    "symbol": "BTC-PERP",
    "side": "BUY",
    "type": "MARKET",
    "quantity": "0.1",
    "price": "1",
    "reduceOnly": true
  }'

Success Response

{
  "success": true,
  "data": {
    "success": true,
    "closedCount": 1,
    "totalPositions": 1,
    "results": [
      {
        "symbol": "BTC",
        "status": "CLOSED",
        "orderId": "255732635491"
      }
    ],
    "message": "Successfully closed 1/1 positions"
  }
}

Aster - Close Position

Close positions on Aster exchange with a single API call.

Endpoint

POST /api/aster/perp/:walletId/close-position

Path Parameters

Parameter	Type	Required	Description
`walletId`	string	Yes	Wallet ID (UUID)

Request Body

{
  "symbol": "BTCUSDT"
}

Optional - Close specific side:

{
  "symbol": "BTCUSDT",
  "positionSide": "LONG"
}

Request Parameters

Field	Type	Required	Description
`symbol`	string	Yes	Trading pair (e.g., “BTCUSDT”)
`positionSide`	string	No	”LONG” or “SHORT” (for hedge mode). Omit to close all positions for the symbol

Example Request

curl -X POST https://api.tide.ag/api/aster/perp/ee337309-3e77-4278-b21a-4681468168ba/close-position \
  -H "Content-Type: application/json" \
  -d '{
    "symbol": "BTCUSDT"
  }'

Success Response

{
  "success": true,
  "data": {
    "orderId": 9884649221,
    "symbol": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "6D52PQwRlg0PcdHz5ttkgN",
    "price": "0",
    "avgPrice": "0.0000",
    "origQty": "0.001",
    "executedQty": "0",
    "cumQty": "0",
    "cumQuote": "0",
    "timeInForce": "GTC",
    "type": "MARKET",
    "reduceOnly": true,
    "closePosition": false,
    "side": "SELL",
    "positionSide": "BOTH",
    "stopPrice": "0",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "MARKET",
    "updateTime": 1764640797006
  }
}

Avantis - Close Position (Client-Side Execution)

Avantis positions are closed client-side via on-chain transactions on the Base network. Like opening, closing is not routed through the Tide backend.

Avantis close execution uses client-side wallet signing via the useAvantisTrade React hook. Supports both full and partial closes.

Close by Pair and Trade Index

useAvantisTrade().closePosition({
  pairIndex: 0,              // From PAIR_INDEX_MAP (e.g., 0 = ETH)
  tradeIndex: 0,             // On-chain trade index
  closeAmountUsdc: "50.00"   // Partial close amount (optional)
})
// Returns: txHash

Close by Symbol and Direction

// Convenience method — finds and closes the matching open trade
useAvantisTrade().closeBySymbol("ETH", "LONG")
// Returns: txHash

Request Parameters

Field	Type	Required	Description
`pairIndex`	number	Yes	Pair index from PAIR_INDEX_MAP
`tradeIndex`	number	Yes	On-chain trade index
`closeAmountUsdc`	string	No	Partial close amount in USDC. Omit for full close

Close by Symbol Parameters

Field	Type	Required	Description
`symbol`	string	Yes	Asset symbol (e.g., “ETH”)
`direction`	string	Yes	`"LONG"` or `"SHORT"`

The close operation uses initialPosToken (not positionSizeUSDC) for the collateral amount, read from TradingStorage.openTrades() on-chain.

Authorizations

X-API-KEY

string

header

required

API key for authentication. Also requires X-API-SECRET, X-API-TIMESTAMP, and X-API-SIGNATURE headers for private endpoints.

Body

application/json

symbol

string

required

Asset symbol being closed

direction

enum<string>

required

Available options:

LONG,

SHORT

size

string

required

Quantity to close

credentials

object

required

Show child attributes

orderType

enum<string>

Available options:

LIMIT,

MARKET,

STOP_MARKET,

STOP_LIMIT

limitPrice

string

Required when orderType is LIMIT

preferredExchange

enum<string>

Available options:

hyperliquid,

aster,

lighter,

pacifica

Response

200 - application/json

Position closed successfully

success

boolean

data

object

Show child attributes

Place Order Set Leverage (Aster)

​Features

​Use Cases

​Request

​Request Fields

​Usage Tips

​Hyperliquid - Close Single Position

​Endpoint

​Path Parameters

​Headers

​Request Body

​Request Parameters

​Example Request

​Success Response

​Hyperliquid - Close All Positions

​Endpoint

​Path Parameters

​Headers

​Request Body

​Example Request

​Success Response

​Aster - Close Position

​Endpoint

​Path Parameters

​Request Body

​Request Parameters

​Example Request

​Success Response

​Avantis - Close Position (Client-Side Execution)

​Close by Pair and Trade Index

​Close by Symbol and Direction

​Request Parameters

​Close by Symbol Parameters

Authorizations

Body

Response

Features

Use Cases

Request

Request Fields

Usage Tips

Hyperliquid - Close Single Position

Endpoint

Path Parameters

Headers

Request Body

Request Parameters

Example Request

Success Response

Hyperliquid - Close All Positions

Endpoint

Path Parameters

Headers

Request Body

Example Request

Success Response

Aster - Close Position

Endpoint

Path Parameters

Request Body

Request Parameters

Example Request

Success Response

Avantis - Close Position (Client-Side Execution)

Close by Pair and Trade Index

Close by Symbol and Direction

Request Parameters

Close by Symbol Parameters