polyedge

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2026 License: MIT Imports: 13 Imported by: 0

README

PolyEdge Go SDK

Go Reference Documentation Benchmark

Official Go client library for PolyEdge — Ultra-Low-Latency Polymarket Mempool Trade Streaming & Real-Time On-Chain Analytics API.

Engineered for Polymarket copy-trading bots, professional traders, and prediction market builders. Capture pending trades pre-block and track smart money with institutional-grade on-chain analytics.

Key Features

  • 4 First-Class Namespaces: Aligned with OpenAPI 3.1:
    • client.Streams: Real-time SSE trade streaming, sessions & filter management.
    • client.Analytics: Polymarket trade attribution, trader leaderboards, market settlement audit.
    • client.Account: User profile, API keys, request telemetry, and ledger.
    • client.Subscription: Pricing tiers catalog, upgrade quotes, and promo codes.
  • Pure Standard Library: Zero external runtime dependencies.
  • High-Performance SSE Engine:
    • 45s Keep-Alive Watchdog: Native timer watchdog detects silent dead TCP half-open connections.
    • Atomic Last-Event-ID Resumption: Preserves event progress across reconnects.
    • Jittered Exponential Backoff: Prevents server connection storms.
    • Go Channels: Delivers events via <-chan *LiveTransaction and errors via <-chan error.
  • Pre-Block Polymarket Trade Streaming: Peered with 100+ Polygon nodes to capture pending Polymarket trades pre-block. The World's Fastest — verify yourself.

Installation

go get github.com/PolyEdgeDev/polyedge-go

Quick Start

1. Initialize Client
package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/PolyEdgeDev/polyedge-go"
)

func main() {
	apiKey := os.Getenv("POLYEDGE_API_KEY")
	client, err := polyedge.NewClient(apiKey)
	if err != nil {
		log.Fatalf("Failed to initialize client: %v", err)
	}

	ctx := context.Background()

	// 1. Query Leaderboard
	leaderboard, err := client.Analytics.GetLeaderboard(ctx, 5, 0)
	if err != nil {
		log.Fatalf("GetLeaderboard error: %v", err)
	}
	fmt.Printf("Total active traders: %d\n", leaderboard.TotalCount)
	for i, t := range leaderboard.Traders {
		pnlUsd := float64(t.TotalPnl) / 1e6
		fmt.Printf("#%d %s (%s) - PnL: $%.2f\n", i+1, t.Profile.Address, t.Profile.Name, pnlUsd)
	}

	// 2. Real-Time Mempool SSE Trade Stream
	streamClient, err := client.Streams.Connect("your_stream_id")
	if err != nil {
		log.Fatalf("Connect error: %v", err)
	}

	txCh, errCh := streamClient.Subscribe(ctx)
	for {
		select {
		case tx, ok := <-txCh:
			if !ok {
				return
			}
			fmt.Printf("⚡ [Live Trade] Tx: %s...\n", tx.TxHash[:18])
			fmt.Printf("   Market: \"%s\"\n", tx.Market.Question)
			fmt.Printf("   Taker: %s (%s) | Shares: %s\n", tx.Taker.Outcome, tx.Taker.Side, tx.Taker.Shares)
			fmt.Printf("   Matched Makers: %d orders\n", len(tx.Makers))
		case sErr := <-errCh:
			if sErr != nil {
				log.Printf("Stream warning/reconnect: %v\n", sErr)
			}
		}
	}
}

Complete API Service Reference (28 Methods)

1. Streams Service (client.Streams)
Method HTTP Description
Connect(streamID, opts...) GET /streams/{id} (SSE) Connect to ultra-low-latency real-time SSE mempool trade stream
List(ctx) GET /streams List all configured data streams
Create(ctx, req) POST /streams Provision a new targeted filter stream (tags, addresses, series)
Get(ctx, id) GET /streams/{id} Get stream metadata and configuration by ID
UpdateMetadata(ctx, id, req) PUT /streams/{id}/meta Update stream name and description
UpdateSubscription(ctx, id, req) PUT /streams/{id}/subscription Hot-reload market filters (addresses, tags, series) on active stream
Delete(ctx, id) DELETE /streams/{id} Delete stream by ID
GetActiveSessions(ctx) GET /sessions List all active live SSE connections across streams
GetSessionHistory(ctx, limit, offset) GET /sessions/history Query historical SSE connection logs and durations
2. Analytics Service (client.Analytics)
Method HTTP Description
GetLeaderboard(ctx, limit, offset) GET /v2/analytics/leaderboard Top profitable traders ranked by realized PnL, volume, and ROI
GetTrader(ctx, address) GET /v2/traders/{address} Comprehensive trader intelligence profile, taker tier, and top tags
GetTraderHourlyStats(ctx, address) GET /v2/traders/{address}/hourly_stats 24-hour hourly trading PnL and volume breakdown
GetTraderMarkets(ctx, addr, limit, offset) GET /v2/traders/{address}/markets Historical market positions and settled outcomes by trader
GetTraderMarketOrders(ctx, addr, id, ...) GET /v2/traders/{address}/markets/{id}/orders Order fill details for a specific trader in a specific market
GetMarket(ctx, id) GET /v2/markets/{id} Prediction market detail, top 20 earners, and volume attribution
GetDeposits(ctx, limit, offset) GET /v2/analytics/deposits 60-day aggregated trader deposit summaries (>= 100 pUSD)
3. Account Service (client.Account)
Method HTTP Description
GetProfile(ctx) GET /v2/user/me Current user profile, active tier, and deposit balance
ListKeys(ctx) GET /v2/user/keys List all active API keys and statuses
CreateKey(ctx, req) POST /v2/user/keys Generate a new API key with custom name
UpdateKey(ctx, key, req) PATCH /v2/user/keys/{key} Enable, disable, or rename an API key
DeleteKey(ctx, key) DELETE /v2/user/keys/{key} Revoke and delete an API key
GetLedger(ctx, limit, offset) GET /v2/user/ledger Balance ledger transaction records
GetTelemetry(ctx) GET /v2/user/telemetry Daily request count and per-endpoint usage telemetry
Withdraw(ctx, req) POST /v2/user/withdraw Request balance withdrawal
4. Subscription Service (client.Subscription)
Method HTTP Description
ListTiers(ctx) GET /v2/tiers Public tier catalog, feature allowances, and pricing specifications
GetQuote(ctx, req) POST /v2/user/subscribe/quote Calculate quote for plan upgrade or billing cycle change
Subscribe(ctx, req) POST /v2/user/subscribe Purchase or upgrade tier subscription
ValidatePromoCode(ctx, req) POST /v2/user/promo-codes/validate Validate promotional discount code

License

MIT © 2026 PolyEdge Labs

Documentation

Overview

Package polyedge provides the official Go client for PolyEdge's ultra-low latency Polymarket mempool trade streaming and real-time on-chain analytics API.

Engineered for Polymarket copy-trading bots, professional market makers, and prediction market builders. PolyEdge peers directly with 100+ Polygon validator P2P gossip nodes to deliver pending CLOB trade executions pre-block, coupled with institutional-grade on-chain trade analytics.

