Custom Rule Signal

post

Body

userIdstringRequired

Coinrule User ID

hookIdstringRequired

Hook ID to identify the signal source.

hookTokenstringRequired

Hook token to authenticate the signal source.

sidestring · enumRequired

Order side ("buy" or "sell").

Possible values:

productstringOptional

Product symbol (e.g. BTCUSD_PERP). If provided, baseCoin and quoteCoin should not be provided. For spot trading, better to use baseCoin and quoteCoin instead, or alternatively send this value in a format baseCoin/quoteCoin.

baseCoinstringOptional

Base coin for spot trading (e.g. BTC).

quoteCoinstringOptional

Quote coin for spot trading (e.g. USD). If provided, the wallet in the rule will be checked for this coin - it does not overwrite the wallet coin. If not matched, the signal will be ignored.

amountValuestringOptional

Amount value to trade. If provided, it will overwrite the action amount in the rule. If multiple actions are present, the amount will be applied to all of them. Required when amount symbol is provided.

amountSymbolstring · enumOptional

Amount symbol to trade (currently only "%" is supported). Required when amount value is provided.

Possible values:

Responses

201

The signal was successfully processed and passed to the Rule Engine.

application/json

400

The request is malformed or the arguments are invalid.

application/json

401

Security tokens are invalid.

application/json

404

No rule found for the signal, it could be paused or completed.

application/json

429

The rate limit (1 request per rule per second) has been exceeded.

application/json

500

An internal server error has occurred.

application/json

post

HTTPcURLJavaScriptPython

POST /signal HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "userId": "text",
  "hookId": "text",
  "hookToken": "text",
  "side": "buy",
  "product": "text",
  "baseCoin": "text",
  "quoteCoin": "text",
  "amountValue": "text",
  "amountSymbol": "%"
}

{
  "success": true
}