Hoppscotch - Open source API development ecosystem

Helps you create requests faster, saving precious time on development - Subscribe

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](CODE_OF_CONDUCT.md) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=hoppscotch)](https://hoppscotch.io) [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/main?logo=Travis)](https://travis-ci.com/hoppscotch/hoppscotch) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fhoppscotch.io%2F)](https://twitter.com/share?text=%F0%9F%91%BD%20Hoppscotch%20%E2%80%A2%20Open%20source%20API%20development%20ecosystem%20-%20Helps%20you%20create%20requests%20faster,%20saving%20precious%20time%20on%20development.&url=https://hoppscotch.io&hashtags=hoppscotch&via=hoppscotch_io)

_{Built with ❤︎ by
liyasthomas and
contributors}

Sponsored by

Powered by

#### **Contact** [![Chat on Telegram](https://img.shields.io/badge/chat-Telegram-2CA5E0?logo=Telegram)](https://hoppscotch.io/telegram) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://hoppscotch.io/discord) #### **Support** [![Sponsor on GitHub](https://img.shields.io/badge/sponsor-GitHub-181717?logo=github)](https://github.com/sponsors/hoppscotch) [![Contribute on Open Collective](https://img.shields.io/badge/contribute-Open%20Collective-7FADF2?logo=open-collective)](https://opencollective.com/hoppscotch) [![Join on Patreon](https://img.shields.io/badge/join-Patreon-F96854?logo=patreon)](https://www.patreon.com/liyasthomas) [![Donate on PayPal](https://img.shields.io/badge/donate-PayPal-00457C?logo=paypal)](https://www.paypal.me/liyascthomas)

Table of contents

--- - [Features](#features) - [Demo](#demo) - [Usage](#usage) - [Built with](#built-with) - [Developing](#developing) - [Browser based development environment](#browser-based-development-environment) - [Local development environment](#local-development-environment) - [Docker compose](#docker-compose) - [Docker](#docker) - [Releasing](#releasing) - [Contributing](#contributing) - [Continuous Integration](#continuous-integration) - [Changelog](#changelog) - [Authors](#authors) - [Lead Developers](#lead-developers) - [Collaborators](#collaborators-) - [Financial Contributors](#financial-contributors) - [GitHub Sponsors](#github-sponsors) - [Open Collective](#open-collective) - [Code Contributors](#code-contributors) - [License](#license) ---

### **Features** ❤️ **Lightweight:** Crafted with minimalistic UI design. ⚡️ **Fast:** Send requests and get/copy responses in real-time.

HTTP Methods

--- - `GET` - Requests retrieve resource information - `HEAD` - Retrieve response headers identical to those of a GET request, but without the response body. - `POST` - The server creates a new entry in a database - `PUT` - Updates an existing resource - `DELETE` - Deletes resource or related component - `CONNECT` - Establishes a tunnel to the server identified by the target resource - `OPTIONS` - Describe the communication options for the target resource - `TRACE` - Performs a message loop-back test along the path to the target resource - `PATCH` - Very similar to `PUT` but makes a partial update on a resource - `` - Some APIs use custom request methods such as `LIST`. Type in your custom methods. ---

🌈 **Make it yours:** Customizable combinations for background, foreground and accent colors. [Customize now ✨](https://hoppscotch.io/settings)

Theming

--- - Choose theme: System, Light, Dark (default) and Black - Choose accent color: Blue, Green (default), Teal, Indigo, Purple, Orange, Pink, Red, and Yellow - Toggle auto-scroll to response

---

_Customized themes are synced with local session storage_ 🔥 **PWA:** Install as a [PWA](https://developers.google.com/web/progressive-web-apps) on your device.

Features

--- - Instant loading with Service Workers - Offline support - Low RAM/memory and CPU usage - Add to Home Screen - Desktop PWA ---

🚀 **Request:** Retrieve response from endpoint instantly. - Choose `method` - Enter `URL` - Send

Features

--- - Copy/share public "Share URL" - Generate/copy request code snippets for 10+ languages and frameworks - Import `cURL` - Label requests ---

🔌 **WebSocket:** Establish full-duplex communication channels over a single TCP connection. 📡 **Server Sent Events:** Receive a stream of updates from a server over a HTTP connection without resorting to polling. 🌩 **Socket.IO:** Send and Receive data with SocketIO server. 🦟 **MQTT:** Subscribe and Publish to topics of a MQTT Broker. 🔮 **GraphQL:** GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.

Features

--- - Set endpoint and get schemas - Multi-column docs - Set custom request headers - Query schema - Get query response ---

🔐 **Authentication:** Allows to identify the end user.

Types

--- - None - Basic - Bearer Token - OAuth 2.0 - OIDC Access Token/PKCE ---

📢 **Headers:** Describes the format the body of your request is being sent as. 📫 **Parameters:** Use request parameters to set varying parts in simulated requests. 📃 **Request Body:** Used to send and receive data via the REST API.

Options

--- - Set `Content Type` - Add or remove Parameter list - Toggle between key-value and RAW input parameter list ---

👋 **Response:** Contains the status line, headers and the message/response body.

Features

--- - Copy response to clipboard - Download response as a file - View response headers - View raw and preview of HTML, image, JSON, XML responses ---

⏰ **History:** Request entries are synced with cloud / local session storage to restore with a single click. 📁 **Collections:** Keep your API requests organized with collections and folders. Reuse them with a single click.

Features

--- - Unlimited collections, folders and requests - Nested folders - Export as / import from GitHub gist ---

_Collections are synced with cloud / local session storage_ 🌐 **Proxy:** Enable Proxy Mode from Settings to access blocked APIs.

Features

--- - Hide your IP address - Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues - Access APIs served in non-HTTPS (`http://`) - Use custom Proxy URL ---

_Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/hoppscotch/proxyscotch)** - **[Privacy Policy](https://github.com/hoppscotch/proxyscotch/wiki/Privacy-policy)**_ 📜 **Pre-Request Scripts β:** Snippets of code associated with a request that are executed before the request is sent.

Use-cases

--- - Initialize environment variables - Include timestamp in the request headers - Send a random alphanumeric string in the URL parameters ---

📄 **API Documentation:** Create and share dynamic API documentation easily, quickly.

Usage

--- 1. Add your requests to Collections and Folders 2. Export Collections and easily share your APIs with the rest of your team 3. Import Collections and Generate Documentation on-the-go ---

⌨️ **Keyboard Shortcuts:** Optimized for efficiency. > **[Shortcuts WIki](https://github.com/hoppscotch/hoppscotch/wiki/Shortcuts)** 🌎 **i18n:** Experience the app in your own language.

Usage

--- 1. Scroll down to the footer 2. Click "Choose Language" icon button 3. Select your language from the menu ---

_Keep in mind: Translations aren't available for all source and target language combinations_ **To provide a localized experience for users around the world, you can add you own translations.** _**All `i18n` contributions are welcome to `i18n` [branch](https://github.com/hoppscotch/hoppscotch/tree/i18n) only!**_ 📦 **Add-ons:** Official add-ons for hoppscotch. - **[Proxy](https://github.com/hoppscotch/proxyscotch)** - A simple proxy server created for Hoppscotch - **[CLI β](https://github.com/hoppscotch/hopp-cli)** - A CLI solution for Hoppscotch - **[Browser Extensions](https://github.com/hoppscotch/hoppscotch-extension)** - Browser extensions that simplifies access to Hoppscotch [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_16x16.png) **Firefox**](https://addons.mozilla.org/en-US/firefox/addon/hoppscotch) | [![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_16x16.png) **Chrome**](https://chrome.google.com/webstore/detail/hoppscotch-extension-for-c/amknoiejhlmhancpahfcfcfhllgkpbld) > **Extensions fixes `CORS` issues.** - **[Hopp-Doc-Gen](https://github.com/hoppscotch/hopp-doc-gen)** - An API doc generator CLI for Hoppscotch _Add-ons are developed and maintained under **[Official Hoppscotch Organization](https://github.com/hoppscotch)**._ ☁️ **Auth + Sync:** Sign in and sync in real-time. **Sign in with** - Google - GitHub **Sync** - History - Collections - Environments - Notes ✅ **Post-Request Tests β:** Write tests associated with a request that are executed after the request response.

Use-cases

--- - Check the status code as an integer - Filter response headers - Parse the response data ---

📝 **Notes** : Instantly jot down notes, tasks or whatever you feel like as they come to your mind. _Notes are only available for signed-in users_ 🌱 **Environments** : Environment variables allow you to store and reuse values in your requests and scripts.

Features

--- - Unlimited environments and variables - Initialize through pre-request script - Export as / import from GitHub gist ---

Use-cases

--- - By storing a value in a variable, you can reference it throughout your request section - If you need to update the value, you only have to change it in one place - Using variables increases your ability to work efficiently and minimizes the likelihood of error ---

👨‍👩‍👧‍👦 **Teams β:** Helps you collaborate across your team to design, develop, and test APIs faster.

Features

--- - Unlimited team collections and shared requests - Unlimited team members - User roles ---

**To find out more, please check out [Hoppscotch Wiki](https://github.com/hoppscotch/hoppscotch/wiki).** ## **Demo** [hoppscotch.io](https://hoppscotch.io) ## **Usage** 1. Choose `method` 2. Enter `URL` 3. Send request 4. Get response ## **Built with** - [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-lang.com), [Tailwind CSS](https://tailwindcss.com) - [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - [TypeScript](https://www.typescriptlang.org) - [Vue](https://vuejs.org) - [Nuxt](https://nuxtjs.org) ## **Developing** 0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/.env.example) file found in repository's root directory with your own keys and rename it to `.env`. _Sample keys only works with the [production build](https://hoppscotch.io)._ #### Browser based development environment [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch) #### Local development environment 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. 2. Install dependencies by running `npm install` within the directory that you cloned (probably `hoppscotch`). 3. Start the development server with `npm run dev`. 4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. #### Docker compose 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. 2. Run `docker-compose up` 3. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. ## **Docker** **Official container** [![hoppscotch/hoppscotch](https://img.shields.io/docker/pulls/hoppscotch/hoppscotch?style=social)](https://hub.docker.com/r/hoppscotch/hoppscotch) ```bash #pull docker pull hoppscotch/hoppscotch #build docker build -t hoppscotch/hoppscotch:latest . #run docker run -p 3000:3000 hoppscotch/hoppscotch:latest ``` **Legacy container** [![liyasthomas/postwoman](https://img.shields.io/docker/pulls/liyasthomas/postwoman?style=social)](https://hub.docker.com/r/liyasthomas/postwoman)

Legacy container

--- ```bash #pull docker pull liyasthomas/postwoman #build docker build -t liyasthomas/postwoman:latest . #run docker run -p 3000:3000 liyasthomas/postwoman:latest ``` ---

## **Releasing** 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. 2. Install dependencies by running `npm install` within the directory that you cloned (probably `hoppscotch`). 3. Build the release files with `npm run generate`. 4. Find the built project in `./dist`. ## **Contributing** Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/hoppscotch/hoppscotch/compare). Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. ## **Continuous Integration** We use [Travis CI](https://travis-ci.com) for continuous integration. Check out our [Travis CI Status](https://travis-ci.com/hoppscotch/hoppscotch). ## **Changelog** See the [`CHANGELOG`](CHANGELOG.md) file for details. ## **Authors** ### Lead Developers - **[Liyas Thomas](https://github.com/liyasthomas)** - _Author_ - **[Andrew Bastin](https://github.com/andrewbastin)** - _Lead developer_ - **[Caneco](https://twitter.com/caneco)** - _Logo and banner designer_ ### Collaborators

_{Liyas Thomas}
💻 🎨

_{Andrew Bastin}
💻

See the list of [contributors](https://github.com/hoppscotch/hoppscotch/graphs/contributors) who participated in this project. ### Financial Contributors Become a financial contributor and help us sustain our community [[Support](#support)]. #### GitHub Sponsors