Key Features

  • Pre-Block Polymarket Trade Streaming: Peered with 100+ Polygon nodes to capture pending Polymarket trades pre-block with verified speed advantage.
  • Smart Money & Trader Analytics: Track smart money, profitable trader leaderboards, and institutional-grade on-chain analytics.
  • Full OpenAPI 3.1 Domain Coverage: 4 core service namespaces covering Streams, Analytics, Account, and Subscription.
  • Ultra-Low Latency SSE Engine: Automatic reconnection, 45-second heartbeat watchdog, and Last-Event-ID buffer resumption.

For more information, benchmarks, and documentation, visit https://polyedge.dev and https://polyedge.dev/docs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrFatalUnauthorized   = errors.New("polyedge: unauthorized (HTTP 401)")
	ErrFatalForbidden      = errors.New("polyedge: forbidden or quota exceeded (HTTP 403)")
	ErrFatalStreamNotFound = errors.New("polyedge: stream not found (HTTP 404)")
	ErrFatalBadRequest     = errors.New("polyedge: bad request (HTTP 400)")
	ErrWatchdogTimeout     = errors.New("polyedge: sse watchdog timed out with no data/heartbeat")
)

Functions

This section is empty.

Types

type AccountService 

type AccountService struct {
	// contains filtered or unexported fields
}

AccountService handles communication with Account related methods of the PolyEdge API.

func (*AccountService) CreateKey 

func (s *AccountService) CreateKey(ctx context.Context, req *CreateAPIKeyRequest) (*UserAPIKey, error)

CreateKey: Create API Key. Generates a new authenticated API key token with optional memo label.

func (*AccountService) DeleteKey 

func (s *AccountService) DeleteKey(ctx context.Context, key string) (*DeleteKeyResponse, error)

DeleteKey: Revoke API Key. Permanently revokes and deactivates an API key token.

func (*AccountService) GetLedger 

func (s *AccountService) GetLedger(ctx context.Context, limit int, offset int) (*UserLedgerResponse, error)

GetLedger: List User Balance Ledger. Lists chronological ledger entries (subscription billing charges, deposits, withdrawals).

func (*AccountService) GetProfile 

func (s *AccountService) GetProfile(ctx context.Context) (*UserProfile, error)

GetProfile: Get Current Profile. Retrieves the authenticated user profile, tier subscription status, and available USDC balance.

func (*AccountService) GetTelemetry 

func (s *AccountService) GetTelemetry(ctx context.Context) (*UserTelemetryResponse, error)

GetTelemetry: Get Account Telemetry & Limits. Provides live usage statistics, quota limits, and remaining streaming bandwidth.

func (*AccountService) ListKeys 

func (s *AccountService) ListKeys(ctx context.Context) (*UserKeysResponse, error)

ListKeys: List API Keys. Lists all active and revoked API keys issued to the authenticated account.

func (*AccountService) UpdateKey 

func (s *AccountService) UpdateKey(ctx context.Context, key string, req *UserUpdateKeyRequest) (*UserAPIKey, error)

UpdateKey: Update API Key. Modifies label memo or operational status of an existing API key.

func (*AccountService) Withdraw 

func (s *AccountService) Withdraw(ctx context.Context, req *UserWithdrawRequest) (*UserWithdrawResponse, error)

Withdraw: Request Balance Withdrawal. Submits a request to withdraw unspent USDC balance to a designated Polygon address.

type ActiveSessionInfo 

type ActiveSessionInfo struct {
	// ApiKey: Masked API credential used to authenticate the stream connection
	ApiKey string `json:"api_key,omitempty"`
	// ClientIp: Remote IP address of the connected client
	ClientIp string `json:"client_ip,omitempty"`
	// ConnectedAt: ISO 8601 timestamp when the SSE connection was established
	ConnectedAt string `json:"connected_at,omitempty"`
	// DurationSeconds: Total active connection uptime in seconds
	DurationSeconds int64 `json:"duration_seconds,omitempty"`
	// PushedTxCount: Total number of live matched order events delivered over this connection
	PushedTxCount int64 `json:"pushed_tx_count,omitempty"`
	// StreamId: Unique persistent stream identifier (UUID)
	StreamId string `json:"stream_id,omitempty"`
	// UserAgent: HTTP User-Agent identifier of the client library or application
	UserAgent string `json:"user_agent,omitempty"`
}

ActiveSessionInfo ActiveSessionInfo represents the ActiveSessionInfo data model.

type AnalyticsService 

type AnalyticsService struct {
	// contains filtered or unexported fields
}

AnalyticsService handles communication with Analytics related methods of the PolyEdge API.

func (*AnalyticsService) GetDeposits 

func (s *AnalyticsService) GetDeposits(ctx context.Context, limit int, offset int) (*DepositQueryResult, error)

GetDeposits: 60-Day Trader Deposit Analytics. Returns 60-day aggregated deposit summary and individual transaction breakdown for top traders.

func (*AnalyticsService) GetLeaderboard 

func (s *AnalyticsService) GetLeaderboard(ctx context.Context, limit int, offset int) (*LeaderboardResponse, error)

GetLeaderboard: Top Traders PnL Leaderboard. Queries ranked traders across timeframes with PnL, volume, win rate, and performance metrics.

func (*AnalyticsService) GetMarket 

func (s *AnalyticsService) GetMarket(ctx context.Context, id string) (*MarketDetailResponse, error)

GetMarket: Get Prediction Market Detail. Fetches standardized market metadata matching on-chain condition IDs and NegRisk parameters.

func (*AnalyticsService) GetTrader 

func (s *AnalyticsService) GetTrader(ctx context.Context, address string) (*TraderProfileResponse, error)

GetTrader: Get Trader Intelligence Profile. Fetches trader identity dossier, pUSD balance, total PnL, win rates, and ranking metrics.

func (*AnalyticsService) GetTraderHourlyStats 

func (s *AnalyticsService) GetTraderHourlyStats(ctx context.Context, address string) (*TraderHourlyStatsResponse, error)

GetTraderHourlyStats: Get Hourly PnL Equity Curve. Provides 1-hour bucketed historical equity curves and trade metrics for a specific trader.

func (*AnalyticsService) GetTraderMarketOrders 

func (s *AnalyticsService) GetTraderMarketOrders(ctx context.Context, address string, id string, limit int, offset int) (*UserOrdersResponse, error)

GetTraderMarketOrders: Get Trader Orders in Market. Retrieves granular fill events, side, price, and token outcomes for a trader in a given market.

func (*AnalyticsService) GetTraderMarkets 

func (s *AnalyticsService) GetTraderMarkets(ctx context.Context, address string, limit int, offset int) (*TraderHistoryResponse, error)

GetTraderMarkets: Get Trader Market Participation History. Queries resolved and active prediction markets traded by the specified wallet address.

type Client 

type Client struct {

	// Streams handles real-time SSE streams and filters
	Streams *StreamsService
	// Analytics handles trader dossiers, leaderboard, and markets
	Analytics *AnalyticsService
	// Account handles profile, API keys, ledger, and telemetry
	Account *AccountService
	// Subscription handles plan tiers, quotes, and subscriptions
	Subscription *SubscriptionService
	// contains filtered or unexported fields
}

Client manages communication with the PolyEdge API.

func NewClient 

func NewClient(apiKey string, opts ...ClientOptions) (*Client, error)

func (*Client) Stream 

func (c *Client) Stream(streamID string, opts ...StreamOptions) (*StreamClient, error)

Stream establishes real-time order stream directly.

type ClientOptions 

type ClientOptions struct {
	APIBaseURL    string
	StreamBaseURL string
	HTTPClient    *http.Client
}

