TopReq API Client
A lightweight, fast, and easy-to-use API client for testing HTTP, GraphQL, WebSocket, and SSE inside VS Code. Your data stays on this machine — nothing is synced to a TopReq cloud.
Features
- Local Storage — collections, requests, environments, and history stay on this machine
- Create and save requests into collections from the Activity Bar
GET / POST / PUT / PATCH / DELETE- Query params, headers, auth (None / Basic / Bearer / API key / JWT), and JSON body
- Inspect status, timing, size, and response body (Pretty / Raw with syntax highlighting)
- Environment variables with
{{variable}} substitution
- Request history
- GraphQL over HTTP, SSE, and raw WebSocket streaming
Getting Started
- Install TopReq API Client from the Extensions view (
Ctrl+Shift+X / Cmd+Shift+X).
- Click the TopReq icon in the Activity Bar.
- Open a request from Examples in Collections, or create one with New Request.
- Edit method, URL, params, headers, auth, or body.
- Press Send (or
Ctrl+Enter / Cmd+Enter).
- Inspect status, timing, size, and the response pane.
Keyboard Shortcuts
| Action |
macOS |
Windows / Linux |
| Open TopReq |
⌘⇧T |
Ctrl+Shift+T |
| New Request (Collections focused) |
⌘N |
Ctrl+N |
| Send Request (TopReq focused) |
⌘Enter |
Ctrl+Enter |
| Save Request (TopReq focused) |
⌘S |
Ctrl+S |
Examples & Environments
Fresh installs include an Examples collection with one working demo per protocol:
- HTTP GET / HTTP POST
- GraphQL
- SSE
- WebSocket
TopReq also ships a Local environment with empty baseUrl and apiKey variables for your own APIs.
Use variables anywhere in URL, headers, auth, or body:
{{baseUrl}}/users
Authorization: Bearer {{apiKey}}
Missing variables are reported before the request is sent.
Create a separate collection for real work; keep Examples as a reference you can delete later.
Layout
- Activity Bar — TopReq container
- TopReq Sidebar — collections tree and actions
- Request Editor — protocol, method/URL, params, headers, auth, body/query/message
- Response Viewer — status/size/time for HTTP+GraphQL, live event console for SSE/WS
Settings
| Setting |
Default |
Purpose |
topreq.history.maxEntries |
50 |
Max request history entries |
topreq.request.timeoutMs |
30000 |
HTTP/GraphQL fetch timeout |
topreq.confirmDelete |
true |
Modal confirm before delete |
topreq.openPanelOnActivate |
false |
Open the editor panel when the TopReq sidebar becomes visible |
Local Storage & Privacy
API client data is stored locally to enhance privacy and security.
- What: collections, folders, requests, environments, open tabs, and request history (including recent response bodies)
- Where: VS Code
globalState for your profile on this machine (topreq.store.v2)
- Scope: machine-local only — TopReq does not sync data to a cloud service
Requirements
Release Notes
See the Changelog tab on the Marketplace page (also in CHANGELOG.md in the extension package).
Support
See SUPPORT.md in the extension package for how to report issues.
| |
