clob

package

Go to main page

Versions in this module

v1

v1.3.5

Jul 15, 2026

v1.3.4

Jul 13, 2026

v1.3.3

Jul 13, 2026

v1.3.2

Jul 11, 2026

Changes in this version

+ const ContractAddressCombinatorialModule

+ const ContractAddressComboAutoRedeemer

+ const ContractAddressComboExchange

+ const ContractAddressComboPositionManager

+ const ContractAddressComboRouter

+ const MaxComboLegs

+ func CanonicalizeComboLegs(legs []string) ([]*big.Int, error)

type Client

+ func (c *Client) BuildComboCollateralApprovalTx(amount *big.Int, out *CTFTransaction) error

+ func (c *Client) BuildComboMergePositionsTxs(req *ComboMergePositionsRequest, out *[]CTFTransaction) error

+ func (c *Client) BuildComboPositionApprovalTx(approved bool, out *CTFTransaction) error

+ func (c *Client) BuildComboRedeemPositionTx(req *ComboRedeemPositionRequest, out *CTFTransaction) error

+ func (c *Client) BuildComboSplitPositionTxs(req *ComboSplitPositionRequest, out *[]CTFTransaction) error

+ func (c *Client) ComboMaxMergeAmount(ctx context.Context, owner common.Address, legs []string) (*big.Int, error)

+ func (c *Client) ComboMergePositions(ctx context.Context, req *ComboMergePositionsRequest, ...) error

+ func (c *Client) ComboMergePositionsRelayer(ctx context.Context, req *ComboMergePositionsRequest, args *CTFRelayerArgs, ...) error

+ func (c *Client) ComboMergePositionsWithDepositWallet(ctx context.Context, req *ComboMergePositionsRequest, ...) error

+ func (c *Client) ComboPositionBalance(ctx context.Context, owner common.Address, positionID string) (*big.Int, error)

+ func (c *Client) ComboRedeemPosition(ctx context.Context, req *ComboRedeemPositionRequest, out *TxReceipt) error

+ func (c *Client) ComboRedeemPositionRelayer(ctx context.Context, req *ComboRedeemPositionRequest, args *CTFRelayerArgs, ...) error

+ func (c *Client) ComboRedeemPositionWithDepositWallet(ctx context.Context, req *ComboRedeemPositionRequest, ...) error

+ func (c *Client) ComboSplitPosition(ctx context.Context, req *ComboSplitPositionRequest, ...) error

+ func (c *Client) ComboSplitPositionRelayer(ctx context.Context, req *ComboSplitPositionRequest, args *CTFRelayerArgs, ...) error

+ func (c *Client) ComboSplitPositionWithDepositWallet(ctx context.Context, req *ComboSplitPositionRequest, ...) error

+ func (c *Client) GetFeeBps(ctx context.Context, marketID common.Hash) (*big.Int, error)

+ func (c *Client) GetQuestionCount(ctx context.Context, marketID common.Hash) (*big.Int, error)

+ type ComboConditionID [31]byte

+ func DecodeComboPositionID(positionID string) (ComboConditionID, uint8, error)

+ type ComboMergePositionsRequest struct

+ Amount *big.Int

+ LegPositionIDs []string

+ type ComboOperationReceipt struct

+ Transactions []TxReceipt

+ type ComboPositionContext struct

+ ConditionID ComboConditionID

+ PositionIDs [2]string

+ func DeriveComboPositionContext(legs []string) (ComboPositionContext, error)

+ type ComboRedeemPositionRequest struct

+ Amount *big.Int

+ PositionID string

+ type ComboSplitPositionRequest struct

+ Amount *big.Int

+ LegPositionIDs []string

type ContractConfig

+ CombinatorialModule common.Address

+ ComboAutoRedeemer common.Address

+ ComboExchange common.Address

+ ComboPositionManager common.Address

+ ComboRouter common.Address

v1.3.1

Jul 11, 2026

Changes in this version

type Client

+ func (c *Client) BuildConvertPositionsTx(req *ConvertPositionsRequest, out *CTFTransaction) error

+ func (c *Client) ConvertPositions(ctx context.Context, req *ConvertPositionsRequest, out *TxReceipt) error

+ func (c *Client) ConvertPositionsRelayer(ctx context.Context, req *ConvertPositionsRequest, relayerReq *CTFRelayerArgs, ...) error

+ func (c *Client) ConvertPositionsWithDepositWallet(ctx context.Context, req *ConvertPositionsRequest, args *DepositWalletCTFArgs, ...) error

+ type ConvertPositionsRequest struct

+ Amount *big.Int

+ IndexSet *big.Int

+ MarketID common.Hash

v1.3.0

Jul 7, 2026

v1.2.9

Jul 5, 2026

v1.2.8

Jul 2, 2026

Changes in this version

type RewardsMarketsMultiParams

+ EventID []string

v1.2.7

Jun 6, 2026

Changes in this version

type Client

+ func (c *Client) SendHeartbeat(ctx context.Context, out *HeartbeatResponse) error

type HeartbeatResponse

+ Status string

v1.2.6

May 31, 2026

v1.2.5

May 25, 2026

Changes in this version

type Client

+ func (c *Client) GetTradesPage(ctx context.Context, params TradeParams) (*Page[Trade], error)

type MakerOrder

+ BuilderCode string

+ BuilderFee Float64

+ type MarketLiveActivity struct

+ ConditionID string

+ EventSlug string

+ Events []MarketTradeEvent

+ ID Int

+ Icon string

+ Image string

+ MarketSlug string

+ Question string

+ Raw json.RawMessage

+ SeriesSlug string

+ Tags []string

