Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.alterscope.org/llms.txt

Use this file to discover all available pages before exploring further.

The Alterscope API is plain HTTPS + JSON, so any HTTP client can call it. First-party SDKs add typed models, the agentic-envelope helpers, retry, and pagination so you write less boilerplate.
ClientPackageStatusUse when
TypeScript@alterscope/sdkBetaNode 20+ or browser apps. Typed resources + envelope helpers.
Pythonalterscope (PyPI)BetaSync or async Python; data/quant workflows.
curl / raw HTTP—AlwaysShell scripts, quick checks, or any language without an SDK.

​
Install

# TypeScript
npm install @alterscope/sdk

# Python
pip install alterscope
# with async support
pip install "alterscope[async]"

​
SDK or raw HTTP?

  • Use an SDK when you want typed responses, automatic retries, pagination helpers, and the freshnessStatusOf / freshness_status_of envelope helpers without writing them yourself.
  • Use raw HTTP for one-off calls, shell scripts, languages without a first-party SDK, or when you want full control over the wire. See curl.
Whichever you choose, authentication and the response envelope are identical — see Authentication and Response envelope.