⚠️ This version of the docs is deprecated. Looking for the latest features and updates? Explore our latest documentation.

# Make HTTP Requests with Node.js

HTTP requests are fundamental to working with APIs or other web services. You can make HTTP requests to retrieve data from APIs, fetch HTML from websites, or do pretty much anything your web browser can do.

Below, we'll review how to make HTTP requests using Node.js code on Pipedream.

We'll use the axios (opens new window) and got (opens new window) HTTP clients in the examples below, but you can use any npm package you'd like on Pipedream, so feel free to experiment with other clients, too.

If you're developing Pipedream components, you may find the @pipedream/platform version of axios helpful for displaying error data clearly in the Pipedream UI.

If you're new to HTTP, see our glossary of HTTP terms (opens new window) for a helpful introduction.

# Basic axios usage notes

To use axios on Pipedream, you'll just need to import the axios npm package:

import axios from "axios";

You make HTTP requests by passing a JavaScript object (opens new window) to axios that defines the parameters of the request. For example, you'll typically want to define the HTTP method and the URL you're sending data to:

{
  method: "GET",
  url: `https://swapi.co/api/films/`
}

axios returns a Promise (opens new window), which is just a fancy way of saying that it makes the HTTP request in the background (asynchronously) while the rest of your code runs. On Pipedream, all asynchronous code must be run synchronously, which means you'll need to wait for the HTTP request to finish before moving on to the next step. You do this by adding an await in front of the call to axios.

Putting all of this together, here's how to make a basic HTTP request on Pipedream:

const resp = await axios({
  method: "GET",
  url: `https://swapi.co/api/films/`,
});

The response object resp contains a lot of information about the response: its data, headers, and more. Typically, you just care about the data, which you can access in the data property of the response:

const resp = await axios({
  method: "GET",
  url: `https://swapi.co/api/films/`,
});

// HTTP response data is in the data property
const data = resp.data;

Alternatively, you can access the data using object destructuring (opens new window), which is equivalent to the above and preferred in modern JavaScript:

const { data } = resp;

# Send a GET request to fetch data

Make a request to retrieve Star Wars films from the Star Wars API:

import axios from "axios";

// Make an HTTP GET request using axios
const resp = await axios({
  method: "GET",
  url: `https://swapi.co/api/films/`,
});

// Retrieve just the data from the response
const { data } = resp;

Copy this workflow to run this example on Pipedream (opens new window).

# Send a POST request to submit data

POST sample JSON to JSONPlaceholder (opens new window), a free mock API service:

import axios from "axios";

// Make an HTTP POST request using axios
const resp = await axios({
  method: "POST",
  url: `https://jsonplaceholder.typicode.com/posts`,
  data: {
    name: "Luke",
  }
});

// Retrieve just the data from the response
const { data } = resp;

When you make a POST request, you pass POST as the method, and include the data you'd like to send in the data object.

Copy this workflow to run this example on Pipedream (opens new window).

# Pass query string parameters to a GET request

Retrieve fake comment data on a specific post using JSONPlaceholder (opens new window), a free mock API service. Here, you fetch data from the /comments resource, retrieving data for a specific post by query string parameter: /comments?postId=1.

import axios from "axios";

// Make an HTTP GET request using axios
const resp = await axios({
  method: "GET",
  url: `https://jsonplaceholder.typicode.com/comments`,
  params: {
    postId: 1,
  },
});

// Retrieve just the data from the response
const { data } = resp;

You should pass query string parameters using the params object, like above. When you do, axios automatically URL-encodes (opens new window) the parameters for you, which you'd otherwise have to do manually.

Copy this workflow to run this code on Pipedream (opens new window).

# Send a request with HTTP headers

You pass HTTP headers in the headers object of the axios request:

import axios from "axios";

// Make an HTTP POST request using axios
const resp = await axios({
  method: "POST",
  url: `https://jsonplaceholder.typicode.com/posts`,
  headers: {
    "Content-Type": "application/json",
  },
  data: {
    name: "Luke",
  },
});

# Send a request with a secret or API key

Most APIs require you authenticate HTTP requests with an API key or other token. Please review the docs for your service to understand how they accept this data.

