instrument

package
v1.0.8 Latest Latest
Warning

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

 Go to latest Published: Oct 11, 2020 License: LGPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for instrument API

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client

New creates a new instrument API client.

func (*Client) InstrumentGet 

func (a *Client) InstrumentGet(params *InstrumentGetParams) (*InstrumentGetOK, error)

InstrumentGet gets instruments

This returns all instruments and indices, including those that have settled or are unlisted. Use this endpoint if you want to query for individual instruments or use a complex filter. Use `/instrument/active` to return active instruments, or use a filter like `{"state": "Open"}`.

func (*Client) InstrumentGetActive 

func (a *Client) InstrumentGetActive(params *InstrumentGetActiveParams) (*InstrumentGetActiveOK, error)

InstrumentGetActive gets all active instruments and instruments that have expired in 24hrs

func (*Client) InstrumentGetActiveAndIndices 

func (a *Client) InstrumentGetActiveAndIndices(params *InstrumentGetActiveAndIndicesParams) (*InstrumentGetActiveAndIndicesOK, error)

InstrumentGetActiveAndIndices helpers method gets all active instruments and all indices this is a join of the result of indices and active

func (*Client) InstrumentGetActiveIntervals 

func (a *Client) InstrumentGetActiveIntervals(params *InstrumentGetActiveIntervalsParams) (*InstrumentGetActiveIntervalsOK, error)

InstrumentGetActiveIntervals returns all active contract series and interval pairs

This endpoint is useful for determining which pairs are live. It returns two arrays of strings. The first is intervals, such as `["XBT:perpetual", "XBT:monthly", "XBT:quarterly", "ETH:monthly", ...]`. These identifiers are usable in any query's `symbol` param. The second array is the current resolution of these intervals. Results are mapped at the same index.

func (*Client) InstrumentGetCompositeIndex 

func (a *Client) InstrumentGetCompositeIndex(params *InstrumentGetCompositeIndexParams) (*InstrumentGetCompositeIndexOK, error)

InstrumentGetCompositeIndex shows constituent parts of an index

Composite indices are built from multiple external price sources.

Use this endpoint to get the underlying prices of an index. For example, send a `symbol` of `.XBT` to get the ticks and weights of the constituent exchanges that build the ".XBT" index.

A tick with reference `"BMI"` and weight `null` is the composite index tick.

func (*Client) InstrumentGetIndices 

func (a *Client) InstrumentGetIndices(params *InstrumentGetIndicesParams) (*InstrumentGetIndicesOK, error)

InstrumentGetIndices gets all price indices

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type InstrumentGetActiveAndIndicesBadRequest 

type InstrumentGetActiveAndIndicesBadRequest struct {
	Payload *models.Error
}

InstrumentGetActiveAndIndicesBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetActiveAndIndicesBadRequest 

func NewInstrumentGetActiveAndIndicesBadRequest() *InstrumentGetActiveAndIndicesBadRequest

NewInstrumentGetActiveAndIndicesBadRequest creates a InstrumentGetActiveAndIndicesBadRequest with default headers values

func (*InstrumentGetActiveAndIndicesBadRequest) Error 

func (o *InstrumentGetActiveAndIndicesBadRequest) Error() string

type InstrumentGetActiveAndIndicesNotFound 

type InstrumentGetActiveAndIndicesNotFound struct {
	Payload *models.Error
}

InstrumentGetActiveAndIndicesNotFound handles this case with default header values.

Not Found

func NewInstrumentGetActiveAndIndicesNotFound 

func NewInstrumentGetActiveAndIndicesNotFound() *InstrumentGetActiveAndIndicesNotFound

NewInstrumentGetActiveAndIndicesNotFound creates a InstrumentGetActiveAndIndicesNotFound with default headers values

func (*InstrumentGetActiveAndIndicesNotFound) Error 

func (o *InstrumentGetActiveAndIndicesNotFound) Error() string

type InstrumentGetActiveAndIndicesOK 

type InstrumentGetActiveAndIndicesOK struct {
	Payload []*models.Instrument
}

InstrumentGetActiveAndIndicesOK handles this case with default header values.

Request was successful

func NewInstrumentGetActiveAndIndicesOK 

func NewInstrumentGetActiveAndIndicesOK() *InstrumentGetActiveAndIndicesOK

NewInstrumentGetActiveAndIndicesOK creates a InstrumentGetActiveAndIndicesOK with default headers values

func (*InstrumentGetActiveAndIndicesOK) Error 

func (o *InstrumentGetActiveAndIndicesOK) Error() string

type InstrumentGetActiveAndIndicesParams 

type InstrumentGetActiveAndIndicesParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetActiveAndIndicesParams contains all the parameters to send to the API endpoint for the instrument get active and indices operation typically these are written to a http.Request

func NewInstrumentGetActiveAndIndicesParams 

func NewInstrumentGetActiveAndIndicesParams() *InstrumentGetActiveAndIndicesParams

