Signal API

This section documents the Signal API.

---

About

The Signal API is the core of Katoshi - Allowing you to send trading commands to your Hyperliquid account and vaults via simple POST requests or using webhooks. See all action types below.

---

Quick Start

POST https://api.katoshi.ai/signal?id=USER_ID

Replace USER_ID with your unique ID, which can be found in the Settings Page

Headers

Name	Type	Description
Content-Type*	String	application/json

Request Body

Name	Type	Description
action*	String	Type of action
api_key*	String	Katoshi API Key
bot_id*	Number	ID of your bot

Example Request

{
  "action": "open_position",
  "api_key": "12345678-1234-1234-1234-123456789012",
  "bot_id": 7
}

For TradingView, add the Request JSON directly in the alert message field.

---

Testing & Debugging

The Terminal page can help you generate the JSON for each request as well as sending signals.

Our API endpoints and MCP servers are also available in Postman.

---

Perpetual & Spot Actions

Actions applying to both Perps and Spot market.

Market OrderLimit OrderScale OrderCancel OrderCancel AllClear All

---

Perpetual Market Actions

Actions applying only to Perps market.

The coin parameter for Perps uses a format such as BTC

Open PositionClose PositionStop Market OrderClose AllModify TP/SLCancel TP/SLSet Leverage

---

Spot Market Actions

Actions applying only to Spot market.

The coin parameter for Spot uses a format such as UBTC/USDC or pair ID such as @142

Sell All

---

Bot Control Actions

Actions to control your bot status

Start BotStop Bot