api

Documentation

Index

• Constants
• Variables
• type DynamicPathRequest
  • func (r *DynamicPathRequest) Do(ctx context.Context) (*NoParamResponse, error)
  • func (r *DynamicPathRequest) GetDynamicPath() (string, error)
  • func (r *DynamicPathRequest) GetParameters() (map[string]interface{}, error)
  • func (r *DynamicPathRequest) GetParametersJSON() ([]byte, error)
  • func (r *DynamicPathRequest) GetParametersQuery() (url.Values, error)
  • func (r *DynamicPathRequest) GetPath() string
  • func (r *DynamicPathRequest) GetQueryParameters() (url.Values, error)
  • func (r *DynamicPathRequest) GetSlugParameters() (map[string]interface{}, error)
  • func (r *DynamicPathRequest) GetSlugsMap() (map[string]string, error)
• type NoParamRequest
  • func (n *NoParamRequest) Do(ctx context.Context) (*NoParamResponse, error)
  • func (n *NoParamRequest) GetParameters() (map[string]interface{}, error)
  • func (n *NoParamRequest) GetParametersJSON() ([]byte, error)
  • func (n *NoParamRequest) GetParametersQuery() (url.Values, error)
  • func (n *NoParamRequest) GetPath() string
  • func (n *NoParamRequest) GetQueryParameters() (url.Values, error)
  • func (n *NoParamRequest) GetSlugParameters() (map[string]interface{}, error)
  • func (n *NoParamRequest) GetSlugsMap() (map[string]string, error)
• type NoParamResponse
• type ResponseValidator
  • func (n ResponseValidator) Validate() error
• type ResponseValidatorRequest
  • func (r *ResponseValidatorRequest) Do(ctx context.Context) (*ResponseValidator, error)
  • func (r *ResponseValidatorRequest) GetParameters() (map[string]interface{}, error)
  • func (r *ResponseValidatorRequest) GetParametersJSON() ([]byte, error)
  • func (r *ResponseValidatorRequest) GetParametersQuery() (url.Values, error)
  • func (r *ResponseValidatorRequest) GetPath() string
  • func (r *ResponseValidatorRequest) GetQueryParameters() (url.Values, error)
  • func (r *ResponseValidatorRequest) GetSlugParameters() (map[string]interface{}, error)
  • func (r *ResponseValidatorRequest) GetSlugsMap() (map[string]string, error)
• type RestClient
  • func NewClient() *RestClient
  • func (c *RestClient) Auth(key, secret, passphrase string)
  • func (c *RestClient) NewAuthenticatedRequest(ctx context.Context, method, refURL string, params url.Values, ...) (*http.Request, error)

Constants

const RestBaseURL = "https://api.kucoin.com/api"

const SandboxRestBaseURL = "https://openapi-sandbox.kucoin.com/api"

Variables

var DynamicPathRequestLimiter = rate.NewLimiter(5, 5)

Types

type DynamicPathRequest

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

func (*DynamicPathRequest) Do

func (r *DynamicPathRequest) Do(ctx context.Context) (*NoParamResponse, error)

Do generates the request object and send the request object to the API endpoint

func (*DynamicPathRequest) GetDynamicPath

func (r *DynamicPathRequest) GetDynamicPath() (string, error)

func (*DynamicPathRequest) GetParameters

func (r *DynamicPathRequest) GetParameters() (map[string]interface{}, error)

GetParameters builds and checks the parameters and return the result in a map object

func (*DynamicPathRequest) GetParametersJSON

func (r *DynamicPathRequest) GetParametersJSON() ([]byte, error)

GetParametersJSON converts the parameters from GetParameters into the JSON format

func (*DynamicPathRequest) GetParametersQuery

func (r *DynamicPathRequest) GetParametersQuery() (url.Values, error)

GetParametersQuery converts the parameters from GetParameters into the url.Values format

func (*DynamicPathRequest) GetPath

func (r *DynamicPathRequest) GetPath() string

GetPath returns the request path of the API

func (*DynamicPathRequest) GetQueryParameters

func (r *DynamicPathRequest) GetQueryParameters() (url.Values, error)