type CreateAPIKeyRequest 

type CreateAPIKeyRequest struct {
	Key  string `json:"key,omitempty"`
	Name string `json:"name,omitempty"`
}

CreateAPIKeyRequest CreateAPIKeyRequest represents the CreateAPIKeyRequest data model.

type DeleteKeyResponse 

type DeleteKeyResponse struct {
	ID string `json:"id,omitempty"`
}

DeleteKeyResponse DeleteKeyResponse represents the DeleteKeyResponse data model.

type DeleteStreamResponse 

type DeleteStreamResponse struct {
	ID string `json:"id,omitempty"`
}

DeleteStreamResponse DeleteStreamResponse represents the DeleteStreamResponse data model.

type DepositItem 

type DepositItem struct {
	Address      string `json:"address,omitempty"`
	DepositCount int64  `json:"deposit_count,omitempty"`
	// FirstDepositAt: Earliest deposit time in 60-day window (RFC3339)
	FirstDepositAt string `json:"first_deposit_at,omitempty"`
	FirstTradeAt   string `json:"first_trade_at,omitempty"`
	// LastDepositAt: Most recent deposit time (RFC3339)
	LastDepositAt string `json:"last_deposit_at,omitempty"`
	LastTradeAt   string `json:"last_trade_at,omitempty"`
	// TotalDeposit: 6 decimals micro-USD integer as string (e.g. "100000000")
	TotalDeposit string `json:"total_deposit,omitempty"`
}

DepositItem DepositItem represents the DepositItem data model.

type DepositQueryResult 

type DepositQueryResult struct {
	Items     []DepositItem `json:"items,omitempty"`
	Total     int64         `json:"total,omitempty"`
	UpdatedAt string        `json:"updated_at,omitempty"`
}

DepositQueryResult DepositQueryResult represents the DepositQueryResult data model.

type ErrorResponse 

type ErrorResponse struct {
	Error   string `json:"error,omitempty"`
	Message string `json:"message,omitempty"`
}

ErrorResponse ErrorResponse represents the ErrorResponse data model.

type HistoryMarket 

type HistoryMarket struct {
	// Icon: Market thumbnail image URL
	Icon string `json:"icon,omitempty"`
	// ID: Unique numeric prediction market identifier
	ID int64 `json:"id,omitempty"`
	// Outcomes: Raw JSON array of outcome display names, e.g. ["Yes", "No"]
	Outcomes [2]string `json:"outcomes,omitempty"`
	// Question: Full title question describing the market condition
	Question string `json:"question,omitempty"`
	// ResolvedAt: Timestamp when market officially settled (RFC 3339 UTC), or null if active
	ResolvedAt string `json:"resolved_at,omitempty"`
	// Result: Resolution outcome (-2: unresolved, -1: void/invalid, 0-100: payout percentage for Outcome 0, e.g. 100 = Outcome 0 won, 0 = Outcome 1 won, 50 = 50/50 split)
	Result int64 `json:"result,omitempty"`
	// SeriesSlug: URL slug of the recurring sports league or tournament series
	SeriesSlug string `json:"series_slug,omitempty"`
	// Slug: URL-friendly slug identifying the market on Polymarket
	Slug string `json:"slug,omitempty"`
}

HistoryMarket HistoryMarket represents the HistoryMarket data model.

type HourlyStat 

type HourlyStat struct {
	// CostBasis: Aggregate capital cost basis in micro-USD (6 decimals)
	CostBasis int64 `json:"cost_basis,omitempty"`
	// Fee: Total trading fees incurred in micro-USD (6 decimals)
	Fee int64 `json:"fee,omitempty"`
	// Hour: 1-hour UTC bucket timestamp (ISO 8601)
	Hour string `json:"hour,omitempty"`
	// MakerVolume: Maker trading volume in micro-USD (6 decimals)
	MakerVolume int64 `json:"maker_volume,omitempty"`
	// MarketCount: Number of distinct prediction markets active or settled in this hour
	MarketCount int64 `json:"market_count,omitempty"`
	// PnL: Realized net PnL in micro-USD (6 decimals)
	PnL int64 `json:"pnl,omitempty"`
	// TakerVolume: Taker trading volume in micro-USD (6 decimals)
	TakerVolume int64 `json:"taker_volume,omitempty"`
	// WinCount: Number of profitable markets settled in this hour
	WinCount int64 `json:"win_count,omitempty"`
}

HourlyStat HourlyStat represents the HourlyStat data model.

type LeaderboardResponse 

type LeaderboardResponse struct {
	// TotalCount: Total count of matching traders for pagination
	TotalCount int64 `json:"total_count,omitempty"`
	// Traders: Ranked array of trader performance summaries
	Traders []TraderSummary `json:"traders,omitempty"`
}

LeaderboardResponse LeaderboardResponse represents the LeaderboardResponse data model.

type LiveOrder 

type LiveOrder struct {
	// Fee: Execution and relayer fee paid in micro-USDC
	Fee string `json:"fee,omitempty"`
	// Order: Underlying signed off-chain CLOB limit order metadata
	Order OrderInfo `json:"order,omitempty"`
	// Outcome: Market outcome label (e.g. "Yes", "No", "Up", "Down")
	Outcome string `json:"outcome,omitempty"`
	// Shares: Filled outcome shares amount represented as a 10^6 fixed-point decimal string
	Shares string `json:"shares,omitempty"`
	// Side: Order execution direction: "BUY" or "SELL"
	Side Side `json:"side,omitempty"`
	// TokenIdsIndex: 0-based index matching market.token_ids and market.outcomes
	TokenIdsIndex uint8 `json:"token_ids_index,omitempty"`
	// USDC: Filled USDC notional amount in micro-USDC (10^6 scale) decimal string
	USDC string `json:"usdc,omitempty"`
	// User: Trader account identity (wallet address and optional display pseudonym)
	User MonitorTrader `json:"user,omitempty"`
}

LiveOrder LiveOrder represents the LiveOrder data model.

type LiveTransaction 

type LiveTransaction struct {
	// Makers: List of matched maker limit orders filled in this transaction
	Makers []LiveOrder `json:"makers,omitempty"`
	// Market: Associated Polymarket prediction market condition and metadata
	Market Market `json:"market,omitempty"`
	// Taker: Taker order execution details that initiated the match against the CLOB
	Taker LiveOrder `json:"taker,omitempty"`
	// Timestamp: ISO 8601 UTC timestamp (millisecond precision) indicating when the pending transaction was detected in the mempool
	Timestamp string `json:"timestamp,omitempty"`
	// TxHash: Canonical Ethereum/Polygon on-chain transaction hash confirming the match execution
	TxHash string `json:"tx_hash,omitempty"`
}

LiveTransaction LiveTransaction represents the LiveTransaction data model.

type Market 

