Documentation

Guides

Support

Download

Blog

Changelog

Hoppscotch Documentation

Home

Shortcuts

Introduction

Introduction to Hoppscotch

Quick start

Clients

Hoppscotch Clients

Setup

Setup Hoppscotch

Facing issues with Hoppscotch? Check out this page to resolve them.

Troubleshooting

Learn how to create a request in Hoppscotch.

Creating a request

Request parameters help you to filter and request specific data from an API endpoint.

Request parameters

Organize your requests categorically for future reference or collaboration with your team using collections.

Organizing requests

Learn how to use environment variables in your requests and scripts.

Environment variables

Learn how to use authentication tokens in Hoppscotch.

Using auth tokens

Learn how to upload data to an API using Hoppscotch.

Uploading data

Learn how to use pre-request scripts in Hoppscotch.

Pre-request scripts

Tests are executed after a response is received from the server. You can add multiple tests to a request. You can add tests to both requests saved and not saved in a collection.

Tests

Learn how to run a simple query using Hoppscotch.

Running a simple query

Learn how to use variables in a GraphQL query.

Using variables

Using variables in a GraphQL query

Connect to a WebSocket and send messages.

Websocket

Learn how to use the Socket.IO testing tool in Hoppscotch.

Socket.IO

Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server via HTTP connection.

Server-Sent Events

MQTT is a lightweight publish-subscribe messaging protocol.

MQTT

Build, test, and share your APIs directly in your browser.

Hoppscotch Web App

Cross-platform desktop application that runs on macOS, Windows, and Linux.

Desktop

Hoppscotch Desktop App

Run tests, manage automated API monitoring, and more.

Hoppscotch CLI

RESTful

GraphQL is a query language for APIs that queries the server and provides the client only the data that is requested by the client. GraphQL enables you to fetch data from multiple APIs in a single query thus helping you build better-performing applications.

GraphQL

Hoppscotch's Realtime API platform helps you test your real-time APIs easily.

Realtime

Organize your requests, collections, and environments into different workspaces. You can also invite other users to your workspace to collaborate.

Workspaces

Save, organize, and share your API requests with collections.

Collections

Dynamic placeholders for your API interactions.

Variables

Environments help you create variables that you can reuse in requests and scripts.

Environments

Store and access your previous requests and responses.

History

Spotlight

Write pre-request scripts and build tests.

Scripts

Migrate your data from other tools into Hoppscotch.

Importer

Customization

Detect and resolve configuration errors in your API requests.

Inspections

Create and modify cookies associated with a domain and send cookies with requests.

Cookies

Generate code snippets for your API in a variety of languages and frameworks.

Snippets

Intercept and modify requests and responses.

Interceptor

Widgets

Authorization is the process of verifying that a client has permission to access a resource.

Authorization

Test and play around with your RESTful API endpoints.

RESTful API

RESTful API Testing

GraphQL API

GraphQL API Testing

Welcome to the home of your new documentation

Realtime API

Realtime API Testing

Getting started

Learn how to get started with Hoppscotch Community Edition.

Prerequisites for installing Hoppscotch on your own infrastructure.

Prerequisites

Learn how to install and build Hoppscotch Community Edition.

Install and build

Learn how to set up and access Hoppscotch Community Edition.

Setup and access

Get started with the Hoppscotch Admin Dashboard.

Admin dashboard

Deploy and upgrade Hoppscotch Community Edition on your infrastructure.

Deploy and upgrade

Telemetry and data sharing in Hoppscotch community edition

Telemetry

Learn how to get started with Hoppscotch Enterprise Edition.

Learn how to install and build Hoppscotch Enterprise Edition.

Learn how to set up and access Hoppscotch Enterprise Edition.

Deploy and upgrade Hoppscotch Enterprise Edition on your infrastructure.

Telemetry and data sharing in Hoppscotch enterprise edition

Community

Hoppscotch exists thanks to the awesome people who contribute to it.

Contributors

New updates and improvements to Hoppscotch.

Develop

i18n

Guides and tutorials to help you get started with Hoppscotch.

Complete list of articles and guides for Hoppscotch.

Index

Learn how to use Hoppscotch to test your RESTful APIs.

RESTful API testing with Hoppscotch

Learn how to improve your API workflow with Hoppscotch.

Improving your API workflow

Learn how to use the GraphQL schema on Hoppscotch.

Understanding the GraphQL Schema on Hoppscotch

Learn how to manage your Hoppscotch Enterprise Edition license key.

Managing your Enterprise License Key

Learn about the audit logs in Hoppscotch Enterprise.

Audit Logs

We're here to help you get started with Hoppscotch.

These are the most frequently asked questions about Hoppscotch.

Frequently Asked Questions

Contact us to get technical support, report a bug, suggest a new feature or improvement, or join our community.

Contact

Hoppscotch is an open-source project. Community is at the heart of everything we do.

Shortcut	Action
`?`	Help menu
`/`	Search & command menu
`Ctrl/Cmd` + `K`	Keyboard Shortcuts
`esc`	Close current menu

Shortcut	Action
`Ctrl/Cmd` + `enter`	Send request
`Ctrl/Cmd` + `S`	Save to collections
`Ctrl/Cmd` + `U`	Generate and copy request link
`Ctrl/Cmd` + `I`	Reset Request to `echo.hoppscotch.io`
`Alt/Option` + `↑`	Select Next method
`Alt/Option` + `↓`	Select Previous method
`Alt/Option` + `G`	Select GET method
`Alt/Option` + `H`	Select HEAD method
`Alt/Option` + `P`	Select POST method
`Alt/Option` + `U`	Select PUT method
`Alt/Option` + `X`	Select DELETE method

Shortcut	Action
`Ctrl/Cmd` + `J`	Download response as a file
`Ctrl/Cmd` + `.`	Copy response to clipboard

Shortcut	Action
`Ctrl/Cmd` + `←`	Go back to previous page
`Ctrl/Cmd` + `→`	Go forward to next page
`Alt/Option` + `R`	Go to REST page
`Alt/Option` + `Q`	Go to GraphQL page
`Alt/Option` + `W`	Go to Realtime page
`Alt/Option` + `S`	Go to Settings page
`Alt/Option` + `M`	Go to Profile page

Getting started

Clients

Protocols

Features

Self-Host

Resources

Shortcuts

General shortcuts

Request shortcuts

Response shortcuts

Navigation shortcuts

Miscellaneous shortcuts

Getting started

Clients

Protocols

Features

Self-Host

Resources

​General shortcuts

​Request shortcuts

​Response shortcuts

​Navigation shortcuts

​Miscellaneous shortcuts

General shortcuts

Request shortcuts

Response shortcuts

Navigation shortcuts

Miscellaneous shortcuts