PlurexSignalCore

28 พ.ย. 2022

Library "PlurexSignalCore"
General purpose functions and helpers for use in more specific Plurex Signal alerting scripts and libraries

plurexMarket()
  Build a Plurex market string from a base and quote asset symbol.
  Returns: A market string that can be used in Plurex Signal messages.

tickerToPlurexMarket()
  Builds Plurex market string from the syminfo
  Returns: A market string that can be used in Plurex Signal messages.

simpleMessage(secret, action, marketOverride)
  Builds Plurex Signal Message json to be sent to a Signal webhook
  Parameters:
    secret: The secret for your Signal on plurex
    action: The action of the message. One of [LONG, SHORT, CLOSE_LONGS, CLOSE_SHORTS, CLOSE_ALL, CLOSE_LAST_LONG, CLOSE_LAST_SHORT, CLOSE_FIRST_LONG, CLOSE_FIRST_SHORT].
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

entryMessage(secret, isLong, budgetPercentage, priceLimit, marketOverride)
  Builds Plurex Signal Entry Message json to be sent to a Signal webhook with optional parameters for budget and price limits.
  Parameters:
    secret: The secret for your Signal on plurex
    isLong: The action of the message. true for LONG, false for SHORT.
    budgetPercentage: Optional, The percentage of budget to use in the entry.
    priceLimit: Optional, The worst price to accept for the entry.
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

long(secret, budgetPercentage, priceLimit, marketOverride)
  Builds Plurex Signal LONG Message json to be sent to a Signal webhook with optional parameters for budget and price limits.
  Parameters:
    secret: The secret for your Signal on plurex
    budgetPercentage: Optional, The percentage of budget to use in the entry.
    priceLimit: Optional, The worst price to accept for the entry.
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

short(secret, budgetPercentage, priceLimit, marketOverride)
  Builds Plurex Signal SHORT Message json to be sent to a Signal webhook with optional parameters for budget and price limits.
  Parameters:
    secret: The secret for your Signal on plurex
    budgetPercentage: Optional, The percentage of budget to use in the entry.
    priceLimit: Optional, The worst price to accept for the entry.
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeAll(secret, marketOverride)
  Builds Plurex Signal CLOSE_ALL Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeShorts(secret, marketOverride)
  Builds Plurex Signal CLOSE_SHORTS Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeLongs(secret, marketOverride)
  Builds Plurex Signal CLOSE_LONGS Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeFirstLong(secret, marketOverride)
  Builds Plurex Signal CLOSE_FIRST_LONG Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeLastLong(secret, marketOverride)
  Builds Plurex Signal CLOSE_LAST_LONG Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeFirstShort(secret, marketOverride)
  Builds Plurex Signal CLOSE_FIRST_SHORT Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.

closeLastShort(secret, marketOverride)
  Builds Plurex Signal CLOSE_LAST_SHORT Message json to be sent to a Signal webhook.
  Parameters:
    secret: The secret for your Signal on plurex
    marketOverride: Optional, defaults to the syminfo for the ticker. Use the `plurexMarket` function to build your own.
  Returns: A json string message that can be used in alerts to send messages to Plurex.