+ func (m *MarketLiveActivity) UnmarshalJSON(data []byte) error

+ type MarketTradeEvent struct

+ EventType string

+ FeeRateBps Float64

+ Market MarketTradeEventMarket

+ Outcome string

+ OutcomeIndex Int

+ Price Float64

+ Side Side

+ Size Float64

+ Timestamp Time

+ TransactionHash string

+ User MarketTradeEventUser

+ type MarketTradeEventMarket struct

+ AssetID String

+ ConditionID string

+ Icon string

+ Question string

+ Slug string

+ type MarketTradeEventUser struct

+ Address string

+ OptimizedProfilePicture string

+ ProfilePicture string

+ Pseudonym string

+ Username string

type Trade

+ ErrMsg string

+ MatchTimeNano string

type TradeParams

+ NextCursor string

v1.2.4

May 19, 2026

Changes in this version

+ const ContractAddressDepositWalletImplementation

+ func DeriveDepositWalletAddress(owner common.Address, chainID int64) (common.Address, error)

type Client

+ func (c *Client) DeriveDepositWalletAddress() (common.Address, error)

type ContractConfig

+ DepositWalletImplementation common.Address

v1.2.3

May 16, 2026

v1.2.2

May 15, 2026

Changes in this version

+ type CurrentRewardsParams struct

+ NextCursor string

+ Sponsored bool

type EarningsParams

+ FavoriteMarkets bool

+ OnlyMergeable bool

+ OnlyOpenOrders bool

+ OnlyOpenPositions bool

+ Q string

+ Sponsored bool

+ TagSlugs []string

type MarketReward

+ CreatedAt Time

+ EventID Int

+ GroupItemTitle string

+ MarketID Int

+ OneDayPriceChange Float64

type RewardsConfig

+ ID Int

+ type RewardsMarketParams struct

+ NextCursor string

+ Sponsored bool

+ type RewardsMarketsMultiParams struct

+ EventIDs []Int

+ EventTitle string

+ MaxPrice Float64

+ MaxSpread Float64

+ MaxVolume24h Float64

+ MinPrice Float64

+ MinSpread Float64

+ MinVolume24h Float64

+ NextCursor string

+ OrderBy string

+ PageSize int

+ Position string

+ Q string

+ TagSlugs []string

type UserRewardsEarning

+ EventID Int

+ MarketID Int

type UserRewardsParams

+ Sponsored bool

v1.2.1

May 14, 2026

Changes in this version

type Client

+ func (c *Client) GetCurrentRewardsWithParams(ctx context.Context, params RewardsMarketsParams, out *Page[CurrentReward]) error

+ func (c *Client) GetEarningsForUserForDayWithParams(ctx context.Context, params UserRewardsParams, out *Page[UserEarning]) error

+ func (c *Client) GetRewardPercentagesWithParams(ctx context.Context, params UserRewardsParams) (map[string]Float64, error)

+ func (c *Client) GetRewardsForMarketWithParams(ctx context.Context, conditionID string, params RewardsMarketsParams, ...) error

+ func (c *Client) GetRewardsMarketsMulti(ctx context.Context, params RewardsMarketsParams, out *Page[MarketReward]) error

+ func (c *Client) GetTotalEarningsForUserForDayWithParams(ctx context.Context, params UserRewardsParams, out *[]TotalUserEarning) error

type CurrentReward

+ EndDate Time

+ EventSlug string

+ MarketCompetitiveness Float64

+ MarketSlug string

+ NativeDailyRate Float64

+ NegRisk bool

+ Question string

+ SponsoredDailyRate Float64

+ SponsorsCount Int

+ Spread Float64

+ Tokens []Token

+ TotalDailyRate Float64

+ Volume24h Float64

type EarningsParams

+ MakerAddress string

+ PageSize int

+ SignatureType SignatureType

type MarketReward

+ EndDate Time

+ NativeDailyRate Float64

+ NegRisk bool

+ SponsoredDailyRate Float64

+ SponsorsCount Int

+ Spread Float64

+ TotalDailyRate Float64

+ Volume24h Float64

type RewardsConfig

+ TotalDays Float64

type RewardsMarketsParams

+ MaxPrice string

+ MaxSpread string

+ MinPrice string

+ MinVolume24h string

+ OrderBy string

+ PageSize int

+ Position string

+ type TotalUserEarning struct

+ AssetAddress string

+ AssetRate Float64

+ Date Time

+ Earnings Float64

+ MakerAddress string

type UserRewardsEarning

+ Spread Float64

+ Volume24h Float64

+ type UserRewardsParams struct

+ Date string

+ MakerAddress string

+ NextCursor string

+ SignatureType SignatureType

v1.2.0

May 11, 2026

v1.1.9

May 10, 2026

v1.1.8

May 9, 2026

v1.1.7

May 8, 2026

v1.1.6

May 7, 2026

v1.1.5

May 6, 2026

Changes in this version

+ const ContractAddressCTFCollateralAdapter

+ const ContractAddressCTFExchange

+ const ContractAddressCollateralOfframp

+ const ContractAddressCollateralOnramp

+ const ContractAddressConditionalTokens

+ const ContractAddressDepositWalletFactory

+ const ContractAddressGnosisSafeFactory

+ const ContractAddressNegRiskAdapter

+ const ContractAddressNegRiskCTFCollateralAdapter

+ const ContractAddressNegRiskCTFExchange

+ const ContractAddressPUSD

+ const ContractAddressPUSDImplementation

+ const ContractAddressPermissionedRamp

+ const ContractAddressPolymarketProxyFactory

+ const ContractAddressUMAAdapter

+ const ContractAddressUMAOptimisticOracle

