ftxapi

Mar 15, 2022

Changes in this version

+ const RestBaseURL

+ type APIResponse struct

+ HasMoreData bool

+ Result json.RawMessage

+ Success bool

+ type Account struct

+ BackstopProvider bool

+ Collateral fixedpoint.Value

+ FreeCollateral fixedpoint.Value

+ InitialMarginRequirement fixedpoint.Value

+ Leverage fixedpoint.Value

+ Liquidating bool

+ MaintenanceMarginRequirement fixedpoint.Value

+ MakerFee fixedpoint.Value

+ MarginFraction fixedpoint.Value

+ OpenMarginFraction fixedpoint.Value

+ Positions []Position

+ TakerFee fixedpoint.Value

+ TotalAccountValue fixedpoint.Value

+ TotalPositionSize fixedpoint.Value

+ Username string

+ type Balance struct

+ AvailableWithoutBorrow fixedpoint.Value

+ Coin string

+ Free fixedpoint.Value

+ SpotBorrow fixedpoint.Value

+ Total fixedpoint.Value

+ UsdValue fixedpoint.Value

+ type CancelAllOrderRequest struct

+ func (c *CancelAllOrderRequest) Do(ctx context.Context) (*APIResponse, error)

+ func (c *CancelAllOrderRequest) GetParameters() (map[string]interface{}, error)

+ func (c *CancelAllOrderRequest) GetParametersJSON() ([]byte, error)

+ func (c *CancelAllOrderRequest) GetParametersQuery() (url.Values, error)

+ func (c *CancelAllOrderRequest) GetQueryParameters() (url.Values, error)

