Kick off Hacktoberfest ๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘Œ with the next best thing DEVs will โค๏ธ


hoppscotch.io logo

Hoppscotch - A free, fast and beautiful API request builder

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

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=postwoman)](https://hoppscotch.io) [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/master?logo=Travis)](https://travis-ci.com/hoppscotch/hoppscotch) [![GitHub release](https://img.shields.io/github/release/hoppscotch/hoppscotch/all?logo=GitHub)](https://github.com/hoppscotch/hoppscotch/releases/latest) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fhoppscotch.io%2F)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fhoppscotch.io&text=%F0%9F%91%BD%20hoppscotch%20%E2%80%A2%20API%20request%20builder%20-%20Helps%20you%20create%20your%20requests%20faster%2C%20saving%20you%20precious%20time%20on%20your%20development&original_referer=https%3A%2F%2Ftwitter.com%2Fshare%3Ftext%3D%25F0%259F%2591%25BD%2520hoppscotch%2520%25E2%2580%25A2%2520API%2520request%2520builder%2520-%2520Helps%2520you%2520create%2520your%2520requests%2520faster%2C%2520saving%2520you%2520precious%2520time%2520on%2520your%2520development%26url%3Dhttps%3A%2F%2Fhoppscotch.io%26hashtags%3Dhoppscotch%26via%3Dliyasthomas&via=liyasthomas&hashtags=hoppscotch)

Built with โค๏ธŽ by liyasthomas and contributors

Screenshot1
#### **Contact** [![Chat on Telegram](https://img.shields.io/badge/chat-Telegram-2CA5E0?logo=Telegram)](https://t.me/hoppscotch) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/GAMWxmR) #### **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) - [Versioning](#versioning) - [Changelog](#changelog) - [Authors](#authors) - [Lead Developers](#lead-developers) - [Testing and Debugging](#testing-and-debugging) - [Collaborators](#collaborators-) - [Thanks](#thanks) - [Financial Contributors](#financial-contributors) - [GitHub Sponsors](#github-sponsors) - [Organizations](#organizations) - [Individuals](#individuals) - [Code Contributors](#code-contributors) - [License](#license) - [Acknowledgements](#acknowledgements) - [Badges](#badges) ---
### **Features** โค๏ธ **Lightweight:** Crafted with minimalistic UI design. โšก๏ธ **Fast:** Send requests and get/copy responses in real-time. **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. **Theming:** [Customize now โœจ](https://hoppscotch.io/settings) - Choose theme: System, Light, Dark (default) and Black - Choose accent color: Blue, Green (default), Teal, Purple, Orange, Pink, Red, and Yellow - Toggle multi-colored headings - 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 for `JavaScript XHR`, `Fetch` and `cURL` - Import `cURL` - Label requests ๐Ÿ”Œ **WebSocket:** Establish full-duplex communication channels over a single TCP connection. - Send and receive data - Basic and Bearer Token authentication ๐Ÿ“ก **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. - 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 ๐Ÿ‘‹ **Responses:** Contains the status line, headers and the message/response body. - Copy response to clipboard - Download response as a file - View preview of HTML 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. _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 Hoppscotch Proxy is hosted by Apollo Software - **[Privacy Policy](https://apollosoftware.xyz/legal/postwoman)**_ ๐Ÿ“œ **Pre-Request Scripts ฮฒ:** Snippets of code associated with a request that are executed before the request is sent. **Use-cases** - 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. 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/proxywoman)** - 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.** _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. **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 **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) - [Vue](https://vuejs.org) - [Nuxt](https://nuxtjs.org) ## **Developing** 0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/master/.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** ```bash #pull docker pull liyasthomas/postwoman #build docker build -t postwoman:latest . #run docker run -p 3000:3000 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 build`. 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). ## **Versioning** This project is developed by [Liyas Thomas](https://github.com/liyasthomas) using the [Semantic Versioning specification](https://semver.org). For the versions available, see the [releases on this repository](https://github.com/liyasthomas/hoppscotch/releases). ## **Changelog** See the [`CHANGELOG`](CHANGELOG.md) file for details. ## **Authors** ### Lead Developers - **[Liyas Thomas](https://github.com/liyasthomas)** - _Author_ - **[John Harker](https://github.com/NBTX)** - _Lead developer_ - **[Andrew Bastin](https://github.com/andrewbastin)** - _Lead developer_ - **[James George](https://github.com/jamesgeorge007)** - _Lead maintainer_ - **[Caneco](https://twitter.com/caneco)** - _Logo and banner designer_ ### Testing and Debugging - [Contributors](https://github.com/hoppscotch/hoppscotch/graphs/contributors) ### Collaborators [![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)

Liyas Thomas
๐Ÿ’ป ๐ŸŽจ
John Harker
๐Ÿ’ป ๐ŸŽจ
Nicholas La Roux
๐Ÿ’ป
Thomas Yuba
๐Ÿ’ป
Nick Palenchar
๐Ÿ’ป
Andrew Bastin
๐Ÿ’ป
Vladislav
๐Ÿ’ป

izerozlu
๐Ÿ’ป
Jacob Anavisca
๐Ÿ’ป
Nityananda Gohain
๐Ÿ’ป
Hossein Nedaee
๐Ÿ’ป
James George
๐Ÿ’ป
Dmitry Yankowski
๐Ÿ’ป
Samir Boulema
๐Ÿ’ป
See the list of [contributors](https://github.com/hoppscotch/hoppscotch/graphs/contributors) who participated in this project. ### Thanks - [dev.to ๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป](https://dev.to) ### Financial Contributors Become a financial contributor and help us sustain our community [[Support](#support)]. #### GitHub Sponsors Shivam Mishra Zach Silveira Harshit Pant Jan Piotrowski Anil Kumar Gabriel Peal Kristjรกn Oddsson Don Okuda Erica Brescia Pedro Filho Peter Pistorius Tom Preston-Werner Max Lynch David McKay Brian Shaler Max Stoiber John Caine #### Organizations Support this project with your organization. Your logo will show up here with a link to your website [[Support](#support)]. #### Individuals ### Code Contributors This project exists thanks to all the people who contribute [[Contribute](CONTRIBUTING.md)]. ## **License** This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [`LICENSE`](LICENSE) file for details. ## **Acknowledgements** - Hat tip to anyone whose code was used - Inspirations: - [Dribbble](https://dribbble.com) ## **Badges**
Preview Markdown code


Default 		[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=postwoman)](https://hoppscotch.io)


Success 		[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=postwoman)](https://hoppscotch.io)


Critical 		[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=postwoman)](https://hoppscotch.io)


Custom 		[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=postwoman)](https://hoppscotch.io)


Customize 		[![hoppscotch](https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=postwoman)](https://hoppscotch.io)

hoppscotch.io

Happy Coding โค๏ธŽ