Learning Node? Download my free Node and Express Handbooks 🔥

Introduction

Axios is a very popular JavaScript library you can use to perform HTTP requests, that works in both Browser and Node.js platforms.

Axios

It supports all modern browsers, including support for IE8 and higher.

It is promise-based, and this lets us write async/await code to perform XHR requests very easily.

Using Axios has quite a few advantages over the native Fetch API:

  • supports older browsers (Fetch needs a polyfill)
  • has a way to abort a request
  • has a way to set a response timeout
  • has built-in CSRF protection
  • supports upload progress
  • performs automatic JSON data transformation
  • works in Node.js

A video tutorial

Check out this video where I create an Express server that offers a POST endpoint, and I make an Axios request to it, to post data:


Installation

Axios can be installed using npm:

npm install axios

or yarn:

yarn add axios

or include it in your page using unpkg.com:

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

The Axios API

You can start an HTTP request from the axios object:

I use foo and bar as random names. Enter any kind of name to replace them.

axios({
  url: 'https://dog.ceo/api/breeds/list/all',
  method: 'get',
  data: {
    foo: 'bar'
  }
})

but for convenience, you will generally use

  • axios.get()
  • axios.post()

(like in jQuery you would use $.get() and $.post() instead of $.ajax())

Axios offers methods for all the HTTP verbs, which are less popular but still used:

  • axios.delete()
  • axios.put()
  • axios.patch()
  • axios.options()

and a method to get the HTTP headers of a request, discarding the body:

  • axios.head()

GET requests

One convenient way to use Axios is to use the modern (ES2017) async/await syntax.

This Node.js example queries the Dog API to retrieve a list of all the dogs breeds, using axios.get(), and it counts them:

const axios = require('axios')

const getBreeds = async () => {
  try {
    return await axios.get('https://dog.ceo/api/breeds/list/all')
  } catch (error) {
    console.error(error)
  }
}

const countBreeds = async () => {
  const breeds = await getBreeds()

  if (breeds.data.message) {
    console.log(`Got ${Object.entries(breeds.data.message).length} breeds`)
  }
}

countBreeds()

If you don’t want to use async/await you can use the Promises syntax:

const axios = require('axios')

const getBreeds = () => {
  try {
    return axios.get('https://dog.ceo/api/breeds/list/all')
  } catch (error) {
    console.error(error)
  }
}

const countBreeds = async () => {
  const breeds = getBreeds()
    .then(response => {
      if (response.data.message) {
        console.log(
          `Got ${Object.entries(response.data.message).length} breeds`
        )
      }
    })
    .catch(error => {
      console.log(error)
    })
}

countBreeds()

Add parameters to GET requests

A GET response can contain parameters in the URL, like this: https://site.com/?foo=bar.

With Axios you can perform this by using that URL:

axios.get('https://site.com/?foo=bar')

or you can use a params property in the options:

axios.get('https://site.com/', {
  params: {
    foo: 'bar'
  }
})

POST Requests

Performing a POST request is just like doing a GET request, but instead of axios.get, you use axios.post:

axios.post('https://site.com/')

An object containing the POST parameters is the second argument:

axios.post('https://site.com/', {
  foo: 'bar'
})

Found a typo or problem? Edit this page