private

Documentation

Index

• type Account
• type AccountResponse
• type ApiBaseOrder
• type ApiOrder
• type CancelOrderResponse
• type CancelOrdersResponse
• type Fill
• type FillsParam
• type FillsResponse
• type FundingPayment
• type FundingPaymentsParam
• type FundingPaymentsResponse
• type HistoricalPnL
• type HistoricalPnLParam
• type HistoricalPnLResponse
• type Order
• type OrderListResponse
• type OrderQueryParam
  • func (o OrderQueryParam) ToParams() url.Values
• type OrderResponse
• type Position
• type PositionResponse
• type Private
  • func (p *Private) CancelOrder(orderId string) (*CancelOrderResponse, error)
  • func (p *Private) CancelOrders(market string) (*CancelOrdersResponse, error)
  • func (p *Private) CreateOrder(input *ApiOrder, positionId int64) (*OrderResponse, error)
  • func (p *Private) GetAccount(ethereumAddress string) (*AccountResponse, error)
  • func (p *Private) GetFills(param *FillsParam) (*FillsResponse, error)
  • func (p *Private) GetFundingPayments(param *FundingPaymentsParam) (*FundingPaymentsResponse, error)
  • func (p *Private) GetHistoricalPnL(param *HistoricalPnLParam) (*HistoricalPnLResponse, error)
  • func (p *Private) GetOrderById(orderId string) (*OrderResponse, error)
  • func (p *Private) GetOrders(input *OrderQueryParam) (*OrderListResponse, error)
  • func (p *Private) GetPositions(market string) (*PositionResponse, error)
  • func (p *Private) GetTradingRewards(param *TradingRewardsParam) (*TradingRewardsResponse, error)
  • func (p *Private) GetUsers() (*UsersResponse, error)
  • func (p *Private) Sign(requestPath, method, isoTimestamp, body string) string
  • func (p *Private) WithdrawFast(param *WithdrawalParam) (*WithdrawResponse, error)
• type TradingReward
• type TradingRewardsParam
• type TradingRewardsResponse
• type Transfer
• type TransfersParam
• type TransfersResponse
• type User
• type UsersResponse
• type WithdrawResponse
• type Withdrawal
• type WithdrawalParam

Types

type Account

type Account struct {
	PositionId         int64               `json:"positionId,string"`
	ID                 string              `json:"id"`
	StarkKey           string              `json:"starkKey"`
	Equity             string              `json:"equity"`
	FreeCollateral     string              `json:"freeCollateral"`
	QuoteBalance       string              `json:"quoteBalance"`
	PendingDeposits    string              `json:"pendingDeposits"`
	PendingWithdrawals string              `json:"pendingWithdrawals"`
	AccountNumber      string              `json:"accountNumber"`
	OpenPositions      map[string]Position `json:"openPositions"`
	CreatedAt          time.Time           `json:"createdAt"`
}

type AccountResponse

type AccountResponse struct {
	Account Account `json:"account"`
}

type ApiBaseOrder

type ApiBaseOrder struct {
	Signature  string `json:"signature"`
	Expiration string `json:"expiration"`
}

type ApiOrder

type ApiOrder struct {
	ApiBaseOrder
	Market          string `json:"market"`
	Side            string `json:"side"`
	Type            string `json:"type"`
	Size            string `json:"size"`
	Price           string `json:"price"`
	ClientId        string `json:"clientId"`
	TimeInForce     string `json:"timeInForce"`
	LimitFee        string `json:"limitFee"`
	CancelId        string `json:"cancelId,omitempty"`
	TriggerPrice    string `json:"triggerPrice,omitempty"`
	TrailingPercent string `json:"trailingPercent,omitempty"`
	PostOnly        bool   `json:"postOnly"`
}

type CancelOrderResponse

type CancelOrderResponse struct {
	CancelOrder Order `json:"cancelOrder"`
}

type CancelOrdersResponse

type CancelOrdersResponse struct {
	CancelOrders Order `json:"cancelOrder"`
}

type Fill

type Fill struct {
	ID        string    `json:"id"`
	Side      string    `json:"side"`
	Liquidity string    `json:"liquidity"`
	Type      string    `json:"type"`
	Market    string    `json:"market"`
	OrderID   string    `json:"orderId"`
	Price     string    `json:"price"`
	Size      string    `json:"size"`
	Fee       string    `json:"fee"`
	CreatedAt time.Time `json:"createdAt"`
}

type FillsParam

type FillsParam struct {
	Market            string `json:"market,omitempty"`
	OrderId           string `json:"order_id,omitempty"`
	Limit             string `json:"limit,omitempty"`
	CreatedBeforeOrAt string `json:"createdBeforeOrAt,omitempty"`
}

type FillsResponse

type FillsResponse struct {
	Fills []Fill `json:"fills"`
}

type FundingPayment

type FundingPayment struct {
	Market       string    `json:"market"`
	Payment      string    `json:"payment"`
	Rate         string    `json:"rate"`
	PositionSize string    `json:"positionSize"`
	Price        string    `json:"price"`
	EffectiveAt  time.Time `json:"effectiveAt"`
}

type FundingPaymentsParam

type FundingPaymentsParam struct {
	Market              string `json:"market,omitempty"`
	Limit               string `json:"limit,omitempty"`
	EffectiveBeforeOrAt string `json:"effectiveBeforeOrAt,omitempty"`
}

type FundingPaymentsResponse

type FundingPaymentsResponse struct {
	FundingPayments []FundingPayment `json:"fundingPayments"`
}

type HistoricalPnL

type HistoricalPnL struct {
	AccountID    string    `json:"accountId"`
	Equity       string    `json:"equity"`
	TotalPnl     string    `json:"totalPnl"`
	NetTransfers string    `json:"netTransfers"`
	CreatedAt    time.Time `json:"createdAt"`
}

type HistoricalPnLParam

type HistoricalPnLParam struct {
	EffectiveBeforeOrAt string `json:"effectiveBeforeOrAt,omitempty"`
	EffectiveAtOrAfter  string `json:"effectiveAtOrAfter,omitempty"`
}

type HistoricalPnLResponse

type HistoricalPnLResponse struct {
	HistoricalPnLs []HistoricalPnL `json:"historicalPnl"`
}

type Order

type Order struct {
	ID              string    `json:"id"`
	ClientID        string    `json:"clientId"`
	AccountID       string    `json:"accountId"`
	Market          string    `json:"market"`
	Side            string    `json:"side"`
	Price           string    `json:"price"`
	TriggerPrice    string    `json:"triggerPrice"`
	TrailingPercent string    `json:"trailingPercent"`
	Size            string    `json:"size"`
	RemainingSize   string    `json:"remainingSize"`
	Type            string    `json:"type"`
	UnfillableAt    string    `json:"unfillableAt"`
	Status          string    `json:"status"`
	TimeInForce     string    `json:"timeInForce"`
	CancelReason    string    `json:"cancelReason"`
	PostOnly        bool      `json:"postOnly"`
	CreatedAt       time.Time `json:"createdAt"`
	ExpiresAt       time.Time `json:"expiresAt"`
}

type OrderListResponse

type OrderListResponse struct {
	Orders []Order `json:"orders"`
}

type OrderQueryParam

type OrderQueryParam struct {
	Limit              int    `json:"limit"`
	Market             string `json:"market"`
	Status             string `json:"status"`
	Type               string `json:"type"`
	Side               string `json:"side"`
	CreatedBeforeOrAt  string `json:"createdAt"`
	ReturnLatestOrders string `json:"returnLatestOrders"`
}

func (OrderQueryParam) ToParams

func (o OrderQueryParam) ToParams() url.Values

type OrderResponse

type OrderResponse struct {
	Order Order `json:"order"`
}

type Position

type Position struct {
	Market        string      `json:"market"`
	Status        string      `json:"status"`
	Side          string      `json:"side"`
	Size          string      `json:"size"`
	MaxSize       string      `json:"maxSize"`
	EntryPrice    string      `json:"entryPrice"`
	ExitPrice     interface{} `json:"exitPrice"`
	UnrealizedPnl string      `json:"unrealizedPnl"`
	RealizedPnl   string      `json:"realizedPnl"`
	CreatedAt     time.Time   `json:"createdAt"`
	ClosedAt      interface{} `json:"closedAt"`
	NetFunding    string      `json:"netFunding"`
	SumOpen       string      `json:"sumOpen"`
	SumClose      string      `json:"sumClose"`
}

type PositionResponse

type PositionResponse struct {
	Positions []Position `json:"positions"`
}

type Private

type Private struct {
	NetworkId         int
	Host              string
	StarkPrivateKey   string
	DefaultAddress    string
	ApiKeyCredentials *types.ApiKeyCredentials

	RateLimit *types.RateLimit
	Logger    *log.Logger
}

func (*Private) CancelOrder

func (p *Private) CancelOrder(orderId string) (*CancelOrderResponse, error)

func (*Private) CancelOrders

func (p *Private) CancelOrders(market string) (*CancelOrdersResponse, error)

func (*Private) CreateOrder

func (p *Private) CreateOrder(input *ApiOrder, positionId int64) (*OrderResponse, error)

func (*Private) GetAccount

func (p *Private) GetAccount(ethereumAddress string) (*AccountResponse, error)

func (*Private) GetFills

func (p *Private) GetFills(param *FillsParam) (*FillsResponse, error)

func (*Private) GetFundingPayments

func (p *Private) GetFundingPayments(param *FundingPaymentsParam) (*FundingPaymentsResponse, error)

func (*Private) GetHistoricalPnL

func (p *Private) GetHistoricalPnL(param *HistoricalPnLParam) (*HistoricalPnLResponse, error)

func (*Private) GetOrderById

func (p *Private) GetOrderById(orderId string) (*OrderResponse, error)

func (*Private) GetOrders

func (p *Private) GetOrders(input *OrderQueryParam) (*OrderListResponse, error)

func (*Private) GetPositions

func (p *Private) GetPositions(market string) (*PositionResponse, error)

func (*Private) GetTradingRewards

func (p *Private) GetTradingRewards(param *TradingRewardsParam) (*TradingRewardsResponse, error)

func (*Private) GetUsers

func (p *Private) GetUsers() (*UsersResponse, error)

func (*Private) Sign

func (p *Private) Sign(requestPath, method, isoTimestamp, body string) string

func (*Private) WithdrawFast

func (p *Private) WithdrawFast(param *WithdrawalParam) (*WithdrawResponse, error)

type TradingReward

type TradingReward struct {
	Epoch      int       `json:"epoch"`
	EpochStart time.Time `json:"epochStart"`
	EpochEnd   time.Time `json:"epochEnd"`
	Fees       struct {
		FeesPaid      string `json:"feesPaid"`
		TotalFeesPaid string `json:"totalFeesPaid"`
	} `json:"fees"`
	OpenInterest struct {
		AverageOpenInterest      string `json:"averageOpenInterest"`
		TotalAverageOpenInterest string `json:"totalAverageOpenInterest"`
	} `json:"openInterest"`
	StakedDYDX struct {
		AverageStakedDYDX          string `json:"averageStakedDYDX"`
		AverageStakedDYDXWithFloor string `json:"averageStakedDYDXWithFloor"`
		TotalAverageStakedDYDX     string `json:"totalAverageStakedDYDX"`
	} `json:"stakedDYDX"`
	Weight struct {
		Weight      string `json:"weight"`
		TotalWeight string `json:"totalWeight"`
	} `json:"weight"`
	TotalRewards     string `json:"totalRewards"`
	EstimatedRewards string `json:"estimatedRewards"`
}

type TradingRewardsParam

type TradingRewardsParam struct {
	Epoch int `json:"epoch,omitempty"`
}

type TradingRewardsResponse

type TradingRewardsResponse TradingReward

type Transfer

type Transfer struct {
	Type            string    `json:"type"`
	ID              string    `json:"id"`
	ClientID        string    `json:"clientId"`
	CreditAmount    string    `json:"creditAmount"`
	CreditAsset     string    `json:"creditAsset"`
	DebitAmount     string    `json:"debitAmount"`
	DebitAsset      string    `json:"debitAsset"`
	FromAddress     string    `json:"fromAddress"`
	Status          string    `json:"status"`
	ToAddress       string    `json:"toAddress"`
	TransactionHash string    `json:"transactionHash"`
	ConfirmedAt     time.Time `json:"confirmedAt"`
	CreatedAt       time.Time `json:"createdAt"`
}

type TransfersParam

type TransfersParam struct {
}

type TransfersResponse

type TransfersResponse struct {
	Transfers []Transfer `json:"transfers"`
}

type User

type User struct {
	PublicID        string `json:"publicId"`
	EthereumAddress string `json:"ethereumAddress"`
	IsRegistered    bool   `json:"isRegistered"`
	Email           string `json:"email"`
	Username        string `json:"username"`
	UserData        struct {
		WalletType  string `json:"walletType"`
		Preferences struct {
			SaveOrderAmount  bool `json:"saveOrderAmount"`
			UserTradeOptions struct {
				Limit struct {
					PostOnlyChecked           bool   `json:"postOnlyChecked"`
					GoodTilTimeInput          string `json:"goodTilTimeInput"`
					GoodTilTimeTimescale      string `json:"goodTilTimeTimescale"`
					SelectedTimeInForceOption string `json:"selectedTimeInForceOption"`
				} `json:"LIMIT"`
				Market struct {
					PostOnlyChecked           bool   `json:"postOnlyChecked"`
					GoodTilTimeInput          string `json:"goodTilTimeInput"`
					GoodTilTimeTimescale      string `json:"goodTilTimeTimescale"`
					SelectedTimeInForceOption string `json:"selectedTimeInForceOption"`
				} `json:"MARKET"`
				StopLimit struct {
					PostOnlyChecked           bool   `json:"postOnlyChecked"`
					GoodTilTimeInput          string `json:"goodTilTimeInput"`
					GoodTilTimeTimescale      string `json:"goodTilTimeTimescale"`
					SelectedTimeInForceOption string `json:"selectedTimeInForceOption"`
				} `json:"STOP_LIMIT"`
				TakeProfit struct {
					PostOnlyChecked           bool   `json:"postOnlyChecked"`
					GoodTilTimeInput          string `json:"goodTilTimeInput"`
					GoodTilTimeTimescale      string `json:"goodTilTimeTimescale"`
					SelectedTimeInForceOption string `json:"selectedTimeInForceOption"`
				} `json:"TAKE_PROFIT"`
				LastPlacedTradeType string `json:"lastPlacedTradeType"`
			} `json:"userTradeOptions"`
			PopUpNotifications      bool      `json:"popUpNotifications"`
			OrderbookAnimations     bool      `json:"orderbookAnimations"`
			OneTimeNotifications    []string  `json:"oneTimeNotifications"`
			LeaguesCurrentStartDate time.Time `json:"leaguesCurrentStartDate"`
		} `json:"preferences"`
		Notifications struct {
			Trade struct {
				Email bool `json:"email"`
			} `json:"trade"`
			Deposit struct {
				Email bool `json:"email"`
			} `json:"deposit"`
			Transfer struct {
				Email bool `json:"email"`
			} `json:"transfer"`
			Marketing struct {
				Email bool `json:"email"`
			} `json:"marketing"`
			Withdrawal struct {
				Email bool `json:"email"`
			} `json:"withdrawal"`
			Liquidation struct {
				Email bool `json:"email"`
			} `json:"liquidation"`
			FundingPayment struct {
				Email bool `json:"email"`
			} `json:"funding_payment"`
		} `json:"notifications"`
		StarredMarkets []interface{} `json:"starredMarkets"`
	} `json:"userData"`
	MakerFeeRate                 string        `json:"makerFeeRate"`
	TakerFeeRate                 string        `json:"takerFeeRate"`
	MakerVolume30D               string        `json:"makerVolume30D"`
	TakerVolume30D               string        `json:"takerVolume30D"`
	Fees30D                      string        `json:"fees30D"`
	ReferredByAffiliateLink      string        `json:"referredByAffiliateLink"`
	IsSharingUsername            bool          `json:"isSharingUsername"`
	IsSharingAddress             bool          `json:"isSharingAddress"`
	DydxTokenBalance             string        `json:"dydxTokenBalance"`
	StakedDydxTokenBalance       string        `json:"stakedDydxTokenBalance"`
	ActiveStakedDydxTokenBalance string        `json:"activeStakedDydxTokenBalance"`
	IsEmailVerified              bool          `json:"isEmailVerified"`
	Country                      interface{}   `json:"country"`
	HedgiesHeld                  []interface{} `json:"hedgiesHeld"`
}

type UsersResponse

type UsersResponse struct {
	User User `json:"user"`
}

type WithdrawResponse

type WithdrawResponse struct {
	Withdrawal []Withdrawal `json:"withdrawal"`
}

type Withdrawal

type Withdrawal struct {
	ID              string      `json:"id"`
	Type            string      `json:"type"`
	DebitAsset      string      `json:"debitAsset"`
	CreditAsset     string      `json:"creditAsset"`
	DebitAmount     string      `json:"debitAmount"`
	CreditAmount    string      `json:"creditAmount"`
	TransactionHash string      `json:"transactionHash"`
	Status          string      `json:"status"`
	ClientID        string      `json:"clientId"`
	FromAddress     string      `json:"fromAddress"`
	ToAddress       interface{} `json:"toAddress"`
	ConfirmedAt     interface{} `json:"confirmedAt"`
	CreatedAt       time.Time   `json:"createdAt"`
}

type WithdrawalParam

type WithdrawalParam struct {
	ClientID     string `json:"clientId"`
	ToAddress    string `json:"toAddress"`
	CreditAsset  string `json:"creditAsset"`
	CreditAmount string `json:"creditAmount"`

	DebitAmount string `json:"debitAmount"`

	LpPositionId string `json:"lpPositionId"`
	Expiration   string `json:"expiration"`
	Signature    string `json:"signature"`
}