Go API client for fuglego

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.1.0
• Package version: 1.0.0
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import fuglego "github.com/yitech/fugle-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value fuglego.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), fuglego.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value fuglego.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), fuglego.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using fuglego.ContextOperationServerIndices and fuglego.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), fuglego.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), fuglego.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
MarketAPI	GetCandlesApiV1HistoricalCandlesGet	Get /api/v1/historical/candles	Get Candles
MarketAPI	GetQuoteApiV1IntradayQuoteGet	Get /api/v1/intraday/quote	Get Quote
OrderAPI	CreateOrderEndpointApiV1OrderPost	Post /api/v1/order	Create Order Endpoint
OrderAPI	DeleteOrderEndpointApiV1OrderOrdNoDelete	Delete /api/v1/order/{ord_no}	Delete Order Endpoint
OrderAPI	GetMarketStatusEndpointApiV1MarketStatusGet	Get /api/v1/market_status	Get Market Status Endpoint
OrderAPI	GetOrdersEndpointApiV1OrdersGet	Get /api/v1/orders	Get Orders Endpoint
OrderAPI	GetTransactionEndpointApiV1TransactionsGet	Get /api/v1/transactions	Get Transaction Endpoint
SystemAPI	PingApiV1PingGet	Get /api/v1/ping	Ping
TradeAPI	GetTransactionEndpointApiV2TransactionsGet	Get /api/v2/transactions	Get Transaction Endpoint
WalletAPI	GetBalanceEndpointApiV1BalanceGet	Get /api/v1/balance	Get Balance Endpoint
WalletAPI	GetBalanceEndpointApiV2BalanceGet	Get /api/v2/balance	Get Balance Endpoint
WalletAPI	GetInventoriesEndpointApiV1InventoriesGet	Get /api/v1/inventories	Get Inventories Endpoint
WalletAPI	GetInventoriesEndpointApiV2InventoriesGet	Get /api/v2/inventories	Get Inventories Endpoint
WalletAPI	GetSettlementsEndpointApiV1SettlementsGet	Get /api/v1/settlements	Get Settlements Endpoint

Documentation For Models

• APCode
• Action
• AppSchemaV1OrderTransactionResponse
• AppSchemaV1WalletBalanceResponse
• AppSchemaV1WalletInventoryResponse
• AppSchemaV2TradeTransactionResponse
• AppSchemaV2WalletBalanceResponse
• AppSchemaV2WalletInventoryResponse
• BSFlag
• BidAsk
• CancelResponse
• CreateOrder
• HTTPValidationError
• InventoryDetail
• KLine
• KLinesResponse
• LastTrade
• LastTrial
• MarketStatusResponse
• MatDetail
• OrderResponse
• OrderResultResponse
• PriceFlag
• QuoteResponse
• SettlementResponse
• Total
• Trade
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author