Create Order with BitMEX API on Monthly Schedule from Schedule API

Pipedream makes it easy to connect APIs for BitMEX, Schedule and 3,000+ other apps remarkably fast.

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Create Order with the BitMEX API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and BitMEX action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Order action
1. Connect your BitMEX account
2. Select a Symbol
3. Optional- Configure Strategy
4. Optional- Select a Side
5. Optional- Configure Order Quantity
6. Optional- Configure Price
7. Optional- Configure Display Quantity
8. Optional- Configure Stop Price
9. Optional- Configure Client Order ID
10. Optional- Configure Client Order Link ID
11. Optional- Configure Peg Offset Value
12. Optional- Select a Peg Price Type
13. Optional- Select a Order Type
14. Optional- Select a Time In Force
15. Optional- Configure Execution Instructions
16. Optional- Select a Contingency Type
17. Optional- Configure Text
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Order on BitMEX

Description:Submit a new trading order in your BitMEX account. [See the documentation](https://www.bitmex.com/api/explorer/#!/Order/Order_new)

Version:0.0.1

Key:bitmex-create-order

View on GitHub

Action Code#

import bitmex from "../../bitmex.app.mjs";

export default {
  key: "bitmex-create-order",
  name: "Create Order",
  description: "Submit a new trading order in your BitMEX account. [See the documentation](https://www.bitmex.com/api/explorer/#!/Order/Order_new)",
  version: "0.0.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: false,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    bitmex,
    symbol: {
      propDefinition: [
        bitmex,
        "symbol",
      ],
    },
    strategy: {
      type: "string",
      label: "Strategy",
      description: "Order strategy. e.g. 'OneWay', 'Long', 'Short'",
      optional: true,
    },
    side: {
      type: "string",
      label: "Side",
      description: "Order side. Valid options: Buy, Sell. Defaults to 'Buy' unless `orderQty` is negative",
      optional: true,
      options: [
        "Buy",
        "Sell",
      ],
    },
    orderQty: {
      type: "integer",
      label: "Order Quantity",
      description: "Order quantity in units of the instrument (i.e. contracts, for spot it is base currency in minor currency for spot (e.g. XBt quantity for XBT))",
      optional: true,
    },
    price: {
      type: "string",
      label: "Price",
      description: "Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders",
      optional: true,
    },
    displayQty: {
      type: "integer",
      label: "Display Quantity",
      description: "Optional quantity to display in the book. Use 0 for a fully hidden order.",
      optional: true,
    },
    stopPx: {
      type: "string",
      label: "Stop Price",
      description: "Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of 'MarkPrice' or 'LastPrice' to define the current price used for triggering.",
      optional: true,
    },
    clOrdID: {
      type: "string",
      label: "Client Order ID",
      description: "Optional Client Order ID. This clOrdID will come back on the order and any related executions.",
      optional: true,
    },
    clOrdLinkID: {
      type: "string",
      label: "Client Order Link ID",
      description: "Optional Client Order Link ID for contingent orders",
      optional: true,
    },
    pegOffsetValue: {
      type: "string",
      label: "Peg Offset Value",
      description: "Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders.",
      optional: true,
    },
    pegPriceType: {
      type: "string",
      label: "Peg Price Type",
      description: "Optional peg price type. Valid options: MarketPeg, PrimaryPeg, TrailingStopPeg",
      optional: true,
      options: [
        "MarketPeg",
        "PrimaryPeg",
        "TrailingStopPeg",
      ],
    },
    ordType: {
      type: "string",
      label: "Order Type",
      description: "Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, Pegged. Defaults to 'Limit' when `price` is specified. Defaults to 'Stop' when `stopPx` is specified. Defaults to 'StopLimit' when `price` and `stopPx` are specified.",
      optional: true,
      default: "Limit",
      options: [
        "Market",
        "Limit",
        "Stop",
        "StopLimit",
        "MarketIfTouched",
        "LimitIfTouched",
        "Pegged",
      ],
    },
    timeInForce: {
      type: "string",
      label: "Time In Force",
      description: "Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to 'GoodTillCancel' for 'Limit', 'StopLimit', and 'LimitIfTouched' orders.",
      optional: true,
      options: [
        "Day",
        "GoodTillCancel",
        "ImmediateOrCancel",
        "FillOrKill",
      ],
    },
    execInst: {
      type: "string",
      label: "Execution Instructions",
      description: "Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed, LastWithinMark. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. 'LastWithinMark' instruction valid for 'Stop' and 'StopLimit' with instruction 'LastPrice'. IndexPrice, LastWithMark, Close and ReduceOnly are not applicable to spot trading symbols.",
      optional: true,
    },
    contingencyType: {
      type: "string",
      label: "Contingency Type",
      description: "Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther.",
      optional: true,
      options: [
        "OneCancelsTheOther",
        "OneTriggersTheOther",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "Optional order annotation. e.g. 'Take profit'",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.bitmex.createOrder({
      symbol: this.symbol,
      strategy: this.strategy,
      side: this.side,
      orderQty: this.orderQty,
      price: this.price,
      displayQty: this.displayQty,
      stopPx: this.stopPx,
      clOrdID: this.clOrdID,
      clOrdLinkID: this.clOrdLinkID,
      pegOffsetValue: this.pegOffsetValue,
      pegPriceType: this.pegPriceType,
      ordType: this.ordType,
      timeInForce: this.timeInForce,
      execInst: this.execInst,
      contingencyType: this.contingencyType,
      text: this.text,
    });

    $.export("$summary", `Successfully created order${response.orderID
      ? ` with ID: ${response.orderID}`
      : ""}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
BitMEX	`bitmex`	`app`	This component uses the BitMEX app.
Symbol	`symbol`	`string`	Select a value from the drop down menu.
Strategy	`strategy`	`string`	Order strategy. e.g. 'OneWay', 'Long', 'Short'
Side	`side`	`string`	Select a value from the drop down menu:`BuySell`
Order Quantity	`orderQty`	`integer`	Order quantity in units of the instrument (i.e. contracts, for spot it is base currency in minor currency for spot (e.g. XBt quantity for XBT))
Price	`price`	`string`	Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders
Display Quantity	`displayQty`	`integer`	Optional quantity to display in the book. Use 0 for a fully hidden order.
Stop Price	`stopPx`	`string`	Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of 'MarkPrice' or 'LastPrice' to define the current price used for triggering.
Client Order ID	`clOrdID`	`string`	Optional Client Order ID. This clOrdID will come back on the order and any related executions.
Client Order Link ID	`clOrdLinkID`	`string`	Optional Client Order Link ID for contingent orders
Peg Offset Value	`pegOffsetValue`	`string`	Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders.
Peg Price Type	`pegPriceType`	`string`	Select a value from the drop down menu:`MarketPegPrimaryPegTrailingStopPeg`
Order Type	`ordType`	`string`	Select a value from the drop down menu:`MarketLimitStopStopLimitMarketIfTouchedLimitIfTouchedPegged`
Time In Force	`timeInForce`	`string`	Select a value from the drop down menu:`DayGoodTillCancelImmediateOrCancelFillOrKill`
Execution Instructions	`execInst`	`string`	Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed, LastWithinMark. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. 'LastWithinMark' instruction valid for 'Stop' and 'StopLimit' with instruction 'LastPrice'. IndexPrice, LastWithMark, Close and ReduceOnly are not applicable to spot trading symbols.
Contingency Type	`contingencyType`	`string`	Select a value from the drop down menu:`OneCancelsTheOtherOneTriggersTheOther`
Text	`text`	`string`	Optional order annotation. e.g. 'Take profit'