+ func (c *CancelAllOrderRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (c *CancelAllOrderRequest) GetSlugsMap() (map[string]string, error)

+ func (c *CancelAllOrderRequest) Market(market string) *CancelAllOrderRequest

+ type CancelOrderByClientOrderIdRequest struct

+ func (c *CancelOrderByClientOrderIdRequest) ClientOrderId(clientOrderId string) *CancelOrderByClientOrderIdRequest

+ func (c *CancelOrderByClientOrderIdRequest) Do(ctx context.Context) (*APIResponse, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetParameters() (map[string]interface{}, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetParametersJSON() ([]byte, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetParametersQuery() (url.Values, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetQueryParameters() (url.Values, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (c *CancelOrderByClientOrderIdRequest) GetSlugsMap() (map[string]string, error)

+ type CancelOrderRequest struct

+ func (c *CancelOrderRequest) Do(ctx context.Context) (*APIResponse, error)

+ func (c *CancelOrderRequest) GetParameters() (map[string]interface{}, error)

+ func (c *CancelOrderRequest) GetParametersJSON() ([]byte, error)

+ func (c *CancelOrderRequest) GetParametersQuery() (url.Values, error)

+ func (c *CancelOrderRequest) GetQueryParameters() (url.Values, error)

+ func (c *CancelOrderRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (c *CancelOrderRequest) GetSlugsMap() (map[string]string, error)

+ func (c *CancelOrderRequest) OrderID(orderID string) *CancelOrderRequest

+ type Coin struct

+ Bep2Asset *string

+ CanConvert bool

+ CanDeposit bool

+ CanWithdraw bool

+ Collateral bool

+ CollateralWeight fixedpoint.Value

+ CreditTo *string

+ Erc20Contract string

+ Fiat bool

+ HasTag bool

+ Id string

+ IsToken bool

+ Methods []string

+ Name string

+ SplMint string

+ Trc20Contract string

+ UsdFungible bool

+ type Fill struct

+ BaseCurrency string

+ Fee fixedpoint.Value

+ FeeCurrency string

+ FeeRate fixedpoint.Value

+ Future string

+ Id uint64

+ Liquidity Liquidity

+ Market string

+ OrderId uint64

+ Price fixedpoint.Value

+ QuoteCurrency string

+ Side Side

+ Size fixedpoint.Value

+ Time time.Time

+ TradeId uint64

+ Type string

+ type GetAccountRequest struct

+ func (g *GetAccountRequest) Do(ctx context.Context) (*Account, error)

+ func (g *GetAccountRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetAccountRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetAccountRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetAccountRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetAccountRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetAccountRequest) GetSlugsMap() (map[string]string, error)

+ type GetBalancesRequest struct

+ func (g *GetBalancesRequest) Do(ctx context.Context) ([]Balance, error)

+ func (g *GetBalancesRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetBalancesRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetBalancesRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetBalancesRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetBalancesRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetBalancesRequest) GetSlugsMap() (map[string]string, error)

+ type GetCoinsRequest struct

+ func (g *GetCoinsRequest) Do(ctx context.Context) ([]Coin, error)

+ func (g *GetCoinsRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetCoinsRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetCoinsRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetCoinsRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetCoinsRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetCoinsRequest) GetSlugsMap() (map[string]string, error)

+ type GetFillsRequest struct

+ func (g *GetFillsRequest) Do(ctx context.Context) ([]Fill, error)

+ func (g *GetFillsRequest) EndTime(endTime time.Time) *GetFillsRequest

+ func (g *GetFillsRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetFillsRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetFillsRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetFillsRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetFillsRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetFillsRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetFillsRequest) Market(market string) *GetFillsRequest

+ func (g *GetFillsRequest) Order(order string) *GetFillsRequest

+ func (g *GetFillsRequest) OrderID(orderID int) *GetFillsRequest

+ func (g *GetFillsRequest) StartTime(startTime time.Time) *GetFillsRequest

+ type GetMarketRequest struct

+ func (g *GetMarketRequest) Do(ctx context.Context) (*Market, error)

+ func (g *GetMarketRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetMarketRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetMarketRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetMarketRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetMarketRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetMarketRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetMarketRequest) Market(market string) *GetMarketRequest

+ type GetMarketsRequest struct

+ func (g *GetMarketsRequest) Do(ctx context.Context) ([]Market, error)

+ func (g *GetMarketsRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetMarketsRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetMarketsRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetMarketsRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetMarketsRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetMarketsRequest) GetSlugsMap() (map[string]string, error)

+ type GetOpenOrdersRequest struct

+ func (g *GetOpenOrdersRequest) Do(ctx context.Context) ([]Order, error)

+ func (g *GetOpenOrdersRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetOpenOrdersRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetOpenOrdersRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetOpenOrdersRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetOpenOrdersRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetOpenOrdersRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetOpenOrdersRequest) Market(market string) *GetOpenOrdersRequest

+ type GetOrderHistoryRequest struct

+ func (g *GetOrderHistoryRequest) Do(ctx context.Context) ([]Order, error)

+ func (g *GetOrderHistoryRequest) EndTime(endTime time.Time) *GetOrderHistoryRequest

+ func (g *GetOrderHistoryRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetOrderHistoryRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetOrderHistoryRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetOrderHistoryRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetOrderHistoryRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetOrderHistoryRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetOrderHistoryRequest) Market(market string) *GetOrderHistoryRequest

+ func (g *GetOrderHistoryRequest) StartTime(startTime time.Time) *GetOrderHistoryRequest

+ type GetOrderStatusRequest struct

+ func (g *GetOrderStatusRequest) Do(ctx context.Context) (*Order, error)

+ func (g *GetOrderStatusRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetOrderStatusRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetOrderStatusRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetOrderStatusRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetOrderStatusRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetOrderStatusRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetOrderStatusRequest) OrderID(orderID uint64) *GetOrderStatusRequest

+ type GetPositionsRequest struct

+ func (g *GetPositionsRequest) Do(ctx context.Context) ([]Position, error)

+ func (g *GetPositionsRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetPositionsRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetPositionsRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetPositionsRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetPositionsRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetPositionsRequest) GetSlugsMap() (map[string]string, error)

+ type Liquidity string

+ const LiquidityMaker

+ const LiquidityTaker

+ type Market struct

+ Ask fixedpoint.Value

+ BaseCurrency string

+ Bid fixedpoint.Value

+ Change1H fixedpoint.Value

+ Change24H fixedpoint.Value

+ ChangeBod fixedpoint.Value

+ Enabled bool

+ HighLeverageFeeExempt bool

+ Last fixedpoint.Value

+ MinProvideSize fixedpoint.Value

+ Name string

+ PostOnly bool

+ Price fixedpoint.Value

+ PriceIncrement fixedpoint.Value

+ QuoteCurrency string

+ QuoteVolume24H fixedpoint.Value

+ Restricted bool

+ SizeIncrement fixedpoint.Value

+ Type string

+ Underlying string

+ VolumeUsd24H fixedpoint.Value

+ type Order struct

+ AvgFillPrice fixedpoint.Value

+ ClientId string

+ CreatedAt time.Time

+ FilledSize fixedpoint.Value

+ Future string

+ Id int64

+ Ioc bool

+ Market string

+ PostOnly bool

+ Price fixedpoint.Value

+ ReduceOnly bool

+ RemainingSize fixedpoint.Value

+ Side Side

+ Size fixedpoint.Value

+ Status OrderStatus

+ Type OrderType

+ type OrderStatus string

+ const OrderStatusClosed

+ const OrderStatusNew

+ const OrderStatusOpen

+ type OrderType string

+ const OrderTypeLimit

+ const OrderTypeMarket

+ const OrderTypeStopLimit

+ const OrderTypeTakeProfit

+ const OrderTypeTrailingStop

+ type PlaceOrderRequest struct

+ func (p *PlaceOrderRequest) ClientID(clientID string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Do(ctx context.Context) (*Order, error)

+ func (p *PlaceOrderRequest) GetParameters() (map[string]interface{}, error)

+ func (p *PlaceOrderRequest) GetParametersJSON() ([]byte, error)

+ func (p *PlaceOrderRequest) GetParametersQuery() (url.Values, error)

+ func (p *PlaceOrderRequest) GetQueryParameters() (url.Values, error)

+ func (p *PlaceOrderRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (p *PlaceOrderRequest) GetSlugsMap() (map[string]string, error)

+ func (p *PlaceOrderRequest) Ioc(ioc bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Market(market string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) OrderType(orderType OrderType) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) PostOnly(postOnly bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Price(price fixedpoint.Value) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Side(side Side) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Size(size fixedpoint.Value) *PlaceOrderRequest

+ type Position struct

+ Cost fixedpoint.Value

+ EntryPrice fixedpoint.Value

+ Future string

+ InitialMarginRequirement fixedpoint.Value

+ LongOrderSize fixedpoint.Value

+ MaintenanceMarginRequirement fixedpoint.Value

+ NetSize fixedpoint.Value

+ OpenSize fixedpoint.Value

+ RealizedPnl fixedpoint.Value

+ ShortOrderSize fixedpoint.Value

+ Side string

+ Size fixedpoint.Value

+ UnrealizedPnl fixedpoint.Value

+ type RestClient struct

+ BaseURL *url.URL

+ Key string

+ Secret string

+ func NewClient() *RestClient

+ func (c *RestClient) Auth(key, secret, subAccount string)

+ func (c *RestClient) NewAuthenticatedRequest(ctx context.Context, method, refURL string, params url.Values, ...) (*http.Request, error)

+ func (c *RestClient) NewCancelAllOrderRequest() *CancelAllOrderRequest

+ func (c *RestClient) NewCancelOrderByClientOrderIdRequest(clientOrderId string) *CancelOrderByClientOrderIdRequest

+ func (c *RestClient) NewCancelOrderRequest(orderID string) *CancelOrderRequest

+ func (c *RestClient) NewGetAccountRequest() *GetAccountRequest

+ func (c *RestClient) NewGetBalancesRequest() *GetBalancesRequest

+ func (c *RestClient) NewGetCoinsRequest() *GetCoinsRequest

+ func (c *RestClient) NewGetFillsRequest() *GetFillsRequest

+ func (c *RestClient) NewGetMarketRequest(market string) *GetMarketRequest

+ func (c *RestClient) NewGetMarketsRequest() *GetMarketsRequest

+ func (c *RestClient) NewGetOpenOrdersRequest(market string) *GetOpenOrdersRequest

+ func (c *RestClient) NewGetOrderHistoryRequest(market string) *GetOrderHistoryRequest

+ func (c *RestClient) NewGetOrderStatusRequest(orderID uint64) *GetOrderStatusRequest

+ func (c *RestClient) NewGetPositionsRequest() *GetPositionsRequest

+ func (c *RestClient) NewPlaceOrderRequest() *PlaceOrderRequest

+ func (c *RestClient) NewRequest(ctx context.Context, method, refURL string, params url.Values, ...) (*http.Request, error)

+ func (c *RestClient) SendRequest(req *http.Request) (*requestgen.Response, error)

+ type Side string

+ const SideBuy

+ const SideSell