Here's an example showing an API key passed in an HTTP header:

import axios from "axios";

// Make an HTTP POST request using axios
const resp = await axios({
  method: "POST",
  url: `https://jsonplaceholder.typicode.com/posts`,
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "123", // API KEY
  },
  data: {
    name: "Luke",
  },
});

Copy this workflow to run this code on Pipedream (opens new window).

# Send multiple HTTP requests in sequence

There are many ways to make multiple HTTP requests. This code shows you a simple example that sends the numbers 1, 2, and 3 in the body of an HTTP POST request:

import axios from "axios";

// We'll store each response and return them in this array
const responses = [];

for (const num of [1, 2, 3]) {
  const resp = await axios({
    method: "POST",
    url: params.url,
    data: {
      num, // Will send the current value of num in the loop
    },
  });
  responses.push(resp.data);
}

return responses;

This sends each HTTP request in sequence, one after another, and returns an array of response data returned from the URL to which you send the POST request. If you need to make requests in parallel, see these docs.

Copy this workflow (opens new window) and fill in your destination URL to see how this works. This workflow iterates over the value of a Pipedream step export - data returned from a previous step. Since you often want to iterate over data returned from a Pipedream action or other code step, this is a common use case.

# Send multiple HTTP requests in parallel

Sometimes you'll want to make multiple HTTP requests in parallel. If one request doesn't depend on the results of another, this is a nice way to save processing time in a workflow. It can significantly cut down on the time you spend waiting for one request to finish, and for the next to begin.

To make requests in parallel, you can use two techniques. By default, we recommend using promise.allSettled (opens new window), which makes all HTTP requests and returns data on their success / failure. If an HTTP request fails, all other requests will proceed.

import axios from "axios"
const arr = ["https://www.example.com", "https://www.cnn.com", "https://www.espn.com"]
const promises = arr.map(url => axios.get(url))
return Promise.allSettled(promises)

First, we generate an array of axios.get requests (which are all Promises (opens new window)), and then call Promise.allSettled to run them in parallel.

When you want to stop future requests when one of the requests fails, you can use Promise.all (opens new window), instead:

import axios from "axios"
const arr = ["https://www.example.com", "https://www.cnn.com", "https://www.espn.com"]
const promises = arr.map(url => axios.get(url))
return Promise.all(promises)

The Mozilla docs expand on the difference between these methods, and when you may want to use one or the other:

The Promise.allSettled() method returns a promise that resolves after all of the given promises have either fulfilled or rejected, with an array of objects that each describes the outcome of each promise.

It is typically used when you have multiple asynchronous tasks that are not dependent on one another to complete successfully, or you'd always like to know the result of each promise.

In comparison, the Promise returned by Promise.all() may be more appropriate if the tasks are dependent on each other / if you'd like to immediately reject upon any of them rejecting.

# Send a multipart/form-data request

import axios from "axios";
import FormData from "form-data";

const formData = new FormData();
formData.append("name", "Luke Skywalker");

const headers = formData.getHeaders();
const config = {
  method: "POST",
  url: params.url,
  headers,
  data: formData,
};
return await axios(config);

Copy this workflow (opens new window) to run this example.

# Download a file to the /tmp directory

This example shows you how to download a file to a file in the /tmp directory. This can be especially helpful for downloading large files: it streams the file to disk, minimizing the memory the workflow uses when downloading the file.

import stream from "stream";
import { promisify } from "util";
import fs from "fs";
import got from "got";

// DOWNLOAD
const pipeline = promisify(stream.pipeline);
await pipeline(
  got.stream(params.downloadURL),
  fs.createWriteStream(params.filePath)
);

Copy this workflow (opens new window) to run this example.

# Upload a file from the /tmp directory

This example shows you how to make a multipart/form-data request with a file as a form part. You can store and read any files from the /tmp directory.

This can be especially helpful for uploading large files: it streams the file from disk, minimizing the memory the workflow uses when uploading the file.

import axios from "axios";
import fs from "fs";
import FormData from "form-data";

const formData = new FormData();
formData.append("file", fs.createReadStream(params.pathToYourFile));
const headers = formData.getHeaders();

