@pipedream/alpaca 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/actions/cancel-all-orders/cancel-all-orders.mjs

@@ -0,0 +1,27 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-cancel-all-orders",
+  version: "0.0.1",
+  name: "Cancel All Orders",
+  description: "Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server reject the request, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#cancel-all-orders)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = await this.app.cancelAllOrders({
+      $,
+      isPaperAPI: this.isPaperAPI,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${response.length} order${response.length == 1 ? "" : "s"} has been cancelled.`);
+    return response;
+  },
+};

package/actions/cancel-order/cancel-order.mjs

@@ -0,0 +1,36 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-cancel-order",
+  version: "0.0.1",
+  name: "Cancel Order",
+  description: "Attempts to cancel an open order. If the order is no longer cancelable (example: status=`filled`), the server will reject the request, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#cancel-an-order)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+    orderId: {
+      propDefinition: [
+        app,
+        "orderId",
+        (configuredProps) => ({
+          isPaperAPI: configuredProps.isPaperAPI,
+        }),
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = await this.app.cancelOrder({
+      $,
+      isPaperAPI: this.isPaperAPI,
+      orderId: this.orderId,
+    });
+    $.export("$summary", `Order(ID:${this.orderId}) has been cancelled.`);
+    return response;
+  },
+};

package/actions/close-all-positions/close-all-positions.mjs

@@ -0,0 +1,36 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-close-all-positions",
+  version: "0.0.1",
+  name: "Close All Positions",
+  description: "Closes (liquidates) all of the account’s open long and short positions. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server will reject the request, [See the docs](https://alpaca.markets/docs/api-references/trading-api/positions/#close-all-positions)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+    cancelOrders: {
+      propDefinition: [
+        app,
+        "cancelOrders",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = await this.app.closeAllPositions({
+      $,
+      isPaperAPI: this.isPaperAPI,
+      params: {
+        cancel_orders: this.cancelOrders,
+      },
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${response.length} position${response.length == 1 ? "" : "s"} has been closed.`);
+    return response;
+  },
+};

package/actions/close-position/close-position.mjs

@@ -0,0 +1,36 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-close-position",
+  version: "0.0.1",
+  name: "Close Position",
+  description: "Closes (liquidates) the account’s open position. Works for both long and short positions, [See the docs](https://alpaca.markets/docs/api-references/trading-api/positions/#close-a-position)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+    positionSymbol: {
+      propDefinition: [
+        app,
+        "positionSymbol",
+        (configuredProps) => ({
+          isPaperAPI: configuredProps.isPaperAPI,
+        }),
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = await this.app.closePosition({
+      $,
+      isPaperAPI: this.isPaperAPI,
+      symbol: this.positionSymbol,
+    });
+    $.export("$summary", `Position(Symbol:${this.positionSymbol}) has been closed.`);
+    return response;
+  },
+};

package/actions/get-account-info/get-account-info.mjs

@@ -0,0 +1,26 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-get-account-info",
+  version: "0.0.1",
+  name: "Get Account Info",
+  description: "Returns the account info, [See the docs](https://alpaca.markets/docs/api-references/trading-api/account/)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = this.app.getAccountInfo({
+      $,
+      isPaperAPI: this.isPaperAPI,
+    });
+    $.export("$summary", "Account info has been retreived.");
+    return response;
+  },
+};

package/actions/list-orders/list-orders.mjs

