Skip to main content
POST
/
api
/
v1
/
signal
/
{id}
Send messages
curl --request POST \
  --url https://protocols.plurex.io/api/v1/signal/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
[
  {
    "type": "Long",
    "market": "BTC-USD"
  },
  {
    "type": "Short",
    "market": "ETH-USD"
  },
  {
    "type": "CloseAll",
    "market": "SOL-USD"
  },
  {
    "type": "CloseShorts",
    "market": "BTC-USD"
  },
  {
    "type": "CloseLongs",
    "market": "ETH-USD"
  },
  {
    "type": "CloseLastLong",
    "market": "SOL-USD"
  },
  {
    "type": "CloseLastShort",
    "market": "BTC-USD"
  },
  {
    "type": "CloseFirstLong",
    "market": "ETH-USD"
  },
  {
    "type": "CloseFirstShort",
    "market": "SOL-USD"
  }
]
'
{
  "errors": [
    {
      "path": [
        "budget",
        "amount"
      ],
      "message": "Must be > 0"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required
​
X-API-SECRET
string
header
required

Path Parameters

​
id
string
required

The ID of the signal to send a message to.

Query Parameters

​
test
boolean

Optional parameter to indicate a test message. This message will be ignored by Trading Sessions if true.

Body

application/json

A batch of Signal Messages

A message to go long with optional overrides for the Entry settings

​
type
enum<string>
default:Long
required
Available options:
Long
​
market
string
required

The market the message is for. Fore example 'BTC-USD'.

​
override
object

Optional overrides for the Entry settings

Example:
[
  { "type": "Long", "market": "BTC-USD" },
  { "type": "Short", "market": "ETH-USD" },
  { "type": "CloseAll", "market": "SOL-USD" },
  {
    "type": "CloseShorts",
    "market": "BTC-USD"
  },
  { "type": "CloseLongs", "market": "ETH-USD" },
  {
    "type": "CloseLastLong",
    "market": "SOL-USD"
  },
  {
    "type": "CloseLastShort",
    "market": "BTC-USD"
  },
  {
    "type": "CloseFirstLong",
    "market": "ETH-USD"
  },
  {
    "type": "CloseFirstShort",
    "market": "SOL-USD"
  }
]

Response

OK