+ func BuildDepositWalletBatchTypedData(chainID int64, depositWallet string, nonce string, deadline string, ...) (apitypes.TypedData, error)

+ func BuildDepositWalletOrderTypedData(chainID int64, verifyingContract common.Address, order SignedOrder) apitypes.TypedData

+ func SignDepositWalletOrder(signer *polyauth.Signer, chainID int64, order *SignedOrder, ...) error

type Client

+ func (c *Client) CTFDepositWalletTransactionRequest(ctx context.Context, tx *CTFTransaction, args *DepositWalletCTFArgs, ...) error

+ func (c *Client) DeployDepositWallet(ctx context.Context, out *relayer.SubmitTransactionResponse) error

+ func (c *Client) DepositWalletBatch(ctx context.Context, args *DepositWalletBatchArgs, ...) error

+ func (c *Client) DepositWalletBatchRelayerRequest(ctx context.Context, args *DepositWalletBatchArgs, ...) error

+ func (c *Client) DepositWalletCreateRelayerRequest(out *relayer.SubmitTransactionRequest) error

+ func (c *Client) MergePositionsWithDepositWallet(ctx context.Context, req *MergePositionsRequest, args *DepositWalletCTFArgs, ...) error

+ func (c *Client) NormalizeCollateralToken(collateral common.Address) (common.Address, error)

+ func (c *Client) RedeemNegRiskWithDepositWallet(ctx context.Context, req *RedeemNegRiskRequest, args *DepositWalletCTFArgs, ...) error

+ func (c *Client) RedeemPositionsWithDepositWallet(ctx context.Context, req *RedeemPositionsRequest, args *DepositWalletCTFArgs, ...) error

+ func (c *Client) SignDepositWalletOrder(order *SignedOrder, depositWallet common.Address, opts ...SignOrderOption) error

+ func (c *Client) SplitPositionWithDepositWallet(ctx context.Context, req *SplitPositionRequest, args *DepositWalletCTFArgs, ...) error

+ func (c *Client) SubmitCTFDepositWalletTransaction(ctx context.Context, tx *CTFTransaction, args *DepositWalletCTFArgs, ...) error

type ContractConfig

+ CTFCollateralAdapter common.Address

+ CollateralImplementation common.Address

+ CollateralOfframp common.Address

+ CollateralOnramp common.Address

+ DepositWalletFactory common.Address

+ GnosisSafeFactory common.Address

+ NegRiskCTFCollateralAdapter common.Address

+ PermissionedRamp common.Address

+ ProxyFactory common.Address

+ UMAOptimisticOracle common.Address

+ type DepositWalletBatchArgs struct

+ Calls []relayer.DepositWalletCall

+ Deadline string

+ DepositWallet string

+ Factory string

+ From string

+ Metadata string

+ Nonce string

+ type DepositWalletCTFArgs struct

+ Deadline string

+ DepositWallet string

+ Factory string

+ From string

+ Metadata string

+ Nonce string

+ type RelayerNonceGetter interface

+ GetNonce func(context.Context, *relayer.NonceResponse, ...relayer.NonceType) error

v1.1.4

May 5, 2026

Changes in this version

+ type CTFRelayerArgs struct

+ From string

+ GasLimit string

+ Metadata string

+ ProxyWallet string

+ Type relayer.NonceType

type Client

+ func (c *Client) BuildCTFRelayerRequest(ctx context.Context, tx *CTFTransaction, req *CTFRelayerArgs, ...) error

+ func (c *Client) MergePositionsRelayer(ctx context.Context, req *MergePositionsRequest, relayerReq *CTFRelayerArgs, ...) error

+ func (c *Client) RedeemNegRiskRelayer(ctx context.Context, req *RedeemNegRiskRequest, relayerReq *CTFRelayerArgs, ...) error

+ func (c *Client) RedeemPositionsRelayer(ctx context.Context, req *RedeemPositionsRequest, relayerReq *CTFRelayerArgs, ...) error

+ func (c *Client) SplitPositionRelayer(ctx context.Context, req *SplitPositionRequest, relayerReq *CTFRelayerArgs, ...) error

+ type ProxyRelayerBuilder interface

+ ProxySubmitTransactionRequest func(context.Context, *polyauth.Signer, *relayer.ProxySubmitTransactionArgs, ...) error

type RelayerCTFRequest

+ Data string

+ To string

+ type SafeRelayerBuilder interface

+ SafeSubmitTransactionRequest func(context.Context, *polyauth.Signer, *relayer.SafeSubmitTransactionArgs, ...) error

v1.1.3

May 4, 2026

Changes in this version

type Client

+ func (c *Client) ResolveSignatureType(signatureType *SignatureType) SignatureType

type Option

+ func WithDefaultSignatureType(signatureType SignatureType) Option

v1.1.2

May 2, 2026

v1.1.1

Apr 30, 2026

Changes in this version

type Client

+ func (c *Client) GetOpenOrdersPage(ctx context.Context, params OpenOrderParams) (*Page[OpenOrder], error)

type OpenOrderParams

+ NextCursor string

v1.1.0

Apr 30, 2026

v1.0.9

Apr 30, 2026

v1.0.8

Apr 30, 2026

Changes in this version

type TickSize

+ func (t *TickSize) UnmarshalJSON(data []byte) error

v1.0.7

Apr 29, 2026

Changes in this version

+ func ValidateHexAddress(name, value string, allowEmpty bool) error

type Client

+ func (c *Client) Credentials() *Credentials

+ func (c *Client) Signer() *polyauth.Signer

type MarketOrderArgsV2

+ Maker string

type OrderArgsV2

+ Maker string

v1.0.6