type Market struct {
	// ConditionId: 32-byte hexadecimal condition ID from Gnosis Conditional Tokens
	ConditionId string `json:"condition_id,omitempty"`
	// EventSlug: URL slug of the parent event containing this market
	EventSlug string `json:"event_slug,omitempty"`
	// GroupItemTitle: Sub-category item title within a grouped multi-market event
	GroupItemTitle string `json:"group_item_title,omitempty"`
	// ID: Polymarket numeric prediction market identifier (e.g. 3688221)
	ID int64 `json:"id,omitempty"`
	// NegRisk: True if market operates under multi-outcome negative risk adapter
	NegRisk bool `json:"neg_risk,omitempty"`
	// Outcomes: Array of market outcome labels: [Outcome 1, Outcome 2] (e.g. ["Yes", "No"])
	Outcomes [2]string `json:"outcomes,omitempty"`
	// Question: Full question describing the prediction market condition
	Question string `json:"question,omitempty"`
	// SeriesSlug: URL slug of the recurring sports league or tournament series
	SeriesSlug string `json:"series_slug,omitempty"`
	// Slug: URL-friendly slug identifying the market on Polymarket
	Slug string `json:"slug,omitempty"`
	// SportsMarketType: Sports market classification (e.g. moneyline, spread, over/under)
	SportsMarketType string `json:"sports_market_type,omitempty"`
	// StartDate: ISO 8601 UTC timestamp when trading began
	StartDate string `json:"start_date,omitempty"`
	// TagsSlug: Canonical categorical tags for content filtering
	TagsSlug []string `json:"tags_slug,omitempty"`
	// TokenIds: ERC-1155 token IDs: [Token 1, Token 2]
	TokenIds [2]string `json:"token_ids,omitempty"`
}

Market Market represents the Market data model.

type MarketDetailResponse 

type MarketDetailResponse struct {
	// Market: Complete standardized market metadata matching exporter format
	Market MarketMetadata `json:"market,omitempty"`
	// TopEarners: Ranked list of top 20 profitable traders in this market
	TopEarners []MarketEarner `json:"top_earners,omitempty"`
	// TotalFees: Total protocol and liquidity fees collected in micro-USD (6 decimals)
	TotalFees int64 `json:"total_fees,omitempty"`
	// TotalPnlDistributed: Total positive realized PnL distributed to winners in micro-USD (6 decimals)
	TotalPnlDistributed int64 `json:"total_pnl_distributed,omitempty"`
	// TotalTraders: Total count of distinct wallet addresses that traded this market
	TotalTraders int64 `json:"total_traders,omitempty"`
	// TotalVolume: Cumulative trading volume across all participants in micro-USD (6 decimals)
	TotalVolume int64 `json:"total_volume,omitempty"`
	// TotalWinners: Total number of distinct traders with positive realized PnL
	TotalWinners int64 `json:"total_winners,omitempty"`
}

MarketDetailResponse MarketDetailResponse represents the MarketDetailResponse data model.

type MarketEarner 

type MarketEarner struct {
	// Orders: Executed fill orders for this earner (included when include_orders=true)
	Orders []UserOrder `json:"orders,omitempty"`
	// PnL: Realized net profit and loss in micro-USD (6 decimals, e.g. 1000000 = 1 USD)
	PnL int64 `json:"pnl,omitempty"`
	// Profile: Public identity dossier of the earner
	Profile TraderIdentity `json:"profile,omitempty"`
	// Rank: Rank position among top earners in this market (1-based)
	Rank int64 `json:"rank,omitempty"`
	// Roi: Return on investment percentage (e.g. 25.5 for 25.5%)
	Roi float64 `json:"roi,omitempty"`
	// Volume: Total traded volume in micro-USD (6 decimals)
	Volume int64 `json:"volume,omitempty"`
}

MarketEarner MarketEarner represents the MarketEarner data model.

type MarketMetadata 

type MarketMetadata struct {
	// ConditionId: 0x-prefixed 66-character CTF condition identifier
	ConditionId string `json:"condition_id,omitempty"`
	// CreatedAt: Timestamp when market was indexed in database (RFC 3339 UTC)
	CreatedAt string `json:"created_at,omitempty"`
	// Description: Extended details and market resolution criteria
	Description string `json:"description,omitempty"`
	// EndDate: Estimated resolution date or scheduled closing time (RFC 3339 UTC)
	EndDate string `json:"end_date,omitempty"`
	// EventSlug: URL slug of the parent event containing this market
	EventSlug string `json:"event_slug,omitempty"`
	// FeeSchedule: Detailed fee schedule JSON specification
	FeeSchedule map[string]any `json:"fee_schedule,omitempty"`
	// FeeType: Fee model classification (e.g. "dynamic", "fixed")
	FeeType string `json:"fee_type,omitempty"`
	// FeesEnabled: Whether trading fees are activated on this market
	FeesEnabled bool `json:"fees_enabled,omitempty"`
	// GroupItemThreshold: Threshold for numerical interval outcomes if applicable
	GroupItemThreshold int64 `json:"group_item_threshold,omitempty"`
	// GroupItemTitle: Sub-category item title within a grouped multi-market event
	GroupItemTitle string `json:"group_item_title,omitempty"`
	// Icon: Market thumbnail image URL
	Icon string `json:"icon,omitempty"`
	// ID: Unique numeric prediction market identifier
	ID int64 `json:"id,omitempty"`
	// NegRisk: True if market operates under multi-outcome negative risk adapter
	NegRisk bool `json:"neg_risk,omitempty"`
	// Outcomes: Raw JSON array of outcome display names, e.g. ["Yes", "No"]
	Outcomes [2]string `json:"outcomes,omitempty"`
	// Question: Full title question describing the market condition
	Question string `json:"question,omitempty"`
	// ResolutionSource: Source URL or oracle specification for resolution
	ResolutionSource string `json:"resolution_source,omitempty"`
	// ResolvedAt: Timestamp when the market officially settled (RFC 3339 UTC), or null if active
	ResolvedAt string `json:"resolved_at,omitempty"`
	// Result: Resolution outcome (-2: unresolved, -1: void/invalid, 0-100: payout percentage for Outcome 0, e.g. 100 = Outcome 0 won, 0 = Outcome 1 won, 50 = 50/50 split)
	Result int64 `json:"result,omitempty"`
	// SeriesSlug: URL slug of the recurring sports league or tournament series
	SeriesSlug string `json:"series_slug,omitempty"`
	// Slug: URL-friendly slug identifying the market on Polymarket
	Slug string `json:"slug,omitempty"`
	// SportsMarketType: Sports market classification type if applicable
	SportsMarketType string `json:"sports_market_type,omitempty"`
	// StartDate: Timestamp when trading began (RFC 3339 UTC)
	StartDate string `json:"start_date,omitempty"`
	// TagsSlug: Raw JSON array of topic tag URL slugs
	TagsSlug []string `json:"tags_slug,omitempty"`
	// TokenIds: Array of 2 ERC-1155 token IDs corresponding to outcomes
	TokenIds [2]string `json:"token_ids,omitempty"`
}

MarketMetadata MarketMetadata represents the MarketMetadata data model.

type MarketSettlementDetail 

type MarketSettlementDetail struct {
	// LastTradeAt: ISO 8601 UTC timestamp of the trader's last trade in this market
	LastTradeAt string `json:"last_trade_at,omitempty"`
	// Market: Concise standardized market metadata
	Market HistoryMarket `json:"market,omitempty"`
	// Orders: Detailed order fill events (present only when include_orders=true)
	Orders []UserOrder `json:"orders,omitempty"`
	// PnL: Realized net PnL in micro-USD (6 decimals)
	PnL int64 `json:"pnl,omitempty"`
	// Roi: Return on investment percentage in this market
	Roi float64 `json:"roi,omitempty"`
	// Volume: Total traded volume in this market in micro-USD (6 decimals)
	Volume int64 `json:"volume,omitempty"`
}

