.mint-pointer-events-none {
    pointer-events: none
}
.mint-mt-1 {
    margin-top: 0.25rem
}
.mint-mt-4 {
    margin-top: 1rem
}
.mint-block {
    display: block
}
.mint-flex {
    display: flex
}
.mint-hidden {
    display: none
}
.mint-w-full {
    width: 100%
}
.mint-cursor-pointer {
    cursor: pointer
}
.mint-items-center {
    align-items: center
}
.mint-space-x-1 > :not([hidden]) ~ :not([hidden]) {
    --tw-space-x-reverse: 0;
    margin-right: calc(0.25rem * var(--tw-space-x-reverse));
    margin-left: calc(0.25rem * calc(1 - var(--tw-space-x-reverse)))
}
.mint-rounded-md {
    border-radius: 0.375rem
}
.mint-border-b {
    border-bottom-width: 1px
}
.mint-border-gray-500 {
    --tw-border-opacity: 1;
    border-color: rgb(107 114 128 / var(--tw-border-opacity))
}
.mint-px-4 {
    padding-left: 1rem;
    padding-right: 1rem
}
.mint-py-2 {
    padding-top: 0.5rem;
    padding-bottom: 0.5rem
}
.mint-pb-8 {
    padding-bottom: 2rem
}
.mint-text-sm {
    font-size: 0.875rem;
    line-height: 1.25rem
}
.mint-font-bold {
    font-weight: 700
}
.mint-font-semibold {
    font-weight: 600
}
.mint-leading-6 {
    line-height: 1.5rem
}
.mint-text-gray-600 {
    --tw-text-opacity: 1;
    color: rgb(75 85 99 / var(--tw-text-opacity))
}
.mint-text-gray-900 {
    --tw-text-opacity: 1;
    color: rgb(17 24 39 / var(--tw-text-opacity))
}
.mint-text-white {
    --tw-text-opacity: 1;
    color: rgb(255 255 255 / var(--tw-text-opacity))
}
.mint-group:hover .group-hover\:mint-opacity-\[0\.9\] {
    opacity: 0.9
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}
.dark\:mint-border-gray-800:is(.dark *) {
    --tw-border-opacity: 1;
    border-color: rgb(31 41 55 / var(--tw-border-opacity))
}
.dark\:mint-text-gray-400:is(.dark *) {
    --tw-text-opacity: 1;
    color: rgb(156 163 175 / var(--tw-text-opacity))
}
.dark\:mint-text-white:is(.dark *) {
    --tw-text-opacity: 1;
    color: rgb(255 255 255 / var(--tw-text-opacity))
}

Find user guides, quickstarts, tutorials, use cases, code samples, and more.

Home

Hoppscotch Documentation

Introduction

Introduction to Hoppscotch

Quick start

Clients

Hoppscotch Clients

Setup

Setup Hoppscotch

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

Troubleshooting

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

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

Iterate and execute your requests in a collection.

Runner

Dynamic placeholders for your API interactions.

Variables

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

Environments

Securely connect your Hoppscotch account with other services within Hoppscotch ecosystem.

Personal Access Token

Store and access your previous requests and responses.

History

Spotlight

Shortcuts

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

Configure client certificates for SSL authentication in Hoppscotch.

Client Certificate

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

Code Snippets

Intercept and modify requests and responses.

Interceptor

Use context-aware menus to assist with your actions and improve your workflow.

Context Menu

Widgets

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

Authorization

Optimize API Development and Testing Workflows with Hoppscotch using AI.

AI Features

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

Community

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

Contributors

New updates and improvements to Hoppscotch.

Changelog

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

Create and add interactive and dynamic elements to your website using Hoppscotch Widgets.

Uplifting web experience with Hoppscotch Widgets

Learn how to use the GraphQL schema on Hoppscotch.

Understanding the GraphQL Schema on Hoppscotch

Set up Hoppscotch on your servers for complete control and customization.

Self-Host Hoppscotch on your own servers

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.

Experts

Hoppscotch Experts

Hoppscotch is licensed under MIT License.

License

Code of conduct

Security procedures and general policies for Hoppscotch.

Security policy

Privacy policy

Terms and conditions

Learn how to create a request in Hoppscotch.

Creating a request

View, interpret and manage responses from your API requests.

Response handling

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

Request parameters

Request Headers allow you to pass additional information with requests, helping to control how the server responds.

Request headers

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

Run tests, manage automated API monitoring, and more.

Overview

Hoppscotch CLI

Troubleshoot the CLI errors by understanding their meanings and possible causes.

Hoppscotch CLI Troubleshooting

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.

Manage users efficiently with SCIM provisioning in Hoppscotch.

User provisioning

SCIM Integration for User Provisioning

Track all changes made to collections and requests within a workspace, and monitor user interactions through Activity Logs.

Activity Logs

Deploy and upgrade Hoppscotch Enterprise Edition on your infrastructure.

Telemetry and data sharing in Hoppscotch enterprise edition

Deploy Hoppscotch on Kubernetes with Helm charts for a scalable and efficient self-hosting solution.

Getting Started

Install and configure Hoppscotch on Digital Ocean using Helm Charts for cloud-based deployment.

Getting started

Clients

Protocols

Features

Self-Host

Resources

Hoppscotch Documentation

Hoppscotch Cloud

Everything you need to get started with Hoppscotch, hosted by us.

Hoppscotch Self-Host

Deploy your own instance of Hoppscotch on your own infrastructure.