Apr 28, 2026

v1.0.5

Apr 28, 2026

Changes in this version

+ func ValidateBytes32Hex(name, v string) error

+ type CreateOrderOptions struct

+ NegRisk bool

+ TickSize string

+ type GetMarketOptionsResponse struct

+ NegRisk bool

+ TickSize string

type MarketOrderArgsV2

+ SignatureType SignatureType

type OrderArgsV2

+ SignatureType SignatureType

+ type OrderBuilder struct

+ func NewOrderBuilder(client *Client) *OrderBuilder

+ func (b *OrderBuilder) BuildMarketOrder(args MarketOrderArgsV2, opts CreateOrderOptions) (*SignedOrder, error)

+ func (b *OrderBuilder) BuildMarketOrderForToken(ctx context.Context, args MarketOrderArgsV2) (*SignedOrder, error)

+ func (b *OrderBuilder) BuildOrder(args OrderArgsV2, opts CreateOrderOptions) (*SignedOrder, error)

+ func (b *OrderBuilder) BuildOrderForToken(ctx context.Context, args OrderArgsV2) (*SignedOrder, error)

+ func (b *OrderBuilder) CreateAndPostMarketOrder(ctx context.Context, args MarketOrderArgsV2, opts CreateOrderOptions, ...) (*PostOrderResponse, error)

+ func (b *OrderBuilder) CreateAndPostMarketOrderForToken(ctx context.Context, args MarketOrderArgsV2, orderType OrderType, ...) (*PostOrderResponse, error)

+ func (b *OrderBuilder) CreateAndPostOrder(ctx context.Context, args OrderArgsV2, opts CreateOrderOptions, ...) (*PostOrderResponse, error)

+ func (b *OrderBuilder) CreateAndPostOrderForToken(ctx context.Context, args OrderArgsV2, orderType OrderType, deferExec *bool) (*PostOrderResponse, error)

+ func (b *OrderBuilder) GetMarketOptions(ctx context.Context, tokenID string) (*GetMarketOptionsResponse, error)

v1.0.4

Apr 28, 2026

Changes in this version

type PostOrderRequest

+ DeferExec bool

type SignatureType

+ const SignatureTypePoly1271

v1.0.3

Apr 26, 2026

v1.0.2

Apr 26, 2026

Changes in this version

+ func SignOrder(signer *polyauth.Signer, chainID int64, order *SignedOrder, ...) error

type Client

+ func (c *Client) SignOrder(order *SignedOrder, opts ...SignOrderOption) error

+ type SignOrderOption func(*signOrderConfig)

+ func WithSignOrderNegRisk(enabled bool) SignOrderOption

+ func WithSignOrderSalt(salt *big.Int) SignOrderOption

+ func WithSignOrderTime(now time.Time) SignOrderOption

+ func WithSignOrderVerifyingContract(address common.Address) SignOrderOption

v1.0.1

Apr 25, 2026

Changes in this version

+ const AmoyChainID

+ const AmoyHost

+ const MainnetHost

+ const PolygonChainID

+ const V2Host

+ const ZeroAddress

+ const ZeroBytes32

+ func BinaryPartition() []*big.Int

+ func BuildHMACSignature(secret string, timestamp int64, method, requestPath string, body []byte) (string, error)

+ func CollectionID(parentCollectionID common.Hash, conditionID common.Hash, indexSet *big.Int) common.Hash

+ func ConditionID(oracle common.Address, questionID common.Hash, outcomeSlotCount uint) common.Hash

+ func GenerateKey() (string, error)

+ func ParsePrivateKey(raw string) (*polyauth.Signer, error)

+ func PositionID(collateralToken common.Address, collectionID common.Hash) *big.Int

+ type APIError struct

+ Body []byte

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type AssetType string

+ const AssetCollateral

+ const AssetConditional

+ type Auth struct

+ ChainID int64

+ Credentials *Credentials

+ Signer *polyauth.Signer

+ UseServerTime bool

+ type BalanceAllowanceParams struct

+ AssetType AssetType

+ SignatureType SignatureType

+ TokenID string

+ type BalanceAllowanceResponse struct

+ Allowance Float64

+ Allowances map[string]string

+ Balance Float64

+ type BanStatus struct

+ ClosedOnly bool

+ type BatchPriceHistoryParams struct

+ EndTS int64

+ Fidelity int

+ Interval string

+ Markets []string

+ StartTS int64

+ type BatchPriceHistoryResponse struct

+ History map[string][]PricePoint

+ type BookParams struct

+ Side Side

+ TokenID string

+ type BuilderAPIKey struct

+ CreatedAt Time

+ Key string

+ RevokedAt Time

+ type BuilderFeeRate struct

+ BuilderMakerFeeRateBps Int

+ BuilderTakerFeeRateBps Int

+ type BuilderTrade struct

+ AssetID String

+ BucketIndex Int

+ Builder string

+ CreatedAt Time

+ ErrMsg string

+ Fee Float64

+ FeeUSDC Float64

+ ID string

+ Maker string

+ Market string

+ MatchTime Time

+ Outcome string

+ OutcomeIndex Int

+ Owner string

+ Price Float64

+ Side Side

+ Size Float64

+ SizeUSDC Float64

+ Status string

+ TakerOrderHash string

+ TradeType string

+ TransactionHash string

+ UpdatedAt Time

+ type BuilderTradeParams struct

+ After int64

+ AssetID string

+ Before int64

+ BuilderCode string

+ ID string

+ MakerAddress string

+ Market string

+ NextCursor string

+ type CTFTransaction struct

+ Data []byte

+ To common.Address

+ type CancelOrdersResponse struct