MarketSettlementDetail MarketSettlementDetail represents the MarketSettlementDetail data model.

type MonitorTrader 

type MonitorTrader struct {
	// Address: Canonical 42-character hexadecimal Ethereum/Polygon wallet address
	Address string `json:"address,omitempty"`
	// Name: Polymarket public username
	Name string `json:"name,omitempty"`
}

MonitorTrader MonitorTrader represents the MonitorTrader data model.

type OrderInfo 

type OrderInfo struct {
	// OrderHash: Cryptographic EIP-712 order hash identifying the unique off-chain order
	OrderHash string `json:"order_hash,omitempty"`
	// Shares: Original clob order shares capacity in 10^6 scale
	Shares string `json:"shares,omitempty"`
	// SignatureType: Signature scheme encoding (0: Direct EOA, 1: Magic / Proxy Wallet, 2: Gnosis Safe, 3: Deposit Wallet (ERC-1271))
	SignatureType int64 `json:"signature_type,omitempty"`
	// Timestamp: Unix epoch seconds when the order was signed
	Timestamp string `json:"timestamp,omitempty"`
	// USDC: Original clob order notional value in micro-USDC (10^6 scale)
	USDC string `json:"usdc,omitempty"`
}

OrderInfo OrderInfo represents the OrderInfo data model.

type QuoteSubscriptionRequest 

type QuoteSubscriptionRequest struct {
	BillingCycle string `json:"billing_cycle,omitempty"`
	PromoCode    string `json:"promo_code,omitempty"`
	Tier         string `json:"tier,omitempty"`
}

QuoteSubscriptionRequest QuoteSubscriptionRequest represents the QuoteSubscriptionRequest data model.

type QuoteSubscriptionResponse 

type QuoteSubscriptionResponse struct {
	AmountToPay         int64  `json:"amount_to_pay,omitempty"`
	BillingCycle        string `json:"billing_cycle,omitempty"`
	CanAfford           bool   `json:"can_afford,omitempty"`
	CurrentBalance      int64  `json:"current_balance,omitempty"`
	CurrentBillingCycle string `json:"current_billing_cycle,omitempty"`
	CurrentLicense      string `json:"current_license,omitempty"`
	CurrentTier         string `json:"current_tier,omitempty"`
	DiscountAmount      int64  `json:"discount_amount,omitempty"`
	DurationDays        int64  `json:"duration_days,omitempty"`
	IsActive            bool   `json:"is_active,omitempty"`
	License             string `json:"license,omitempty"`
	Message             string `json:"message,omitempty"`
	OriginalPrice       int64  `json:"original_price,omitempty"`
	ProratedCredit      int64  `json:"prorated_credit,omitempty"`
	Tier                string `json:"tier,omitempty"`
}

QuoteSubscriptionResponse QuoteSubscriptionResponse represents the QuoteSubscriptionResponse data model.

type Side 

type Side string

Side represents the trade execution order side (BUY or SELL). 

const (
	SideBuy  Side = "BUY"
	SideSell Side = "SELL"
)

type StreamClient 

type StreamClient struct {
	// contains filtered or unexported fields
}

func NewStreamClient 

func NewStreamClient(streamID, apiKey string, opts ...StreamOptions) (*StreamClient, error)

func (*StreamClient) LastEventID 

func (s *StreamClient) LastEventID() uint64

func (*StreamClient) SetOnHeartbeat 

func (s *StreamClient) SetOnHeartbeat(fn func())

func (*StreamClient) Subscribe 

func (s *StreamClient) Subscribe(ctx context.Context) (<-chan *LiveTransaction, <-chan error)

type StreamOptions 

type StreamOptions struct {
	StreamBaseURL    string
	HeartbeatTimeout time.Duration
	InitialBackoff   time.Duration
	MaxBackoff       time.Duration
	HTTPClient       *http.Client
}

type StreamsService 

type StreamsService struct {
	// contains filtered or unexported fields
}

StreamsService handles communication with Streams related methods of the PolyEdge API.

func (*StreamsService) Connect 

func (s *StreamsService) Connect(streamID string, opts ...StreamOptions) (*StreamClient, error)

Connect initializes a real-time SSE order stream client.

func (*StreamsService) Create 

func (s *StreamsService) Create(ctx context.Context, req *UserCreateStreamRequest) (*UserStreamResponse, error)

Create: Create Filtered Order Stream. Provisions a new custom real-time stream with optional address, tag, or series filters.

func (*StreamsService) Delete 

func (s *StreamsService) Delete(ctx context.Context, id string) (*DeleteStreamResponse, error)

Delete: Delete Stream. Permanently removes a stream and gracefully disconnects all connected listener sessions.

func (*StreamsService) Get 

func (s *StreamsService) Get(ctx context.Context, id string) (*UserStreamResponse, error)

Get: Get Stream Metadata. Fetches metadata, active sessions count, and filter configuration for a specific stream.

func (*StreamsService) GetActiveSessions 

func (s *StreamsService) GetActiveSessions(ctx context.Context) (*UserActiveSessionsResponse, error)

GetActiveSessions: List All User Active Sessions. Returns all currently connected active SSE listeners for this account.

func (*StreamsService) GetSessionHistory 

func (s *StreamsService) GetSessionHistory(ctx context.Context, limit int, offset int) (*UserSessionHistoryResponse, error)

GetSessionHistory: List User Stream Session History. Returns historical SSE connection logs including duration and pushed transactions count.

func (*StreamsService) List 

func (s *StreamsService) List(ctx context.Context) (*UserStreamsResponse, error)

List: List User Streams. Returns custom and managed real-time trade streams configured by the user.

func (*StreamsService) UpdateMetadata 

func (s *StreamsService) UpdateMetadata(ctx context.Context, id string, req *UserUpdateStreamMetadataRequest) (*UserStreamResponse, error)

UpdateMetadata: Update Stream Metadata. Updates operational attributes of the stream, such as nickname or enabled/disabled status.

func (*StreamsService) UpdateSubscription 

func (s *StreamsService) UpdateSubscription(ctx context.Context, id string, req *UpdateSubscriptionRequest) (*UserStreamResponse, error)

UpdateSubscription: Update Stream Filter Subscription. Dynamically mutates monitored wallet addresses, market tags, or series slugs without disconnecting SSE clients.

type SubscribeRequest 

type SubscribeRequest struct {
	BillingCycle   string `json:"billing_cycle,omitempty"`
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	PromoCode      string `json:"promo_code,omitempty"`
	Tier           string `json:"tier,omitempty"`
}

SubscribeRequest SubscribeRequest represents the SubscribeRequest data model.

type SubscribeResponse 

type SubscribeResponse struct {
	Subscription UserSubscription `json:"subscription,omitempty"`
	User         UserProfile      `json:"user,omitempty"`
}

SubscribeResponse SubscribeResponse represents the SubscribeResponse data model.

type SubscriptionService 

type SubscriptionService struct {
	// contains filtered or unexported fields
}

SubscriptionService handles communication with Subscription related methods of the PolyEdge API.

func (*SubscriptionService) GetQuote 

func (s *SubscriptionService) GetQuote(ctx context.Context, req *QuoteSubscriptionRequest) (*QuoteSubscriptionResponse, error)

GetQuote: Get Subscription Quote. Calculates prorated billing amounts for subscribing to or upgrading a tier plan.

func (*SubscriptionService) ListTiers 