NewInstrumentGetActiveAndIndicesParams creates a new InstrumentGetActiveAndIndicesParams object with the default values initialized.

func NewInstrumentGetActiveAndIndicesParamsWithContext 

func NewInstrumentGetActiveAndIndicesParamsWithContext(ctx context.Context) *InstrumentGetActiveAndIndicesParams

NewInstrumentGetActiveAndIndicesParamsWithContext creates a new InstrumentGetActiveAndIndicesParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetActiveAndIndicesParamsWithHTTPClient 

func NewInstrumentGetActiveAndIndicesParamsWithHTTPClient(client *http.Client) *InstrumentGetActiveAndIndicesParams

NewInstrumentGetActiveAndIndicesParamsWithHTTPClient creates a new InstrumentGetActiveAndIndicesParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetActiveAndIndicesParamsWithTimeout 

func NewInstrumentGetActiveAndIndicesParamsWithTimeout(timeout time.Duration) *InstrumentGetActiveAndIndicesParams

NewInstrumentGetActiveAndIndicesParamsWithTimeout creates a new InstrumentGetActiveAndIndicesParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetActiveAndIndicesParams) SetContext 

func (o *InstrumentGetActiveAndIndicesParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) SetHTTPClient 

func (o *InstrumentGetActiveAndIndicesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) SetTimeout 

func (o *InstrumentGetActiveAndIndicesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) WithContext 

func (o *InstrumentGetActiveAndIndicesParams) WithContext(ctx context.Context) *InstrumentGetActiveAndIndicesParams

WithContext adds the context to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) WithHTTPClient 

func (o *InstrumentGetActiveAndIndicesParams) WithHTTPClient(client *http.Client) *InstrumentGetActiveAndIndicesParams

WithHTTPClient adds the HTTPClient to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) WithTimeout 

func (o *InstrumentGetActiveAndIndicesParams) WithTimeout(timeout time.Duration) *InstrumentGetActiveAndIndicesParams

WithTimeout adds the timeout to the instrument get active and indices params

func (*InstrumentGetActiveAndIndicesParams) WriteToRequest 

func (o *InstrumentGetActiveAndIndicesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetActiveAndIndicesReader 

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

InstrumentGetActiveAndIndicesReader is a Reader for the InstrumentGetActiveAndIndices structure.

func (*InstrumentGetActiveAndIndicesReader) ReadResponse 

func (o *InstrumentGetActiveAndIndicesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetActiveAndIndicesUnauthorized 

type InstrumentGetActiveAndIndicesUnauthorized struct {
	Payload *models.Error
}

InstrumentGetActiveAndIndicesUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetActiveAndIndicesUnauthorized 

func NewInstrumentGetActiveAndIndicesUnauthorized() *InstrumentGetActiveAndIndicesUnauthorized

NewInstrumentGetActiveAndIndicesUnauthorized creates a InstrumentGetActiveAndIndicesUnauthorized with default headers values

func (*InstrumentGetActiveAndIndicesUnauthorized) Error 

func (o *InstrumentGetActiveAndIndicesUnauthorized) Error() string

type InstrumentGetActiveBadRequest 

type InstrumentGetActiveBadRequest struct {
	Payload *models.Error
}

InstrumentGetActiveBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetActiveBadRequest 

func NewInstrumentGetActiveBadRequest() *InstrumentGetActiveBadRequest

NewInstrumentGetActiveBadRequest creates a InstrumentGetActiveBadRequest with default headers values

func (*InstrumentGetActiveBadRequest) Error 

func (o *InstrumentGetActiveBadRequest) Error() string

type InstrumentGetActiveIntervalsBadRequest 

type InstrumentGetActiveIntervalsBadRequest struct {
	Payload *models.Error
}

InstrumentGetActiveIntervalsBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetActiveIntervalsBadRequest 

func NewInstrumentGetActiveIntervalsBadRequest() *InstrumentGetActiveIntervalsBadRequest

NewInstrumentGetActiveIntervalsBadRequest creates a InstrumentGetActiveIntervalsBadRequest with default headers values

func (*InstrumentGetActiveIntervalsBadRequest) Error 

func (o *InstrumentGetActiveIntervalsBadRequest) Error() string

type InstrumentGetActiveIntervalsNotFound 

type InstrumentGetActiveIntervalsNotFound struct {
	Payload *models.Error
}

InstrumentGetActiveIntervalsNotFound handles this case with default header values.

Not Found

func NewInstrumentGetActiveIntervalsNotFound 

func NewInstrumentGetActiveIntervalsNotFound() *InstrumentGetActiveIntervalsNotFound

NewInstrumentGetActiveIntervalsNotFound creates a InstrumentGetActiveIntervalsNotFound with default headers values

func (*InstrumentGetActiveIntervalsNotFound) Error 

func (o *InstrumentGetActiveIntervalsNotFound) Error() string

type InstrumentGetActiveIntervalsOK 

type InstrumentGetActiveIntervalsOK struct {
	Payload *models.InstrumentInterval
}

InstrumentGetActiveIntervalsOK handles this case with default header values.

Request was successful

func NewInstrumentGetActiveIntervalsOK 

func NewInstrumentGetActiveIntervalsOK() *InstrumentGetActiveIntervalsOK

NewInstrumentGetActiveIntervalsOK creates a InstrumentGetActiveIntervalsOK with default headers values

func (*InstrumentGetActiveIntervalsOK) Error 

func (o *InstrumentGetActiveIntervalsOK) Error() string

type InstrumentGetActiveIntervalsParams 

type InstrumentGetActiveIntervalsParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetActiveIntervalsParams contains all the parameters to send to the API endpoint for the instrument get active intervals operation typically these are written to a http.Request

func NewInstrumentGetActiveIntervalsParams 

func NewInstrumentGetActiveIntervalsParams() *InstrumentGetActiveIntervalsParams

NewInstrumentGetActiveIntervalsParams creates a new InstrumentGetActiveIntervalsParams object with the default values initialized.

func NewInstrumentGetActiveIntervalsParamsWithContext 

func NewInstrumentGetActiveIntervalsParamsWithContext(ctx context.Context) *InstrumentGetActiveIntervalsParams

NewInstrumentGetActiveIntervalsParamsWithContext creates a new InstrumentGetActiveIntervalsParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetActiveIntervalsParamsWithHTTPClient 

func NewInstrumentGetActiveIntervalsParamsWithHTTPClient(client *http.Client) *InstrumentGetActiveIntervalsParams

NewInstrumentGetActiveIntervalsParamsWithHTTPClient creates a new InstrumentGetActiveIntervalsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetActiveIntervalsParamsWithTimeout 

func NewInstrumentGetActiveIntervalsParamsWithTimeout(timeout time.Duration) *InstrumentGetActiveIntervalsParams

NewInstrumentGetActiveIntervalsParamsWithTimeout creates a new InstrumentGetActiveIntervalsParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetActiveIntervalsParams) SetContext 

func (o *InstrumentGetActiveIntervalsParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) SetHTTPClient 

func (o *InstrumentGetActiveIntervalsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) SetTimeout 

func (o *InstrumentGetActiveIntervalsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) WithContext 

func (o *InstrumentGetActiveIntervalsParams) WithContext(ctx context.Context) *InstrumentGetActiveIntervalsParams

WithContext adds the context to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) WithHTTPClient 

