Scalar

<picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/b391b82f-d993-4e97-8a17-1c3c7ccbb19b"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/579d0853-b2a5-4ea8-b2bd-a98753faeaf3"> </picture> <picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/9b639f2d-0204-4b15-b918-158072a9afa5"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/be723d07-ec9c-4edb-b657-05a8bc05c7d6"> </picture>

An offline first API Client built for OpenAPI

└ Minimal, powerful & open-source
└ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
└ Syncs directly with your server frameworks with our Watch Mode
└ First class OpenAPI (formerly Swagger) support
└ Environment variables and dynamic parameters
└ Save and organize requests into collections
└ Download (Windows, MacOS, Linux)
└ Try Online Demo

Interactive API Reference from OpenAPI/Swagger

└ Uses OpenAPI/Swagger documents
└ Request examples for many favorite languages and frameworks
└ Comes with an integrated API playground
└ Integrates with your favorite framework
└ Doesn't look like 2011
└ Try Demo

### Trusted by:

Quickstart

You’re just one HTML file away from having an awesome 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>
    <div id="app"></div>

    <!-- Load the Script -->
    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>

    <!-- Initialize the Scalar API Reference -->
    <script>
      Scalar.createApiReference('#app', {
        // The URL of the OpenAPI/Swagger document
        url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.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:

Integrations

Built-in Support

The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design:

Managed Hosting

We’re offering a free and paid managed hosting on the edge, too:

Write your API documentation and publish your API references (free)
Get SSL and a super cool *.apidocumentation.com subdomain (free)
Write free text documentation (paid)
Collaborate with your whole team (paid)
Use any domain (paid)

Ready? Create your account on scalar.com.

Projects

Project	Description
Scalar API Client	API client
Scalar CLI	Command-line interface
Scalar Galaxy	OpenAPI Example
Scalar Mock Server	OpenAPI Mock Server
Scalar Void Server	HTTP Request Mirror
Scalar Open API Parser	OpenAPI SDK
Scalar Sandbox	Online OpenAPI Editor

Documentation

Topic	Description
Themes	Predefined themes, layouts & styling
Configuration	The universal configuration object
Plugins	Extend the functionality
OpenAPI	OpenAPI and our extensions to it
Markdown	The supported Markdown syntax

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

Contributions

Contributions are welcome! Read the CONTRIBUTING guide.

Top 10 Contributors (April 2025)

Top Contributors (All Time)

_hanspagel	_amritk	_xC0dex	_antlio	_marclave	_hwkr
_{cameronrohani}	_tmastrom	_geoffgscott	_inyourtime	_DemonHa	_bgrcs
_Amorim33	_ivanagas	_Mason-Little	_adjsky	_matthyk	_RemcoGoy
_mcollina	_mpminardi	_nsychev	_Mohib834	_lc-soft	_fuma-nama
_Edgaraszs	_ATREAY	_ahmedrangel	_yshrsmz	_hex0id	_soulchild
_x-delfino	_ykdojo	_timheuer	_{SebastianBienert}	_mouhannad-sh	_{mason-at-pieces}
_luc122c	_handrews	_gsmcdonald	_federicobond	_WDaan	_Duncanma
_rpmccarter	_rmp135	_STP5940	_captainsafia	_realsama	_dotfortun
_smoores-dev	_soGit	_sinh117801	_stratosblue	_yokeTH	_{hrynevychroman}
_rbange	_{rickihastings}	_{petercinibulk}	_Olexandr88	_{malinbranduse}	_MaxBreida
_MarioGK	_ShadiestGoat	_sanscontext	_kyllian	_KiARC	_Huliiiiii
_unnoq	_tsiwek-piwik	_dunklesToast	_o-az	_kwaichanz	_g-airey
_ga1az	_{FotieMConstant}	_danwithabox	_{WilliamBonvini}	_bsdayo	_Chinlinlee
_bingbeann	_{rolldeep-stepmerrily}	_{Wolf-Syndrome}	_{wilcoschoneveld}	_rotciw	_Ma-ve
_Mai0313	_{Courtcircuits}	_rektdeckard	_{thibaultleouay}	_untiny	_lundibundi
_darekaze	_danp	_danjohnson95	_yungwarlock	_ClanEver	_chrislearn
_chadwhitacre	_carstenlebek	_cactysman	_brunogrcsada	_Borisich	_bdpiprava
_saithis	_zsilbi	_{arthurfiorette}	_arashsheyda	_sigpwned	_gizero
_alewin	_slash686	_{MathurAditya724}	_abdulamite	_jlnslv	_IHIutch
_jonataw	_Jannchie	_jwangnz	_Jefwillems	_TheVaan	_JacobCoffee
_kevinand11	_IceyWu	_iagobalmeida	_hpmouton	_CJHwong	_HelgeSverre
_Hamidrzash	_GreyXor	_Fdawgs	_filiabel	_facus26	_{emmanuel-ferdman}
_{elliott-with-the-longest-name-on-github}	_elliotnash	_{DmitriiKhudiakov}	_diegolopes