+ Canceled []string

+ NotCanceled map[string]string

+ type CancelRFQQuoteRequest struct

+ QuoteID string

+ type CancelRFQRequest struct

+ RequestID string

+ type Client struct

+ func NewClient(host string, opts ...Option) *Client

+ func (c *Client) AcceptRFQRequest(ctx context.Context, requestID string) error

+ func (c *Client) ApproveRFQQuote(ctx context.Context, quoteID string) (map[string]any, error)

+ func (c *Client) AreOrdersScoring(ctx context.Context, orderIDs []string) (map[string]bool, error)

+ func (c *Client) BuildMergePositionsTx(req MergePositionsRequest, out *CTFTransaction) error

+ func (c *Client) BuildRedeemNegRiskTx(req RedeemNegRiskRequest, out *CTFTransaction) error

+ func (c *Client) BuildRedeemPositionsTx(req RedeemPositionsRequest, out *CTFTransaction) error

+ func (c *Client) BuildSplitPositionTx(req SplitPositionRequest, out *CTFTransaction) error

+ func (c *Client) CancelAll(ctx context.Context, out *CancelOrdersResponse) error

+ func (c *Client) CancelMarketOrders(ctx context.Context, params OrderMarketCancelParams, out *CancelOrdersResponse) error

+ func (c *Client) CancelOrder(ctx context.Context, orderID string, out *CancelOrdersResponse) error

+ func (c *Client) CancelOrders(ctx context.Context, orderIDs []string, out *CancelOrdersResponse) error

+ func (c *Client) CancelRFQQuote(ctx context.Context, quoteID string) error

+ func (c *Client) CancelRFQRequest(ctx context.Context, requestID string) error

+ func (c *Client) CreateAPIKey(ctx context.Context, nonce int64, out *Credentials) error

+ func (c *Client) CreateBuilderAPIKey(ctx context.Context, out *Credentials) error

+ func (c *Client) CreateRFQQuote(ctx context.Context, req CreateRFQQuoteRequest) (map[string]any, error)

+ func (c *Client) CreateRFQRequest(ctx context.Context, req CreateRFQRequest) (map[string]any, error)

+ func (c *Client) CreateReadonlyAPIKey(ctx context.Context, out *ReadonlyAPIKey) error

+ func (c *Client) DeleteAPIKey(ctx context.Context) error

+ func (c *Client) DeleteReadonlyAPIKey(ctx context.Context, key string) error

+ func (c *Client) DeriveAPIKey(ctx context.Context, nonce int64, out *Credentials) error

+ func (c *Client) DropNotifications(ctx context.Context, params DropNotificationParams) error

+ func (c *Client) GetAPIKeys(ctx context.Context) ([]Credentials, error)

+ func (c *Client) GetBalanceAllowance(ctx context.Context, params BalanceAllowanceParams, ...) error

+ func (c *Client) GetBatchPricesHistory(ctx context.Context, params BatchPriceHistoryParams, ...) error

+ func (c *Client) GetBuilderAPIKeys(ctx context.Context) ([]BuilderAPIKey, error)

+ func (c *Client) GetBuilderFeeRate(ctx context.Context, builderCode string, out *BuilderFeeRate) error

+ func (c *Client) GetBuilderTrades(ctx context.Context, params BuilderTradeParams, out *Page[BuilderTrade]) error

+ func (c *Client) GetClobMarketInfo(ctx context.Context, out *ClobMarketInfo) error

+ func (c *Client) GetClosedOnlyMode(ctx context.Context, out *BanStatus) error

+ func (c *Client) GetCurrentRebates(ctx context.Context, params RebateParams) ([]Rebate, error)

+ func (c *Client) GetCurrentRewards(ctx context.Context, cursor string, out *Page[CurrentReward]) error

+ func (c *Client) GetEarningsForUserForDay(ctx context.Context, date string, signatureType SignatureType, cursor string, ...) error

+ func (c *Client) GetFeeRate(ctx context.Context, tokenID string, out *FeeRateResponse) error

+ func (c *Client) GetFeeRateByTokenID(ctx context.Context, tokenID string, out *FeeRateResponse) error

+ func (c *Client) GetLastTradePrice(ctx context.Context, tokenID string, out *LastTradePriceResponse) error

+ func (c *Client) GetLastTradesPrices(ctx context.Context, books []BookParams) ([]LastTradesPricesResponse, error)

+ func (c *Client) GetMarket(ctx context.Context, out *Market) error

+ func (c *Client) GetMarketByToken(ctx context.Context, out *MarketByToken) error

+ func (c *Client) GetMarketTradesEvents(ctx context.Context, conditionID string) ([]Trade, error)

+ func (c *Client) GetMarkets(ctx context.Context, cursor string, out *Page[Market]) error

+ func (c *Client) GetMidpoint(ctx context.Context, tokenID string, out *MidpointResponse) error

+ func (c *Client) GetMidpoints(ctx context.Context, books []BookParams) (map[string]Float64, error)

+ func (c *Client) GetNegRisk(ctx context.Context, tokenID string, out *NegRiskResponse) error

+ func (c *Client) GetNotifications(ctx context.Context) ([]Notification, error)

+ func (c *Client) GetOk(ctx context.Context) (string, error)

+ func (c *Client) GetOpenOrders(ctx context.Context, params OpenOrderParams) ([]OpenOrder, error)

+ func (c *Client) GetOrder(ctx context.Context, out *OpenOrder) error

+ func (c *Client) GetOrderBook(ctx context.Context, out *OrderBookSummary) error

+ func (c *Client) GetOrderBooks(ctx context.Context, books []BookParams) ([]OrderBookSummary, error)