@@ -0,0 +1,99 @@
+import app from "../../alpaca.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  type: "action",
+  key: "alpaca-list-orders",
+  version: "0.0.1",
+  name: "List Orders",
+  description: "Retrieves a list of orders for the account, filtered by the supplied query parameters, if no filter given all will be returned, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#get-a-list-of-orders)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+    //the API does not provide pagination for symbols,
+    //returns all at once and there are more than 3k symbols
+    //because of these I preferred to get them from user input
+    symbols: {
+      type: "string[]",
+      label: "Symbols",
+      description: "A list of symbols to filter by (ex. `AAPL,TSLA,MSFT`). A currency pair is required for crypto orders (ex. `BTC/USD,BCH/USD,LTC/USDT,ETC/USDT`).",
+      optional: true,
+    },
+    side: {
+      propDefinition: [
+        app,
+        "side",
+      ],
+      description: "Filters down to orders that have a matching `side` field set.",
+      optional: true,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "Order status to be queried. `open`, `closed` or `all`. Defaults to `open`.",
+      optional: true,
+      options: [
+        "open",
+        "closed",
+        "all",
+      ],
+    },
+    after: {
+      type: "string",
+      label: "After",
+      description: "The response will include only ones submitted after this time, in ISO 8601 format, e.g. `2022-09-07` or `2022-09-07T13:26:53`",
+      optional: true,
+    },
+    until: {
+      type: "string",
+      label: "Until",
+      description: "The response will include only ones submitted until this time, in ISO 8601 format, e.g. `2022-09-07` or `2022-09-07T13:26:53`",
+      optional: true,
+    },
+    nested: {
+      type: "string",
+      label: "Nested",
+      description: "If true, the result will roll up multi-leg orders under the `legs` field of primary order.",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const after = this.after && Date.parse(this.after);
+    if (this.after && isNaN(after))
+      throw new ConfigurationError("`After` should be in ISO 8601 format!");
+    const until = this.until && Date.parse(this.until);
+    if (this.until && isNaN(until))
+      throw new ConfigurationError("`Until` should be in ISO 8601 format!");
+    let pageSize = 25, orders = [], nextAfter = after && new Date(after).toISOString();
+    while (true) {
+      const response = await this.app.getOrders({
+        $,
+        isPaperAPI: this.isPaperAPI,
+        params: {
+          symbols: this.symbols && this.symbols.join(),
+          side: this.side,
+          status: this.status,
+          after: nextAfter,
+          until: until && new Date(until).toISOString(),
+          nested: this.nested,
+          direction: "asc",
+          limit: pageSize,
+        },
+      });
+      orders.push(...response);
+      if (response.length < pageSize) {
+        break;
+      } else {
+        nextAfter = response.pop().updated_at;
+      }
+    }
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${orders.length} order${orders.length == 1 ? "" : "s"} has been retrieved.`);
+    return orders;
+  },
+};

package/actions/list-positions/list-positions.mjs

@@ -0,0 +1,27 @@
+import app from "../../alpaca.app.mjs";
+
+export default {
+  type: "action",
+  key: "alpaca-list-positions",
+  version: "0.0.1",
+  name: "List Positions",
+  description: "Retrieves a list of the account’s open positions, [See the docs](https://alpaca.markets/docs/api-references/trading-api/positions/#get-open-positions)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const response = await this.app.getPositions({
+      $,
+      isPaperAPI: this.isPaperAPI,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${response.length} position${response.length == 1 ? "" : "s"} has been retrieved.`);
+    return response;
+  },
+};

package/actions/place-order/place-order.mjs

@@ -0,0 +1,126 @@
+import app from "../../alpaca.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  type: "action",
+  key: "alpaca-place-order",
+  version: "0.0.1",
+  name: "Place Order",
+  description: "Places a new order for the given account. An order request may be rejected if the account is not authorized for trading, or if the tradable balance is insufficient to fill the order, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#request-a-new-order)",
+  props: {
+    app,
+    isPaperAPI: {
+      propDefinition: [
+        app,
+        "isPaperAPI",
+      ],
+    },
+    symbol: {
+      type: "string",
+      label: "Symbol",
+      description: "Symbol, asset ID, or currency pair to identify the asset to trade (ex. `AAPL`, `BTC/USD`).",
+    },
+    qty: {
+      type: "string",
+      label: "Qty",
+      description: "Number of shares to trade. Can be fractionable for only `market` and `day` order types.",
+      optional: true,
+    },
+    notional: {
+      type: "string",
+      label: "Notional",
+      description: "Dollar amount to trade. Cannot work with `Qty`. Can only work for `market` order types and `day` for time in force.",
+      optional: true,
+    },
+    side: {
+      propDefinition: [
+        app,
+        "side",
+      ],
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "Type",
+      options: [
+        "market",
+        "limit",
+        "stop",
+        "stop_limit",
+        "trailing_stop",
+      ],
+    },
+    timeInForce: {
+      type: "string",
+      label: "Time in Force",
+      description: "Please see [this doc](https://alpaca.markets/docs/trading/orders/#time-in-force) for more info on what values are possible for what kind of orders.",
+      options: [
+        "day",
+        "gtc",
+        "opg",
+        "cls",
+        "ioc",
+        "fok",
+      ],
+    },
+    limitPrice: {
+      type: "string",
+      label: "Limit Price",
+      description: "Required if type is `limit` or `stop_limit`",
+      optional: true,
+    },
+    stopPrice: {
+      type: "string",
+      label: "Stop Price",
+      description: "Required if type is `stop` or `stop_limit`",
+      optional: true,
+    },
+    trailPrice: {
+      type: "string",
+      label: "Trail Price",
+      description: "This or `trail_percent` is required if type is `trailing_stop`",
+      optional: true,
+    },
+    trailPercent: {
+      type: "string",
+      label: "Trail Percent",
+      description: "This or `trail_price` is required if type is `trailing_stop`",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    if (!this.qty && !this.notional) {
+      throw new ConfigurationError("Either `Qty` or `Notional` is required!");
+    }
+    if (this.qty && this.notional) {
+      throw new ConfigurationError("`Qty` and `Notional` cannot be given at the same time!");
+    }
+    if ((this.type == "limit" || this.type == "stop_limit") && !this.limitPrice) {
+      throw new ConfigurationError("`Limit Price` is required when `Type` is `limit` or `stop_limit`!");
+    }
+    if ((this.type == "stop" || this.type == "stop_limit") && !this.stopPrice) {
+      throw new ConfigurationError("`Stop Price` is required when `Type` is `limit` or `stop_limit`!");
+    }
+    if (this.type == "trailing_stop" && !this.trailPrice && !this.trailPercent) {
+      throw new ConfigurationError("`Trail Price` or `Trail Percent` is required when `Type` is `trailing_stop`!");
+    }
+    const response = await this.app.placeOrder({
+      $,
+      isPaperAPI: this.isPaperAPI,
+      data: {
+        symbol: this.symbol,
+        qty: this.qty,
+        notional: this.notional,
+        side: this.side,
+        type: this.type,
+        time_in_force: this.timeInForce,
+        limit_price: this.limitPrice,
+        stop_price: this.stopPrice,
+        trail_price: this.trailPrice,
+        trail_percent: this.trailPercent,
+      },
+    });
+    $.export("$summary", `Order(ID:${response.id}) has been placed.`);
+    return response;
+  },
+};