func (s *SubscriptionService) ListTiers(ctx context.Context) ([]Tier, error)

ListTiers: List Public Tiers Catalog. Returns plan tiers (Free, Starter, Pro, Growth, Whale) with limits and pricing details.

func (*SubscriptionService) Subscribe 

func (s *SubscriptionService) Subscribe(ctx context.Context, req *SubscribeRequest) (*SubscribeResponse, error)

Subscribe: Purchase / Upgrade Tier Subscription. Executes purchase, renewal, or upgrade of an active subscription tier plan.

func (*SubscriptionService) ValidatePromoCode 

func (s *SubscriptionService) ValidatePromoCode(ctx context.Context, req *ValidatePromoCodeRequest) (*ValidatePromoCodeResponse, error)

ValidatePromoCode: Validate Promo Code. Verifies validity, discount percentage, and applicable plans for a promotion coupon code.

type TagStat 

type TagStat struct {
	// MakerVolume: Passive maker volume in micro-USD (6 decimals)
	MakerVolume int64 `json:"maker_volume,omitempty"`
	// MarketsCount: Number of markets traded in this tag
	MarketsCount int64 `json:"markets_count,omitempty"`
	// PnL: Realized net PnL in micro-USD (6 decimals)
	PnL int64 `json:"pnl,omitempty"`
	// Roi: Return on investment percentage for this tag
	Roi float64 `json:"roi,omitempty"`
	// Slug: Category tag URL slug (e.g. "crypto", "politics", "sports")
	Slug string `json:"slug,omitempty"`
	// TakerVolume: Aggressive taker volume in micro-USD (6 decimals)
	TakerVolume int64 `json:"taker_volume,omitempty"`
	// Volume: Aggregated trading volume in micro-USD (6 decimals)
	Volume int64 `json:"volume,omitempty"`
	// WinRate: Win rate percentage for this tag (0.0 to 100.0)
	WinRate float64 `json:"win_rate,omitempty"`
	// WinsCount: Number of profitable markets in this tag
	WinsCount int64 `json:"wins_count,omitempty"`
}

TagStat TagStat represents the TagStat data model.

type Tier 

type Tier struct {
	// AllowRestApi: Whether the tier is permitted to access REST API endpoints
	AllowRestApi bool `json:"allow_rest_api,omitempty"`
	// AllowStream: Whether the tier is permitted to access real-time stream endpoints
	AllowStream bool `json:"allow_stream,omitempty"`
	// AllowTrial: Whether this tier supports a trial subscription
	AllowTrial bool `json:"allow_trial,omitempty"`
	// CreatedAt: Record creation timestamp
	CreatedAt string `json:"created_at,omitempty"`
	// ID: Unique tier identifier (e.g. "free", "starter", "individual", "builder")
	ID string `json:"id,omitempty"`
	// Level: Relative tier rank for upgrade comparison (0=free, 1=starter, etc.)
	Level int64 `json:"level,omitempty"`
	// License: License type: "personal" or "builder"
	License string `json:"license,omitempty"`
	// MaxDailyRequests: Maximum API queries allowed per 24-hour UTC window (0 = unlimited)
	MaxDailyRequests int64 `json:"max_daily_requests,omitempty"`
	// MaxDailyStreamSeconds: Maximum aggregated streaming seconds allowed per 24-hour UTC window
	MaxDailyStreamSeconds int64 `json:"max_daily_stream_seconds,omitempty"`
	// MaxFilterAddrs: Maximum wallet addresses that can be filtered per stream
	MaxFilterAddrs int64 `json:"max_filter_addrs,omitempty"`
	// MaxFilterSeries: Maximum market series allowed across active streams (0 = disabled)
	MaxFilterSeries int64 `json:"max_filter_series,omitempty"`
	// MaxFilterTags: Maximum market tags allowed across active streams (0 = disabled)
	MaxFilterTags int64 `json:"max_filter_tags,omitempty"`
	// MaxKeys: Maximum concurrent API keys allowed per account
	MaxKeys int64 `json:"max_keys,omitempty"`
	// MaxNakedStreams: Maximum unfiltered streams allowed
	MaxNakedStreams int64 `json:"max_naked_streams,omitempty"`
	// MaxQps: Maximum API queries allowed per second
	MaxQps int64 `json:"max_qps,omitempty"`
	// MaxSessions: Maximum concurrent active SSE connections per account
	MaxSessions int64 `json:"max_sessions,omitempty"`
	// MaxStreams: Maximum persistent stream IDs the user can create
	MaxStreams int64 `json:"max_streams,omitempty"`
	// MonthlyCredits: Monthly credit quota allocated to this tier
	MonthlyCredits int64 `json:"monthly_credits,omitempty"`
	// Name: Display title of the tier
	Name string `json:"name,omitempty"`
	// PriceMonthly: 6 decimals, micro-USD (e.g. 99_000_000 = 99 USD)
	PriceMonthly int64 `json:"price_monthly,omitempty"`
	// PriceQuarterly: 6 decimals, micro-USD (e.g. 237_000_000 = 237 USD)
	PriceQuarterly int64 `json:"price_quarterly,omitempty"`
	// PriceTrial: 6 decimals, micro-USD for trial (e.g. 10_000_000 = 10 USD)
	PriceTrial int64 `json:"price_trial,omitempty"`
	// PriceYearly: 6 decimals, micro-USD (e.g. 499_000_000 = 499 USD)
	PriceYearly int64 `json:"price_yearly,omitempty"`
	// TrialDurationDays: Duration in days for trial subscription (e.g. 5)
	TrialDurationDays int64 `json:"trial_duration_days,omitempty"`
	// UpdatedAt: Last modification timestamp
	UpdatedAt string `json:"updated_at,omitempty"`
}

Tier Tier represents the Tier data model.

type TraderHistoryResponse 

type TraderHistoryResponse struct {
	// History: Paginated list of market settlement details
	History []MarketSettlementDetail `json:"history,omitempty"`
	// TotalCount: Total count of matching market positions for pagination
	TotalCount int64 `json:"total_count,omitempty"`
}

TraderHistoryResponse TraderHistoryResponse represents the TraderHistoryResponse data model.

type TraderHourlyStatsResponse 

type TraderHourlyStatsResponse struct {
	// Stats: Chronological array of 1-hour performance metrics
	Stats []HourlyStat `json:"stats,omitempty"`
}

TraderHourlyStatsResponse TraderHourlyStatsResponse represents the TraderHourlyStatsResponse data model.

type TraderIdentity 

type TraderIdentity struct {
	// Address: Checksummed 0x-prefixed EVM wallet address
	Address string `json:"address,omitempty"`
	// Name: Custom display name or Polymarket profile username
	Name string `json:"name,omitempty"`
	// ProfileCreatedAt: ISO 8601 UTC timestamp of Polymarket profile creation
	ProfileCreatedAt string `json:"profile_created_at,omitempty"`
	// ProfileImage: Public avatar image URL
	ProfileImage string `json:"profile_image,omitempty"`
	// XUsername: Linked X (formerly Twitter) social handle
	XUsername string `json:"x_username,omitempty"`
}

TraderIdentity TraderIdentity represents the TraderIdentity data model.

type TraderProfileResponse 