+ func (c *Client) GetPreMigrationOrders(ctx context.Context, params OpenOrderParams) ([]OpenOrder, error)

+ func (c *Client) GetPrice(ctx context.Context, tokenID string, side Side, out *PriceResponse) error

+ func (c *Client) GetPrices(ctx context.Context, books []BookParams) (map[string]map[Side]Float64, error)

+ func (c *Client) GetPricesHistory(ctx context.Context, params PriceHistoryParams, out *PriceHistoryResponse) error

+ func (c *Client) GetRFQBestQuote(ctx context.Context, params RFQListParams, out *RfqQuote) error

+ func (c *Client) GetRFQConfig(ctx context.Context) (map[string]any, error)

+ func (c *Client) GetRFQQuoterQuotes(ctx context.Context, params RFQListParams, out *Page[RfqQuote]) error

+ func (c *Client) GetRFQRequesterQuotes(ctx context.Context, params RFQListParams, out *Page[RfqQuote]) error

+ func (c *Client) GetRFQRequests(ctx context.Context, params RFQListParams, out *Page[RfqRequest]) error

+ func (c *Client) GetReadonlyAPIKeys(ctx context.Context) ([]ReadonlyAPIKey, error)

+ func (c *Client) GetRewardPercentages(ctx context.Context, signatureType SignatureType) (map[string]Float64, error)

+ func (c *Client) GetRewardsForMarket(ctx context.Context, conditionID, cursor string, out *Page[MarketReward]) error

+ func (c *Client) GetSamplingMarkets(ctx context.Context, cursor string, out *Page[Market]) error

+ func (c *Client) GetSamplingSimplifiedMarkets(ctx context.Context, cursor string, out *Page[SimplifiedMarket]) error

+ func (c *Client) GetServerTime(ctx context.Context) (int64, error)

+ func (c *Client) GetSimplifiedMarkets(ctx context.Context, cursor string, out *Page[SimplifiedMarket]) error

+ func (c *Client) GetSpread(ctx context.Context, tokenID string, out *SpreadResponse) error

+ func (c *Client) GetSpreads(ctx context.Context, books []BookParams) (map[string]Float64, error)

+ func (c *Client) GetTickSize(ctx context.Context, tokenID string, out *TickSizeResponse) error

+ func (c *Client) GetTickSizeByTokenID(ctx context.Context, tokenID string, out *TickSizeResponse) error

+ func (c *Client) GetTotalEarningsForUserForDay(ctx context.Context, date string, signatureType SignatureType, ...) error

+ func (c *Client) GetTrades(ctx context.Context, params TradeParams) ([]Trade, error)

+ func (c *Client) GetUserEarningsAndMarketsConfig(ctx context.Context, params EarningsParams, signatureType SignatureType, ...) error

+ func (c *Client) GetVersion(ctx context.Context) (int, error)

+ func (c *Client) Host() string

+ func (c *Client) IsOrderScoring(ctx context.Context, orderID string, out *OrderScoring) error

+ func (c *Client) MergePositions(ctx context.Context, req MergePositionsRequest, out *TxReceipt) error

+ func (c *Client) PostHeartbeat(ctx context.Context, heartbeatID string, out *HeartbeatResponse) error

+ func (c *Client) PostOrder(ctx context.Context, req PostOrderRequest, out *PostOrderResponse) error

+ func (c *Client) PostOrders(ctx context.Context, reqs []PostOrderRequest, postOnly, deferExec bool) ([]PostOrderResponse, error)

+ func (c *Client) RedeemNegRisk(ctx context.Context, req RedeemNegRiskRequest, out *TxReceipt) error

+ func (c *Client) RedeemPositions(ctx context.Context, req RedeemPositionsRequest, out *TxReceipt) error

+ func (c *Client) RevokeBuilderAPIKey(ctx context.Context) error

+ func (c *Client) SplitPosition(ctx context.Context, req SplitPositionRequest, out *TxReceipt) error

+ func (c *Client) SubmitCTFRelayerTransaction(ctx context.Context, tx *CTFTransaction, req RelayerCTFRequest, ...) error

+ func (c *Client) SubmitRelayerTransaction(ctx context.Context, req relayer.SubmitTransactionRequest, ...) error

+ func (c *Client) UpdateBalanceAllowance(ctx context.Context, params BalanceAllowanceParams, ...) error

+ type ClobMarketInfo struct

+ ConditionID string

+ FeeDetails FeeInfo

+ MakerBaseFee Float64

+ MinimumOrderSize Float64

+ MinimumTickSize Float64

+ NegRisk bool

+ RFQEnabled bool

+ TakerBaseFee Float64

+ Tokens []ClobMarketToken

+ type ClobMarketToken struct

+ Outcome string

+ TokenID String

+ type ContractConfig struct

+ Collateral common.Address

+ ConditionalTokens common.Address

+ Exchange common.Address

+ NegRiskAdapter common.Address

+ NegRiskExchange common.Address

+ UMAAdapter common.Address

+ func Contracts(chainID int64) (ContractConfig, error)

+ type CreateRFQQuoteRequest struct

+ AmountIn Float64

+ AmountOut Float64

+ AssetIn string

+ AssetOut string

+ RequestID string

+ UserType SignatureType

+ type CreateRFQRequest struct

+ AmountIn Float64

+ AmountOut Float64

+ AssetIn string

+ AssetOut string

+ UserType SignatureType

+ type Credentials struct

+ Key string

+ Passphrase string

+ Secret string

+ type CurrentReward struct

+ ConditionID string

+ RewardsConfig []RewardsConfig

+ RewardsMaxSpread Float64

+ RewardsMinSize Float64

