CS2Cap SDKs

Client SDKs for the CS2Cap market-data API. Available for Python and TypeScript.

Packages

Language	Package	Install
Python	cs2cap	pip install cs2cap
TypeScript	cs2cap	npm install cs2cap

Contents

• python/ — Python SDK source and bundled example workflows in python/examples/
• typescript/ — TypeScript SDK source and bundled example workflows in typescript/examples/
• openapi/openapi.json — public OpenAPI spec used to generate these SDKs

API Base URL

https://api.cs2c.app

Onboarding

Get an API key

1. Create an account at cs2cap.com and verify your email address.
2. Navigate to cs2cap.com/account/api-keys and generate a key.

When you are ready to unlock additional endpoints and higher rate limits, upgrade at cs2cap.com/account/billing.

---

Python

Requirements: Python 3.9+

Install the SDK from PyPI:

pip install cs2cap

Provide your API key:

export BEARER_TOKEN=sk_your_key_here

Or copy the env template and fill in your key:

cd python
cp .env.example .env
# edit .env and set CS2C_API_KEY=sk_your_key_here

Run examples from the python/ directory:

Tier	Example	Command
Free	Bootstrap & search	python examples/free-tier/bootstrap-and-search/bootstrap_and_search.py
Free	Market data workbench	python examples/free-tier/market-data-workbench/market_data_workbench.py
Pro	Bulk price and bid report	python examples/pro-tier/create-comparison-table/create_comparison_table.py
Pro	Sales and history report	python examples/pro-tier/sales-history-report/sales_history_report.py
Pro	Market research report	python examples/pro-tier/item-analytics-report/item_analytics_report.py
Quant	Signals and arbitrage	python examples/quant-tier/quant-signals-and-arbitrage/quant_signals_and_arbitrage.py
Quant	Sub-key lifecycle	python examples/quant-tier/sub-key-lifecycle/sub_key_lifecycle.py
Quant	Webhook lifecycle	python examples/quant-tier/webhook-lifecycle/webhook_lifecycle.py

See python/examples/ for per-tier README files with full option descriptions.

---

TypeScript

Requirements: Node.js 18+

Install the SDK from npm:

npm install cs2cap

Provide your API key:

export BEARER_TOKEN=sk_your_key_here

Or copy the env template and fill in your key:

cd typescript
cp .env.example .env
# edit .env and set CS2C_API_KEY=sk_your_key_here

Install example runner dependencies and run examples from the typescript/ directory:

cd typescript
npm install

Tier	Example	Command
Free	Bootstrap & search	npm run example -- examples/free-tier/bootstrap-and-search/bootstrap_and_search.ts
Free	Market data workbench	npm run example -- examples/free-tier/market-data-workbench/market_data_workbench.ts
Pro	Bulk price and bid report	npm run example -- examples/pro-tier/create-comparison-table/create_comparison_table.ts
Pro	Sales and history report	npm run example -- examples/pro-tier/sales-history-report/sales_history_report.ts
Pro	Market research report	npm run example -- examples/pro-tier/item-analytics-report/item_analytics_report.ts
Quant	Signals and arbitrage	npm run example -- examples/quant-tier/quant-signals-and-arbitrage/quant_signals_and_arbitrage.ts
Quant	Sub-key lifecycle	npm run example -- examples/quant-tier/sub-key-lifecycle/sub_key_lifecycle.ts
Quant	Webhook lifecycle	npm run example -- examples/quant-tier/webhook-lifecycle/webhook_lifecycle.ts

See typescript/examples/ for per-tier README files with full option descriptions.