type TraderProfileResponse struct {
	// LastTradeAt: ISO 8601 UTC timestamp of trader's most recent trade across the platform
	LastTradeAt string `json:"last_trade_at,omitempty"`
	// Profile: Public identity dossier of the trader
	Profile TraderIdentity `json:"profile,omitempty"`
	// PusdBalance: Trader's pUSD balance in micro-pUSD (6 decimals, e.g. 1000000 = 1 pUSD)
	PusdBalance int64 `json:"pusd_balance,omitempty"`
	// TakerTier: Polymarket Taker Rebate Program tier level (0-6: 0=Tier 0, 1=Bronze, 2=Silver, 3=Gold, 4=Platinum, 5=Diamond, 6=Obsidian)
	TakerTier int64 `json:"taker_tier,omitempty"`
	// TakerTierName: Descriptive taker rebate tier name ("Tier 0", "Bronze", "Silver", "Gold", "Platinum", "Diamond", "Obsidian", or empty string if unsynced)
	TakerTierName string `json:"taker_tier_name,omitempty"`
	// TopTags: Performance breakdown across top 5 categories in last 30 days
	TopTags []TagStat `json:"top_tags,omitempty"`
	// WeightedVolume: Rolling 30-day taker Weighted Volume (wV) in USD, calculated by Trade Size * (1 - Entry Price) * Category Weight * Bonuses
	WeightedVolume float64 `json:"weighted_volume,omitempty"`
}

TraderProfileResponse TraderProfileResponse represents the TraderProfileResponse data model.

type TraderSummary 

type TraderSummary struct {
	// LastTradeAt: ISO 8601 UTC timestamp of trader's most recent trade across the platform
	LastTradeAt string `json:"last_trade_at,omitempty"`
	// MarketsCount: Number of distinct prediction markets traded in timeframe
	MarketsCount int64 `json:"markets_count,omitempty"`
	// Profile: Public identity dossier of the trader
	Profile TraderIdentity `json:"profile,omitempty"`
	// Rank: Leaderboard ranking position (1-based)
	Rank int64 `json:"rank,omitempty"`
	// Roi: Return on investment percentage over timeframe (e.g. 25.5 for 25.5%)
	Roi float64 `json:"roi,omitempty"`
	// TotalPnl: Realized net profit and loss in micro-USD (6 decimals, e.g. 1000000 = 1 USD)
	TotalPnl int64 `json:"total_pnl,omitempty"`
	// TotalVolume: Aggregated trading volume in micro-USD (6 decimals)
	TotalVolume int64 `json:"total_volume,omitempty"`
	// WinRate: Percentage of profitable closed positions (0.0 to 100.0)
	WinRate float64 `json:"win_rate,omitempty"`
	// WinsCount: Number of profitable settled markets in timeframe
	WinsCount int64 `json:"wins_count,omitempty"`
}

TraderSummary TraderSummary represents the TraderSummary data model.

type UpdateSubscriptionRequest 

type UpdateSubscriptionRequest struct {
	Addresses []string `json:"addresses,omitempty"`
	Series    []string `json:"series,omitempty"`
	Tags      []string `json:"tags,omitempty"`
}

UpdateSubscriptionRequest UpdateSubscriptionRequest represents the UpdateSubscriptionRequest data model.

type UserAPIKey 

type UserAPIKey struct {
	CreatedAt string `json:"created_at,omitempty"`
	Key       string `json:"key,omitempty"`
	Name      string `json:"name,omitempty"`
	Status    int64  `json:"status,omitempty"`
}

UserAPIKey UserAPIKey represents the UserAPIKey data model.

type UserActiveSessionsResponse 

type UserActiveSessionsResponse struct {
	// Data: Array of active connected client session metadata
	Data []ActiveSessionInfo `json:"data,omitempty"`
	// TotalCount: Total concurrent active sessions currently running across all user streams
	TotalCount int64 `json:"total_count,omitempty"`
}

UserActiveSessionsResponse UserActiveSessionsResponse represents the UserActiveSessionsResponse data model.

type UserCreateStreamRequest 

type UserCreateStreamRequest struct {
	Addresses []string `json:"addresses,omitempty"`
	Name      string   `json:"name,omitempty"`
	Series    []string `json:"series,omitempty"`
	Tags      []string `json:"tags,omitempty"`
}

UserCreateStreamRequest UserCreateStreamRequest represents the UserCreateStreamRequest data model.

type UserKeysResponse 

type UserKeysResponse struct {
	Data       []UserAPIKey `json:"data,omitempty"`
	TotalCount int64        `json:"total_count,omitempty"`
}

UserKeysResponse UserKeysResponse represents the UserKeysResponse data model.

type UserLedgerEntry 

type UserLedgerEntry struct {
	Amount       int64  `json:"amount,omitempty"`
	BalanceAfter int64  `json:"balance_after,omitempty"`
	CreatedAt    string `json:"created_at,omitempty"`
	ReferenceId  string `json:"reference_id,omitempty"`
	Type         string `json:"type,omitempty"`
}

UserLedgerEntry UserLedgerEntry represents the UserLedgerEntry data model.

type UserLedgerResponse 

type UserLedgerResponse struct {
	Data       []UserLedgerEntry `json:"data,omitempty"`
	TotalCount int64             `json:"total_count,omitempty"`
}

UserLedgerResponse UserLedgerResponse represents the UserLedgerResponse data model.

type UserOrder 

type UserOrder struct {
	// Fee: Protocol trading fee deducted in micro-USD (6 decimals)
	Fee int64 `json:"fee,omitempty"`
	// IsTaker: True if executed against resting book liquidity as a taker
	IsTaker bool `json:"is_taker,omitempty"`
	// Outcome: Prediction outcome label (e.g. "Yes", "No")
	Outcome string `json:"outcome,omitempty"`
	// Shares: Filled outcome token shares (6 decimals)
	Shares int64 `json:"shares,omitempty"`
	// Side: Order execution side: "BUY" or "SELL"
	Side Side `json:"side,omitempty"`
	// Time: ISO 8601 UTC timestamp of order fill execution
	Time string `json:"time,omitempty"`
	// USDC: Total collateral USDC transferred (6 decimals micro-USD)
	USDC int64 `json:"usdc,omitempty"`
}

UserOrder UserOrder represents the UserOrder data model.

type UserOrdersResponse 

type UserOrdersResponse struct {
	// Orders: Chronological list of compacted order fill events
	Orders []UserOrder `json:"orders,omitempty"`
}

UserOrdersResponse UserOrdersResponse represents the UserOrdersResponse data model.

type UserProfile 

type UserProfile struct {
	BillingCycle   string `json:"billing_cycle,omitempty"`
	CreatedAt      string `json:"created_at,omitempty"`
	DepositAddress string `json:"deposit_address,omitempty"`
	DepositBalance int64  `json:"deposit_balance,omitempty"`
	Email          string `json:"email,omitempty"`
	IsExpired      bool   `json:"is_expired,omitempty"`
	Status         int64  `json:"status,omitempty"`
	TelegramId     int64  `json:"telegram_id,omitempty"`
	Tier           string `json:"tier,omitempty"`
	TierExpiresAt  string `json:"tier_expires_at,omitempty"`
	UpdatedAt      string `json:"updated_at,omitempty"`
}

UserProfile UserProfile represents the UserProfile data model.

type UserSessionHistoryResponse 

type UserSessionHistoryResponse struct {
	// Data: Array of historical stream session records
	Data []UserSessionRecord `json:"data,omitempty"`
	// TotalCount: Total count of historical session records
	TotalCount int64 `json:"total_count,omitempty"`
}

