Setup Hoppscotch

To get started with Hoppscotch, you need to choose a platform to use it on. Hoppscotch is available on the following platforms:

• Web
• Desktop
• CLI

​

Web App

To get started with Hoppscotch web client, head to hoppscotch.io and start using it right away for free.

​

Deployed APIs

To test your deployed APIs, you can use the Hoppscotch Web App without any additional setup.

​

Locally served APIs

If you’re using Hoppscotch web app to test your locally served APIs, it is recommended that you install the Hoppscotch Browser Extension. Read the prerequisites and follow the steps below to get started.

1. Install the browser extension from the below links:

   • Chrome
   • Firefox

2. Click on the Hoppscotch Browser Extension icon from the browser toolbar and ensure that hoppscotch.io is in your active origins. If you are using Hoppscotch Self-Host, add your own domain as a new origin

   

3. Refresh the Hoppscotch web app to apply the changes.

4. Open the interceptor and change the middleware to the browser extension.

   You can either go to the settings and enable the use of the browser extension as shown below:

   

   Or you can open the interceptor menu and change the middleware as shown below:

   

​

Fix CORS errors

If your API is CORS enabled, you should switch the interceptor to ”Proxy” from the Settings page or the bottom bar to avoid CORS errors.

Proxy mode helps you to:

• Bypass CORS (Cross-Origin Resource Sharing) restrictions.
• Hide your IP address.
• Access APIs served in non-HTTPS endpoints.
• Use your own Proxy middleware URL.

​

Desktop App

Hoppscotch Desktop App is a cross-platform desktop application built with Tauri and Hoppscotch Web Client. It is a standalone version of Hoppscotch that can be installed on your computer and used without a browser. Hoppscotch Desktop App is available for Mac, Windows and Linux.

​

CLI

Hoppscotch CLI is the command-line interface for Hoppscotch. It is a standalone version of Hoppscotch that can be installed on your computer and used without a browser. Hoppscotch CLI is available as an npm package.