# README
max-exchange-api-go
MAX (Maicoin Assets eXchange) Go SDK
Examples
See the examples
directory.
Documentation for API Endpoints
Notes
Private APIs require authentication. Pass your API tokens by AuthToken()
or WSAuthToken()
before using them.
RESTful APIs
All URIs are relative to https://max-api.maicoin.com
Class | Go Method | HTTP request | Description |
---|---|---|---|
Public | Currencies | GET /api/v2/currencies | |
Public | Depth | GET /api/v2/depth | |
Public | K | GET /api/v2/k | |
Public | Markets | GET /api/v2/markets | |
Public | OrderBook | GET /api/v2/order_book | |
Public | Tickers | GET /api/v2/tickers | |
Public | Ticker | GET /api/v2/tickers/{market} | |
Public | Timestamp | GET /api/v2/timestamp | |
Public | Trades | GET /api/v2/trades |
Class | Go Method | HTTP request | Description |
---|---|---|---|
Private | Deposit | GET /api/v2/deposit | |
Private | DepositAddress | GET /api/v2/deposit_address | Deprecated |
Private | CreateDepositAddresses | POST /api/v2/deposit_addresses | create deposit addresses |
Private | DepositAddresses | GET /api/v2/deposit_addresses | where to deposit |
Private | Deposits | GET /api/v2/deposits | |
Private | Me | GET /api/v2/members/me | |
Private | Order | GET /api/v2/order | |
Private | Orders | GET /api/v2/orders | |
Private | MyTrades | GET /api/v2/trades/my | |
Private | Withdrawal | GET /api/v2/withdrawal | |
Private | Withdrawals | GET /api/v2/withdrawals | |
Private | CancelOrder | POST /api/v2/order/delete | |
Private | CancelOrders | POST /api/v2/orders/clear | |
Private | CreateOrder | POST /api/v2/orders | |
Private | CreateOrders | POST /api/v2/orders/multi | create multiple sell/buy orders |
Websocket APIs (Beta)
Class | Go Method | Description |
---|---|---|
Public | SubscribeTicker | Subscribe the realtime price information |
Public | SubscribeOrderBook | Subscribe the realtime changes on order books |
Public | SubscribeTrade | Subscribe the realtime trades information |
Class | Go Method | Description |
---|---|---|
Private | SubscribeAccount | Subscribe the accounts changes for an user |
API Reference
# Functions
AsksLimit represents the asks_limit parameter.
AuthToken passess the access key and secret key to the API client.
BasePath sets base path of the API endpoint.
BidsLimit represents the bids_limit parameter.
Currency represents the currency parameter.
DepositState represents the state parameter for deposit.
From represents the from parameter.
FromTime represents the from parameter in Go time.Time format.
Limit represents the limit parameter.
Logging enables HTTP request logging.
Market represents the market parameter.
No description provided by the author
NewWSClient returns a websocket client.
Offset represents the offset parameter.
OrderAsc represents the order_by=asc parameter.
OrderDesc represents the order_by=desc parameter.
OrderSide represents the side parameter.
OrderType represents the ord_type parameter.
OrderTypes represents the orders[ord_type] parameter.
Page represents the page parameter.
Pagination represents the pagination parameter.
Period represents the period parameter.
PeriodDuration represents the period parameter in Go time.Duration format.
Price represents the price parameter.
Prices represents the orders[price] parameter.
StopPrice represents the stop_price parameter.
StopPrices represents the orders[stop_price] parameter.
Time represents the timestamp parameter in Go time.Time format.
Timeout sets the HTTP request timeout.
Timestamp represents the timestamp parameter.
To represents the to parameter.
ToTime represents the to parameter.
UserAgent sets the User-Agent in HTTP header.
WithdrawalState represents the state parameter for withdrawal.
WSAuthToken passes API tokens to the websocket client.
WSLogging sets logger of the websocket client.
WSURL sets the websocket URL to connect to.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
API provides an interface to the MAX APIs.
No description provided by the author
PrivateAPI provides an interface the private MAX APIs which has authtication requirements and rate limits.
PublicAPI provides an interface to the public MAX APIs.
No description provided by the author
No description provided by the author
# Type aliases
CallOption represents the API parameters.
No description provided by the author
No description provided by the author
No description provided by the author