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": "EntryOpen",
    "market": "BTC-USD",
    "side": "Long"
  },
  {
    "type": "EntryClose",
    "market": "BTC-USD",
    "target": {
      "type": "All"
    },
    "side": "Long"
  },
  {
    "type": "EntrySetExits",
    "market": "ETH-USD",
    "target": {
      "type": "LastOnly"
    },
    "stopLoss": {
      "type": "AverageEntry",
      "offsetPercentage": 2,
      "inBreachSeconds": 60
    }
  }
]
'
{
  "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 open a new entry.

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

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

​
side
enum<string>
required

The side of the signal.

Available options:
Long,
Short
​
override
object

Overrides for the default entry settings.

​
externalId
string

An optional external ID to associate with the entry.

Example:
[
  {
    "type": "EntryOpen",
    "market": "BTC-USD",
    "side": "Long"
  },
  {
    "type": "EntryClose",
    "market": "BTC-USD",
    "target": { "type": "All" },
    "side": "Long"
  },
  {
    "type": "EntrySetExits",
    "market": "ETH-USD",
    "target": { "type": "LastOnly" },
    "stopLoss": {
      "type": "AverageEntry",
      "offsetPercentage": 2,
      "inBreachSeconds": 60
    }
  }
]

Response

OK