Balance & Allowance Types
BalanceAllowanceParams
Parameters for querying balance and allowance.Type of asset (COLLATERAL or CONDITIONAL)
Token ID (required for CONDITIONAL assets)
Example
BalanceAllowanceResponse
Response containing balance and allowance information.Current token balance (in wei/smallest unit)
Approved allowance for the CLOB contract (in wei/smallest unit)
Example
Fee Types
FeeRates
Mapping of token IDs to their fee rates.Example
Rewards Types
UserEarning
Daily earnings for a user on a specific market.Date of the earnings (ISO 8601 format)
Market condition ID
Reward asset address
Maker’s address
Earnings amount for the day
Exchange rate of the asset
TotalUserEarning
Total earnings across all markets for a user.Date of the earnings
Reward asset address
Maker’s address
Total earnings for the day
Exchange rate of the asset
RewardsPercentages
Mapping of markets to their reward percentage allocations.Example
Token
Token information with price.Token/asset ID
Outcome name (e.g., “Yes”, “No”)
Current price
RewardsConfig
Configuration for a rewards program.Address of the reward token
Start date of the rewards program
End date of the rewards program
Daily reward distribution rate
Total amount of rewards in the program
MarketReward
Reward information for a specific market.Market condition ID
Market question
URL slug for the market
URL slug for the event
Market image URL
Maximum spread allowed for rewards eligibility
Minimum order size for rewards eligibility
Array of tokens in this market
Array of reward configurations
Earning
Earnings information for a specific asset.Reward asset address
Earnings amount
Exchange rate of the asset
UserRewardsEarning
Detailed rewards earning information for a user.Market condition ID
Market question
URL slug for the market
URL slug for the event
Market image URL
Maximum spread allowed for rewards
Minimum order size for rewards
Competitiveness score for the market
Array of tokens
Array of reward configurations
Maker’s address
User’s percentage of total earnings
Array of earnings by asset
Order Scoring Types
OrderScoringParams
Parameters for checking if an order is eligible for rewards.Order ID to check
OrderScoring
Response indicating if an order is eligible for rewards.Whether the order is eligible for rewards scoring
OrdersScoringParams
Parameters for checking multiple orders.Array of order IDs to check
OrdersScoring
Mapping of order IDs to their scoring eligibility.Example
Builder Types
BuilderTrade
Trade information from the builder API.Unique trade identifier
Type of trade
Hash of the taker order
Builder address
Market condition ID
Asset/token ID
Trade side (BUY or SELL)
Trade size in tokens
Trade size in USDC
Execution price
Trade status
Outcome name
Outcome index
Owner address
Maker address
Transaction hash
When the trade was matched
Bucket index for time aggregation
Fee amount in tokens
Fee amount in USDC
Error message if the trade failed
Creation timestamp
Last update timestamp
Notification Types
Notification
Generic notification structure.Notification type identifier
Notification owner address
Notification payload data
DropNotificationParams
Parameters for dropping/dismissing notifications.Array of notification IDs to drop
Heartbeat Type
HeartbeatResponse
Response from heartbeat endpoint.Unique heartbeat identifier
Error message if the heartbeat failed