const config = {
  method: "POST",
  url: params.url,
  headers,
  data: formData,
};
return await axios(config);

Copy this workflow (opens new window) to run this example.

# Use an HTTP proxy to proxy requests through another host

When you make HTTP requests to certain services, they might require you whitelist a set of IP addresses those requests come from. Often, this is to improve the security of the target service.

By default, HTTP requests made from Pipedream can come from a range of IP addresses. If you need to make requests from a single IP address, you can route traffic through an HTTP proxy:

import axios from "axios";

import httpsProxyAgent from "https-proxy-agent";
const agent = new httpsProxyAgent(`http://${user}:${pass}@${host}:${port}`);

const config = {
  method: "GET",
  url,
  httpsAgent: agent,
};

const resp = await axios.request(config);

If you don't have access to an HTTP proxy, and you are a paying Pipedream customer, reach out to our team (opens new window). We operate a proxy that you can use for HTTP requests made through Pipedream.

Copy this workflow to run this code on Pipedream (opens new window).

# IP addresses for HTTP requests made from Pipedream workflows

By default, HTTP requests made from Pipedream can come from a large range of IP addresses. If you need to restrict the IP addresses HTTP requests come from, you have two options:

# Forward an incoming HTTP request to another URL

Often, you'll want to forward an incoming HTTP request from Pipedream to another service, with the same HTTP method, headers, body, etc. This workflow (opens new window) does just that.

Once you Copy the workflow, enter the URL where you'd like to forward an HTTP request in the forward_http_request step. Every HTTP request you send to the workflow's HTTP endpoint will get forwarded to that URL.

const config = {
  method: event.method || "POST",
  url: params.url,
};

const { query } = event;
if (Object.keys(query).length) {
  config.params = query;
}

// Headers, removing the original Host
const { headers } = event;
delete headers.host;
if (Object.keys(headers).length) {
  config.headers = headers;
}

if (event.body) config.data = event.body;

return await require("@pipedreamhq/platform").axios(this, config);

You can modify this workflow in any way you'd like. For example, if you wanted to forward only certain types of requests, you could add another Node.js code step before the forward_http_request step, ending the workflow early if the request doesn't contain a specific key in the HTTP payload:

if (!event.body.myImportantData) {
  $end("myImportantData not present in HTTP payload. Exiting");
}

# Stream a downloaded file directly to another URL

Sometimes you need to upload a downloaded file directly to another service, without processing the downloaded file. You could download the file and then upload it to the other URL, but these intermediate steps are unnecessary: you can just stream the download to the other service directly, without saving the file to disk.

This method is especially effective for large files that exceed the limits of the /tmp directory.

Copy this workflow (opens new window) or paste this code into a new Node.js code step:

import stream from "stream";
import { promisify } from "util";
import fs from "fs";
import got from "got";

const pipeline = promisify(stream.pipeline);

await pipeline(
  got.stream(params.downloadURL),
  got.stream.post(params.uploadURL)
);

You'll be asked to provide the Download URL — the URL of the content you want to download — and the Upload URL — the place you want to upload the content to. got streams the content directly, downloading the file using a GET request and uploading it as a POST request.

If you need to modify this behavior, see the got Stream API (opens new window).

# Catch and process HTTP errors

By default, axios throws an error when the HTTP response code is in the 400-500 range (a client or server error). If you'd like to process the error data instead of throwing an error, you can pass a custom function to the validateStatus property:

import axios from "axios";

const resp = await axios({
  url: "https://httpstat.us/400",
  validateStatus: () => true, // will not throw error when axios gets a 400+ status code (the default behavior)
})
if (resp.status >= 400) {
  this.debug = resp
  throw new Error(JSON.stringify(resp.data)) // This can be modified to throw any error you'd like
}
return resp

See the axios docs (opens new window) for more details.

# Paginating API requests

When you fetch data from an API, the API may return records in "pages". For example, if you're trying to fetch a list of 1,000 records, the API might return those in groups of 100 items.

Different APIs paginate data in different ways. You'll need to consult the docs of your API provider to see how they suggest you paginate through records.

← Working with the filesystem in Node.js →