func (o *InstrumentGetActiveIntervalsParams) WithHTTPClient(client *http.Client) *InstrumentGetActiveIntervalsParams

WithHTTPClient adds the HTTPClient to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) WithTimeout 

func (o *InstrumentGetActiveIntervalsParams) WithTimeout(timeout time.Duration) *InstrumentGetActiveIntervalsParams

WithTimeout adds the timeout to the instrument get active intervals params

func (*InstrumentGetActiveIntervalsParams) WriteToRequest 

func (o *InstrumentGetActiveIntervalsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetActiveIntervalsReader 

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

InstrumentGetActiveIntervalsReader is a Reader for the InstrumentGetActiveIntervals structure.

func (*InstrumentGetActiveIntervalsReader) ReadResponse 

func (o *InstrumentGetActiveIntervalsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetActiveIntervalsUnauthorized 

type InstrumentGetActiveIntervalsUnauthorized struct {
	Payload *models.Error
}

InstrumentGetActiveIntervalsUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetActiveIntervalsUnauthorized 

func NewInstrumentGetActiveIntervalsUnauthorized() *InstrumentGetActiveIntervalsUnauthorized

NewInstrumentGetActiveIntervalsUnauthorized creates a InstrumentGetActiveIntervalsUnauthorized with default headers values

func (*InstrumentGetActiveIntervalsUnauthorized) Error 

func (o *InstrumentGetActiveIntervalsUnauthorized) Error() string

type InstrumentGetActiveNotFound 

type InstrumentGetActiveNotFound struct {
	Payload *models.Error
}

InstrumentGetActiveNotFound handles this case with default header values.

Not Found

func NewInstrumentGetActiveNotFound 

func NewInstrumentGetActiveNotFound() *InstrumentGetActiveNotFound

NewInstrumentGetActiveNotFound creates a InstrumentGetActiveNotFound with default headers values

func (*InstrumentGetActiveNotFound) Error 

func (o *InstrumentGetActiveNotFound) Error() string

type InstrumentGetActiveOK 

type InstrumentGetActiveOK struct {
	Payload []*models.Instrument
}

InstrumentGetActiveOK handles this case with default header values.

Request was successful

func NewInstrumentGetActiveOK 

func NewInstrumentGetActiveOK() *InstrumentGetActiveOK

NewInstrumentGetActiveOK creates a InstrumentGetActiveOK with default headers values

func (*InstrumentGetActiveOK) Error 

func (o *InstrumentGetActiveOK) Error() string

type InstrumentGetActiveParams 

type InstrumentGetActiveParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetActiveParams contains all the parameters to send to the API endpoint for the instrument get active operation typically these are written to a http.Request

func NewInstrumentGetActiveParams 

func NewInstrumentGetActiveParams() *InstrumentGetActiveParams

NewInstrumentGetActiveParams creates a new InstrumentGetActiveParams object with the default values initialized.

func NewInstrumentGetActiveParamsWithContext 

func NewInstrumentGetActiveParamsWithContext(ctx context.Context) *InstrumentGetActiveParams

NewInstrumentGetActiveParamsWithContext creates a new InstrumentGetActiveParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetActiveParamsWithHTTPClient 

func NewInstrumentGetActiveParamsWithHTTPClient(client *http.Client) *InstrumentGetActiveParams

NewInstrumentGetActiveParamsWithHTTPClient creates a new InstrumentGetActiveParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetActiveParamsWithTimeout 

func NewInstrumentGetActiveParamsWithTimeout(timeout time.Duration) *InstrumentGetActiveParams

NewInstrumentGetActiveParamsWithTimeout creates a new InstrumentGetActiveParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetActiveParams) SetContext 

func (o *InstrumentGetActiveParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get active params

func (*InstrumentGetActiveParams) SetHTTPClient 

func (o *InstrumentGetActiveParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get active params

func (*InstrumentGetActiveParams) SetTimeout 

func (o *InstrumentGetActiveParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get active params

func (*InstrumentGetActiveParams) WithContext 

func (o *InstrumentGetActiveParams) WithContext(ctx context.Context) *InstrumentGetActiveParams

WithContext adds the context to the instrument get active params

func (*InstrumentGetActiveParams) WithHTTPClient 

func (o *InstrumentGetActiveParams) WithHTTPClient(client *http.Client) *InstrumentGetActiveParams

WithHTTPClient adds the HTTPClient to the instrument get active params

func (*InstrumentGetActiveParams) WithTimeout 

func (o *InstrumentGetActiveParams) WithTimeout(timeout time.Duration) *InstrumentGetActiveParams

WithTimeout adds the timeout to the instrument get active params

func (*InstrumentGetActiveParams) WriteToRequest 

func (o *InstrumentGetActiveParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetActiveReader 

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

InstrumentGetActiveReader is a Reader for the InstrumentGetActive structure.

func (*InstrumentGetActiveReader) ReadResponse 

func (o *InstrumentGetActiveReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetActiveUnauthorized 

type InstrumentGetActiveUnauthorized struct {
	Payload *models.Error
}

InstrumentGetActiveUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetActiveUnauthorized 

func NewInstrumentGetActiveUnauthorized() *InstrumentGetActiveUnauthorized

NewInstrumentGetActiveUnauthorized creates a InstrumentGetActiveUnauthorized with default headers values

func (*InstrumentGetActiveUnauthorized) Error 

func (o *InstrumentGetActiveUnauthorized) Error() string

type InstrumentGetBadRequest 

type InstrumentGetBadRequest struct {
	Payload *models.Error
}

InstrumentGetBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetBadRequest 

func NewInstrumentGetBadRequest() *InstrumentGetBadRequest

NewInstrumentGetBadRequest creates a InstrumentGetBadRequest with default headers values

func (*InstrumentGetBadRequest) Error 

func (o *InstrumentGetBadRequest) Error() string

type InstrumentGetCompositeIndexBadRequest 

type InstrumentGetCompositeIndexBadRequest struct {
	Payload *models.Error
}

InstrumentGetCompositeIndexBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetCompositeIndexBadRequest 

func NewInstrumentGetCompositeIndexBadRequest() *InstrumentGetCompositeIndexBadRequest

NewInstrumentGetCompositeIndexBadRequest creates a InstrumentGetCompositeIndexBadRequest with default headers values

func (*InstrumentGetCompositeIndexBadRequest) Error 

func (o *InstrumentGetCompositeIndexBadRequest) Error() string

type InstrumentGetCompositeIndexNotFound 

type InstrumentGetCompositeIndexNotFound struct {
	Payload *models.Error
}

InstrumentGetCompositeIndexNotFound handles this case with default header values.

Not Found

func NewInstrumentGetCompositeIndexNotFound 

func NewInstrumentGetCompositeIndexNotFound() *InstrumentGetCompositeIndexNotFound

NewInstrumentGetCompositeIndexNotFound creates a InstrumentGetCompositeIndexNotFound with default headers values

func (*InstrumentGetCompositeIndexNotFound) Error 

func (o *InstrumentGetCompositeIndexNotFound) Error() string

type InstrumentGetCompositeIndexOK 

type InstrumentGetCompositeIndexOK struct {
	Payload []*models.IndexComposite
}

InstrumentGetCompositeIndexOK handles this case with default header values.

Request was successful

func NewInstrumentGetCompositeIndexOK 

func NewInstrumentGetCompositeIndexOK() *InstrumentGetCompositeIndexOK

NewInstrumentGetCompositeIndexOK creates a InstrumentGetCompositeIndexOK with default headers values

func (*InstrumentGetCompositeIndexOK) Error 

func (o *InstrumentGetCompositeIndexOK) Error() string

type InstrumentGetCompositeIndexParams 

type InstrumentGetCompositeIndexParams struct {

	/*Account*/
	Account *float64
	/*Columns
	  Array of column names to fetch. If omitted, will return all columns.

	Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

	*/
	Columns *string
	/*Count
	  Number of results to fetch.

	*/
	Count *int32
	/*EndTime
	  Ending date filter for results.

	*/
	EndTime *strfmt.DateTime
	/*Filter
	  Generic table filter. Send JSON key/value pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details.

	*/
	Filter *string
	/*Reverse
	  If true, will sort results newest first.

	*/
	Reverse *bool
	/*Start
	  Starting point for results.

	*/
	Start *int32
	/*StartTime
	  Starting date filter for results.

	*/
	StartTime *strfmt.DateTime
	/*Symbol
	  The composite index symbol.

	*/
	Symbol *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetCompositeIndexParams contains all the parameters to send to the API endpoint for the instrument get composite index operation typically these are written to a http.Request

func NewInstrumentGetCompositeIndexParams 

func NewInstrumentGetCompositeIndexParams() *InstrumentGetCompositeIndexParams

NewInstrumentGetCompositeIndexParams creates a new InstrumentGetCompositeIndexParams object with the default values initialized.

func NewInstrumentGetCompositeIndexParamsWithContext 

func NewInstrumentGetCompositeIndexParamsWithContext(ctx context.Context) *InstrumentGetCompositeIndexParams

NewInstrumentGetCompositeIndexParamsWithContext creates a new InstrumentGetCompositeIndexParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetCompositeIndexParamsWithHTTPClient 

func NewInstrumentGetCompositeIndexParamsWithHTTPClient(client *http.Client) *InstrumentGetCompositeIndexParams

NewInstrumentGetCompositeIndexParamsWithHTTPClient creates a new InstrumentGetCompositeIndexParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetCompositeIndexParamsWithTimeout 

func NewInstrumentGetCompositeIndexParamsWithTimeout(timeout time.Duration) *InstrumentGetCompositeIndexParams

NewInstrumentGetCompositeIndexParamsWithTimeout creates a new InstrumentGetCompositeIndexParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetCompositeIndexParams) SetAccount 

func (o *InstrumentGetCompositeIndexParams) SetAccount(account *float64)

SetAccount adds the account to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetColumns 

func (o *InstrumentGetCompositeIndexParams) SetColumns(columns *string)

SetColumns adds the columns to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetContext 

func (o *InstrumentGetCompositeIndexParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetCount 

func (o *InstrumentGetCompositeIndexParams) SetCount(count *int32)

SetCount adds the count to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetEndTime 

func (o *InstrumentGetCompositeIndexParams) SetEndTime(endTime *strfmt.DateTime)

SetEndTime adds the endTime to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetFilter 

func (o *InstrumentGetCompositeIndexParams) SetFilter(filter *string)

SetFilter adds the filter to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetHTTPClient 

func (o *InstrumentGetCompositeIndexParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetReverse 

func (o *InstrumentGetCompositeIndexParams) SetReverse(reverse *bool)

SetReverse adds the reverse to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetStart 

func (o *InstrumentGetCompositeIndexParams) SetStart(start *int32)

SetStart adds the start to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetStartTime 

func (o *InstrumentGetCompositeIndexParams) SetStartTime(startTime *strfmt.DateTime)

SetStartTime adds the startTime to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetSymbol 

func (o *InstrumentGetCompositeIndexParams) SetSymbol(symbol *string)

SetSymbol adds the symbol to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) SetTimeout 

func (o *InstrumentGetCompositeIndexParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithAccount 

func (o *InstrumentGetCompositeIndexParams) WithAccount(account *float64) *InstrumentGetCompositeIndexParams

WithAccount adds the account to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithColumns 

func (o *InstrumentGetCompositeIndexParams) WithColumns(columns *string) *InstrumentGetCompositeIndexParams

WithColumns adds the columns to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithContext 

func (o *InstrumentGetCompositeIndexParams) WithContext(ctx context.Context) *InstrumentGetCompositeIndexParams

WithContext adds the context to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithCount 

func (o *InstrumentGetCompositeIndexParams) WithCount(count *int32) *InstrumentGetCompositeIndexParams

WithCount adds the count to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithEndTime 

func (o *InstrumentGetCompositeIndexParams) WithEndTime(endTime *strfmt.DateTime) *InstrumentGetCompositeIndexParams

WithEndTime adds the endTime to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithFilter 

func (o *InstrumentGetCompositeIndexParams) WithFilter(filter *string) *InstrumentGetCompositeIndexParams

WithFilter adds the filter to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithHTTPClient 

func (o *InstrumentGetCompositeIndexParams) WithHTTPClient(client *http.Client) *InstrumentGetCompositeIndexParams

WithHTTPClient adds the HTTPClient to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithReverse 

func (o *InstrumentGetCompositeIndexParams) WithReverse(reverse *bool) *InstrumentGetCompositeIndexParams

WithReverse adds the reverse to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithStart 

func (o *InstrumentGetCompositeIndexParams) WithStart(start *int32) *InstrumentGetCompositeIndexParams

WithStart adds the start to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithStartTime 

func (o *InstrumentGetCompositeIndexParams) WithStartTime(startTime *strfmt.DateTime) *InstrumentGetCompositeIndexParams

WithStartTime adds the startTime to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithSymbol 

func (o *InstrumentGetCompositeIndexParams) WithSymbol(symbol *string) *InstrumentGetCompositeIndexParams

WithSymbol adds the symbol to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WithTimeout 

func (o *InstrumentGetCompositeIndexParams) WithTimeout(timeout time.Duration) *InstrumentGetCompositeIndexParams

WithTimeout adds the timeout to the instrument get composite index params

func (*InstrumentGetCompositeIndexParams) WriteToRequest 

func (o *InstrumentGetCompositeIndexParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetCompositeIndexReader 

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

InstrumentGetCompositeIndexReader is a Reader for the InstrumentGetCompositeIndex structure.

func (*InstrumentGetCompositeIndexReader) ReadResponse 

func (o *InstrumentGetCompositeIndexReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetCompositeIndexUnauthorized 

type InstrumentGetCompositeIndexUnauthorized struct {
	Payload *models.Error
}

InstrumentGetCompositeIndexUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetCompositeIndexUnauthorized 

func NewInstrumentGetCompositeIndexUnauthorized() *InstrumentGetCompositeIndexUnauthorized

NewInstrumentGetCompositeIndexUnauthorized creates a InstrumentGetCompositeIndexUnauthorized with default headers values

func (*InstrumentGetCompositeIndexUnauthorized) Error 

func (o *InstrumentGetCompositeIndexUnauthorized) Error() string

type InstrumentGetIndicesBadRequest 

type InstrumentGetIndicesBadRequest struct {
	Payload *models.Error
}

InstrumentGetIndicesBadRequest handles this case with default header values.

Parameter Error

func NewInstrumentGetIndicesBadRequest 

func NewInstrumentGetIndicesBadRequest() *InstrumentGetIndicesBadRequest

NewInstrumentGetIndicesBadRequest creates a InstrumentGetIndicesBadRequest with default headers values

func (*InstrumentGetIndicesBadRequest) Error 

func (o *InstrumentGetIndicesBadRequest) Error() string

type InstrumentGetIndicesNotFound 

type InstrumentGetIndicesNotFound struct {
	Payload *models.Error
}

InstrumentGetIndicesNotFound handles this case with default header values.

Not Found

func NewInstrumentGetIndicesNotFound 

func NewInstrumentGetIndicesNotFound() *InstrumentGetIndicesNotFound

NewInstrumentGetIndicesNotFound creates a InstrumentGetIndicesNotFound with default headers values

func (*InstrumentGetIndicesNotFound) Error 

func (o *InstrumentGetIndicesNotFound) Error() string

type InstrumentGetIndicesOK 

type InstrumentGetIndicesOK struct {
	Payload []*models.Instrument
}

InstrumentGetIndicesOK handles this case with default header values.

Request was successful

func NewInstrumentGetIndicesOK 

func NewInstrumentGetIndicesOK() *InstrumentGetIndicesOK

NewInstrumentGetIndicesOK creates a InstrumentGetIndicesOK with default headers values

func (*InstrumentGetIndicesOK) Error 

func (o *InstrumentGetIndicesOK) Error() string

type InstrumentGetIndicesParams 

type InstrumentGetIndicesParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetIndicesParams contains all the parameters to send to the API endpoint for the instrument get indices operation typically these are written to a http.Request

func NewInstrumentGetIndicesParams 

func NewInstrumentGetIndicesParams() *InstrumentGetIndicesParams

NewInstrumentGetIndicesParams creates a new InstrumentGetIndicesParams object with the default values initialized.

func NewInstrumentGetIndicesParamsWithContext 

func NewInstrumentGetIndicesParamsWithContext(ctx context.Context) *InstrumentGetIndicesParams

NewInstrumentGetIndicesParamsWithContext creates a new InstrumentGetIndicesParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetIndicesParamsWithHTTPClient 

func NewInstrumentGetIndicesParamsWithHTTPClient(client *http.Client) *InstrumentGetIndicesParams

NewInstrumentGetIndicesParamsWithHTTPClient creates a new InstrumentGetIndicesParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetIndicesParamsWithTimeout 

func NewInstrumentGetIndicesParamsWithTimeout(timeout time.Duration) *InstrumentGetIndicesParams

NewInstrumentGetIndicesParamsWithTimeout creates a new InstrumentGetIndicesParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetIndicesParams) SetContext 

func (o *InstrumentGetIndicesParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get indices params

func (*InstrumentGetIndicesParams) SetHTTPClient 

func (o *InstrumentGetIndicesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get indices params

func (*InstrumentGetIndicesParams) SetTimeout 

func (o *InstrumentGetIndicesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get indices params

func (*InstrumentGetIndicesParams) WithContext 

func (o *InstrumentGetIndicesParams) WithContext(ctx context.Context) *InstrumentGetIndicesParams

WithContext adds the context to the instrument get indices params

func (*InstrumentGetIndicesParams) WithHTTPClient 

func (o *InstrumentGetIndicesParams) WithHTTPClient(client *http.Client) *InstrumentGetIndicesParams

WithHTTPClient adds the HTTPClient to the instrument get indices params

func (*InstrumentGetIndicesParams) WithTimeout 

func (o *InstrumentGetIndicesParams) WithTimeout(timeout time.Duration) *InstrumentGetIndicesParams

WithTimeout adds the timeout to the instrument get indices params

func (*InstrumentGetIndicesParams) WriteToRequest 

func (o *InstrumentGetIndicesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetIndicesReader 

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

InstrumentGetIndicesReader is a Reader for the InstrumentGetIndices structure.

func (*InstrumentGetIndicesReader) ReadResponse 

func (o *InstrumentGetIndicesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetIndicesUnauthorized 

type InstrumentGetIndicesUnauthorized struct {
	Payload *models.Error
}

InstrumentGetIndicesUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetIndicesUnauthorized 

func NewInstrumentGetIndicesUnauthorized() *InstrumentGetIndicesUnauthorized

NewInstrumentGetIndicesUnauthorized creates a InstrumentGetIndicesUnauthorized with default headers values

func (*InstrumentGetIndicesUnauthorized) Error 

func (o *InstrumentGetIndicesUnauthorized) Error() string

type InstrumentGetNotFound 

type InstrumentGetNotFound struct {
	Payload *models.Error
}

InstrumentGetNotFound handles this case with default header values.

Not Found

func NewInstrumentGetNotFound 

func NewInstrumentGetNotFound() *InstrumentGetNotFound

NewInstrumentGetNotFound creates a InstrumentGetNotFound with default headers values

func (*InstrumentGetNotFound) Error 

func (o *InstrumentGetNotFound) Error() string

type InstrumentGetOK 

type InstrumentGetOK struct {
	Payload []*models.Instrument
}

InstrumentGetOK handles this case with default header values.

Request was successful

func NewInstrumentGetOK 

func NewInstrumentGetOK() *InstrumentGetOK

NewInstrumentGetOK creates a InstrumentGetOK with default headers values

func (*InstrumentGetOK) Error 

func (o *InstrumentGetOK) Error() string

type InstrumentGetParams 

type InstrumentGetParams struct {

	/*Columns
	  Array of column names to fetch. If omitted, will return all columns.

	Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

	*/
	Columns *string
	/*Count
	  Number of results to fetch.

	*/
	Count *int32
	/*EndTime
	  Ending date filter for results.

	*/
	EndTime *strfmt.DateTime
	/*Filter
	  Generic table filter. Send JSON key/value pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details.

	*/
	Filter *string
	/*Reverse
	  If true, will sort results newest first.

	*/
	Reverse *bool
	/*Start
	  Starting point for results.

	*/
	Start *int32
	/*StartTime
	  Starting date filter for results.

	*/
	StartTime *strfmt.DateTime
	/*Symbol
	  Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series.

	You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.

	*/
	Symbol *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InstrumentGetParams contains all the parameters to send to the API endpoint for the instrument get operation typically these are written to a http.Request

func NewInstrumentGetParams 

func NewInstrumentGetParams() *InstrumentGetParams

NewInstrumentGetParams creates a new InstrumentGetParams object with the default values initialized.

func NewInstrumentGetParamsWithContext 

func NewInstrumentGetParamsWithContext(ctx context.Context) *InstrumentGetParams

NewInstrumentGetParamsWithContext creates a new InstrumentGetParams object with the default values initialized, and the ability to set a context for a request

func NewInstrumentGetParamsWithHTTPClient 

func NewInstrumentGetParamsWithHTTPClient(client *http.Client) *InstrumentGetParams

NewInstrumentGetParamsWithHTTPClient creates a new InstrumentGetParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewInstrumentGetParamsWithTimeout 

func NewInstrumentGetParamsWithTimeout(timeout time.Duration) *InstrumentGetParams

NewInstrumentGetParamsWithTimeout creates a new InstrumentGetParams object with the default values initialized, and the ability to set a timeout on a request

func (*InstrumentGetParams) SetColumns 

func (o *InstrumentGetParams) SetColumns(columns *string)

SetColumns adds the columns to the instrument get params

func (*InstrumentGetParams) SetContext 

func (o *InstrumentGetParams) SetContext(ctx context.Context)

SetContext adds the context to the instrument get params

func (*InstrumentGetParams) SetCount 

func (o *InstrumentGetParams) SetCount(count *int32)

SetCount adds the count to the instrument get params

func (*InstrumentGetParams) SetEndTime 

func (o *InstrumentGetParams) SetEndTime(endTime *strfmt.DateTime)

SetEndTime adds the endTime to the instrument get params

func (*InstrumentGetParams) SetFilter 

func (o *InstrumentGetParams) SetFilter(filter *string)

SetFilter adds the filter to the instrument get params

func (*InstrumentGetParams) SetHTTPClient 

func (o *InstrumentGetParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the instrument get params

func (*InstrumentGetParams) SetReverse 

func (o *InstrumentGetParams) SetReverse(reverse *bool)

SetReverse adds the reverse to the instrument get params

func (*InstrumentGetParams) SetStart 

func (o *InstrumentGetParams) SetStart(start *int32)

SetStart adds the start to the instrument get params

func (*InstrumentGetParams) SetStartTime 

func (o *InstrumentGetParams) SetStartTime(startTime *strfmt.DateTime)

SetStartTime adds the startTime to the instrument get params

func (*InstrumentGetParams) SetSymbol 

func (o *InstrumentGetParams) SetSymbol(symbol *string)

SetSymbol adds the symbol to the instrument get params

func (*InstrumentGetParams) SetTimeout 

func (o *InstrumentGetParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the instrument get params

func (*InstrumentGetParams) WithColumns 

func (o *InstrumentGetParams) WithColumns(columns *string) *InstrumentGetParams

WithColumns adds the columns to the instrument get params

func (*InstrumentGetParams) WithContext 

func (o *InstrumentGetParams) WithContext(ctx context.Context) *InstrumentGetParams

WithContext adds the context to the instrument get params

func (*InstrumentGetParams) WithCount 

func (o *InstrumentGetParams) WithCount(count *int32) *InstrumentGetParams

WithCount adds the count to the instrument get params

func (*InstrumentGetParams) WithEndTime 

func (o *InstrumentGetParams) WithEndTime(endTime *strfmt.DateTime) *InstrumentGetParams

WithEndTime adds the endTime to the instrument get params

func (*InstrumentGetParams) WithFilter 

func (o *InstrumentGetParams) WithFilter(filter *string) *InstrumentGetParams

WithFilter adds the filter to the instrument get params

func (*InstrumentGetParams) WithHTTPClient 

func (o *InstrumentGetParams) WithHTTPClient(client *http.Client) *InstrumentGetParams

WithHTTPClient adds the HTTPClient to the instrument get params

func (*InstrumentGetParams) WithReverse 

func (o *InstrumentGetParams) WithReverse(reverse *bool) *InstrumentGetParams

WithReverse adds the reverse to the instrument get params

func (*InstrumentGetParams) WithStart 

func (o *InstrumentGetParams) WithStart(start *int32) *InstrumentGetParams

WithStart adds the start to the instrument get params

func (*InstrumentGetParams) WithStartTime 

func (o *InstrumentGetParams) WithStartTime(startTime *strfmt.DateTime) *InstrumentGetParams

WithStartTime adds the startTime to the instrument get params

func (*InstrumentGetParams) WithSymbol 

func (o *InstrumentGetParams) WithSymbol(symbol *string) *InstrumentGetParams

WithSymbol adds the symbol to the instrument get params

func (*InstrumentGetParams) WithTimeout 

func (o *InstrumentGetParams) WithTimeout(timeout time.Duration) *InstrumentGetParams

WithTimeout adds the timeout to the instrument get params

func (*InstrumentGetParams) WriteToRequest 

func (o *InstrumentGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InstrumentGetReader 

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

InstrumentGetReader is a Reader for the InstrumentGet structure.

func (*InstrumentGetReader) ReadResponse 

func (o *InstrumentGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InstrumentGetUnauthorized 

type InstrumentGetUnauthorized struct {
	Payload *models.Error
}

InstrumentGetUnauthorized handles this case with default header values.

Unauthorized

func NewInstrumentGetUnauthorized 

func NewInstrumentGetUnauthorized() *InstrumentGetUnauthorized

NewInstrumentGetUnauthorized creates a InstrumentGetUnauthorized with default headers values

func (*InstrumentGetUnauthorized) Error 

func (o *InstrumentGetUnauthorized) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.