+ type Date = shared.Date

+ type DropNotificationParams struct

+ IDs []string

+ type Earning struct

+ AssetAddress string

+ AssetRate Float64

+ Earnings Float64

+ type EarningsParams struct

+ Date string

+ NextCursor string

+ NoCompetition bool

+ OrderBy string

+ Position string

+ type FeeInfo struct

+ Exponent Float64

+ Rate Float64

+ TakerOnly bool

+ type FeeRateResponse struct

+ BaseFee Int

+ type Float64 = shared.Float64

+ type GeoblockResponse struct

+ Blocked bool

+ Country string

+ IP string

+ Region string

+ type HeartbeatResponse struct

+ Error string

+ HeartbeatID string

+ type Int = shared.Int

+ type Int64 = shared.Int64

+ type LastTradePriceResponse struct

+ Price Float64

+ Side Side

+ type LastTradesPricesResponse struct

+ Price Float64

+ Side Side

+ TokenID String

+ type MakerOrder struct

+ AssetID String

+ FeeRateBps Float64

+ MakerAddress string

+ MatchedAmount Float64

+ OrderID string

+ Outcome string

+ Owner string

+ Price Float64

+ Side Side

+ type Market struct

+ AcceptingOrderTimestamp Time

+ AcceptingOrders bool

+ Active bool

+ Archived bool

+ Closed bool

+ ConditionID string

+ Description string

+ EnableOrderBook bool

+ EndDateISO Time

+ FPMM string

+ GameStartTime Time

+ Icon string

+ Image string

+ Is5050Outcome bool

+ MakerBaseFee Float64

+ MarketSlug string

+ MinimumOrderSize Float64

+ MinimumTickSize Float64

+ NegRisk bool

+ NegRiskMarketID string

+ NegRiskRequestID string

+ NotificationsEnabled bool

+ Question string

+ QuestionID string

+ Rewards Rewards

+ SecondsDelay Uint64

+ Tags []string

+ TakerBaseFee Float64

+ Tokens []Token

+ type MarketByToken struct

+ ConditionID string

+ PrimaryTokenID String

+ SecondaryTokenID String

+ type MarketOrderArgsV2 struct

+ Amount float64

+ BuilderCode string

+ Metadata string

+ OrderType OrderType

+ Price float64

+ Side Side

+ TokenID string

+ UserUSDCBalance float64

+ type MarketReward struct

+ ConditionID string

+ EventSlug string

+ Image string

+ MarketCompetitiveness Float64

+ MarketSlug string

+ Question string

+ RewardsConfig []MarketRewardsConfig

+ RewardsMaxSpread Float64

+ RewardsMinSize Float64

+ Tokens []Token

+ type MarketRewardsConfig struct

+ AssetAddress string

+ EndDate Date

+ ID String

+ RatePerDay Float64

+ StartDate Date

+ TotalDays Float64

+ TotalRewards Float64

+ type MergePositionsRequest struct

+ Amount *big.Int

+ CollateralToken common.Address

+ ConditionID common.Hash

+ ParentCollectionID common.Hash

+ Partition []*big.Int

+ func MergeBinary(collateral common.Address, conditionID common.Hash, amount *big.Int) MergePositionsRequest

+ type MidpointResponse struct

+ Mid Float64

+ type NegRiskResponse struct

+ NegRisk bool

+ type Notification struct

+ Owner string

+ Payload jsonRawObject

+ Type Int

+ type OpenOrder struct

+ AssetID String

+ AssociateTrades []string

+ CreatedAt Time

+ Expiration Time

+ ID string

+ MakerAddress string

+ Market string

+ OrderType OrderType

+ OriginalSize Float64

+ Outcome string

+ Owner string

+ Price Float64

+ Side Side

+ SizeMatched Float64

+ Status string

+ type OpenOrderParams struct

+ AssetID string

+ ID string

+ Market string

+ type Option func(*Client)

+ func WithChainID(chainID int64) Option

+ func WithCredentials(creds Credentials) Option

+ func WithGeoblockHost(host string) Option

+ func WithHTTPClient(h *http.Client) Option

+ func WithRPCURL(rpcURL string) Option

+ func WithRelayerClient(client *relayer.Client) Option

+ func WithRelayerSubmitter(submitter RelayerSubmitter) Option

+ func WithServerTime(enabled bool) Option

+ func WithSigner(signer *polyauth.Signer) Option

+ type OrderArgsV2 struct

+ BuilderCode string

+ Expiration int64

+ Metadata string

+ Price float64

+ Side Side

+ Size float64

+ TokenID string

+ type OrderBookSummary struct

+ Asks []OrderSummary

+ AssetID String

+ Bids []OrderSummary

+ Hash string

+ LastTradePrice Float64

+ Market string

+ MinOrderSize Float64

+ NegRisk bool

+ TickSize Float64

+ Timestamp Time

+ type OrderMarketCancelParams struct

+ AssetID string

+ Market string

+ type OrderScoring struct

+ Scoring bool

+ type OrderSummary struct

+ Price Float64

+ Size Float64

+ type OrderType string

+ const FAK

+ const FOK

+ const GTC

+ const GTD

+ type Page struct

+ Count Int

+ Data []T

+ Limit Int

+ NextCursor string

+ type PostOrderRequest struct

+ Order SignedOrder

+ OrderType OrderType

+ Owner string

+ type PostOrderResponse struct

+ ErrorMsg string

+ MakingAmount Float64

+ OrderID string

+ Status string

+ Success bool

+ TakingAmount Float64

+ TradeIDs []string

+ TransactionHashes []string

+ type PriceHistoryParams struct

+ EndTS int64

