List Trades with BitMEX API on New Item in Feed from RSS API

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

Trigger workflow on

New Item in Feed from the RSS API

Next, do this

List Trades 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 RSS 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 New Item in Feed trigger
1. Connect your RSS account
2. Configure timer
3. Configure Feed URL
4. Configure Published After
Configure the List Trades action
1. Connect your BitMEX account
2. Optional- Configure Filter
3. Optional- Select a Symbol
4. Optional- Configure Columns
5. Optional- Configure Count
6. Optional- Configure Start
7. Optional- Configure Reverse
8. Optional- Configure Start Time
9. Optional- Configure End Time
10. Optional- Configure Target Account ID
11. Optional- Configure Target Account IDs
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 Item in Feed on RSS

Description:Emit new items from an RSS feed

Version:1.2.10

Key:rss-new-item-in-feed

View on GitHub

RSS Overview#

The RSS app allows users to automatically fetch and parse updates from web feeds. This functionality is pivotal for staying abreast of content changes or updates from websites, blogs, and news outlets that offer RSS feeds. With Pipedream, you can harness the RSS API to trigger workflows that enable a broad range of automations, like content aggregation, monitoring for specific keywords, notifications, and data synchronization across platforms.

Trigger Code#

// components/rss/sources/new-item-in-feed/new-item-in-feed.ts
import { defineSource } from "@pipedream/types";

// components/rss/app/rss.app.ts
import {
  ConfigurationError,
  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL
} from "@pipedream/platform";
import { defineApp } from "@pipedream/types";
import axios from "axios";
import FeedParser from "feedparser";
import hash from "object-hash";
var rss_app_default = defineApp({
  type: "app",
  app: "rss",
  propDefinitions: {
    url: {
      type: "string",
      label: "Feed URL",
      description: "Enter the URL for any public RSS feed"
    },
    urls: {
      type: "string[]",
      label: "Feed URLs",
      description: "Enter either one or multiple URLs from any public RSS feed"
    },
    timer: {
      type: "$.interface.timer",
      description: "How often you want to poll the feed for new items",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL
      }
    }
  },
  methods: {
    // in theory if alternate setting title and description or aren't unique this won't work
    itemTs(item = {}) {
      const {
        pubdate,
        pubDate,
        date_published
      } = item;
      const itemPubDate = pubdate ?? pubDate ?? date_published;
      if (itemPubDate) {
        return +new Date(itemPubDate);
      }
      return +/* @__PURE__ */ new Date();
    },
    itemKey(item = {}) {
      const {
        id,
        guid,
        link,
        title
      } = item;
      const itemId = id ?? guid ?? link ?? title;
      if (itemId) {
        return itemId.length > 64 ? itemId.slice(-64) : itemId;
      }
      return hash(item);
    },
    async fetchFeed(url) {
      const res = await axios.request({
        url,
        method: "GET",
        headers: {
          "accept": "text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8, application/json, application/feed+json",
          "User-Agent": "@PipedreamHQ/pipedream v1.0"
        },
        validateStatus: () => true,
        // does not throw on any bad status code
        responseType: "stream"
        // stream is required for feedparser
      });
      if (res.status === 404) throw new ConfigurationError(`The URL ${url} does not exist. Please double-check the URL and try again.`);
      if (res.status === 429) throw new ConfigurationError(`${url} isn't returning a valid feed because requests have been rate-limited. Please reach out to the site hosting the RSS feed to confirm or increase their rate limit.`);
      if (res.status >= 500) throw new ConfigurationError(`${url} is returning a server error. Please try again later or reach out to the site hosting the RSS feed if you continue to see this error.`);
      if (res.status >= 400) {
        throw new ConfigurationError(`Error fetching URL ${url}. Please load the URL directly in your browser and try again.`);
      }
      return {
        data: res.data,
        contentType: res.headers["content-type"]
      };
    },
    async parseFeed(stream) {
      const feedparser = new FeedParser({
        addmeta: true
      });
      const items = [];
      await new Promise((resolve, reject) => {
        feedparser.on("error", reject);
        feedparser.on("end", resolve);
        feedparser.on("readable", function() {
          let item = this.read();
          while (item) {
            if (item["atom:title"] && item["atom:title"]["#"]) {
              item.title = item["atom:title"]["#"];
            } else if (item["rss:title"] && item["rss:title"]["#"]) {
              item.title = item["rss:title"]["#"];
            }
            for (const k in item) {
              if (item[`rss:${k}`]) {
                delete item[`rss:${k}`];
                continue;
              }
              const o = item[k];
              if (o == null || typeof o === "object" && !Object.keys(o).length || Array.isArray(o) && !o.length) {
                delete item[k];
                continue;
              }
            }
            items.push(item);
            item = this.read();
          }
        });
        stream.pipe(feedparser);
      });
      return items;
    },
    isJSONFeed(response) {
      const acceptedJsonFeedMimes = [
        "application/feed+json",
        "application/json"
      ];
      return acceptedJsonFeedMimes.includes(response?.contentType?.toLowerCase());
    },
    async parseJSONFeed(stream) {
      const buffer = await new Promise((resolve, reject) => {
        const _buf = [];
        stream.on("data", (chunk) => _buf.push(chunk));
        stream.on("end", () => resolve(Buffer.concat(_buf)));
        stream.on("error", (err) => reject(err));
      });
      const contentString = buffer.toString();
      const feed = JSON.parse(contentString);
      return feed?.items || [];
    },
    async fetchAndParseFeed(u) {
      const url = this.validateAndFixFeedURL(u);
      const response = await this.fetchFeed(url);
      if (this.isJSONFeed(response)) {
        return await this.parseJSONFeed(response.data);
      } else {
        return await this.parseFeed(response.data);
      }
    },
    validateAndFixFeedURL(u) {
      if (!u) throw new ConfigurationError("No URL provided. Please enter an RSS URL to fetch");
      let url = u;
      if (!/^(?:(ht|f)tp(s?):\/\/)/.test(url)) {
        url = `https://${u}`;
      }
      return url;
    },
    sortItems(items) {
      return items.sort((itemA, itemB) => {
        if (this.itemTs(itemA) > this.itemTs(itemB)) {
          return 1;
        }
        return -1;
      });
    },
    sortItemsForActions(items) {
      return this.sortItems(items).reverse();
    }
  }
});

// components/rss/sources/common/common.ts
var common_default = {
  props: {
    rss: rss_app_default,
    timer: {
      propDefinition: [
        rss_app_default,
        "timer"
      ]
    }
  },
  methods: {
    generateMeta: function(item) {
      return {
        id: this.rss.itemKey(item),
        summary: item.title,
        ts: this.rss.itemTs(item)
      };
    }
  }
};

// components/rss/sources/new-item-in-feed/new-item-in-feed.ts
var new_item_in_feed_default = defineSource({
  ...common_default,
  key: "rss-new-item-in-feed",
  name: "New Item in Feed",
  description: "Emit new items from an RSS feed",
  version: "1.2.10",
  type: "source",
  dedupe: "unique",
  props: {
    ...common_default.props,
    url: {
      propDefinition: [
        rss_app_default,
        "url"
      ]
    },
    publishedAfter: {
      type: "string",
      label: "Published After",
      description: "Emit items published after the specified date in ISO 8601 format .e.g `2022-12-07T12:57:10+07:00`",
      default: new Date(Date.now() - 24 * 60 * 60 * 1e3).toISOString()
      // default to one day ago
    }
  },
  hooks: {
    async activate() {
      await this.rss.fetchAndParseFeed(this.url);
    }
  },
  methods: {
    ...common_default.methods,
    generateMeta: function(item) {
      return {
        id: this.rss.itemKey(item),
        summary: item.title,
        ts: Date.now()
      };
    }
  },
  async run() {
    const items = await this.rss.fetchAndParseFeed(this.url);
    for (const item of items.reverse()) {
      const publishedAfter = +new Date(this.publishedAfter);
      const ts = this.rss.itemTs(item);
      if (Number.isNaN(publishedAfter) || publishedAfter > ts) {
        continue;
      }
      const meta = this.generateMeta(item);
      this.$emit(item, meta);
    }
  }
});
export {
  new_item_in_feed_default as default
};

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
RSS	`rss`	`app`	This component uses the RSS app.
	`timer`	`$.interface.timer`	How often you want to poll the feed for new items
Feed URL	`url`	`string`	Enter the URL for any public RSS feed
Published After	`publishedAfter`	`string`	Emit items published after the specified date in ISO 8601 format .e.g `2022-12-07T12:57:10+07:00`

Trigger Authentication#

The RSS API does not require authentication.

About RSS#

Real Simple Syndication

Action#

List Trades on BitMEX

Description:Retrieve a list of executed trades from your BitMEX account. [See the documentation](https://www.bitmex.com/api/explorer/#!/Execution/Execution_getTradeHistory)

Version:0.0.1

Key:bitmex-list-trades

View on GitHub

Action Code#

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

export default {
  key: "bitmex-list-trades",
  name: "List Trades",
  description: "Retrieve a list of executed trades from your BitMEX account. [See the documentation](https://www.bitmex.com/api/explorer/#!/Execution/Execution_getTradeHistory)",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: false,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    bitmex,
    filter: {
      type: "object",
      label: "Filter",
      description: "Generic table filter. Send JSON key/value pairs, such as `{\"execType\": [\"Settlement\", \"Trade\"]}` to filter on multiple values. For explanations on filters refer to http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_8_8.html",
      optional: true,
    },
    symbol: {
      propDefinition: [
        bitmex,
        "symbol",
      ],
      optional: true,
    },
    columns: {
      type: "string[]",
      label: "Columns",
      description: "Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.",
      optional: true,
    },
    count: {
      type: "integer",
      label: "Count",
      description: "Number of results to fetch. Must be a positive integer. Defaults to 100",
      optional: true,
      default: 100,
    },
    start: {
      type: "integer",
      label: "Start",
      description: "Starting point for results. Defaults to 0",
      optional: true,
      default: 0,
    },
    reverse: {
      type: "boolean",
      label: "Reverse",
      description: "If `true`, will sort results newest first. Defaults to `false`",
      optional: true,
      default: false,
    },
    startTime: {
      type: "string",
      label: "Start Time",
      description: "Starting date filter for results (format: `YYYY-MM-DDTHH:mm:ss.sssZ`)",
      optional: true,
    },
    endTime: {
      type: "string",
      label: "End Time",
      description: "Ending date filter for results (format: `YYYY-MM-DDTHH:mm:ss.sssZ`)",
      optional: true,
    },
    targetAccountId: {
      type: "integer",
      label: "Target Account ID",
      description: "AccountId fetching the trade history, must be a paired account with main user",
      optional: true,
    },
    targetAccountIds: {
      type: "string",
      label: "Target Account IDs",
      description: "AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard `*` to get all accounts linked to the authenticated user",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.bitmex.getTradeHistory({
      filter: this.filter,
      symbol: this.symbol,
      columns: this.columns,
      count: this.count,
      start: this.start,
      reverse: this.reverse,
      startTime: this.startTime,
      endTime: this.endTime,
      targetAccountId: this.targetAccountId,
      targetAccountIds: this.targetAccountIds,
    });

    const count = Array.isArray(response)
      ? response.length
      : 0;
    $.export("$summary", `Successfully retrieved ${count} trade${count === 1
      ? ""
      : "s"}`);
    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.
Filter	`filter`	`object`	Generic table filter. Send JSON key/value pairs, such as `{"execType": ["Settlement", "Trade"]}` to filter on multiple values. For explanations on filters refer to http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_8_8.html
Symbol	`symbol`	`string`	Select a value from the drop down menu.
Columns	`columns`	`string[]`	Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Count	`count`	`integer`	Number of results to fetch. Must be a positive integer. Defaults to 100
Start	`start`	`integer`	Starting point for results. Defaults to 0
Reverse	`reverse`	`boolean`	If `true`, will sort results newest first. Defaults to `false`
Start Time	`startTime`	`string`	Starting date filter for results (format: `YYYY-MM-DDTHH:mm:ss.sssZ`)
End Time	`endTime`	`string`	Ending date filter for results (format: `YYYY-MM-DDTHH:mm:ss.sssZ`)
Target Account ID	`targetAccountId`	`integer`	AccountId fetching the trade history, must be a paired account with main user
Target Account IDs	`targetAccountIds`	`string`	AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard `*` to get all accounts linked to the authenticated user