Bitmex REST APIs for Go

Overview

This bitmexgo package enables golang clients to call REST APIs for the Bitmex crypto trading platform. It fixes critical bugs in the swagger-generated code and enhances its usability.

Notable changes:

• Fixed the authentication logic and API endpoint
• Fixed form data encoding
• Renamed the package from swagger to bitmexgo
• Removed all external dependencies (golang.org/x/oauth2 and github.com/antihax/optional)
• Added a local optional package with mutable states to simplify parameter assignment
• Fixed many type issues and removed the obsolete XAny type

This package also differs from an alternative library at https://github.com/qct/bitmex-go in the following ways:

• bitmexgo employs strongly-typed structs for API parameters instead of map[string]interface{}.
• bitmexgo is forked from a more recent version of the swagger-generated code.
• bitmexgo depends on no external packages and is compatible with Google App Engine.

Installation

go get github.com/zmxv/bitmexgo

Usage

import "github.com/zmxv/bitmexgo"

// Get your API key/secret pair at https://www.bitmex.com/app/apiKeys
apiKey := "..."
apiSecret := "..."

// Create an authentication context
auth := bitmexgo.NewAPIKeyContext(apiKey, apiSecret)

// Create a shareable API client instance
apiClient := bitmexgo.NewAPIClient(bitmexgo.NewConfiguration())

// Create a testnet API client instance
testnetClient := bitmexgo.NewAPIClient(bitmexgo.NewTestnetConfiguration())

// Call APIs without parameters by passing the auth context.
// e.g. getting exchange-wide turnover and volume statistics:
stats, res, err := apiClient.StatsApi.StatsGet(auth)

// Call APIs with default parameters by passing the auth context and a nil.
// e.g. getting all open positions:
pos, res, err := apiClient.PositionApi.PositionGet(auth, nil)

// Call APIs with additional parameters by constructing a corresponding XXXOpts struct.
// e.g. submitting a limit order to buy 20000 contracts of XBTUSD at $6000.5:
var params bitmexgo.OrderNewOpts
params.OrdType.Set("Limit")
params.Side.Set("Buy")
params.OrderQty.Set(20000)
params.Price.Set(6000.5)
order, res, err := apiClient.OrderApi.OrderNew(auth, "XBTUSD", &params)

Documentation for API Endpoints

All URIs are relative to https://www.bitmex.com/api/v1

Documentation For Models

• AccessToken
• Affiliate
• Announcement
• ApiKey
• Chat
• ChatChannel
• ConnectedUsers
• ErrorError
• Execution
• Funding
• IndexComposite
• InlineResponse200
• InlineResponse2001
• Instrument
• InstrumentInterval
• Insurance
• Leaderboard
• Liquidation
• Margin
• ModelError
• Notification
• Order
• OrderBookL2
• Position
• Quote
• Settlement
• Stats
• StatsHistory
• StatsUsd
• Trade
• TradeBin
• Transaction
• User
• UserCommission
• UserPreferences
• UserWithdrawalFees
• Wallet

Bitmex customer support

[email protected]