public

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2023 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package public provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewGetApiV5PublicDeliveryExerciseHistoryRequest

func NewGetApiV5PublicDeliveryExerciseHistoryRequest(server string, params *GetApiV5PublicDeliveryExerciseHistoryParams) (*http.Request, error)

NewGetApiV5PublicDeliveryExerciseHistoryRequest generates requests for GetApiV5PublicDeliveryExerciseHistory

func NewGetApiV5PublicDiscountRateInterestFreeQuotaRequest

func NewGetApiV5PublicDiscountRateInterestFreeQuotaRequest(server string, params *GetApiV5PublicDiscountRateInterestFreeQuotaParams) (*http.Request, error)

NewGetApiV5PublicDiscountRateInterestFreeQuotaRequest generates requests for GetApiV5PublicDiscountRateInterestFreeQuota

func NewGetApiV5PublicEstimatedPriceRequest

func NewGetApiV5PublicEstimatedPriceRequest(server string, params *GetApiV5PublicEstimatedPriceParams) (*http.Request, error)

NewGetApiV5PublicEstimatedPriceRequest generates requests for GetApiV5PublicEstimatedPrice

func NewGetApiV5PublicFundingRateHistoryRequest

func NewGetApiV5PublicFundingRateHistoryRequest(server string, params *GetApiV5PublicFundingRateHistoryParams) (*http.Request, error)

NewGetApiV5PublicFundingRateHistoryRequest generates requests for GetApiV5PublicFundingRateHistory

func NewGetApiV5PublicFundingRateRequest

func NewGetApiV5PublicFundingRateRequest(server string, params *GetApiV5PublicFundingRateParams) (*http.Request, error)

NewGetApiV5PublicFundingRateRequest generates requests for GetApiV5PublicFundingRate

func NewGetApiV5PublicInstrumentsRequest

func NewGetApiV5PublicInstrumentsRequest(server string, params *GetApiV5PublicInstrumentsParams) (*http.Request, error)

NewGetApiV5PublicInstrumentsRequest generates requests for GetApiV5PublicInstruments

func NewGetApiV5PublicInsuranceFundRequest

func NewGetApiV5PublicInsuranceFundRequest(server string, params *GetApiV5PublicInsuranceFundParams) (*http.Request, error)

NewGetApiV5PublicInsuranceFundRequest generates requests for GetApiV5PublicInsuranceFund

func NewGetApiV5PublicInterestRateLoanQuotaRequest

func NewGetApiV5PublicInterestRateLoanQuotaRequest(server string) (*http.Request, error)

NewGetApiV5PublicInterestRateLoanQuotaRequest generates requests for GetApiV5PublicInterestRateLoanQuota

func NewGetApiV5PublicLiquidationOrdersRequest

func NewGetApiV5PublicLiquidationOrdersRequest(server string, params *GetApiV5PublicLiquidationOrdersParams) (*http.Request, error)

NewGetApiV5PublicLiquidationOrdersRequest generates requests for GetApiV5PublicLiquidationOrders

func NewGetApiV5PublicMarkPriceRequest

func NewGetApiV5PublicMarkPriceRequest(server string, params *GetApiV5PublicMarkPriceParams) (*http.Request, error)

NewGetApiV5PublicMarkPriceRequest generates requests for GetApiV5PublicMarkPrice

func NewGetApiV5PublicOpenInterestRequest

func NewGetApiV5PublicOpenInterestRequest(server string, params *GetApiV5PublicOpenInterestParams) (*http.Request, error)

NewGetApiV5PublicOpenInterestRequest generates requests for GetApiV5PublicOpenInterest

func NewGetApiV5PublicOptSummaryRequest

func NewGetApiV5PublicOptSummaryRequest(server string, params *GetApiV5PublicOptSummaryParams) (*http.Request, error)

NewGetApiV5PublicOptSummaryRequest generates requests for GetApiV5PublicOptSummary

func NewGetApiV5PublicPositionTiersRequest

func NewGetApiV5PublicPositionTiersRequest(server string, params *GetApiV5PublicPositionTiersParams) (*http.Request, error)

NewGetApiV5PublicPositionTiersRequest generates requests for GetApiV5PublicPositionTiers

func NewGetApiV5PublicPriceLimitRequest

func NewGetApiV5PublicPriceLimitRequest(server string, params *GetApiV5PublicPriceLimitParams) (*http.Request, error)

NewGetApiV5PublicPriceLimitRequest generates requests for GetApiV5PublicPriceLimit

func NewGetApiV5PublicTimeRequest

func NewGetApiV5PublicTimeRequest(server string) (*http.Request, error)

