Bitpin SDK

English · فارسی · Documentation

The official SDK for the Bitpin exchange API, for market makers, VIP traders, and the AI agents that write their bots.

• Python (sync Bitpin, async AsyncBitpin), TypeScript (@bitpin-dev/bitpin-sdk on npm), Go (github.com/bitpin-dev/bitpin-sdk/go) and Java (io.github.bitpin-dev:bitpin-sdk on Maven Central), all in this repository.
• ccxt method names and result structures, so a ccxt bot ports with small changes.
• Decimal for every price and amount.
• Tokens cached and refreshed for you; the client stays under Bitpin's rate limits, which you can override with your VIP limits.
• Orders and withdrawals are never retried automatically.
• WebSocket streams (watch_ticker, watch_order_book, watch_orders, …).
• Features Bitpin doesn't offer yet raise NotSupported with a clear message.

pip install bitpin-sdk          # add [ws] for WebSocket

from bitpin_sdk import Bitpin, Config

with Bitpin(Config.from_env()) as client:          # BITPIN_API_KEY, BITPIN_SECRET_KEY
    book = client.fetch_order_book("USDT/IRT")
    order = client.create_order("USDT/IRT", "limit", "buy", "10", "90000",
                                {"clientOrderId": "bot-1"})
    client.cancel_order_by_identifier("bot-1")

Warning

Bitpin has no sandbox. Every call is real. The examples only print what they would send unless you pass --live.

Repository

Path	What
spec/bitpin.yaml	The API description every language is generated and tested against: endpoints, rate limits, errors, capabilities
fixtures/	Response samples shared by all languages' tests
python/	The Python SDK (changelog)
ts/	The TypeScript SDK, npm @bitpin-dev/bitpin-sdk (changelog, guide)
go/	The Go SDK, github.com/bitpin-dev/bitpin-sdk/go (changelog, guide)
java/	The Java SDK, Maven io.github.bitpin-dev:bitpin-sdk (changelog, guide)
examples/	Runnable examples in Python and TypeScript, including a market-maker skeleton
docs/en, docs/fa	The documentation site, in English and Persian
AGENTS.md, .ai/project/	Instructions, rules and skills for AI coding agents
llms.txt	A compact reference for AI agents that use the SDK

AI agents

Point your coding agent at llms.txt (or llms-full.txt) and the bitpin-trading-bot skill. Agents working on this repository start at AGENTS.md.

Contributing and security

See CONTRIBUTING.md and REVIEW.md. Report vulnerabilities privately as described in SECURITY.md.

MIT licensed.