# Hoppscotch Documentation

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

## Docs

- [Changelog](https://docs.hoppscotch.io/documentation/changelog.md): Stay up to date with the latest Hoppscotch releases, new features, bug fixes, and performance improvements across the web, desktop, and CLI clients.
- [Hoppscotch CLI](https://docs.hoppscotch.io/documentation/clients/cli/overview.md): Use the Hoppscotch CLI to run API tests, automate monitoring, and manage collections from your terminal. Includes install steps and commands.
- [Hoppscotch CLI Troubleshooting](https://docs.hoppscotch.io/documentation/clients/cli/troubleshooting.md): Resolve Hoppscotch CLI errors with this reference of error codes, messages, and causes related to tokens, workspace access, and collections.
- [Hoppscotch Desktop App](https://docs.hoppscotch.io/documentation/clients/desktop/overview.md): Download and install the Hoppscotch Desktop App for macOS, Windows, and Linux. Build and test APIs natively with a cross-platform client.
- [Connect to Hoppscotch](https://docs.hoppscotch.io/documentation/clients/desktop/setup.md): Connect the Hoppscotch Desktop App to Hoppscotch Cloud, organization instances, or self-hosted editions. Includes setup steps for each platform.
- [Hoppscotch Web App](https://docs.hoppscotch.io/documentation/clients/web/overview.md): Access the Hoppscotch Web App to build, test, and share APIs directly in your browser. Also available as a progressive web app (PWA).
- [Hoppscotch Progressive Web App](https://docs.hoppscotch.io/documentation/clients/web/pwa.md): Install Hoppscotch as a Progressive Web App (PWA) on any device for a fast, native-like API testing experience without an app store download.
- [Hoppscotch community](https://docs.hoppscotch.io/documentation/community.md): Join the Hoppscotch community on Discord, GitHub, and X. Share feedback, get help from other developers, and stay updated on product releases.
- [Contributors](https://docs.hoppscotch.io/documentation/contributors.md): Meet the open-source contributors behind Hoppscotch. View the full list of developers who help build and improve the API platform.
- [Develop](https://docs.hoppscotch.io/documentation/develop.md): Contribute to Hoppscotch by reporting bugs, proposing features, or submitting pull requests. Learn the development workflow and guidelines.
- [AI Features](https://docs.hoppscotch.io/documentation/features/ai-features.md): Use AI-powered features in Hoppscotch to rename requests, generate payloads, and write pre-request scripts and test cases automatically.
- [Authorization](https://docs.hoppscotch.io/documentation/features/authorization.md): Configure API authorization in Hoppscotch using Basic Auth, Bearer Tokens, OAuth 2.0, and more. Set auth at the request or collection level.
- [Client Certificate](https://docs.hoppscotch.io/documentation/features/client-certificate.md): Add and manage PEM or PFX client certificates for SSL/TLS authentication in the Hoppscotch Desktop App or via the Hoppscotch Agent.
- [Collections](https://docs.hoppscotch.io/documentation/features/collections.md): Create, organize, and share API request collections in Hoppscotch. Import and export collections from Postman, OpenAPI, and other formats.
- [Context Menu](https://docs.hoppscotch.io/documentation/features/context-menu.md): Use the Hoppscotch context menu to quickly set environment variables, add query parameters, or open requests in new tabs from selected text.
- [Cookies](https://docs.hoppscotch.io/documentation/features/cookies.md): Use the Hoppscotch Cookie Manager to add, edit, and remove cookies for specific domains. Send cookies with API requests in the Desktop App.
- [Customization](https://docs.hoppscotch.io/documentation/features/customization.md): Personalize Hoppscotch by changing the background color, accent color, font size, language, and other settings to match your workflow.
- [API Documentation](https://docs.hoppscotch.io/documentation/features/documentation.md): Generate API documentation from your Hoppscotch collections with code samples, Markdown descriptions, and shareable public URLs for your team.
- [Environments](https://docs.hoppscotch.io/documentation/features/environments.md): Create global, personal, and shared environments in Hoppscotch to manage reusable variables across API requests, scripts, and workspaces.
- [GraphQL API Testing](https://docs.hoppscotch.io/documentation/features/graphql-api-testing.md): Test GraphQL APIs in Hoppscotch with the query builder, schema explorer, variables, headers, and real-time response inspection tools.
- [History](https://docs.hoppscotch.io/documentation/features/history.md): View and revisit your past API requests and responses in Hoppscotch. Favorite, filter, and quickly re-send previous requests from history.
- [Importer](https://docs.hoppscotch.io/documentation/features/importer.md): Import collections and environments from Postman, Insomnia, OpenAPI, and other tools into Hoppscotch. Supports JSON and HAR formats.
- [Inspections](https://docs.hoppscotch.io/documentation/features/inspections.md): Use Hoppscotch inspections to detect misconfigured API request inputs like missing headers, parameters, or auth settings before sending.
- [Interceptor](https://docs.hoppscotch.io/documentation/features/interceptor.md): Bypass CORS restrictions using the Hoppscotch Agent, Proxyscotch, browser extension, or custom middleware to intercept API requests.
- [API Mocking](https://docs.hoppscotch.io/documentation/features/mock.md): Create mock servers in Hoppscotch to simulate API endpoints with custom responses, status codes, and latency for prototyping and testing.
- [Personal Access Token](https://docs.hoppscotch.io/documentation/features/pat.md): Generate and manage personal access tokens (PATs) to authenticate the Hoppscotch CLI with your Hoppscotch Cloud or self-hosted instance.
- [Realtime API Testing](https://docs.hoppscotch.io/documentation/features/realtime-api-testing.md): Connect to and test real-time APIs in Hoppscotch using WebSocket, Server-Sent Events (SSE), Socket.IO, and MQTT protocols with live logs.
- [RESTful API Testing](https://docs.hoppscotch.io/documentation/features/rest-api-testing.md): Build and debug RESTful API requests in Hoppscotch with support for HTTP methods, headers, parameters, body, auth, and pre-request scripts.
- [Runner](https://docs.hoppscotch.io/documentation/features/runner.md): Run all requests in a Hoppscotch collection sequentially with configurable delays, iterations, and environment variables using the Runner.
- [Scripts](https://docs.hoppscotch.io/documentation/features/scripts.md): Write pre-request scripts and post-request tests in Hoppscotch using JavaScript to add dynamic behavior, set variables, and validate responses.
- [Shortcuts](https://docs.hoppscotch.io/documentation/features/shortcuts.md): Browse the full list of keyboard shortcuts in Hoppscotch for sending requests, navigating tabs, managing collections, and switching views.
- [Code Snippets](https://docs.hoppscotch.io/documentation/features/snippets.md): Generate ready-to-use code snippets for your API requests in JavaScript, Python, Shell, and other languages directly from Hoppscotch.
- [Spotlight](https://docs.hoppscotch.io/documentation/features/spotlight.md): Use the Spotlight search and command palette in Hoppscotch to quickly navigate features, switch tabs, and execute actions with keyboard shortcuts.
- [Variables](https://docs.hoppscotch.io/documentation/features/variables.md): Use global, environment, request, and collection variables in Hoppscotch to create dynamic, reusable values across your API requests.
- [Widgets](https://docs.hoppscotch.io/documentation/features/widgets.md): Embed Hoppscotch widgets in your website as shareable links, buttons, or interactive embeds so visitors can try your API requests directly.
- [Workspaces](https://docs.hoppscotch.io/documentation/features/workspaces.md): Organize your requests, collections, and environments into different workspaces. You can also invite other users to your workspace to collaborate.
- [Hoppscotch Clients](https://docs.hoppscotch.io/documentation/getting-started/clients.md): Explore the Hoppscotch clients available on web, desktop, and CLI. Learn about the user interface and how to navigate the platform.
- [Running a simple query](https://docs.hoppscotch.io/documentation/getting-started/graphql/creating-a-query.md): Connect to a GraphQL server in Hoppscotch, explore the schema documentation, and run your first query step by step with a real API endpoint.
- [Using variables in a GraphQL query](https://docs.hoppscotch.io/documentation/getting-started/graphql/using-variables.md): Pass dynamic variables in your GraphQL queries using Hoppscotch. Follow a step-by-step example to filter country data with query variables.
- [Introduction to Hoppscotch](https://docs.hoppscotch.io/documentation/getting-started/introduction.md): Hoppscotch is an open-source API development ecosystem with web, desktop, and CLI clients for building, testing, and debugging APIs.
- [Quick start](https://docs.hoppscotch.io/documentation/getting-started/quick-start.md): Get started quickly with Hoppscotch Cloud, self-hosted editions, or the desktop app. Choose your platform and begin testing APIs in minutes.
- [MQTT](https://docs.hoppscotch.io/documentation/getting-started/realtime/mqtt.md): Connect to an MQTT broker in Hoppscotch to publish messages, subscribe to topics, and test lightweight publish-subscribe messaging.
- [Socket.IO](https://docs.hoppscotch.io/documentation/getting-started/realtime/socket-io.md): Test Socket.IO services in Hoppscotch by connecting to a server, listening to events, and sending messages with custom event names.
- [Server-Sent Events](https://docs.hoppscotch.io/documentation/getting-started/realtime/sse.md): Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server via HTTP connection.
- [Websocket](https://docs.hoppscotch.io/documentation/getting-started/realtime/websocket.md): Connect to a WebSocket server in Hoppscotch, send and receive real-time messages, and troubleshoot common connection issues step by step.
- [Using auth tokens](https://docs.hoppscotch.io/documentation/getting-started/rest/auth-tokens.md): Authenticate API requests in Hoppscotch using bearer tokens. Follow a step-by-step tutorial with the GitHub REST API as an example.
- [Creating a request](https://docs.hoppscotch.io/documentation/getting-started/rest/creating-a-request.md): Create your first REST API request in Hoppscotch. Choose an HTTP method, enter an endpoint URL, and send a request to see the response.
- [Environment variables](https://docs.hoppscotch.io/documentation/getting-started/rest/environment-variables.md): Store and reuse values like base URLs and API keys with environment variables in Hoppscotch. Create environments and reference variables.
- [Organizing requests](https://docs.hoppscotch.io/documentation/getting-started/rest/organizing-requests.md): Save and organize API requests into collections in Hoppscotch for easy reuse, team collaboration, and structured project management.
- [Pre-request scripts](https://docs.hoppscotch.io/documentation/getting-started/rest/pre-request-scripts.md): Add pre-request scripts in Hoppscotch to execute JavaScript before sending API requests. Set variables, generate tokens, and add logic.
- [Request headers](https://docs.hoppscotch.io/documentation/getting-started/rest/request-headers.md): Set and manage HTTP request headers in Hoppscotch to pass authorization, content type, caching, and other key-value metadata with requests.
- [Request parameters](https://docs.hoppscotch.io/documentation/getting-started/rest/request-parameters.md): Add query parameters to API requests in Hoppscotch using the URL or the parameters tab. Filter and request specific data from endpoints.
- [Response handling](https://docs.hoppscotch.io/documentation/getting-started/rest/response-handling.md): Inspect API responses in Hoppscotch including HTTP status codes, JSON/HTML/XML response bodies, headers, cookies, and response time metrics.
- [Tests](https://docs.hoppscotch.io/documentation/getting-started/rest/tests.md): Write and run post-request test scripts to validate API responses, check status codes, and verify data. Add tests to saved or unsaved requests.
- [Uploading data](https://docs.hoppscotch.io/documentation/getting-started/rest/uploading-data.md): Upload files and encoded data to APIs in Hoppscotch using POST or PUT methods with multipart form data, JSON, or binary content types.
- [Setup Hoppscotch](https://docs.hoppscotch.io/documentation/getting-started/setup.md): Set up Hoppscotch on web, desktop, or the command-line interface. Choose your preferred platform and start building and testing APIs in minutes.
- [Troubleshooting](https://docs.hoppscotch.io/documentation/getting-started/troubleshooting.md): Fix common Hoppscotch issues including connectivity problems, CORS errors, browser extensions, and firewall configuration for API testing.
- [i18n](https://docs.hoppscotch.io/documentation/i18n.md): Help translate Hoppscotch into your language. Learn how to contribute translations and support internationalization and localization efforts.
- [GraphQL](https://docs.hoppscotch.io/documentation/protocols/graphql.md): Learn about the GraphQL query language for APIs, how it fetches only requested data, and how to test GraphQL endpoints in Hoppscotch.
- [Realtime](https://docs.hoppscotch.io/documentation/protocols/realtime.md): Learn about real-time API protocols supported in Hoppscotch including WebSocket, SSE, Socket.IO, and MQTT for bidirectional communication.
- [RESTful](https://docs.hoppscotch.io/documentation/protocols/rest.md): Understand the RESTful protocol, HTTP methods like GET, POST, PUT, and DELETE, and how to test REST API endpoints using Hoppscotch.
- [Community Edition admin dashboard](https://docs.hoppscotch.io/documentation/self-host/community-edition/admin-dashboard.md): Manage users, invitations, and teams from the Hoppscotch Community Edition admin dashboard. Configure settings and monitor your instance.
- [Deploy and upgrade Community Edition](https://docs.hoppscotch.io/documentation/self-host/community-edition/deploy-and-upgrade.md): Deploy Hoppscotch Community Edition to production and upgrade to newer versions. Includes guides for Docker, subpath access, and migrations.
- [Getting started with Community Edition](https://docs.hoppscotch.io/documentation/self-host/community-edition/getting-started.md): Get started self-hosting Hoppscotch Community Edition. Review the steps for prerequisites, installation, configuration, and deployment.
- [Install and build Community Edition](https://docs.hoppscotch.io/documentation/self-host/community-edition/install-and-build.md): Install and build Hoppscotch Community Edition using Docker. Configure environment variables, authentication providers, and SMTP settings.
- [Community Edition prerequisites](https://docs.hoppscotch.io/documentation/self-host/community-edition/prerequisites.md): Review the system requirements, OAuth provider setup, and SMTP configuration needed before installing Hoppscotch Community Edition.
- [Set up and access Community Edition](https://docs.hoppscotch.io/documentation/self-host/community-edition/setup-and-access.md): Complete the initial setup of Hoppscotch Community Edition by creating an admin account, configuring access, and verifying your installation.
- [Community Edition telemetry](https://docs.hoppscotch.io/documentation/self-host/community-edition/telemetry.md): Understand what telemetry data Hoppscotch Community Edition collects, how it is used, and how to opt out of anonymous usage analytics.
- [Activity logs](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/activity-logs.md): Track changes to collections and requests within workspaces using Activity Logs in Hoppscotch Enterprise. Monitor user interactions.
- [Enterprise Edition admin dashboard](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/admin-dashboard.md): Manage users, teams, SCIM provisioning, and license settings from the Hoppscotch Enterprise Edition admin dashboard and its configuration.
- [Deploy and upgrade Enterprise Edition](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/deploy-and-upgrade.md): Deploy Hoppscotch Enterprise Edition to production and upgrade to newer versions. Includes Docker guides, subpath access, and migrations.
- [Getting started with Enterprise Edition](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/getting-started.md): Get started self-hosting Hoppscotch Enterprise Edition. Review the steps for license activation, prerequisites, installation, and setup.
- [Install and build Enterprise Edition](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/install-and-build.md): Install and build Hoppscotch Enterprise Edition using Docker. Configure environment variables, auth providers, SMTP, and license keys.
- [Observability](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/observability.md): Set up OpenTelemetry observability for Hoppscotch Enterprise to monitor traces, metrics, and logs. Integrate with Grafana, Jaeger, and more.
- [Enterprise Edition prerequisites](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/prerequisites.md): Review system requirements, OAuth provider setup, SMTP, and license key configuration needed before installing Hoppscotch Enterprise.
- [Set up and access Enterprise Edition](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/setup-and-access.md): Complete the initial setup of Hoppscotch Enterprise Edition by creating an admin account, activating your license, and configuring access.
- [Enterprise Edition telemetry](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/telemetry.md): Understand what telemetry data Hoppscotch Enterprise Edition collects, how it is used, and how to manage anonymous usage analytics.
- [User groups](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/user-groups.md): Create and manage user groups to control permissions and roles in shared workspaces. Assign members to groups for structured access control.
- [SCIM Integration for User Provisioning](https://docs.hoppscotch.io/documentation/self-host/enterprise-edition/user-provisioning.md): Set up SCIM integration in Hoppscotch Enterprise to automate user provisioning, deprovisioning, and group sync with identity providers.
- [Getting started with self-hosting](https://docs.hoppscotch.io/documentation/self-host/getting-started.md): Self-host Hoppscotch on your own infrastructure with full data ownership. Choose between Community Edition and Enterprise Edition.
- [Index](https://docs.hoppscotch.io/guides/articles.md): Browse all Hoppscotch guides and tutorials covering API testing, self-hosting, GraphQL, OpenTelemetry, enterprise features, and more.
- [Audit Logs in Hoppscotch](https://docs.hoppscotch.io/guides/articles/audit-logs.md): Enable and use audit logs in Hoppscotch Enterprise to track workspace activity, collection changes, and user actions for compliance.
- [Improving your API workflow](https://docs.hoppscotch.io/guides/articles/improving-your-api-workflow.md): Streamline your API development workflow with Hoppscotch using collections, environments, scripts, and team collaboration features.
- [Managing your Enterprise License Key](https://docs.hoppscotch.io/guides/articles/manage-an-enterprise-license-key.md): Activate, renew, and manage your Hoppscotch Enterprise Edition license key. Troubleshoot license issues and understand key expiration.
- [RESTful API testing with Hoppscotch](https://docs.hoppscotch.io/guides/articles/restful-api-testing-with-hoppscotch.md): Follow a hands-on tutorial to test RESTful APIs with Hoppscotch. Send GET and POST requests, add headers, and inspect JSON responses.
- [Self-Host Hoppscotch on your own servers](https://docs.hoppscotch.io/guides/articles/self-host-hoppscotch-on-your-own-servers.md): Self-host Hoppscotch on your own servers with Docker. Configure OAuth providers, SMTP, environment variables, and deploy step by step.
- [Set Up OpenTelemetry Stack with Docker](https://docs.hoppscotch.io/guides/articles/set-up-opentelemetry-stack-with-docker.md): Set up the OpenTelemetry observability stack with Docker for Hoppscotch Enterprise. Configure collectors, Jaeger, Grafana, and Prometheus.
- [Understanding the GraphQL Schema on Hoppscotch](https://docs.hoppscotch.io/guides/articles/understanding-graphql.md): Explore the GraphQL schema in Hoppscotch to understand queries, mutations, types, and subscriptions. Inspect and navigate API documentation.
- [Uplifting web experience with Hoppscotch Widgets](https://docs.hoppscotch.io/guides/articles/uplifting-web-experience-with-hoppscotch-widgets.md): Embed interactive Hoppscotch widgets in your website as links, buttons, or iframes so visitors can run API requests directly from your pages.
- [Introduction to guides](https://docs.hoppscotch.io/guides/getting-started/introduction.md): Browse step-by-step Hoppscotch guides and tutorials on API testing, self-hosting, GraphQL, integrations, and enterprise administration.
- [Code of conduct](https://docs.hoppscotch.io/support/code-of-conduct.md): Read the Hoppscotch community code of conduct. Guidelines for respectful participation, reporting violations, and enforcement policies.
- [Contact](https://docs.hoppscotch.io/support/getting-started/contact.md): Contact the Hoppscotch team for technical support, bug reports, feature requests, or to connect with the community on Discord and GitHub.
- [Frequently Asked Questions](https://docs.hoppscotch.io/support/getting-started/faq.md): Find answers to common questions about Hoppscotch including pricing, self-hosting, data privacy, integrations, and platform features.
- [Introduction to support](https://docs.hoppscotch.io/support/getting-started/introduction.md): Get help with Hoppscotch through documentation, FAQs, community forums, and direct support channels. Find the right resource for your needs.
- [License](https://docs.hoppscotch.io/support/license.md): Review the MIT License under which Hoppscotch is distributed. Understand the permissions, conditions, and limitations of the license.
- [Privacy policy](https://docs.hoppscotch.io/support/privacy.md): Read the Hoppscotch privacy policy to understand how your personal data is collected, used, stored, and protected when using our services.
- [Security policy](https://docs.hoppscotch.io/support/security-policy.md): Review the Hoppscotch security policy, including scope, per-deployment threat models, security controls, and vulnerability reporting procedures.
- [Community support](https://docs.hoppscotch.io/support/solutions/community.md): Get help from the Hoppscotch open-source community on Discord and GitHub. Ask questions, share ideas, and connect with other developers.
- [Hoppscotch Experts](https://docs.hoppscotch.io/support/solutions/experts.md): Get dedicated help from Hoppscotch experts for enterprise support, custom integrations, onboarding, and advanced API workflow consulting.
- [Terms and conditions](https://docs.hoppscotch.io/support/terms.md): Read the Hoppscotch terms and conditions covering acceptable use, intellectual property, liability, and service agreement for all users.

## OpenAPI Specs

- [openapi](https://docs.hoppscotch.io/api-reference/openapi.json)

## Optional

- [Download](https://hoppscotch.com/download)
- [Blog](https://hoppscotch.com/blog)
- [Changelog](https://github.com/hoppscotch/hoppscotch/releases)