+ Fidelity int

+ Interval string

+ Market string

+ StartTS int64

+ type PriceHistoryResponse struct

+ History []PricePoint

+ type PricePoint struct

+ P Float64

+ T Int64

+ type PriceResponse struct

+ Price Float64

+ type RFQListParams struct

+ Limit int

+ Markets []string

+ Offset string

+ PriceMax Float64

+ PriceMin Float64

+ QuoteIDs []string

+ RequestIDs []string

+ SizeMax Float64

+ SizeMin Float64

+ SizeUSDCMax Float64

+ SizeUSDCMin Float64

+ SortBy string

+ SortDir string

+ State string

+ type ReadonlyAPIKey struct

+ APIKey string

+ type Rebate struct

+ AssetAddress string

+ ConditionID string

+ Date Date

+ MakerAddress string

+ RebatedFeesUSDC Float64

+ type RebateParams struct

+ Date string

+ MakerAddress string

+ type RedeemNegRiskRequest struct

+ Amounts []*big.Int

+ ConditionID common.Hash

+ type RedeemPositionsRequest struct

+ CollateralToken common.Address

+ ConditionID common.Hash

+ IndexSets []*big.Int

+ ParentCollectionID common.Hash

+ func RedeemBinary(collateral common.Address, conditionID common.Hash) RedeemPositionsRequest

+ type RelayerCTFRequest struct

+ From string

+ Metadata string

+ Nonce string

+ ProxyWallet string

+ Signature string

+ SignatureParams relayer.SignatureParams

+ Type string

+ Value string

+ type RelayerSubmitter interface

+ SubmitTransaction func(context.Context, relayer.SubmitTransactionRequest, ...) error

+ type RewardRate struct

+ AssetAddress string

+ RewardsDailyRate Float64

+ type Rewards struct

+ MaxSpread Float64

+ MinSize Float64

+ Rates []RewardRate

+ type RewardsConfig struct

+ AssetAddress string

+ EndDate Date

+ RatePerDay Float64

+ StartDate Date

+ TotalRewards Float64

+ type RewardsMarketsParams struct

+ ConditionID string

+ Date string

+ NextCursor string

+ type RfqQuote struct

+ Complement String

+ Condition string

+ Price Float64

+ ProxyAddress string

+ QuoteID string

+ RequestID string

+ Side Side

+ SizeIn Float64

+ SizeOut Float64

+ Token String

+ UserAddress string

+ type RfqRequest struct

+ Complement String

+ Condition string

+ Expiry Int64

+ Price Float64

+ ProxyAddress string

+ RequestID string

+ Side Side

+ SizeIn Float64

+ SizeOut Float64

+ Token String

+ UserAddress string

+ type Side string

+ const Buy

+ const Sell

+ type SignatureType int

+ const SignatureTypeEOA

+ const SignatureTypeGnosisSafe

+ const SignatureTypeProxy

+ type SignedOrder struct

+ Builder string

+ Expiration String

+ FeeRateBps String

+ Maker string

+ MakerAmount String

+ Metadata string

+ Nonce String

+ Salt String

+ Side Side

+ Signature string

+ SignatureType SignatureType

+ Signer string

+ Taker string

+ TakerAmount String

+ Timestamp String

+ TokenID String

+ type SimplifiedMarket struct

+ AcceptingOrders bool

+ Active bool

+ Archived bool

+ Closed bool

+ ConditionID string

+ Rewards Rewards

+ Tokens []Token

+ type SplitPositionRequest struct

+ Amount *big.Int

+ CollateralToken common.Address

+ ConditionID common.Hash

+ ParentCollectionID common.Hash

+ Partition []*big.Int

+ func SplitBinary(collateral common.Address, conditionID common.Hash, amount *big.Int) SplitPositionRequest

+ type SpreadResponse struct

+ Spread Float64

+ type String = shared.String

+ type TickSize string

+ const TickSizeHundredth

+ const TickSizeTenThousand

+ const TickSizeTenth

+ const TickSizeThousandth

+ type TickSizeResponse struct

+ MinimumTickSize TickSize

+ type Time = shared.Time

+ type Token struct

+ Outcome string

+ Price Float64

+ TokenID String

+ Winner bool

+ type Trade struct

+ AssetID String

+ BucketIndex Int

+ ErrorMsg string

+ FeeRateBps Float64

+ ID string

+ LastUpdate Time

+ MakerAddress string

+ MakerOrders []MakerOrder

+ Market string

+ MatchTime Time

+ Outcome string

+ Owner string

+ Price Float64

+ Side Side

+ Size Float64

+ Status string

+ TakerOrderID string

+ TraderSide string

+ TransactionHash string

+ type TradeParams struct

+ After int64

+ AssetID string

+ Before int64

+ ID string

+ MakerAddress string

+ Market string

+ TakerAddress string

+ type TxReceipt struct

+ BlockNumber uint64

+ Hash common.Hash

+ type Uint64 = shared.Uint64

+ type UserEarning struct

+ AssetAddress string

+ AssetRate Float64

+ ConditionID string

+ Date Date

+ Earnings Float64

+ MakerAddress string

+ type UserRewardsEarning struct

+ ConditionID string

+ EarningPercentage Float64

+ Earnings []Earning

+ EventSlug string

+ Image string

+ MakerAddress string

+ MarketCompetitiveness Float64

+ MarketSlug string

+ Question string

+ RewardsConfig []RewardsConfig

+ RewardsMaxSpread Float64

+ RewardsMinSize Float64

+ Tokens []Token

+ type WSAuth struct

+ APIKey string

+ Passphrase string

+ Secret string

v1.0.0

Apr 25, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL