Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dydx

package module

Go to main page

Versions in this module

v1

v1.0.6

Nov 28, 2023

v1.0.5

Dec 27, 2022

v1.0.4

Aug 22, 2022

v1.0.3

Aug 22, 2022

v1.0.2

Aug 11, 2022

v1.0.1

Jul 29, 2022

v1.0.0

Jul 1, 2022

Changes in this version

+ const AccountChannel

+ const ApiHostMainnet

+ const ApiHostRopsten

+ const ChannelResponseTypeChannelData

+ const ChannelResponseTypeConnected

+ const ChannelResponseTypeError

+ const ChannelResponseTypeSubscribe

+ const ChannelResponseTypeUnsubscribe

+ const MarketsChannel

+ const NetworkIdMainnet

+ const NetworkIdRopsten

+ const OrderbookChannel

+ const PositionStatusClosed

+ const PositionStatusLiquidated

+ const PositionStatusOpen

+ const Resolution15MINS

+ const Resolution1D

+ const Resolution1HOUR

+ const Resolution1MIN

+ const Resolution30MINS

+ const Resolution4HOURS

+ const Resolution5MINS

+ const TradesChannel

+ const WsHostMainnet

+ const WsHostRopsten

+ func GetAccountIdFromEth(ethAddress string) string

+ func GetIsoDateStr(t time.Time) string

+ func GetUserId(ethAddress string) string

+ func NewEcdsaPrivateKeySigner(key *ecdsa.PrivateKey) *ecdsaPrivateKeySigner

+ func ParseApiKeyMap(input []byte) (map[string]*ApiKey, error)

+ func ParseStarkKeyMap(input []byte) (map[string]*StarkKey, error)

+ func SetClientEndpoint(isMainnet bool) clientOption

+ func SetClientTimeout(timeout time.Duration) clientOption

+ type Account struct

+ AccountNumber JsonInt

+ CreatedAt time.Time

+ Equity Decimal

+ FreeCollateral Decimal

+ ID string

+ OpenPositions map[string]Position

+ PendingDeposits string

+ PendingWithdrawals string

+ PositionId int64

+ QuoteBalance Decimal

+ StarkKey string

+ type AccountChannelResponse = ChannelResponse[AccountChannelResponseContents]

+ type AccountChannelResponseContents struct

+ Account *Account

+ Accounts []*Account

+ Fills []*Fill

+ Orders []*Order

+ Positions []*Position

+ Transfers []*Transfer

+ type AccountInfoByMarket struct

+ ActiveOrders map[string]*Order

+ AllPositions []*Position

+ ClosedOrders map[string]*Order

+ Fills map[string]*FillList

+ Market string

+ OpenPosition *Position

+ func NewAccountInfoByMarket(market string) *AccountInfoByMarket

+ func (info *AccountInfoByMarket) AddFill(fill *Fill)

+ func (info *AccountInfoByMarket) AddOrder(order *Order)

+ func (info *AccountInfoByMarket) AddPosition(position *Position)

+ type AccountProcessor struct

+ Account *Account

+ Info map[string]*AccountInfoByMarket

+ func NewAccountProcessor() *AccountProcessor

+ func (ap *AccountProcessor) ProcessChannelResponse(resp *AccountChannelResponse)

+ type AccountResponse struct

+ Account Account

+ type AccountsResponse struct

+ Accounts []*Account

+ type ActiveOrder struct

+ AccountID string

+ ID string

+ Market string

+ Price Decimal

+ RemainingSize Decimal

+ Side OrderSide

+ type ActiveOrdersResponse struct

+ Orders []ActiveOrder

+ type ApiKey struct

+ Key string

+ Passphrase string

+ Secret string

+ func NewApiKey(key, passphrase, secret string) *ApiKey

+ func RecoverDefaultApiKeyCredentials(signer SignTypedData, isMainnet bool) (*ApiKey, error)

+ func (a *ApiKey) Sign(requestPath, method, isoTimestamp string, body []byte) string

+ func (c *ApiKey) Set(filename string) error

+ func (c *ApiKey) String() string

+ func (c *ApiKey) Type() string

+ type Asks struct

+ func (a *Asks) Less(i, j int) bool

+ func (m *Asks) Len() int

+ func (m *Asks) Pop() *OrderbookOrder

+ func (m *Asks) PrintBook() string

+ func (m *Asks) Push(order *OrderbookOrder)

+ func (m *Asks) Swap(i, j int)

+ type Bids struct

+ func (b *Bids) Less(i, j int) bool

+ func (m *Bids) Len() int

+ func (m *Bids) Pop() *OrderbookOrder

+ func (m *Bids) PrintBook() string

+ func (m *Bids) Push(order *OrderbookOrder)

+ func (m *Bids) Swap(i, j int)

+ type CancelActiveOrdersParam struct

+ Id string

+ Market string

+ Side OrderSide

+ type CancelActiveOrdersResponse struct

+ CancelOrders []ActiveOrder

+ type CancelOrderResponse struct

+ CancelOrder Order

+ type CancelOrdersParam struct

+ Market string

+ type CancelOrdersResponse struct

+ CancelOrders []Order

+ type CancelReason string

+ const CancelReasonCouldNotFill

+ const CancelReasonExpired

+ const CancelReasonFailed

+ const CancelReasonPostOnlyWouldCross

+ const CancelReasonSelfTrade

+ const CancelReasonUndercollateralized

+ const CancelReasonUserCancelled

+ func GetCancelReason(input string) (CancelReason, error)

+ func (ot *CancelReason) UnmarshalJSON(input []byte) error

+ func (ot CancelReason) MarshalJSON() ([]byte, error)

+ type Candle struct

+ BaseTokenVolume string

+ Close string

+ High string

+ Low string

+ Market string

+ Open string

+ Resolution string

+ StartedAt time.Time

+ StartingOpenInterest string

+ Trades string

+ UpdatedAt time.Time

+ UsdVolume string

+ type CandlesParam struct

+ FromISO string

+ Limit int

+ Market string

+ Resolution string

+ ToISO string

+ type CandlesResponse struct

+ Candles []Candle

+ type ChannelResponse struct

+ Contents *TContents

+ type ChannelResponseHeader struct

+ Channel string

+ ConnectionID string

+ Id string

+ Message string

+ MessageID int

+ Type string

+ type Client struct

+ func NewClient(starkKey *StarkKey, apiKey *ApiKey, ethAddress string, isMainnet bool, ...) (*Client, error)

+ func (c *Client) CancelActiveOrders(ctx context.Context, params *CancelActiveOrdersParam) (*CancelActiveOrdersResponse, error)

+ func (c *Client) CancelOrder(ctx context.Context, id string) (*CancelOrderResponse, error)

+ func (c *Client) CancelOrders(ctx context.Context, params *CancelOrdersParam) (*CancelOrdersResponse, error)

+ func (c *Client) CreateUser(ctx context.Context, signer SignTypedData, param *CreateUserParam) (*CreateUserResponse, error)

+ func (c *Client) GetAccount(ctx context.Context, id string) (*AccountResponse, error)

+ func (c *Client) GetAccounts(ctx context.Context) (*AccountsResponse, error)

+ func (c *Client) GetActiveOrders(ctx context.Context, params *QueryActiveOrdersParam) (*ActiveOrdersResponse, error)

+ func (c *Client) GetCandles(ctx context.Context, params *CandlesParam) (*CandlesResponse, error)

+ func (c *Client) GetFills(ctx context.Context, params *FillsParam) (*FillsResponse, error)

+ func (c *Client) GetFundingPayments(ctx context.Context, params *FundingPaymentsParam) (*FundingPaymentsResponse, error)

+ func (c *Client) GetHistoricalFunding(ctx context.Context, params *HistoricalFundingsParam) (*HistoricalFundingsResponse, error)

+ func (c *Client) GetHistoricalPnL(ctx context.Context, params *HistoricalPnLParam) (*HistoricalPnLResponse, error)

+ func (c *Client) GetMarkets(ctx context.Context) (*MarketsResponse, error)

+ func (c *Client) GetOrderByClientId(ctx context.Context, clientId string) (*OrderResponse, error)

+ func (c *Client) GetOrderById(ctx context.Context, id string) (*OrderResponse, error)

+ func (c *Client) GetOrderbook(ctx context.Context, market string) (*OrderbookResponse, error)

+ func (c *Client) GetOrders(ctx context.Context, params *OrderQueryParam) (*OrdersResponse, error)

+ func (c *Client) GetPositions(ctx context.Context, params *PositionParams) (*PositionResponse, error)

+ func (c *Client) GetTrades(ctx context.Context, params *TradesParam) (*TradesResponse, error)

+ func (c *Client) GetTradingRewards(ctx context.Context, epoch int64) (*TradingRewardsResponse, error)

+ func (c *Client) GetUser(ctx context.Context) (*UsersResponse, error)

+ func (c *Client) NewOrder(ctx context.Context, order *CreateOrderRequest, positionId int64) (*CreateOrderResponse, error)

+ func (c *Client) RequestTestnetTokens(ctx context.Context) (*RequestTestnetTokensResponse, error)

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

+ func (c *Client) SubscribeMarkets(ctx context.Context, outputChan chan<- *MarketsChannelResponse) error

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

+ func (c *Client) SubscribeTrades(ctx context.Context, market string, outputChan chan<- *TradesChannelResponse) error

+ type CreateOrderRequest struct

+ CancelId string

+ ClientId string

+ Expiration time.Time

+ LimitFee *Decimal

+ Market string

+ PostOnly bool

+ Price *Decimal

+ Side OrderSide

+ Signature string

+ Size *Decimal

+ TimeInForce TimeInForce

+ TrailingPercent string

+ TriggerPrice string

+ Type OrderType

+ func NewCreateOrderRequest(market string, side OrderSide, order_type OrderType, size *Decimal, ...) *CreateOrderRequest

+ type CreateOrderResponse struct

+ Order *Order

+ type CreateUserParam struct

+ Country string

+ EthereumAddress string

+ ReferredByAffiliateLink string

+ StarkPublicKey string

+ StarkPublicKeyYCoordinate string

+ type CreateUserResponse struct

+ Account *Account

+ ApiKey *ApiKey

+ User *User

+ type Decimal = decimal.Decimal

+ func NewDecimalFromString(s string) (*Decimal, error)

+ type DydxError struct

+ Body []byte

+ HttpStatusCode int

+ Message string

+ func (e *DydxError) Error() string

+ type FastWithdrawalParam struct

+ ClientID string

+ CreditAmount string

+ CreditAsset string

+ DebitAmount string

+ Expiration string

+ LpPositionId string

+ Signature string

+ ToAddress string

+ type Fill struct

+ CreatedAt time.Time

+ Fee Decimal

+ ID string

+ Liquidity string

+ Market string

+ OrderID string

+ Price Decimal

+ Side OrderSide

+ Size Decimal

+ Type OrderType

+ type FillList []*Fill

+ type FillsParam struct

+ CreatedBeforeOrAt string

+ Limit string

+ Market string

+ OrderId string

+ type FillsResponse struct

+ Fills []*Fill

+ type FundingPayment struct

+ EffectiveAt time.Time

+ Market string

+ Payment string

+ PositionSize string

+ Price string

+ Rate string

+ type FundingPaymentsParam struct

+ EffectiveBeforeOrAt string

+ Limit string

+ Market string

+ type FundingPaymentsResponse struct

+ FundingPayments []FundingPayment

+ type HistoricalFunding struct

+ EffectiveAt time.Time

+ Market string

+ Price string

+ Rate string

+ type HistoricalFundingsParam struct

+ EffectiveBeforeOrAt string

+ Market string

+ type HistoricalFundingsResponse struct

+ HistoricalFundings []HistoricalFunding

+ type HistoricalPnL struct

+ AccountID string

+ CreatedAt time.Time

+ Equity string

+ NetTransfers string

+ TotalPnl string

+ type HistoricalPnLParam struct

+ EffectiveAtOrAfter string

+ EffectiveBeforeOrAt string

+ type HistoricalPnLResponse struct

+ HistoricalPnLs []HistoricalPnL

+ type JsonInt int

+ func (an *JsonInt) UnmarshalJSON(input []byte) error

+ func (an JsonInt) MarshalJSON() ([]byte, error)

+ type Logger interface

+ Debugf func(string, ...any)

+ Errorf func(string, ...any)

+ Fatalf func(string, ...any)

+ Infof func(string, ...any)

+ Warnf func(string, ...any)

+ func SetupLogger(defaultLevel, envName string) Logger

+ type Market struct

+ AssetResolution string

+ BaseAsset string

+ BaselinePositionSize *Decimal

+ IncrementalInitialMarginFraction *Decimal

+ IncrementalPositionSize *Decimal

+ IndexPrice *Decimal

+ InitialMarginFraction *Decimal

+ MaintenanceMarginFraction *Decimal

+ Market string

+ MaxPositionSize *Decimal

+ MinOrderSize *Decimal

+ NextFundingAt *time.Time

+ NextFundingRate *Decimal

+ OpenInterest *Decimal

+ OraclePrice *Decimal

+ PriceChange24H *Decimal

+ QuoteAsset string

+ Status string

+ StepSize *Decimal

+ SyntheticAssetID string

+ TickSize *Decimal

+ Trades24H *Decimal

+ Type string

+ Volume24H *Decimal

+ type MarketsChannelResponse = ChannelResponse[MarketsChannelResponseContents]

+ type MarketsChannelResponseContents = map[string]Market

+ type MarketsResponse struct

+ Markets map[string]Market

+ type Order struct

+ AccountID string

+ CancelReason *CancelReason

+ ClientID string

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ Market string

+ PostOnly bool

+ Price Decimal

+ RemainingSize Decimal

+ Side OrderSide

+ Size Decimal

+ Status OrderStatus

+ TimeInForce TimeInForce

+ TrailingPercent *Decimal

+ TriggerPrice *Decimal

+ Type OrderType

+ UnfillableAt *time.Time

+ type OrderQueryParam struct

+ CreatedBeforeOrAt string

+ Limit int

+ Market string

+ ReturnLatestOrders string

+ Side string

+ Status string

+ Type string

+ type OrderResponse struct

+ Order Order

+ type OrderSide string

+ const OrderSideBuy

+ const OrderSideSell

+ func GetOrderSide(input string) (OrderSide, error)

+ func (os *OrderSide) UnmarshalJSON(input []byte) error

+ func (os OrderSide) MarshalJSON() ([]byte, error)

+ type OrderStatus string

+ const OrderStatusCanceled

+ const OrderStatusFilled

+ const OrderStatusOpen

+ const OrderStatusPending

+ const OrderStatusUntriggered

+ func GetOrderStatus(input string) (OrderStatus, error)

+ func (ot *OrderStatus) UnmarshalJSON(input []byte) error

+ func (ot OrderStatus) MarshalJSON() ([]byte, error)

+ type OrderType string

+ const OrderTypeLimit

+ const OrderTypeMarket

+ const OrderTypeStop

+ const OrderTypeTakingProfit

+ const OrderTypeTrailingStop

+ func GetOrderType(input string) (OrderType, error)

+ func (ot *OrderType) UnmarshalJSON(input []byte) error

+ func (ot OrderType) MarshalJSON() ([]byte, error)

+ type OrderbookChannelResponse = ChannelResponse[OrderbookChannelResponseContents]

+ type OrderbookChannelResponseContents = OrderbookResponse

+ type OrderbookOrder struct

+ Offset *int64

+ Price *Decimal

+ PriceString string

+ Size *Decimal

+ func (o *OrderbookOrder) IsOtherNewerOffset(other *OrderbookOrder) bool

+ func (p *OrderbookOrder) UnmarshalJSON(data []byte) error

+ type OrderbookProcessor struct

+ Data []*OrderbookChannelResponse

+ Market string

+ func NewOrderbookProcessor(market string, dropData bool) *OrderbookProcessor

+ func (ob *OrderbookProcessor) BookTop() (*OrderbookOrder, *OrderbookOrder)

+ func (ob *OrderbookProcessor) Process(resp *OrderbookChannelResponse)

+ type OrderbookResponse struct

+ Asks []*OrderbookOrder

+ Bids []*OrderbookOrder

+ Offset *int64

+ type OrdersResponse struct

+ Orders []Order

+ type Position struct

+ ClosedAt *time.Time

+ CreatedAt time.Time

+ EntryPrice Decimal

+ ExitPrice *Decimal

+ Market string

+ MaxSize Decimal

+ NetFunding Decimal

+ RealizedPnl Decimal

+ Side string

+ Size Decimal

+ Status string

+ SumClose Decimal

+ SumOpen Decimal

+ UnrealizedPnl Decimal

+ type PositionParams struct

+ CreatedBeforeOrAt time.Time

+ Limit int

+ Market string

+ Status string

+ type PositionResponse struct

+ Positions []Position

+ type QueryActiveOrdersParam struct

+ Id string

+ Market string

+ Side OrderSide

+ type RequestTestnetTokensResponse struct

+ type SignTypedData interface

+ EthSignTypedData func(typedData apitypes.TypedData) ([]byte, error)

+ type StarkKey struct

+ PrivateKey string

+ PublicKey string

+ PublicKeyYCoordinate string

+ func DeriveStarkKey(signer SignTypedData, isMainnet bool) (*StarkKey, error)

+ func NewStarkKey(publicKey, publicKeyYCoordinate, privateKey string) *StarkKey

+ func (c *StarkKey) Set(filename string) error

+ func (c *StarkKey) String() string

+ func (c *StarkKey) Type() string

+ type TimeInForce string

+ const TimeInForceFok

+ const TimeInForceGtt

+ const TimeInForceIoc

+ func GetTimeInForce(input string) (TimeInForce, error)

+ func (ot *TimeInForce) UnmarshalJSON(input []byte) error

+ func (ot TimeInForce) MarshalJSON() ([]byte, error)

+ type Trade struct

+ CreatedAt time.Time

+ Price Decimal

+ Side string

+ Size Decimal

+ type TradesChannelResponse = ChannelResponse[TradesChannelResponseContents]

+ type TradesChannelResponseContents = TradesResponse

+ type TradesParam struct

+ Limit int

+ MarketID string

+ StartingBeforeOrAt string

+ type TradesResponse struct

+ Trades []Trade

+ type TradingReward struct

+ Epoch int

+ EpochEnd time.Time

+ EpochStart time.Time

+ EstimatedRewards string

+ Fees struct{ ... }

+ OpenInterest struct{ ... }

+ StakedDYDX struct{ ... }

+ TotalRewards string

+ Weight struct{ ... }

+ type TradingRewardsResponse TradingReward

+ type Transfer struct

+ ClientID string

+ ConfirmedAt *time.Time

+ CreatedAt time.Time

+ CreditAmount *Decimal

+ CreditAsset string

+ DebitAmount *Decimal

+ DebitAsset string

+ FromAddress string

+ ID string

+ Status string

+ ToAddress string

+ TransactionHash string

+ Type string

+ type TransfersParam struct

+ type TransfersResponse struct

+ Transfers []Transfer

+ type User struct

+ ActiveStakedDydxTokenBalance string

+ Country any

+ DydxTokenBalance string

+ Email string

+ EthereumAddress string

+ Fees30D string

+ HedgiesHeld []any

+ IsEmailVerified bool

+ IsRegistered bool

+ IsSharingAddress bool

+ IsSharingUsername bool

+ MakerFeeRate string

+ MakerVolume30D string

+ PublicID string

+ ReferredByAffiliateLink string

+ StakedDydxTokenBalance string

+ TakerFeeRate string

+ TakerVolume30D string

+ UserData struct{ ... }

+ Username string

+ type UsersResponse struct

+ User User

+ type WithdrawResponse struct

+ Withdrawal []Withdrawal

+ type Withdrawal = Transfer