UserSessionHistoryResponse UserSessionHistoryResponse represents the UserSessionHistoryResponse data model.

type UserSessionRecord 

type UserSessionRecord struct {
	// ApiKey: Masked API credential used to authenticate the stream connection
	ApiKey string `json:"api_key,omitempty"`
	// ClientIp: Remote IP address of the connected client
	ClientIp string `json:"client_ip,omitempty"`
	// CloseReason: Diagnostic termination reason (e.g. client_closed, admin_force_disconnect, quota_exceeded)
	CloseReason string `json:"close_reason,omitempty"`
	// ConnectedAt: ISO 8601 timestamp when the SSE connection was established
	ConnectedAt string `json:"connected_at,omitempty"`
	// DisconnectedAt: ISO 8601 timestamp when the connection was closed, or null if currently active
	DisconnectedAt string `json:"disconnected_at,omitempty"`
	// DurationSeconds: Total connection duration in seconds
	DurationSeconds int64 `json:"duration_seconds,omitempty"`
	// PushedTxCount: Total number of live matched order events delivered over this connection
	PushedTxCount int64 `json:"pushed_tx_count,omitempty"`
	// StreamId: Target stream unique identifier (UUID)
	StreamId string `json:"stream_id,omitempty"`
	// UserAgent: HTTP User-Agent identifier of the client library or application
	UserAgent string `json:"user_agent,omitempty"`
}

UserSessionRecord UserSessionRecord represents the UserSessionRecord data model.

type UserStreamResponse 

type UserStreamResponse struct {
	ActiveSessions int64    `json:"active_sessions,omitempty"`
	Addresses      []string `json:"addresses,omitempty"`
	CreatedAt      string   `json:"created_at,omitempty"`
	Enabled        bool     `json:"enabled,omitempty"`
	ID             string   `json:"id,omitempty"`
	Name           string   `json:"name,omitempty"`
	Series         []string `json:"series,omitempty"`
	Tags           []string `json:"tags,omitempty"`
	UpdatedAt      string   `json:"updated_at,omitempty"`
}

UserStreamResponse UserStreamResponse represents the UserStreamResponse data model.

type UserStreamsResponse 

type UserStreamsResponse struct {
	Data       []UserStreamResponse `json:"data,omitempty"`
	TotalCount int64                `json:"total_count,omitempty"`
}

UserStreamsResponse UserStreamsResponse represents the UserStreamsResponse data model.

type UserSubscription 

type UserSubscription struct {
	AmountPaid     int64  `json:"amount_paid,omitempty"`
	BillingCycle   string `json:"billing_cycle,omitempty"`
	CreatedAt      string `json:"created_at,omitempty"`
	DiscountAmount int64  `json:"discount_amount,omitempty"`
	DurationDays   int64  `json:"duration_days,omitempty"`
	ExpiresAt      string `json:"expires_at,omitempty"`
	OriginalPrice  int64  `json:"original_price,omitempty"`
	PlanTier       string `json:"plan_tier,omitempty"`
	PromoCode      string `json:"promo_code,omitempty"`
	ProratedCredit int64  `json:"prorated_credit,omitempty"`
	StartsAt       string `json:"starts_at,omitempty"`
	Status         string `json:"status,omitempty"`
}

UserSubscription UserSubscription represents the UserSubscription data model.

type UserTelemetryResponse 

type UserTelemetryResponse struct {
	Date          string         `json:"date,omitempty"`
	Endpoints     map[string]any `json:"endpoints,omitempty"`
	TotalRequests int64          `json:"total_requests,omitempty"`
}

UserTelemetryResponse UserTelemetryResponse represents the UserTelemetryResponse data model.

type UserUpdateKeyRequest 

type UserUpdateKeyRequest struct {
	Name string `json:"name,omitempty"`
	// Status: 1: Active, 0: Disabled
	Status int64 `json:"status,omitempty"`
}

UserUpdateKeyRequest UserUpdateKeyRequest represents the UserUpdateKeyRequest data model.

type UserUpdateStreamMetadataRequest 

type UserUpdateStreamMetadataRequest struct {
	Enabled bool   `json:"enabled,omitempty"`
	Name    string `json:"name,omitempty"`
}

UserUpdateStreamMetadataRequest UserUpdateStreamMetadataRequest represents the UserUpdateStreamMetadataRequest data model.

type UserWithdrawRequest 

type UserWithdrawRequest struct {
	Network   string `json:"network,omitempty"`
	ToAddress string `json:"to_address,omitempty"`
	Token     string `json:"token,omitempty"`
}

UserWithdrawRequest UserWithdrawRequest represents the UserWithdrawRequest data model.

type UserWithdrawResponse 

type UserWithdrawResponse struct {
	User       UserProfile `json:"user,omitempty"`
	Withdrawal Withdrawal  `json:"withdrawal,omitempty"`
}

UserWithdrawResponse UserWithdrawResponse represents the UserWithdrawResponse data model.

type ValidatePromoCodeRequest 

type ValidatePromoCodeRequest struct {
	BillingCycle string `json:"billing_cycle,omitempty"`
	Code         string `json:"code,omitempty"`
	Tier         string `json:"tier,omitempty"`
}

ValidatePromoCodeRequest ValidatePromoCodeRequest represents the ValidatePromoCodeRequest data model.

type ValidatePromoCodeResponse 

type ValidatePromoCodeResponse struct {
	AmountToPay    int64  `json:"amount_to_pay,omitempty"`
	Code           string `json:"code,omitempty"`
	DiscountAmount int64  `json:"discount_amount,omitempty"`
	Message        string `json:"message,omitempty"`
	OriginalPrice  int64  `json:"original_price,omitempty"`
	ProratedCredit int64  `json:"prorated_credit,omitempty"`
	Valid          bool   `json:"valid,omitempty"`
}

ValidatePromoCodeResponse ValidatePromoCodeResponse represents the ValidatePromoCodeResponse data model.

type Withdrawal 

type Withdrawal struct {
	// Amount: Full balance amount withdrawn in micro-USD
	Amount int64 `json:"amount,omitempty"`
	// CreatedAt: Withdrawal request creation timestamp
	CreatedAt string `json:"created_at,omitempty"`
	ID        int64  `json:"id,omitempty"`
	// LastDepositAt: User's most recent deposit timestamp
	LastDepositAt string `json:"last_deposit_at,omitempty"`
	// Network: "bsc" or "polygon"
	Network string `json:"network,omitempty"`
	// RejectReason: Reason recorded upon rejection
	RejectReason string `json:"reject_reason,omitempty"`
	// ReviewedAt: Administrative review timestamp
	ReviewedAt string `json:"reviewed_at,omitempty"`
	// Status: "pending", "completed", "rejected"
	Status string `json:"status,omitempty"`
	// ToAddress: Destination EVM wallet address
	ToAddress string `json:"to_address,omitempty"`
	// Token: "USDC" or "USDT"
	Token string `json:"token,omitempty"`
	// TxHash: Transaction hash on destination network
	TxHash string `json:"tx_hash,omitempty"`
	// UpdatedAt: Last modification timestamp
	UpdatedAt string `json:"updated_at,omitempty"`
	UserEmail string `json:"user_email,omitempty"`
	UserId    int64  `json:"user_id,omitempty"`
}

Withdrawal Withdrawal represents the Withdrawal data model.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.