Plurex Docs Help

Publishing

Sync your plans and subscribers and give them access to your trading intelligence.

Set subscribers

/api/v1/publishing/subscribers/all

Set all external subscribers and their subscriptions in a single operation. Missing subscribers will be removed, and new subscribers will be added.

Request parameters

[ [ { "userHandle": "BobBuilder", "planIds": [ "Starter" ] }, { "userHandle": "AliceTrader", "planIds": [ "Pro" ] } ] ]

Responses

{ "userHandlesNotFound": [ "Bob", "Alice" ] }
{ "errors": [ { "path": [ "priceLimit" ], "message": "Must be > 0" } ] }

Get subscribers

/api/v1/publishing/subscribers

Get the state of all external subscribers

Responses

[ [ { "userHandle": "BobBuilder", "planIds": [ "Starter" ] }, { "userHandle": "AliceTrader", "planIds": [ "Pro" ] } ] ]

Set Plans

/api/v1/publishing/plans/all

Set the state of all external plans in a single operation. If plans are missing they will be deleted, and additional plans will be created.

Request parameters

[ [ { "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 } ] } ] ]

Responses

{ "errors": [ { "path": [ "priceLimit" ], "message": "Must be > 0" } ] }

Get plans

/api/v1/publishing/plans

Get all currently configured plans.

Responses

[ [ { "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 } ] } ] ]
08 April 2025