Skip to main content
GET
/
api
/
v1
/
publishing
/
plans
Get plans
curl --request GET \
  --url https://platform.plurex.io/api/v1/publishing/plans \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>'
[
  {
    "id": "Starter",
    "signalIds": [
      "bbebadea-3429-4fed-80fe-0feed5d0e44e",
      "ede6ae78-76ce-4414-8eac-a35067e752d6"
    ],
    "signalRestrictions": [
      {
        "type": "MaxPerSignalOpenPositionCost",
        "usd": 10000
      }
    ]
  },
  {
    "id": "Pro",
    "signalIds": [
      "bbebadea-3429-4fed-80fe-0feed5d0e44e",
      "ede6ae78-76ce-4414-8eac-a35067e752d6"
    ],
    "signalRestrictions": [
      {
        "type": "MaxCombinedOpenPositionCost",
        "usd": 10000
      }
    ]
  }
]

Authorizations

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

Response

200 - application/json

The full state of all publisher plans

​
id
string
required

A unique identifier provided by the owner

Example:

"Starter"

​
signalIds
string[]

The Plurex IDs of the published signals that this sub group give access to.

Example:
[
  "bbebadea-3429-4fed-80fe-0feed5d0e44e",
  "ede6ae78-76ce-4414-8eac-a35067e752d6"
]
​
signalRestrictions
(Max Combined Open Position Cost · object | Max Per Signal Open Position Cost · object)[]

The set of restrictions that apply to the plan.

A type of SubscriptionSignalRestriction. Limits the combined open position cost across all Trading Sessions. Valued in USD.

Example:
{
  "type": "MaxCombinedOpenPositionCost",
  "usd": 15000
}
Example:
[
  {
    "type": "MaxCombinedOpenPositionCost",
    "usd": 5000
  },
  {
    "type": "MaxPerSignalOpenPositionCost",
    "usd": 10000
  }
]
Example:
[
  {
    "id": "Starter",
    "signalIds": [
      "bbebadea-3429-4fed-80fe-0feed5d0e44e",
      "ede6ae78-76ce-4414-8eac-a35067e752d6"
    ],
    "signalRestrictions": [
      {
        "type": "MaxPerSignalOpenPositionCost",
        "usd": 10000
      }
    ]
  },
  {
    "id": "Pro",
    "signalIds": [
      "bbebadea-3429-4fed-80fe-0feed5d0e44e",
      "ede6ae78-76ce-4414-8eac-a35067e752d6"
    ],
    "signalRestrictions": [
      {
        "type": "MaxCombinedOpenPositionCost",
        "usd": 10000
      }
    ]
  }
]