Scalar API

Generated Python SDK for Scalar API. API for managing Scalar platform resources.

TypeScript SDK

For TypeScript, we provide a SDK that makes using our API even easier.

Install

npm add @scalar/sdk

Get a Scalar API key

Create an API key in your Scalar account:

• Dashboard: https://dashboard.scalar.com/account
• Store it in .env, for example:

SCALAR_API_KEY=your_personal_token

Exchange your API key for an access token

The personal token is not an access token. Exchange it first with postv1AuthExchange.

If you use the personal token directly for authenticated API calls, the API returns 401 Invalid authentication token.

import { Scalar } from '@scalar/sdk'

const scalar = new Scalar()

const exchange = await scalar.auth.postv1AuthExchange({
  personalToken: process.env.SCALAR_API_KEY!,
})

const accessToken = exchange.accessToken

Use the access token

Construct a second client with bearer auth. Use this authenticated client for API calls.

import { Scalar } from '@scalar/sdk'

const scalar = new Scalar()

const exchange = await scalar.auth.postv1AuthExchange({
  personalToken: process.env.SCALAR_API_KEY!,
})

const authedScalar = new Scalar({
  bearerAuth: exchange.accessToken,
})

Notes

• The exchange request itself can be made from a client constructed with no arguments (new Scalar()).
• The exchanged access token is valid for 12 hours.
• Timestamps are Unix seconds.

Read more

• @scalar/sdk on npm

Contents

• Installation
• Usage
• API Reference
• Async
• Authentication
• Errors
• Client Options
• Retries and Timeouts
• Helpers
• Logging
• Requirements

Installation

pip install scalar-sdk

Usage

import os

from scalar_sdk import Scalar

client = Scalar(
    bearer_auth=os.environ.get("BEARER_AUTH"),
)

registry = client.registry.list_all_api_documents()
print(registry)

The examples in the following sections assume a client configured as shown above.

See the API reference for every available operation.

Async

Every client has an Async counterpart (AsyncScalar) exposing the same resource tree with await.

import asyncio

from scalar_sdk import AsyncScalar

async def main() -> None:
    client = AsyncScalar()
    registry = await client.registry.list_all_api_documents()

asyncio.run(main())

Authentication

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

Option	Type	Default	Description
bearer_auth	string | provider	-	Credential for the BearerAuth scheme. Defaults to BEARER_AUTH.

Declared schemes:

• BearerAuth bearer token

Errors

Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.

from scalar_sdk import APIStatusError

try:
    registry = client.registry.list_all_api_documents()
except APIStatusError as err:
    print(err.status_code, err.message)
    raise

Documented error statuses: 400, 401, 403, 404, 422, 500.

Client Options

Configure the generated client by setting any of these options when you create it.

from scalar_sdk import Scalar

client = Scalar(
    timeout=60.0,
    max_retries=2,
)

Option	Type	Default	Description
bearer_auth	str | None	os.environ.get("BEARER_AUTH")	Credential for the BearerAuth scheme.
base_url	str | httpx.URL | None	-	Override the default API base URL.
timeout	float | Timeout | None	60.0	Maximum time in seconds to wait for a response before aborting a request.
max_retries	int	2	Number of retries for temporary failures.
default_headers	Mapping[str, str] | None	-	Headers sent with every request.
default_query	Mapping[str, object] | None	-	Query parameters sent with every request.

Retries and Timeouts

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor Retry-After headers when present. Tune the retry and timeout client options shown above, or override them per request.

Helpers

• Use client.with_raw_response.<resource>.<method>(...) to access the raw httpx.Response and parse it yourself.
• Use client.with_streaming_response.<resource>.<method>(...) to stream a response body without buffering it.

Logging

• Set the SCALAR_LOG environment variable to info or debug to enable HTTP logging.
• Logs are emitted through the standard logging module under the scalar_sdk logger.

Requirements

• Python 3.8 or newer

Powered by Scalar.