package/alpaca.app.mjs

@@ -0,0 +1,161 @@
+import { axios } from "@pipedream/platform";
+//Did not use Alpaca JS SDK because it does not work with OAuth
+export default {
+  type: "app",
+  app: "alpaca",
+  propDefinitions: {
+    isPaperAPI: {
+      type: "boolean",
+      label: "Paper API",
+      description: "Set to `true` if Paper API is used. Default is `false`.",
+      optional: true,
+    },
+    cancelOrders: {
+      type: "boolean",
+      label: "Cancel Orders",
+      description: "If `true` is specified, cancel all open orders before liquidating all positions.",
+      optional: true,
+    },
+    side: {
+      type: "string",
+      label: "Side",
+      description: "`buy` or `sell`",
+      options: [
+        "buy",
+        "sell",
+      ],
+    },
+    orderId: {
+      type: "string",
+      label: "Order Id",
+      description: "Order Id",
+      async options({
+        prevContext,
+        isPaperAPI,
+      }) {
+        const pageSize = 25;
+        const after = prevContext.nextAfter;
+        const orders = await this.getOrders({
+          isPaperAPI,
+          params: {
+            limit: pageSize,
+            after,
+            direction: "asc",
+          },
+        });
+        if (!orders.length) {
+          return [];
+        }
+        const nextAfter = orders[orders.length - 1]?.updated_at;
+        return {
+          options: orders.map((order) => ({
+            label: `${order.symbol} ${order.type} ${order.side} - ${order.qty ?? order.notional}`,
+            value: order.id,
+          })),
+          context: {
+            nextAfter,
+          },
+        };
+      },
+    },
+    positionSymbol: {
+      type: "string",
+      label: "Position Id",
+      description: "Position Id",
+      async options({ isPaperAPI }) {
+        const positions = await this.getPositions({
+          isPaperAPI,
+        });
+        return positions.map((position) => ({
+          label: `${position.symbol} ${position.side} - ${position.qty}`,
+          value: position.symbol,
+        }));
+      },
+    },
+  },
+  methods: {
+    _getUrl(path, isPaperAPI) {
+      // eslint-disable-next-line multiline-ternary
+      return `https://${isPaperAPI ? "paper-" : ""}api.alpaca.markets/v2${path}`;
+    },
+    _accessToken() {
+      return this.$auth.oauth_access_token;
+    },
+    _getHeaders(headers = {}) {
+      return {
+        "Authorization": `Bearer ${this._accessToken()}`,
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+        "User-Agent": "@PipedreamHQ/pipedream v0.1",
+        ...headers,
+      };
+    },
+    async _makeRequest({
+      $ = this, isPaperAPI = false, path, headers, ...otherConfig
+    } = {}) {
+      const config = {
+        url: this._getUrl(path, isPaperAPI),
+        headers: this._getHeaders(headers),
+        ...otherConfig,
+      };
+      return axios($, config);
+    },
+    async getOrders({ ...args } = {}) {
+      return this._makeRequest({
+        path: "/orders",
+        ...args,
+      });
+    },
+    async getPositions({ ...args } = {}) {
+      return this._makeRequest({
+        path: "/positions",
+        ...args,
+      });
+    },
+    async cancelOrder({
+      orderId, ...args
+    } = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/orders/${orderId}`,
+        ...args,
+      });
+    },
+    async cancelAllOrders({ ...args } = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: "/orders",
+        ...args,
+      });
+    },
+    async closePosition({
+      symbol, ...args
+    } = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/positions/${symbol}`,
+        ...args,
+      });
+    },
+    async closeAllPositions({ ...args } = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: "/positions",
+        ...args,
+      });
+    },
+    async getAccountInfo({ ...args } = {}) {
+      return this._makeRequest({
+        path: "/account",
+        ...args,
+      });
+    },
+    async placeOrder({ ...args } = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/orders",
+        ...args,
+      });
+    },
+  },
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@pipedream/alpaca",
+  "version": "0.0.1",
+  "description": "Pipedream Alpaca Components",
+  "main": "alpaca.app.mjs",
+  "keywords": [
+    "pipedream",
+    "alpaca"
+  ],
+  "homepage": "https://pipedream.com/apps/alpaca",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "@pipedream/platform": "^1.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}