<img width="830" height="auto" src="https://github.com/user-attachments/assets/3a24fc5c-5d3c-4be4-8b9e-399bd49e4fb7#gh-light-mode-only">
<img width="830" height="auto" src="https://github.com/user-attachments/assets/76f123ae-f458-409f-84d3-b9ad14fd3fb2#gh-dark-mode-only">
└ Renders OpenAPI/Swagger documents
└ Comes with an API testing tool
└ Doesn't look like 2011
└ Generates code examples for many languages & frameworks
└ Integrates with your favorite framework
└ Try Demo
<img width="1200" height="1" src="https://github.com/user-attachments/assets/7d7e7ba7-2b02-49f3-abcd-b24c566a3c16#gh-light-mode-only">
<img width="1200" height="1" src="https://github.com/user-attachments/assets/341bfb1d-5cb0-4ec6-89eb-4b1dcc07eeb7#gh-dark-mode-only">
<img width="830" height="auto" src="https://github.com/user-attachments/assets/d9f90c51-82d4-4948-9365-658ccc7d78c4#gh-light-mode-only">
<img width="830" height="auto" src="https://github.com/user-attachments/assets/e7c2023e-dfbc-428c-bc85-c06d8a6e4b67#gh-dark-mode-only">
└ Free and open-source
└ First-class OpenAPI/Swagger support
└ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
└ Syncs with your favorite server framework (Watch Mode)
└ Has environment variables, dynamic parameters and everything
└ Try It in the Browser └ Download (Windows, MacOS, Linux)
<img width="1200" height="1" src="https://github.com/user-attachments/assets/7d7e7ba7-2b02-49f3-abcd-b24c566a3c16#gh-light-mode-only">
<img width="1200" height="1" src="https://github.com/user-attachments/assets/341bfb1d-5cb0-4ec6-89eb-4b1dcc07eeb7#gh-dark-mode-only">
<img width="48.494%" height="330" src="https://github.com/user-attachments/assets/73dcef95-fc4f-4111-bb09-f3ce37453a81#gh-light-mode-only" alt="Scalar API client">
<img width="48.494%" height="330" src="https://github.com/user-attachments/assets/1da6b904-34be-4760-b535-0dd2160e6d12#gh-light-mode-only" alt="Scalar API client">
All you need is a single HTML file to create an amazing API reference:
<!doctype html>
<html>
<head>
<title>Scalar API Reference</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
</head>
<body>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<script>
Scalar.createApiReference('#app', {
// The URL of the OpenAPI/Swagger document
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
// Avoid CORS issues
proxyUrl: 'https://proxy.scalar.com',
})
</script>
</body>
</html>
Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam
And there's an ever-growing list of plugins and integrations:
The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design:
We're offering a free and paid managed hosting on the edge, too:
YOUR_NAME_HERE.apidocumentation.com subdomain and SSL (free)Ready? Create your Scalar Account
| Topic | Description |
|---|---|
| Configuration | The universal configuration object |
| Themes | Predefined themes, layouts & styling |
| OpenAPI | OpenAPI specification extensions |
| Markdown | Supported Markdown syntax |
| Plugins | Extend the functionality |
| Project | Description |
|---|---|
| Scalar API Reference | Self-hosted API Reference |
| Scalar API Client | Postman alternative |
| Agent Scalar | Chat with your API |
| Scalar Registry | Manage OpenAPI documents |
| Scalar Docs | Hosted documentation |
| Scalar Docs Starter | Starter template for Scalar Docs |
| Scalar SDKs | SDK generation |
| Scalar CLI | Command-line interface |
| Scalar Mock Server | Mock APIs from OpenAPI documents |
| Scalar Galaxy | Our OpenAPI Example |
| Scalar Editor | OpenAPI Online Editor |
| Scalar OpenAPI Parser | Parse OpenAPI documents |
| Scalar OpenAPI to Markdown | OpenAPI > Markdown/HTML |
| Scalar OpenAPI Upgrader | Upgrade OpenAPI documents |
| Scalar Void Server | HTTP Request Mirror |
We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar
Contributions are welcome! Read the CONTRIBUTING guide.
Top 10 Contributors (April 2025)
<img width="830" height="280" src="https://github.com/user-attachments/assets/8c10d2aa-9eb4-4818-9ca2-625cfed5ca08#gh-light-mode-only">
<img width="830" height="280" src="https://github.com/user-attachments/assets/50b9b042-107e-4167-9c7f-94497f85d2e0#gh-dark-mode-only">
Top Contributors (All Time)
|
|
|
|
$ claude mcp add scalar \
-- python -m otcore.mcp_server <graph>