NewGetApiV5PublicTimeRequest generates requests for GetApiV5PublicTime

func NewGetApiV5PublicUnderlyingRequest

func NewGetApiV5PublicUnderlyingRequest(server string, params *GetApiV5PublicUnderlyingParams) (*http.Request, error)

NewGetApiV5PublicUnderlyingRequest generates requests for GetApiV5PublicUnderlying

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetApiV5PublicDeliveryExerciseHistory

func (c *Client) GetApiV5PublicDeliveryExerciseHistory(ctx context.Context, params *GetApiV5PublicDeliveryExerciseHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicDiscountRateInterestFreeQuota

func (c *Client) GetApiV5PublicDiscountRateInterestFreeQuota(ctx context.Context, params *GetApiV5PublicDiscountRateInterestFreeQuotaParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicEstimatedPrice

func (c *Client) GetApiV5PublicEstimatedPrice(ctx context.Context, params *GetApiV5PublicEstimatedPriceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicFundingRate

func (c *Client) GetApiV5PublicFundingRate(ctx context.Context, params *GetApiV5PublicFundingRateParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicFundingRateHistory

func (c *Client) GetApiV5PublicFundingRateHistory(ctx context.Context, params *GetApiV5PublicFundingRateHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicInstruments

func (c *Client) GetApiV5PublicInstruments(ctx context.Context, params *GetApiV5PublicInstrumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicInsuranceFund

func (c *Client) GetApiV5PublicInsuranceFund(ctx context.Context, params *GetApiV5PublicInsuranceFundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicInterestRateLoanQuota

func (c *Client) GetApiV5PublicInterestRateLoanQuota(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicLiquidationOrders

func (c *Client) GetApiV5PublicLiquidationOrders(ctx context.Context, params *GetApiV5PublicLiquidationOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicMarkPrice

func (c *Client) GetApiV5PublicMarkPrice(ctx context.Context, params *GetApiV5PublicMarkPriceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicOpenInterest

func (c *Client) GetApiV5PublicOpenInterest(ctx context.Context, params *GetApiV5PublicOpenInterestParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicOptSummary

func (c *Client) GetApiV5PublicOptSummary(ctx context.Context, params *GetApiV5PublicOptSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicPositionTiers

func (c *Client) GetApiV5PublicPositionTiers(ctx context.Context, params *GetApiV5PublicPositionTiersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicPriceLimit

func (c *Client) GetApiV5PublicPriceLimit(ctx context.Context, params *GetApiV5PublicPriceLimitParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicTime

func (c *Client) GetApiV5PublicTime(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV5PublicUnderlying

func (c *Client) GetApiV5PublicUnderlying(ctx context.Context, params *GetApiV5PublicUnderlyingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetApiV5PublicDeliveryExerciseHistory request
	GetApiV5PublicDeliveryExerciseHistory(ctx context.Context, params *GetApiV5PublicDeliveryExerciseHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicDiscountRateInterestFreeQuota request
	GetApiV5PublicDiscountRateInterestFreeQuota(ctx context.Context, params *GetApiV5PublicDiscountRateInterestFreeQuotaParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicEstimatedPrice request
	GetApiV5PublicEstimatedPrice(ctx context.Context, params *GetApiV5PublicEstimatedPriceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicFundingRate request
	GetApiV5PublicFundingRate(ctx context.Context, params *GetApiV5PublicFundingRateParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicFundingRateHistory request
	GetApiV5PublicFundingRateHistory(ctx context.Context, params *GetApiV5PublicFundingRateHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicInstruments request
	GetApiV5PublicInstruments(ctx context.Context, params *GetApiV5PublicInstrumentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicInsuranceFund request
	GetApiV5PublicInsuranceFund(ctx context.Context, params *GetApiV5PublicInsuranceFundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicInterestRateLoanQuota request
	GetApiV5PublicInterestRateLoanQuota(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicLiquidationOrders request
	GetApiV5PublicLiquidationOrders(ctx context.Context, params *GetApiV5PublicLiquidationOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicMarkPrice request
	GetApiV5PublicMarkPrice(ctx context.Context, params *GetApiV5PublicMarkPriceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicOpenInterest request
	GetApiV5PublicOpenInterest(ctx context.Context, params *GetApiV5PublicOpenInterestParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicOptSummary request
	GetApiV5PublicOptSummary(ctx context.Context, params *GetApiV5PublicOptSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicPositionTiers request
	GetApiV5PublicPositionTiers(ctx context.Context, params *GetApiV5PublicPositionTiersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicPriceLimit request
	GetApiV5PublicPriceLimit(ctx context.Context, params *GetApiV5PublicPriceLimitParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicTime request
	GetApiV5PublicTime(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV5PublicUnderlying request
	GetApiV5PublicUnderlying(ctx context.Context, params *GetApiV5PublicUnderlyingParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetApiV5PublicDeliveryExerciseHistoryWithResponse

func (c *ClientWithResponses) GetApiV5PublicDeliveryExerciseHistoryWithResponse(ctx context.Context, params *GetApiV5PublicDeliveryExerciseHistoryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicDeliveryExerciseHistoryResponse, error)

GetApiV5PublicDeliveryExerciseHistoryWithResponse request returning *GetApiV5PublicDeliveryExerciseHistoryResponse

func (*ClientWithResponses) GetApiV5PublicDiscountRateInterestFreeQuotaWithResponse

func (c *ClientWithResponses) GetApiV5PublicDiscountRateInterestFreeQuotaWithResponse(ctx context.Context, params *GetApiV5PublicDiscountRateInterestFreeQuotaParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicDiscountRateInterestFreeQuotaResponse, error)

GetApiV5PublicDiscountRateInterestFreeQuotaWithResponse request returning *GetApiV5PublicDiscountRateInterestFreeQuotaResponse

func (*ClientWithResponses) GetApiV5PublicEstimatedPriceWithResponse

func (c *ClientWithResponses) GetApiV5PublicEstimatedPriceWithResponse(ctx context.Context, params *GetApiV5PublicEstimatedPriceParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicEstimatedPriceResponse, error)

GetApiV5PublicEstimatedPriceWithResponse request returning *GetApiV5PublicEstimatedPriceResponse

func (*ClientWithResponses) GetApiV5PublicFundingRateHistoryWithResponse

func (c *ClientWithResponses) GetApiV5PublicFundingRateHistoryWithResponse(ctx context.Context, params *GetApiV5PublicFundingRateHistoryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicFundingRateHistoryResponse, error)

GetApiV5PublicFundingRateHistoryWithResponse request returning *GetApiV5PublicFundingRateHistoryResponse

func (*ClientWithResponses) GetApiV5PublicFundingRateWithResponse

func (c *ClientWithResponses) GetApiV5PublicFundingRateWithResponse(ctx context.Context, params *GetApiV5PublicFundingRateParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicFundingRateResponse, error)

GetApiV5PublicFundingRateWithResponse request returning *GetApiV5PublicFundingRateResponse

func (*ClientWithResponses) GetApiV5PublicInstrumentsWithResponse

func (c *ClientWithResponses) GetApiV5PublicInstrumentsWithResponse(ctx context.Context, params *GetApiV5PublicInstrumentsParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicInstrumentsResponse, error)

GetApiV5PublicInstrumentsWithResponse request returning *GetApiV5PublicInstrumentsResponse

func (*ClientWithResponses) GetApiV5PublicInsuranceFundWithResponse

func (c *ClientWithResponses) GetApiV5PublicInsuranceFundWithResponse(ctx context.Context, params *GetApiV5PublicInsuranceFundParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicInsuranceFundResponse, error)

GetApiV5PublicInsuranceFundWithResponse request returning *GetApiV5PublicInsuranceFundResponse

func (*ClientWithResponses) GetApiV5PublicInterestRateLoanQuotaWithResponse

func (c *ClientWithResponses) GetApiV5PublicInterestRateLoanQuotaWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV5PublicInterestRateLoanQuotaResponse, error)

GetApiV5PublicInterestRateLoanQuotaWithResponse request returning *GetApiV5PublicInterestRateLoanQuotaResponse

func (*ClientWithResponses) GetApiV5PublicLiquidationOrdersWithResponse

func (c *ClientWithResponses) GetApiV5PublicLiquidationOrdersWithResponse(ctx context.Context, params *GetApiV5PublicLiquidationOrdersParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicLiquidationOrdersResponse, error)

GetApiV5PublicLiquidationOrdersWithResponse request returning *GetApiV5PublicLiquidationOrdersResponse

func (*ClientWithResponses) GetApiV5PublicMarkPriceWithResponse

func (c *ClientWithResponses) GetApiV5PublicMarkPriceWithResponse(ctx context.Context, params *GetApiV5PublicMarkPriceParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicMarkPriceResponse, error)

GetApiV5PublicMarkPriceWithResponse request returning *GetApiV5PublicMarkPriceResponse

func (*ClientWithResponses) GetApiV5PublicOpenInterestWithResponse

func (c *ClientWithResponses) GetApiV5PublicOpenInterestWithResponse(ctx context.Context, params *GetApiV5PublicOpenInterestParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicOpenInterestResponse, error)

GetApiV5PublicOpenInterestWithResponse request returning *GetApiV5PublicOpenInterestResponse

func (*ClientWithResponses) GetApiV5PublicOptSummaryWithResponse

func (c *ClientWithResponses) GetApiV5PublicOptSummaryWithResponse(ctx context.Context, params *GetApiV5PublicOptSummaryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicOptSummaryResponse, error)

GetApiV5PublicOptSummaryWithResponse request returning *GetApiV5PublicOptSummaryResponse

func (*ClientWithResponses) GetApiV5PublicPositionTiersWithResponse

func (c *ClientWithResponses) GetApiV5PublicPositionTiersWithResponse(ctx context.Context, params *GetApiV5PublicPositionTiersParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicPositionTiersResponse, error)

GetApiV5PublicPositionTiersWithResponse request returning *GetApiV5PublicPositionTiersResponse

func (*ClientWithResponses) GetApiV5PublicPriceLimitWithResponse

func (c *ClientWithResponses) GetApiV5PublicPriceLimitWithResponse(ctx context.Context, params *GetApiV5PublicPriceLimitParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicPriceLimitResponse, error)

GetApiV5PublicPriceLimitWithResponse request returning *GetApiV5PublicPriceLimitResponse

func (*ClientWithResponses) GetApiV5PublicTimeWithResponse

func (c *ClientWithResponses) GetApiV5PublicTimeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV5PublicTimeResponse, error)

GetApiV5PublicTimeWithResponse request returning *GetApiV5PublicTimeResponse

func (*ClientWithResponses) GetApiV5PublicUnderlyingWithResponse

func (c *ClientWithResponses) GetApiV5PublicUnderlyingWithResponse(ctx context.Context, params *GetApiV5PublicUnderlyingParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicUnderlyingResponse, error)

GetApiV5PublicUnderlyingWithResponse request returning *GetApiV5PublicUnderlyingResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetApiV5PublicDeliveryExerciseHistory request
	GetApiV5PublicDeliveryExerciseHistoryWithResponse(ctx context.Context, params *GetApiV5PublicDeliveryExerciseHistoryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicDeliveryExerciseHistoryResponse, error)

	// GetApiV5PublicDiscountRateInterestFreeQuota request
	GetApiV5PublicDiscountRateInterestFreeQuotaWithResponse(ctx context.Context, params *GetApiV5PublicDiscountRateInterestFreeQuotaParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicDiscountRateInterestFreeQuotaResponse, error)

	// GetApiV5PublicEstimatedPrice request
	GetApiV5PublicEstimatedPriceWithResponse(ctx context.Context, params *GetApiV5PublicEstimatedPriceParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicEstimatedPriceResponse, error)

	// GetApiV5PublicFundingRate request
	GetApiV5PublicFundingRateWithResponse(ctx context.Context, params *GetApiV5PublicFundingRateParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicFundingRateResponse, error)

	// GetApiV5PublicFundingRateHistory request
	GetApiV5PublicFundingRateHistoryWithResponse(ctx context.Context, params *GetApiV5PublicFundingRateHistoryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicFundingRateHistoryResponse, error)

	// GetApiV5PublicInstruments request
	GetApiV5PublicInstrumentsWithResponse(ctx context.Context, params *GetApiV5PublicInstrumentsParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicInstrumentsResponse, error)

	// GetApiV5PublicInsuranceFund request
	GetApiV5PublicInsuranceFundWithResponse(ctx context.Context, params *GetApiV5PublicInsuranceFundParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicInsuranceFundResponse, error)

	// GetApiV5PublicInterestRateLoanQuota request
	GetApiV5PublicInterestRateLoanQuotaWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV5PublicInterestRateLoanQuotaResponse, error)

	// GetApiV5PublicLiquidationOrders request
	GetApiV5PublicLiquidationOrdersWithResponse(ctx context.Context, params *GetApiV5PublicLiquidationOrdersParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicLiquidationOrdersResponse, error)

	// GetApiV5PublicMarkPrice request
	GetApiV5PublicMarkPriceWithResponse(ctx context.Context, params *GetApiV5PublicMarkPriceParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicMarkPriceResponse, error)

	// GetApiV5PublicOpenInterest request
	GetApiV5PublicOpenInterestWithResponse(ctx context.Context, params *GetApiV5PublicOpenInterestParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicOpenInterestResponse, error)

	// GetApiV5PublicOptSummary request
	GetApiV5PublicOptSummaryWithResponse(ctx context.Context, params *GetApiV5PublicOptSummaryParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicOptSummaryResponse, error)

	// GetApiV5PublicPositionTiers request
	GetApiV5PublicPositionTiersWithResponse(ctx context.Context, params *GetApiV5PublicPositionTiersParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicPositionTiersResponse, error)

	// GetApiV5PublicPriceLimit request
	GetApiV5PublicPriceLimitWithResponse(ctx context.Context, params *GetApiV5PublicPriceLimitParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicPriceLimitResponse, error)

	// GetApiV5PublicTime request
	GetApiV5PublicTimeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV5PublicTimeResponse, error)

	// GetApiV5PublicUnderlying request
	GetApiV5PublicUnderlyingWithResponse(ctx context.Context, params *GetApiV5PublicUnderlyingParams, reqEditors ...RequestEditorFn) (*GetApiV5PublicUnderlyingResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type GetApiV5PublicDeliveryExerciseHistoryParams

type GetApiV5PublicDeliveryExerciseHistoryParams struct {
	// 产品类型<br>`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 合约标的指数,如:`BTC-USD`<br>仅适用于`交割/期权`
	Uly string `json:"uly"`

	// 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的`ts`
	After *string `json:"after,omitempty"`

	// 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的`ts`
	Before *string `json:"before,omitempty"`

	// 分页返回的结果集数量,最大为100,不填默认返回100条
	Limit *string `json:"limit,omitempty"`
}

GetApiV5PublicDeliveryExerciseHistoryParams defines parameters for GetApiV5PublicDeliveryExerciseHistory.

type GetApiV5PublicDeliveryExerciseHistoryResponse

type GetApiV5PublicDeliveryExerciseHistoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicDeliveryExerciseHistoryResponse

func ParseGetApiV5PublicDeliveryExerciseHistoryResponse(rsp *http.Response) (*GetApiV5PublicDeliveryExerciseHistoryResponse, error)

ParseGetApiV5PublicDeliveryExerciseHistoryResponse parses an HTTP response from a GetApiV5PublicDeliveryExerciseHistoryWithResponse call

func (GetApiV5PublicDeliveryExerciseHistoryResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicDeliveryExerciseHistoryResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicDiscountRateInterestFreeQuotaParams

type GetApiV5PublicDiscountRateInterestFreeQuotaParams struct {
	// 币种,如:`BTC`
	Ccy *string `json:"ccy,omitempty"`

	// 折算率等级<br>`1`:第一档,`2`:第二档,`3`:第三档,`4`:第四档,`5`:第五档
	DiscountLv *string `json:"discountLv,omitempty"`
}

GetApiV5PublicDiscountRateInterestFreeQuotaParams defines parameters for GetApiV5PublicDiscountRateInterestFreeQuota.

type GetApiV5PublicDiscountRateInterestFreeQuotaResponse

type GetApiV5PublicDiscountRateInterestFreeQuotaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicDiscountRateInterestFreeQuotaResponse

func ParseGetApiV5PublicDiscountRateInterestFreeQuotaResponse(rsp *http.Response) (*GetApiV5PublicDiscountRateInterestFreeQuotaResponse, error)

ParseGetApiV5PublicDiscountRateInterestFreeQuotaResponse parses an HTTP response from a GetApiV5PublicDiscountRateInterestFreeQuotaWithResponse call

func (GetApiV5PublicDiscountRateInterestFreeQuotaResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicDiscountRateInterestFreeQuotaResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicEstimatedPriceParams

type GetApiV5PublicEstimatedPriceParams struct {
	// 产品ID,如:`BTC-USD-200214`<br>适用于`交割/期权`
	InstId string `json:"instId"`
}

GetApiV5PublicEstimatedPriceParams defines parameters for GetApiV5PublicEstimatedPrice.

type GetApiV5PublicEstimatedPriceResponse

type GetApiV5PublicEstimatedPriceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicEstimatedPriceResponse

func ParseGetApiV5PublicEstimatedPriceResponse(rsp *http.Response) (*GetApiV5PublicEstimatedPriceResponse, error)

ParseGetApiV5PublicEstimatedPriceResponse parses an HTTP response from a GetApiV5PublicEstimatedPriceWithResponse call

func (GetApiV5PublicEstimatedPriceResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicEstimatedPriceResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicFundingRateHistoryParams

type GetApiV5PublicFundingRateHistoryParams struct {
	// 产品ID,如:`BTC-USDT-SWAP`<br>仅适用于`永续`
	InstId *string `json:"instId,omitempty"`

	// 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的`fundingTime`
	After *string `json:"after,omitempty"`

	// 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的`fundingTime`
	Before *string `json:"before,omitempty"`

	// 分页返回的结果集数量,最大为100,不填默认返回100条
	Limit *string `json:"limit,omitempty"`
}

GetApiV5PublicFundingRateHistoryParams defines parameters for GetApiV5PublicFundingRateHistory.

type GetApiV5PublicFundingRateHistoryResponse

type GetApiV5PublicFundingRateHistoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicFundingRateHistoryResponse

func ParseGetApiV5PublicFundingRateHistoryResponse(rsp *http.Response) (*GetApiV5PublicFundingRateHistoryResponse, error)

ParseGetApiV5PublicFundingRateHistoryResponse parses an HTTP response from a GetApiV5PublicFundingRateHistoryWithResponse call

func (GetApiV5PublicFundingRateHistoryResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicFundingRateHistoryResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicFundingRateParams

type GetApiV5PublicFundingRateParams struct {
	// 产品ID,如:`BTC-USDT-SWAP`<br>仅适用于`永续`
	InstId *string `json:"instId,omitempty"`
}

GetApiV5PublicFundingRateParams defines parameters for GetApiV5PublicFundingRate.

type GetApiV5PublicFundingRateResponse

type GetApiV5PublicFundingRateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicFundingRateResponse

func ParseGetApiV5PublicFundingRateResponse(rsp *http.Response) (*GetApiV5PublicFundingRateResponse, error)

ParseGetApiV5PublicFundingRateResponse parses an HTTP response from a GetApiV5PublicFundingRateWithResponse call

func (GetApiV5PublicFundingRateResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicFundingRateResponse) StatusCode

func (r GetApiV5PublicFundingRateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicInstrumentsParams

type GetApiV5PublicInstrumentsParams struct {
	// 产品类型<br>`SPOT`:币币;`MARGIN`:币币杠杆;`SWAP`:永续合约 `FUTURES`:交割合约;`OPTION`:期权
	InstType string `json:"instType"`

	// 合约标的指数,如:`BTC-USD`<br>仅适用于`交割/永续/期权`,`期权`必填
	Uly *string `json:"uly,omitempty"`

	// 产品ID,如 `BTC-USDT`
	InstId *string `json:"instId,omitempty"`
}

GetApiV5PublicInstrumentsParams defines parameters for GetApiV5PublicInstruments.

type GetApiV5PublicInstrumentsResponse

type GetApiV5PublicInstrumentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicInstrumentsResponse

func ParseGetApiV5PublicInstrumentsResponse(rsp *http.Response) (*GetApiV5PublicInstrumentsResponse, error)

ParseGetApiV5PublicInstrumentsResponse parses an HTTP response from a GetApiV5PublicInstrumentsWithResponse call

func (GetApiV5PublicInstrumentsResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicInstrumentsResponse) StatusCode

func (r GetApiV5PublicInstrumentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicInsuranceFundParams

type GetApiV5PublicInsuranceFundParams struct {
	// 产品类型<br>`MARGIN`:币币杠杆,`SWAP`:永续合约,`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 产品类型<br>`liquidation_balance_deposit`:强平注入,`bankruptcy_loss`:穿仓亏损,`platform_revenue`:平台收入注入
	Type *string `json:"type,omitempty"`

	// 标的指数<br>仅适用于`交割/永续/期权`,且必填写
	Uly *string `json:"uly,omitempty"`

	// 币种,仅适用`币币杠杆`,且必填写
	Ccy *string `json:"ccy,omitempty"`

	// 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的`ts`
	Before *string `json:"before,omitempty"`

	// 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的`ts`
	After *string `json:"after,omitempty"`

	// 分页返回的结果集数量,最大为100,不填默认返回100条
	Limit *string `json:"limit,omitempty"`
}

GetApiV5PublicInsuranceFundParams defines parameters for GetApiV5PublicInsuranceFund.

type GetApiV5PublicInsuranceFundResponse

type GetApiV5PublicInsuranceFundResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicInsuranceFundResponse

func ParseGetApiV5PublicInsuranceFundResponse(rsp *http.Response) (*GetApiV5PublicInsuranceFundResponse, error)

ParseGetApiV5PublicInsuranceFundResponse parses an HTTP response from a GetApiV5PublicInsuranceFundWithResponse call

func (GetApiV5PublicInsuranceFundResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicInsuranceFundResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicInterestRateLoanQuotaResponse

type GetApiV5PublicInterestRateLoanQuotaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicInterestRateLoanQuotaResponse

func ParseGetApiV5PublicInterestRateLoanQuotaResponse(rsp *http.Response) (*GetApiV5PublicInterestRateLoanQuotaResponse, error)

ParseGetApiV5PublicInterestRateLoanQuotaResponse parses an HTTP response from a GetApiV5PublicInterestRateLoanQuotaWithResponse call

func (GetApiV5PublicInterestRateLoanQuotaResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicInterestRateLoanQuotaResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicLiquidationOrdersParams

type GetApiV5PublicLiquidationOrdersParams struct {
	// 产品类型<br>`MARGIN`:币币杠杆,`SWAP`:永续合约,`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 保证金模式<br>`cross`:全仓,`isolated`:逐仓
	MgnMode *string `json:"mgnMode,omitempty"`

	// 产品ID,仅适用于`币币杠杆`
	InstId *string `json:"instId,omitempty"`

	// 币种,仅适用于全仓`币币杠杆`
	Ccy *string `json:"ccy,omitempty"`

	// 合约标的指数<br>`交割/永续/期权`合约情况下,该参数必填
	Uly *string `json:"uly,omitempty"`

	// `this_week`:本周,`next_week`:次周,`quarter`:季度,`next_quarter`:次季度<br>`交割`合约情况下,该参数必填
	Alias *string `json:"alias,omitempty"`

	// 状态<br>`unfilled`:未成交,`filled`:已成交<br>默认为`unfilled`<br>`交割/永续`合约情况下,该参数必填
	State *string `json:"state,omitempty"`

	// 请求此时间戳之前(更旧的数据)的分页内容,传的值为对应接口的`ts`
	After *string `json:"after,omitempty"`

	// 请求此时间戳之后(更新的数据)的分页内容,传的值为对应接口的`ts`
	Before *string `json:"before,omitempty"`

	// 分页返回的结果集数量,最大为100,不填默认返回100条
	Limit *string `json:"limit,omitempty"`
}

GetApiV5PublicLiquidationOrdersParams defines parameters for GetApiV5PublicLiquidationOrders.

type GetApiV5PublicLiquidationOrdersResponse

type GetApiV5PublicLiquidationOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicLiquidationOrdersResponse

func ParseGetApiV5PublicLiquidationOrdersResponse(rsp *http.Response) (*GetApiV5PublicLiquidationOrdersResponse, error)

ParseGetApiV5PublicLiquidationOrdersResponse parses an HTTP response from a GetApiV5PublicLiquidationOrdersWithResponse call

func (GetApiV5PublicLiquidationOrdersResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicLiquidationOrdersResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicMarkPriceParams

type GetApiV5PublicMarkPriceParams struct {
	// 产品类型<br>`MARGIN`:币币杠杆,`SWAP`:永续合约,`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 产品ID,如:`BTC-USDT-SWAP`
	InstId *string `json:"instId,omitempty"`

	// 合约标的指数,如:`BTC-USD`
	Uly *string `json:"uly,omitempty"`
}

GetApiV5PublicMarkPriceParams defines parameters for GetApiV5PublicMarkPrice.

type GetApiV5PublicMarkPriceResponse

type GetApiV5PublicMarkPriceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicMarkPriceResponse

func ParseGetApiV5PublicMarkPriceResponse(rsp *http.Response) (*GetApiV5PublicMarkPriceResponse, error)

ParseGetApiV5PublicMarkPriceResponse parses an HTTP response from a GetApiV5PublicMarkPriceWithResponse call

func (GetApiV5PublicMarkPriceResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicMarkPriceResponse) StatusCode

func (r GetApiV5PublicMarkPriceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicOpenInterestParams

type GetApiV5PublicOpenInterestParams struct {
	// 产品类型<br>`FUTURES`:交割合约,`SWAP`:永续合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 合约标的指数,如:`BTC-USD`<br>仅适用于`交割/永续/期权`
	Uly *string `json:"uly,omitempty"`

	// 产品ID,如:`BTC-USD-SWAP`<br>仅适用于`交割/永续/期权`
	InstId *string `json:"instId,omitempty"`
}

GetApiV5PublicOpenInterestParams defines parameters for GetApiV5PublicOpenInterest.

type GetApiV5PublicOpenInterestResponse

type GetApiV5PublicOpenInterestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicOpenInterestResponse

func ParseGetApiV5PublicOpenInterestResponse(rsp *http.Response) (*GetApiV5PublicOpenInterestResponse, error)

ParseGetApiV5PublicOpenInterestResponse parses an HTTP response from a GetApiV5PublicOpenInterestWithResponse call

func (GetApiV5PublicOpenInterestResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicOpenInterestResponse) StatusCode

func (r GetApiV5PublicOpenInterestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicOptSummaryParams

type GetApiV5PublicOptSummaryParams struct {
	// 合约标的指数,如:`BTC-USD-200103-5500-C`<br>仅适用于`期权`
	Uly string `json:"uly"`

	// 合约到期日,格式为`YYMMDD`,如 `200527`
	ExpTime string `json:"expTime"`
}

GetApiV5PublicOptSummaryParams defines parameters for GetApiV5PublicOptSummary.

type GetApiV5PublicOptSummaryResponse

type GetApiV5PublicOptSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicOptSummaryResponse

func ParseGetApiV5PublicOptSummaryResponse(rsp *http.Response) (*GetApiV5PublicOptSummaryResponse, error)

ParseGetApiV5PublicOptSummaryResponse parses an HTTP response from a GetApiV5PublicOptSummaryWithResponse call

func (GetApiV5PublicOptSummaryResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicOptSummaryResponse) StatusCode

func (r GetApiV5PublicOptSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicPositionTiersParams

type GetApiV5PublicPositionTiersParams struct {
	// 产品类型<br>`MARGIN`:币币杠杆,`SWAP`:永续合约,`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`

	// 交易模式<br>`isolated`:逐仓,`cross`:全仓
	TdMode string `json:"tdMode"`

	// 产品ID,如:`BTC-USDT`<br>仅适用`币币杠杆`,且必填
	InstId *string `json:"instId,omitempty"`

	// 合约标的指数,如:`BTC-USD`<br>仅适用于`交割/永续/期权`,且必填
	Uly *string `json:"uly,omitempty"`

	// 指定档位
	Tier *string `json:"tier,omitempty"`
}

GetApiV5PublicPositionTiersParams defines parameters for GetApiV5PublicPositionTiers.

type GetApiV5PublicPositionTiersResponse

type GetApiV5PublicPositionTiersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicPositionTiersResponse

func ParseGetApiV5PublicPositionTiersResponse(rsp *http.Response) (*GetApiV5PublicPositionTiersResponse, error)

ParseGetApiV5PublicPositionTiersResponse parses an HTTP response from a GetApiV5PublicPositionTiersWithResponse call

func (GetApiV5PublicPositionTiersResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicPositionTiersResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicPriceLimitParams

type GetApiV5PublicPriceLimitParams struct {
	// 产品ID,如:`BTC-USDT-SWAP`<br>适用于`交割/永续/期权`
	InstId string `json:"instId"`
}

GetApiV5PublicPriceLimitParams defines parameters for GetApiV5PublicPriceLimit.

type GetApiV5PublicPriceLimitResponse

type GetApiV5PublicPriceLimitResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicPriceLimitResponse

func ParseGetApiV5PublicPriceLimitResponse(rsp *http.Response) (*GetApiV5PublicPriceLimitResponse, error)

ParseGetApiV5PublicPriceLimitResponse parses an HTTP response from a GetApiV5PublicPriceLimitWithResponse call

func (GetApiV5PublicPriceLimitResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicPriceLimitResponse) StatusCode

func (r GetApiV5PublicPriceLimitResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicTimeResponse

type GetApiV5PublicTimeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicTimeResponse

func ParseGetApiV5PublicTimeResponse(rsp *http.Response) (*GetApiV5PublicTimeResponse, error)

ParseGetApiV5PublicTimeResponse parses an HTTP response from a GetApiV5PublicTimeWithResponse call

func (GetApiV5PublicTimeResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicTimeResponse) StatusCode

func (r GetApiV5PublicTimeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV5PublicUnderlyingParams

type GetApiV5PublicUnderlyingParams struct {
	// 产品类型<br>`SWAP`:永续合约,`FUTURES`:交割合约,`OPTION`:期权
	InstType string `json:"instType"`
}

GetApiV5PublicUnderlyingParams defines parameters for GetApiV5PublicUnderlying.

type GetApiV5PublicUnderlyingResponse

type GetApiV5PublicUnderlyingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetApiV5PublicUnderlyingResponse

func ParseGetApiV5PublicUnderlyingResponse(rsp *http.Response) (*GetApiV5PublicUnderlyingResponse, error)

ParseGetApiV5PublicUnderlyingResponse parses an HTTP response from a GetApiV5PublicUnderlyingWithResponse call

func (GetApiV5PublicUnderlyingResponse) Status

Status returns HTTPResponse.Status

func (GetApiV5PublicUnderlyingResponse) StatusCode

func (r GetApiV5PublicUnderlyingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL