Configuration

Every setting has a default from Bitpin's server, and you can override any of it.

from bitpin_sdk import Bitpin, Config, RateLimit

config = Config(
    api_key="...",
    secret_key="...",
    domain="org",             # "org" (default), "ir" or "market"
    timeout=10,               # seconds per request
    max_retries=3,            # for idempotent requests only
    enable_rate_limit=True,   # client-side limiter
    rate_limits={"orderbook": "10800/min", "order_create": RateLimit(180_000, "hour")},
    rest_url=None,            # default: the domain's REST URL
    ws_url=None,              # default: the domain's WebSocket URL
    user_agent=None,          # default: bitpin-sdk-python/<version>
    token_store=None,         # default: in memory; see Authentication
)
client = Bitpin(config)

Domains

Bitpin serves the same API on three domains. Pick one with domain; the REST and WebSocket URLs switch together:

domain	REST	WebSocket
org (default)	https://api.bitpin.org	wss://centrifugo.bitpin.org/connection/websocket
ir	https://api.bitpin.ir	wss://centrifugo.bitpin.ir/connection/websocket
market	https://api.bitpin.market	wss://centrifugo.bitpin.market/connection/websocket

rest_url and ws_url still win when you set them, for a proxy for example. The environment variable BITPIN_DOMAIN works with Config.from_env().

Four ways to build a config

Config(api_key="...", secret_key="...")                     # in code
Config.from_env(timeout=5)                                  # BITPIN_API_KEY, BITPIN_SECRET_KEY, BITPIN_DOMAIN
Config.from_file("bitpin.toml")                             # TOML, see below
Bitpin({"apiKey": "...", "secret": "...", "timeout": 5000}) # ccxt-style dict (timeout in ms)

bitpin.toml:

[bitpin]
api_key = "..."
secret_key = "..."
domain = "ir"
timeout = 10

[bitpin.rate_limits]
orderbook = "10800/min"
fills = "600/min"

Unknown keys and unknown rate-limit bucket names raise ValueError, so a typo can't silently do nothing.

client.describe() shows the effective URLs, capabilities, timeframes and rate limits.