okex

README

go-okex-v5

介绍

okex v5 sdk

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(config *Config) *Client
  • func (r *Client) Run() (res *RestApiResult, err error)
  • func (r *Client) SetMethod(method common.RequestMethod) *Client
  • func (r *Client) SetParam(param map[string]interface{}) *Client
  • func (r *Client) SetUrl(url string) *Client
• type Config
  • func NewConfig(apiKey, secretKey, passPhrase string) *Config
• type OkexApiResponse
• type RestApiResult

Constants

const (
	SideTypeBuy       common.SideType      = "BUY"
	SideTypeSell      common.SideType      = "SELL"
	RequestMethodGET  common.RequestMethod = "GET"
	RequestMethodPOST common.RequestMethod = "POST"

	/*
	  http headers
	*/
	OK_ACCESS_KEY        = "OK-ACCESS-KEY"
	OK_ACCESS_SIGN       = "OK-ACCESS-SIGN"
	OK_ACCESS_TIMESTAMP  = "OK-ACCESS-TIMESTAMP"
	OK_ACCESS_PASSPHRASE = "OK-ACCESS-PASSPHRASE"
	X_SIMULATE_TRADING   = "x-simulated-trading"

	CONTENT_TYPE = "Content-Type"
	ACCEPT       = "Accept"
	COOKIE       = "Cookie"
	LOCALE       = "locale="

	APPLICATION_JSON      = "application/json"
	APPLICATION_JSON_UTF8 = "application/json; charset=UTF-8"

	/*
	  i18n: internationalization
	*/
	ENGLISH             = "en_US"
	SIMPLIFIED_CHINESE  = "zh_CN"
	TRADITIONAL_CHINESE = "zh_HK"
)

Variables

var (
	UseTestnet = false // UseTestnet 使用测试api
	UseAWSnet  = false // UseAWSnet 使用AWS api
	IsSimulate = false // IsSimulate 是否使用模拟环境
)

var TimeOut = 10 * time.Second

Types

type Client

type Client struct {
	Method  common.RequestMethod
	Url     string
	Param   map[string]interface{}
	BaseURL common.BaseURL
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config *Config) *Client

NewClient 初始化rest api客户端

func (*Client) Run

func (r *Client) Run() (res *RestApiResult, err error)

func (*Client) SetMethod

func (r *Client) SetMethod(method common.RequestMethod) *Client

func (*Client) SetParam

func (r *Client) SetParam(param map[string]interface{}) *Client

func (*Client) SetUrl

func (r *Client) SetUrl(url string) *Client

type Config

type Config struct {
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(apiKey, secretKey, passPhrase string) *Config

type OkexApiResponse

type OkexApiResponse struct {
	Code string                   `json:"code"`
	Msg  string                   `json:"msg"`
	Data []map[string]interface{} `json:"data"`
}

OkexApiResponse 解析结果

type RestApiResult

type RestApiResult struct {
	Url           string          `json:"url"`
	Param         string          `json:"param"`
	Header        string          `json:"header"`
	Code          int             `json:"code"`
	Body          string          `json:"body"`       // 原始返回信息
	V5Response    OkexApiResponse `json:"v5Response"` // okexV5返回的数据
	ReqUsedTime   time.Duration   `json:"reqUsedTime"`
	TotalUsedTime time.Duration   `json:"totalUsedTime"`
}