List Orders with Alpaca API on New Order Created from Square API

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

Trigger workflow on

New Order Created from the Square API

Next, do this

List Orders with the Alpaca 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 Square trigger and Alpaca action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Order Created trigger
1. Connect your Square account
2. Configure timer
3. Select a Location
Configure the List Orders action
1. Connect your Alpaca account
2. Optional- Configure Paper API
3. Optional- Configure Symbols
4. Optional- Select a Side
5. Optional- Select a Status
6. Optional- Configure After
7. Optional- Configure Until
8. Optional- Configure Nested
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#

New Order Created on Square

Description:Emit new event for every new order created. [See the docs](https://developer.squareup.com/reference/square/orders-api/search-orders)

Version:0.0.3

Key:square-new-order-created

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-new-order-created",
  name: "New Order Created",
  description: "Emit new event for every new order created. [See the docs](https://developer.squareup.com/reference/square/orders-api/search-orders)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...base.props,
    location: {
      propDefinition: [
        base.props.square,
        "location",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { order_entries: orders } = await this.square.listOrders({
        data: {
          ...this.getBaseParams(),
        },
      });
      if (!(orders?.length > 0)) {
        return;
      }
      this._setLastTs(Date.parse(orders[0].created_at));
      orders?.slice(0, constants.MAX_HISTORICAL_EVENTS)
        .reverse()
        .forEach((order) => this.$emit(order, this.generateMeta(order)));
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        location_ids: [
          this.location,
        ],
        query: {
          sort: {
            sort_field: "CREATED_AT",
            sort_order: "DESC",
          },
        },
      };
    },
    generateMeta(order) {
      return {
        id: order.id,
        summary: `Order created: ${order.id}`,
        ts: Date.parse(order.created_at),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs;
    let cursor;
    let done = false;

    do {
      const response = await this.square.listOrders({
        data: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { orders } = response;
      if (!(orders?.length > 0)) {
        break;
      }
      if (!newLastTs) {
        newLastTs = Date.parse(orders[0].created_at);
      }
      for (const order of orders) {
        if (Date.parse(order.created_at) <= lastTs) {
          done = true;
          break;
        }
        this.emitEvent(order);
      }
      cursor = response?.cursor;
    } while (cursor && !done);

    this._setLastTs(newLastTs);
  },
};

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
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Location	`location`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Square uses OAuth authentication. When you connect your Square account, Pipedream will open a popup window where you can sign into Square and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Square API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

Action#

List Orders on Alpaca

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)

Version:0.0.2

Key:alpaca-list-orders

View on GitHub

Alpaca Overview#

Alpaca API allows you to harness the power of automated trading by providing an interface to manage your stock and equity portfolio through simple API calls. It's particularly suited for building trading bots, algorithmic trading strategies, or just automating interactions with your investment portfolio. Whether you're looking to place trades based on specific market conditions, automatically adjust your portfolio in response to certain triggers, or simply streamline your investment activities, Alpaca's trading API offers a robust solution.

Action Code#

import app from "../../alpaca.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  type: "action",
  key: "alpaca-list-orders",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  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;
  },
};

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
Alpaca	`app`	`app`	This component uses the Alpaca app.
Paper API	`isPaperAPI`	`boolean`	Set to `true` if Paper API is used. Default is `false`.
Symbols	`symbols`	`string[]`	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`).
Side	`side`	`string`	Select a value from the drop down menu:`buysell`
Status	`status`	`string`	Select a value from the drop down menu:`openclosedall`
After	`after`	`string`	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`
Until	`until`	`string`	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`
Nested	`nested`	`string`	If true, the result will roll up multi-leg orders under the `legs` field of primary order.

Action Authentication#

Alpaca uses OAuth authentication. When you connect your Alpaca account, Pipedream will open a popup window where you can sign into Alpaca and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Alpaca API.

Pipedream requests the following authorization scopes when you connect your account:

account:writetradingdata

About Alpaca#

Commission-Free API First Stock Brokerage

More Ways to Connect Alpaca + Square#

Other Popular Integrations#

Cancel All Orders with Alpaca API on Catalog Item Updated from Square API

Square + Alpaca

List Orders with Alpaca API on New Order Created from Square API

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

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular