Categorygithub.com/jimmyplaza/max-exchange-api-go
modulepackage
1.0.5
Repository: https://github.com/jimmyplaza/max-exchange-api-go.git
Documentation: pkg.go.dev

# README

License GoDoc Go Report Card

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

ClassGo MethodHTTP requestDescription
PublicCurrenciesGET /api/v2/currencies
PublicDepthGET /api/v2/depth
PublicKGET /api/v2/k
PublicMarketsGET /api/v2/markets
PublicOrderBookGET /api/v2/order_book
PublicTickersGET /api/v2/tickers
PublicTickerGET /api/v2/tickers/{market}
PublicTimestampGET /api/v2/timestamp
PublicTradesGET /api/v2/trades
ClassGo MethodHTTP requestDescription
PrivateDepositGET /api/v2/deposit
PrivateDepositAddressGET /api/v2/deposit_addressDeprecated
PrivateCreateDepositAddressesPOST /api/v2/deposit_addressescreate deposit addresses
PrivateDepositAddressesGET /api/v2/deposit_addresseswhere to deposit
PrivateDepositsGET /api/v2/deposits
PrivateMeGET /api/v2/members/me
PrivateOrderGET /api/v2/order
PrivateOrdersGET /api/v2/orders
PrivateMyTradesGET /api/v2/trades/my
PrivateWithdrawalGET /api/v2/withdrawal
PrivateWithdrawalsGET /api/v2/withdrawals
PrivateCancelOrderPOST /api/v2/order/delete
PrivateCancelOrdersPOST /api/v2/orders/clear
PrivateCreateOrderPOST /api/v2/orders
PrivateCreateOrdersPOST /api/v2/orders/multicreate multiple sell/buy orders

Websocket APIs (Beta)

ClassGo MethodDescription
PublicSubscribeTickerSubscribe the realtime price information
PublicSubscribeOrderBookSubscribe the realtime changes on order books
PublicSubscribeTradeSubscribe the realtime trades information
ClassGo MethodDescription
PrivateSubscribeAccountSubscribe the accounts changes for an user

API Reference

See MAX RESTful API List and MAX Websocket API List (Beta).

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# 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