GetQueryParameters builds and checks the query parameters and returns url.Values

func (*DynamicPathRequest) GetSlugParameters

func (r *DynamicPathRequest) GetSlugParameters() (map[string]interface{}, error)

GetSlugParameters builds and checks the slug parameters and return the result in a map object

func (*DynamicPathRequest) GetSlugsMap

func (r *DynamicPathRequest) GetSlugsMap() (map[string]string, error)

type NoParamRequest

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

func (*NoParamRequest) Do

func (n *NoParamRequest) Do(ctx context.Context) (*NoParamResponse, error)

Do generates the request object and send the request object to the API endpoint

func (*NoParamRequest) GetParameters

func (n *NoParamRequest) GetParameters() (map[string]interface{}, error)

GetParameters builds and checks the parameters and return the result in a map object

func (*NoParamRequest) GetParametersJSON

func (n *NoParamRequest) GetParametersJSON() ([]byte, error)

GetParametersJSON converts the parameters from GetParameters into the JSON format

func (*NoParamRequest) GetParametersQuery

func (n *NoParamRequest) GetParametersQuery() (url.Values, error)

GetParametersQuery converts the parameters from GetParameters into the url.Values format

func (*NoParamRequest) GetPath

func (n *NoParamRequest) GetPath() string

GetPath returns the request path of the API

func (*NoParamRequest) GetQueryParameters

func (n *NoParamRequest) GetQueryParameters() (url.Values, error)

GetQueryParameters builds and checks the query parameters and returns url.Values

func (*NoParamRequest) GetSlugParameters

func (n *NoParamRequest) GetSlugParameters() (map[string]interface{}, error)

GetSlugParameters builds and checks the slug parameters and return the result in a map object

func (*NoParamRequest) GetSlugsMap

func (n *NoParamRequest) GetSlugsMap() (map[string]string, error)

type NoParamResponse

type NoParamResponse struct {
	ID string `json:"id"`
}

type ResponseValidator

type ResponseValidator struct {
	RetCode int    `json:"ret_code"`
	Msg     string `json:"msg"`
}

func (ResponseValidator) Validate

func (n ResponseValidator) Validate() error

type ResponseValidatorRequest

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

func (*ResponseValidatorRequest) Do

func (r *ResponseValidatorRequest) Do(ctx context.Context) (*ResponseValidator, error)

Do generates the request object and send the request object to the API endpoint

func (*ResponseValidatorRequest) GetParameters

func (r *ResponseValidatorRequest) GetParameters() (map[string]interface{}, error)

GetParameters builds and checks the parameters and return the result in a map object

func (*ResponseValidatorRequest) GetParametersJSON

func (r *ResponseValidatorRequest) GetParametersJSON() ([]byte, error)

GetParametersJSON converts the parameters from GetParameters into the JSON format

func (*ResponseValidatorRequest) GetParametersQuery

func (r *ResponseValidatorRequest) GetParametersQuery() (url.Values, error)

GetParametersQuery converts the parameters from GetParameters into the url.Values format

func (*ResponseValidatorRequest) GetPath

func (r *ResponseValidatorRequest) GetPath() string

GetPath returns the request path of the API

func (*ResponseValidatorRequest) GetQueryParameters

func (r *ResponseValidatorRequest) GetQueryParameters() (url.Values, error)

GetQueryParameters builds and checks the query parameters and returns url.Values

func (*ResponseValidatorRequest) GetSlugParameters

func (r *ResponseValidatorRequest) GetSlugParameters() (map[string]interface{}, error)

GetSlugParameters builds and checks the slug parameters and return the result in a map object

func (*ResponseValidatorRequest) GetSlugsMap

func (r *ResponseValidatorRequest) GetSlugsMap() (map[string]string, error)

type RestClient

type RestClient struct {
	requestgen.BaseAPIClient

	Key, Secret, Passphrase string
	KeyVersion              string
}

func NewClient

func NewClient() *RestClient

func (*RestClient) Auth

func (c *RestClient) Auth(key, secret, passphrase string)

func (*RestClient) NewAuthenticatedRequest

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

NewAuthenticatedRequest creates new http request for authenticated routes.