Types

All data types are Python dataclasses defined in turbine_client.types. They are returned by TurbineClient methods and can be imported directly.

from turbine_client import Side, Outcome, OrderArgs, SignedOrder
from turbine_client.types import (
    Market, MarketStats, OrderBookSnapshot, PriceLevel, Trade, Position,
    QuickMarket, Resolution, Order, AssetPrice, UserActivity, UserStats,
    PermitSignature, Holder, PlatformStats, ChainStats,
    FailedTrade, PendingTrade, FailedClaim, PendingClaim, SettlementStatus,
    WSMessage, OrderBookUpdate, TradeUpdate, QuickMarketUpdate,
)

Enums

Side

Order side. Used in OrderArgs and order filtering.

class Side(IntEnum):
    BUY = 0
    SELL = 1

Outcome

Market outcome. Used in OrderArgs and orderbook filtering.

class Outcome(IntEnum):
    YES = 0
    NO = 1

Order Types

OrderArgs

Arguments for creating a new order. Passed to client.create_order().

Validation runs on construction. Raises ValueError if price is outside 1–999999 or size is not positive.

SignedOrder

A signed order ready for submission via client.post_order().

Created by client.create_order(), client.create_limit_buy(), or client.create_limit_sell(). Call signed.to_dict() for the API-ready JSON payload.

PermitSignature

EIP-2612 permit signature for gasless USDC approval. Returned by client.sign_usdc_permit().

Order

An order on the orderbook. Returned by client.get_orders(), client.get_order(), client.get_user_orders().

Market Types

Market

A prediction market. Returned by client.get_markets().

MarketStats

Statistics for a market. Returned by client.get_market(), client.get_stats().

QuickMarket

A 15-minute quick market. Returned by client.get_quick_market(), client.get_quick_market_history().

Resolution

Market resolution status. Returned by client.get_resolution().

Orderbook Types

OrderBookSnapshot

Orderbook state for a market. Returned by client.get_orderbook().

PriceLevel

A single price level in the orderbook.

Trade Types

Trade

A trade execution. Returned by client.get_trades().

Position Types

Position

A user's position in a market.

Holder

A top holder in a market. Returned by client.get_holders().

User Types

UserActivity

Trading activity summary. Returned by client.get_user_activity().

UserStats

User portfolio statistics. Returned by client.get_user_stats().

Platform Types

PlatformStats

Platform-wide statistics. Returned by client.get_platform_stats().

ChainStats

AssetPrice

Current price for an asset. Returned by client.get_quick_market_price().

Settlement Tracking Types

FailedTrade

PendingTrade

FailedClaim / PendingClaim

SettlementStatus

WebSocket Message Types

WSMessage

Base WebSocket message. All other message types inherit from this.

OrderBookUpdate

Extends WSMessage. Has an orderbook property that returns OrderBookSnapshot or None.

TradeUpdate

Extends WSMessage. Has a trade property that returns Trade or None.

QuickMarketUpdate

Extends WSMessage. Has a quick_market property that returns QuickMarket or None.

Helper Functions

Available from turbine_client.order_builder.helpers:

from turbine_client.order_builder.helpers import (
    price_to_decimal,   # 500000 → Decimal('0.5')
    decimal_to_price,   # 0.5 → 500000
    size_to_shares,     # 1000000 → Decimal('1')
    shares_to_size,     # 1.5 → 1500000
    calculate_cost,     # cost = price * size / 1e6
    calculate_payout,   # payout = size (winners get 1:1)
    calculate_profit,   # profit = payout - cost
    validate_price,     # raises OrderValidationError
    validate_size,      # raises OrderValidationError
    round_price_down,   # round to tick size
    round_price_up,     # round to tick size
    round_size_down,    # round to minimum increment
)

Examples

from turbine_client.order_builder.helpers import (
    calculate_cost, calculate_profit, price_to_decimal, decimal_to_price
)

# Cost of buying 10 shares at $0.45
cost = calculate_cost(450000, 10000000)  # 4500000 = $4.50 USDC

# Profit if the bet wins
profit = calculate_profit(450000, 10000000)  # 5500000 = $5.50 USDC

# Price conversions
price_to_decimal(750000)   # Decimal('0.75')
decimal_to_price(0.33)     # 330000