Skip to main content

Candles

Get historical price candles for any supported stock index.

Making Requests​

Use IndicesCandlesRequest to make requests to the endpoint using any of the three supported execution methods:

MethodExecutionReturn TypeDescription
GetDirect[]CandleDirectly returns a slice of []Candle, making it straightforward to access each candle individually.
PackedIntermediate*IndicesCandlesResponseReturns a packed *IndicesCandlesResponse object. Must be unpacked to access the []Candle slice.
RawLow-level*resty.ResponseProvides the raw *resty.Response for maximum flexibility. Direct access to raw JSON or *http.Response.

IndicesCandlesRequest​

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

IndicesCandlesRequest represents a request to the /v1/indices/candles/ endpoint. It encapsulates parameters for resolution, symbol, and dates to be used in the request.

Generated By​

Setter Methods​

These methods are used to set the parameters of the request. They allow for method chaining by returning a pointer to the *IndicesCandlesRequest instance they modify.

Execution Methods​

These methods are used to send the request in different formats or retrieve the data. They handle the actual communication with the API endpoint.

vix, err := IndexCandles().Symbol("VIX").Resolution("D").From("2024-01-01").To("2024-01-05").Get()
if err != nil {
	println("Error retrieving VIX index candles:", err.Error())
	return
}

for _, candle := range vix {
	fmt.Println(candle)
}

Output​

Candle{Date: 2024-01-02, Open: 13.21, High: 14.23, Low: 13.1, Close: 13.2}
Candle{Date: 2024-01-03, Open: 13.38, High: 14.22, Low: 13.36, Close: 14.04}
Candle{Date: 2024-01-04, Open: 13.97, High: 14.2, Low: 13.64, Close: 14.13}
Candle{Date: 2024-01-05, Open: 14.24, High: 14.58, Low: 13.29, Close: 13.35}

IndexCandles​

func IndexCandles() *IndicesCandlesRequest

IndexCandles creates a new IndicesCandlesRequest and associates it with the default client. This function initializes the request with default parameters for date, resolution, and symbol, and sets the request path based on the predefined endpoints for indices candles.

Returns​

  • *IndicesCandlesRequest

    A pointer to the newly created *IndicesCandlesRequest with default parameters and associated client.

IndicesCandlesRequest Setter Methods​

Countback​

func (icr *IndicesCandlesRequest) Countback(q int) *IndicesCandlesRequest

Countback sets the countback parameter for the IndicesCandlesRequest. It specifies the number of candles to return, counting backwards from the 'to' date.

Parameters​

  • int

    An int representing the number of candles to return.

Returns​

  • *IndicesCandlesRequest

    A pointer to the *IndicesCandlesRequest instance to allow for method chaining.

Date​

func (icr *IndicesCandlesRequest) Date(q interface{}) *IndicesCandlesRequest

Date sets the date parameter for the IndicesCandlesRequest. This method is used to specify the date for which the candle data is requested. It modifies the 'date' field of the IndicesCandlesRequest instance to store the date value.

Parameters​

  • interface{}

    An interface{} representing the date to be set. It can be a string, a time.Time object, a Unix int, or any other type that the underlying dates package method can process.

Returns​

  • *IndicesCandlesRequest

    This method returns a pointer to the *IndicesCandlesRequest instance it was called on. This allows for method chaining, where multiple setter methods can be called in a single statement.

Notes​

  • If an error occurs while setting the date (e.g., if the date value is not supported), the Error field of the request is set with the encountered error, but the method still returns the *IndicesCandlesRequest instance to allow for further method calls.

From​

func (icr *IndicesCandlesRequest) From(q interface{}) *IndicesCandlesRequest

From sets the 'from' date parameter for the IndicesCandlesRequest. It configures the starting point of the date range for which the candle data is requested.

Parameters​

  • interface{}

    An interface{} that represents the starting date. It can be a string, a time.Time object, a Unix timestamp or any other type that the underlying dates package can process.

Returns​

  • *IndicesCandlesRequest

    A pointer to the *IndicesCandlesRequest instance to allow for method chaining.

Resolution​

func (icr *IndicesCandlesRequest) Resolution(q string) *IndicesCandlesRequest

Resolution sets the resolution parameter for the IndicesCandlesRequest. This method is used to specify the granularity of the candle data to be retrieved. It modifies the resolutionParams field of the IndicesCandlesRequest instance to store the resolution value.

Parameters​

  • string

    A string representing the resolution to be set. Valid resolutions may include values like "D", "5", "1h", etc. See the API's supported resolutions.

Returns​

  • *IndicesCandlesRequest

    This method returns a pointer to the *IndicesCandlesRequest instance it was called on. This allows for method chaining, where multiple setter methods can be called in a single statement. If the receiver (*IndicesCandlesRequest) is nil, it returns nil to prevent a panic.

Notes​

  • If an error occurs while setting the resolution (e.g., if the resolution value is not supported), the Error field of the *IndicesCandlesRequest is set with the encountered error, but the method still returns the IndicesCandlesRequest instance to allow for further method calls by the caller.

Symbol​

func (icr *IndicesCandlesRequest) Symbol(q string) *IndicesCandlesRequest

Symbol sets the symbol parameter for the IndicesCandlesRequest. This method is used to specify the index symbol for which the candle data is requested.

Parameters​

  • string

    A string representing the index symbol to be set.

Returns​

  • *IndicesCandlesRequest

    This method returns a pointer to the *IndicesCandlesRequest instance it was called on. This allows for method chaining, where multiple setter methods can be called in a single statement. If the receiver (*IndicesCandlesRequest) is nil, it returns nil to prevent a panic.

Notes​

  • If an error occurs while setting the symbol (e.g., if the symbol value is not supported), the Error field of the IndicesCandlesRequest is set with the encountered error, but the method still returns the IndicesCandlesRequest instance to allow for further method calls or error handling by the caller.

To​

func (icr *IndicesCandlesRequest) To(q interface{}) *IndicesCandlesRequest

To sets the 'to' date parameter for the IndicesCandlesRequest. It configures the ending point of the date range for which the candle data is requested.

Parameters​

  • interface{}

    An interface{} that represents the ending date. It can be a string, a time.Time object, or any other type that the underlying SetTo method can process.

Returns​

  • *IndicesCandlesRequest

    A pointer to the *IndicesCandlesRequest instance to allow for method chaining.

IndicesCandlesRequest Execution Methods​

Get​

func (icr *IndicesCandlesRequest) Get() ([]models.Candle, error)

Get sends the IndicesCandlesRequest, unpacks the IndicesCandlesResponse, and returns a slice of IndexCandle. It returns an error if the request or unpacking fails. This method is crucial for obtaining the actual candle data from the indices candles request. The method first checks if the IndicesCandlesRequest receiver is nil, which would result in an error as the request cannot be sent. It then proceeds to send the request using the Packed method. Upon receiving the response, it unpacks the data into a slice of IndexCandle using the Unpack method from the response.

Returns​

  • []models.Candle

    A slice of []models.Candle containing the unpacked candle data from the response.

  • error

    An error object that indicates a failure in sending the request or unpacking the response.

Packed​

func (icr *IndicesCandlesRequest) Packed() (*models.IndicesCandlesResponse, error)

Packed sends the IndicesCandlesRequest and returns the IndicesCandlesResponse. This method checks if the IndicesCandlesRequest receiver is nil, returning an error if true. It proceeds to send the request and returns the IndicesCandlesResponse along with any error encountered during the request.

Returns​

  • *models.IndicesCandlesResponse

    A pointer to the *IndicesCandlesResponse obtained from the request.

  • error

    An error object that indicates a failure in sending the request.

Raw​

func (icr *IndicesCandlesRequest) Raw() (*resty.Response, error)

Raw executes the IndicesCandlesRequest and returns the raw *resty.Response. The *resty.Response can be directly used to access the raw JSON or *http.Response for further processing.

Returns​

  • *resty.Response

    The raw HTTP response from the executed IndicesCandlesRequest.

  • error

    An error object if the IndicesCandlesRequest is nil or if an error occurs during the request execution.

IndicesCandlesResponse​

type IndicesCandlesResponse struct {
    Date  []int64   `json:"t"` // Date holds the Unix timestamps for each candle, representing the time at which each candle was opened.
    Open  []float64 `json:"o"` // Open contains the opening prices for each candle in the response.
    High  []float64 `json:"h"` // High includes the highest prices reached during the time period each candle represents.
    Low   []float64 `json:"l"` // Low encompasses the lowest prices during the candle's time period.
    Close []float64 `json:"c"` // Close contains the closing prices for each candle, marking the final price at the end of each candle's time period.
}

IndicesCandlesResponse represents the response structure for indices candles data. It includes slices for time, open, high, low, and close values of the indices.

Generated By​

  • IndexCandlesRequest.Packed()

    This method sends the IndicesCandlesRequest to the Market Data API and returns the IndicesCandlesResponse. It handles the actual communication with the [/v1/indices/candles/] endpoint, sending the request, and returns a packed response that strictly conforms to the Market Data JSON response without unpacking the result into individual candle structs.

Methods​

  • String()

    Provides a formatted string representation of the IndicesCandlesResponse instance. This method is primarily used for logging or debugging purposes, allowing the user to easily view the contents of an IndicesCandlesResponse object in a human-readable format. It concatenates the time, open, high, low, and close values of the indices into a single string.

  • Unpack() ([]Candle, error)

    Unpacks the IndicesCandlesResponse into a slice of Candle structs, checking for errors in data consistency.

  • MarshalJSON()

    Marshals the IndicesCandlesResponse into a JSON object with ordered keys.

  • UnmarshalJSON(data []byte)

    Custom unmarshals a JSON object into the IndicesCandlesResponse, including validation.

  • Validate()

    Runs checks for time in ascending order, equal slice lengths, and no empty slices.

  • IsValid()

    Checks if the IndicesCandlesResponse passes all validation checks and returns a boolean.

IsValid​

func (icr *IndicesCandlesResponse) IsValid() bool

Returns​

  • bool

    Indicates whether the IndicesCandlesResponse is valid.

MarshalJSON​

func (icr *IndicesCandlesResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the IndicesCandlesResponse struct into a JSON object, ensuring the keys are ordered as specified. This method is particularly useful when a consistent JSON structure with ordered keys is required for external interfaces or storage. The "s" key is set to "ok" to indicate successful marshaling, followed by the indices data keys "t", "o", "h", "l", and "c".

Returns​

  • []byte

    A byte slice representing the marshaled JSON object. The keys within the JSON object are ordered as "s", "t", "o", "h", "l", and "c".

  • error

    An error object if marshaling fails, otherwise nil.

String​

func (icr *IndicesCandlesResponse) String() string

String provides a formatted string representation of the IndicesCandlesResponse instance. This method is primarily used for logging or debugging purposes, allowing the user to easily view the contents of an IndicesCandlesResponse object in a human-readable format. It concatenates the time, open, high, low, and close values of the indices into a single string.

Returns​

  • string

    A formatted string containing the time, open, high, low, and close values of the indices.

UnmarshalJSON​

func (icr *IndicesCandlesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON custom unmarshals a JSON object into the IndicesCandlesResponse, incorporating validation to ensure the data integrity of the unmarshaled object. This method is essential for converting JSON data into a structured IndicesCandlesResponse object while ensuring that the data adheres to expected formats and constraints.

Parameters​

  • []byte

    A byte slice of the JSON object to be unmarshaled.

Returns​

  • error

    An error if unmarshaling or validation fails, otherwise nil.

Unpack​

func (icr *IndicesCandlesResponse) Unpack() ([]Candle, error)

Unpack converts the IndicesCandlesResponse into a slice of IndexCandle.

Returns​

  • []Candle

    A slice of Candle that holds the OHLC data.

  • error

    An error object that indicates a failure in unpacking the response.

Validate​

func (icr *IndicesCandlesResponse) Validate() error

Validate performs multiple checks on the IndicesCandlesResponse to ensure data integrity. This method is crucial for verifying that the response data is consistent and reliable, specifically checking for time sequence, equal length of data slices, and the presence of data in each slice. It's used to preemptively catch and handle data-related errors before they can affect downstream processes.

Returns​

  • error

    An error if any validation check fails, otherwise nil. This allows for easy identification of data integrity issues.

Candle​

type Candle struct {
    Symbol string    `json:"symbol,omitempty"` // The symbol of the candle.
    Date   time.Time `json:"t"`                // Date represents the date and time of the candle.
    Open   float64   `json:"o"`                // Open is the opening price of the candle.
    High   float64   `json:"h"`                // High is the highest price reached during the candle's time.
    Low    float64   `json:"l"`                // Low is the lowest price reached during the candle's time.
    Close  float64   `json:"c"`                // Close is the closing price of the candle.
    Volume int64     `json:"v,omitempty"`      // Volume represents the trading volume during the candle's time.
    VWAP   float64   `json:"vwap,omitempty"`   // VWAP is the Volume Weighted Average Price, optional.
    N      int64     `json:"n,omitempty"`      // N is the number of trades that occurred, optional.
}

Candle represents a single candle in a stock candlestick chart, encapsulating the time, open, high, low, close prices, volume, and optionally the symbol, VWAP, and number of trades.

Generated By​

Methods​

Notes​

  • The VWAP, N fields are optional and will only be present in v2 Stock Candles.
  • The Volume field is optional and will not be present in Index Candles.
  • The Symbol field is optional and only be present in candles that were generated using the bulkcandles endpoint.

Clone​

func (c Candle) Clone() Candle

Clones the current Candle instance, creating a new instance with the same values. This method is useful when you need a copy of a Candle instance without modifying the original instance.

Returns​

  • Candle

    A new Candle instance with the same values as the current instance.

Equals​

func (c Candle) Equals(other Candle) bool

Equals compares the current Candle instance with another Candle instance to determine if they represent the same candle data. This method is useful for validating if two Candle instances have identical properties, including symbol, date/time, open, high, low, close prices, volume, VWAP, and number of trades. It's primarily used in scenarios where candle data integrity needs to be verified or when deduplicating candle data.

Parameters​

  • Candle

    The other Candle instance to compare against the current instance.

Returns​

  • bool

    Indicates whether the two Candle instances are identical. True if all properties match, false otherwise.

Notes​

  • This method performs a deep equality check on all Candle properties, including date/time which is compared using the Equal method from the time package to account for potential timezone differences.

IsAfter​

func (c Candle) IsAfter(other Candle) bool

IsAfter determines if the current Candle instance occurred after another specified Candle instance. This method is useful for chronological comparisons between two Candle instances, particularly in time series analysis or when organizing historical financial data in ascending order.

Parameters​

  • Candle

    The other Candle instance to compare with the current Candle instance.

Returns​

  • bool

    Indicates whether the current Candle's date is after the 'other' Candle's date. Returns true if it is; otherwise, false.

IsBefore​

func (c Candle) IsBefore(other Candle) bool

IsBefore determines whether the current Candle instance occurred before another specified Candle instance. This method is primarily used for comparing the dates of two Candle instances to establish their chronological order, which can be useful in time series analysis or when organizing historical financial data.

Parameters​

  • Candle

    The other Candle instance to compare with the current Candle instance.

Returns​

  • bool

    Returns true if the date of the current Candle instance is before the date of the 'other' Candle instance; otherwise, returns false.

Notes​

  • This method only compares the dates of the Candle instances, ignoring other fields such as Open, Close, High, Low, etc.

IsValid​

func (c Candle) IsValid() bool

IsValid evaluates the financial data of a Candle to determine its validity. This method is essential for ensuring that the Candle's data adheres to basic financial integrity rules, making it a critical step before performing further analysis or operations with Candle data. A Candle is deemed valid if its high, open, and close prices are logically consistent with each other and its volume is non-negative.

Returns​

  • bool

    Indicates whether the Candle is valid based on its financial data. Returns true if all validity criteria are met; otherwise, false.

MarshalJSON​

func (c Candle) MarshalJSON() ([]byte, error)

MarshalJSON customizes the JSON output of the Candle struct, primarily used for converting the Candle data into a JSON format that includes the Date as a Unix timestamp instead of the standard time.Time format. This method is particularly useful when the Candle data needs to be serialized into JSON for storage or transmission over networks where a compact and universally understood date format is preferred.

Returns​

  • []byte

    The JSON-encoded representation of the Candle.

  • error

    An error if the JSON marshaling fails.

Notes​

  • The Date field of the Candle is converted to a Unix timestamp to facilitate easier handling of date and time in JSON.

String​

func (c Candle) String() string

String provides a textual representation of the Candle instance. This method is primarily used for logging or debugging purposes, where a developer needs a quick and easy way to view the contents of a Candle instance in a human-readable format.

Returns​

  • string

    A string that represents the Candle instance, including its symbol, date/time, open, high, low, close prices, volume, VWAP, and number of trades, if available.

Notes​

  • The output format is designed to be easily readable, with each field labeled and separated by commas.
  • Fields that are not applicable or not set (e.g., VWAP, N, Volume for Index Candles) are omitted from the output.

UnmarshalJSON​

func (c *Candle) UnmarshalJSON(data []byte) error

UnmarshalJSON customizes the JSON input processing of Candle.

UnmarshalJSON customizes the JSON input processing for the Candle struct, allowing for the Date field to be correctly interpreted from a Unix timestamp (integer) back into a Go time.Time object. This method is essential for deserializing Candle data received in JSON format, where date and time are represented as Unix timestamps, ensuring the Candle struct accurately reflects the original data.

Parameters​

  • data []byte

    The JSON-encoded data that is to be unmarshaled into the Candle struct.

Returns​

  • error

    An error if the JSON unmarshaling fails, nil otherwise.

Notes​

  • The Date field in the JSON is expected to be a Unix timestamp (integer). This method converts it back to a time.Time object, ensuring the Candle struct's Date field is correctly populated.

ByClose​

type ByClose []Candle

ByClose implements sort.Interface for []Candle based on the Close field.

// Create a slice of Candle instances
candles := []Candle{
	{Symbol: "AAPL", Date: time.Now(), Open: 100, High: 105, Low: 95, Close: 102, Volume: 1000},
	{Symbol: "AAPL", Date: time.Now(), Open: 102, High: 106, Low: 98, Close: 104, Volume: 1500},
	{Symbol: "AAPL", Date: time.Now(), Open: 99, High: 103, Low: 97, Close: 100, Volume: 1200},
}

// Sort the candles by their Close value using sort.Sort and ByClose
sort.Sort(ByClose(candles))

// Print the sorted candles to demonstrate the order
for _, candle := range candles {
	fmt.Printf("Close: %v\n", candle.Close)
}

Output​

Close: 100
Close: 102
Close: 104

Len​

func (a ByClose) Len() int

Less​

func (a ByClose) Less(i, j int) bool

Swap​

func (a ByClose) Swap(i, j int)

ByDate​

type ByDate []Candle

ByDate implements sort.Interface for []Candle based on the Date field. This allows for sorting a slice of Candle instances by their Date field in ascending order.

// Assuming the Candle struct has at least a Date field of type time.Time
candles := []Candle{
	{Date: time.Date(2023, 3, 10, 0, 0, 0, 0, time.UTC)},
	{Date: time.Date(2023, 1, 5, 0, 0, 0, 0, time.UTC)},
	{Date: time.Date(2023, 2, 20, 0, 0, 0, 0, time.UTC)},
}

// Sorting the slice of Candle instances by their Date field in ascending order
sort.Sort(ByDate(candles))

// Printing out the sorted dates to demonstrate the order
for _, candle := range candles {
	fmt.Println(candle.Date.Format("2006-01-02"))
}

Output​

2023-01-05
2023-02-20
2023-03-10

Len​

func (a ByDate) Len() int

Less​

func (a ByDate) Less(i, j int) bool

Swap​

func (a ByDate) Swap(i, j int)

ByHigh​

type ByHigh []Candle

ByHigh implements sort.Interface for []Candle based on the High field.

// Assuming the Candle struct has at least a High field of type float64
candles := []Candle{
	{High: 15.2},
	{High: 11.4},
	{High: 13.5},
}

// Sorting the slice of Candle instances by their High field in ascending order
sort.Sort(ByHigh(candles))

// Printing out the sorted High values to demonstrate the order
for _, candle := range candles {
	fmt.Printf("%.1f\n", candle.High)
}

Output​

11.4
13.5
15.2

Len​

func (a ByHigh) Len() int

Less​

func (a ByHigh) Less(i, j int) bool

Swap​

func (a ByHigh) Swap(i, j int)

ByLow​

type ByLow []Candle

ByLow implements sort.Interface for []Candle based on the Low field.

// Assuming the Candle struct has at least a Low field of type float64
candles := []Candle{
	{Low: 5.5},
	{Low: 7.2},
	{Low: 6.3},
}

// Sorting the slice of Candle instances by their Low field in ascending order
sort.Sort(ByLow(candles))

// Printing out the sorted Low values to demonstrate the order
for _, candle := range candles {
	fmt.Printf("%.1f\n", candle.Low)
}

Output​

5.5
6.3
7.2

Len​

func (a ByLow) Len() int

Less​

func (a ByLow) Less(i, j int) bool

Swap​

func (a ByLow) Swap(i, j int)

ByN​

type ByN []Candle

ByN implements sort.Interface for []Candle based on the N field.

// Assuming the Candle struct has at least an N field of type int (or any comparable type)
candles := []Candle{
	{N: 3},
	{N: 1},
	{N: 2},
}

// Sorting the slice of Candle instances by their N field in ascending order
sort.Sort(ByN(candles))

// Printing out the sorted N values to demonstrate the order
for _, candle := range candles {
	fmt.Println(candle.N)
}

Output​

1
2
3

Len​

func (a ByN) Len() int

Less​

func (a ByN) Less(i, j int) bool

Swap​

func (a ByN) Swap(i, j int)

ByOpen​

type ByOpen []Candle

ByOpen implements sort.Interface for []Candle based on the Open field.

// Assuming the Candle struct has at least an Open field of type float64
candles := []Candle{
	{Open: 10.5},
	{Open: 8.2},
	{Open: 9.7},
}

// Sorting the slice of Candle instances by their Open field in ascending order
sort.Sort(ByOpen(candles))

// Printing out the sorted Open values to demonstrate the order
for _, candle := range candles {
	fmt.Printf("%.1f\n", candle.Open)
}

Output​

8.2
9.7
10.5

Len​

func (a ByOpen) Len() int

Less​

func (a ByOpen) Less(i, j int) bool

Swap​

func (a ByOpen) Swap(i, j int)

BySymbol​

type BySymbol []Candle

BySymbol implements sort.Interface for []Candle based on the Symbol field. Candles are sorted in ascending order.

// Create a slice of Candle instances with different symbols
candles := []Candle{
	{Symbol: "MSFT", Date: time.Date(2023, 4, 10, 0, 0, 0, 0, time.UTC), Open: 250.0, High: 255.0, Low: 248.0, Close: 252.0, Volume: 3000},
	{Symbol: "AAPL", Date: time.Date(2023, 4, 10, 0, 0, 0, 0, time.UTC), Open: 150.0, High: 155.0, Low: 149.0, Close: 152.0, Volume: 2000},
	{Symbol: "GOOGL", Date: time.Date(2023, 4, 10, 0, 0, 0, 0, time.UTC), Open: 1200.0, High: 1210.0, Low: 1195.0, Close: 1205.0, Volume: 1000},
}

// Sort the candles by their Symbol using sort.Sort and BySymbol
sort.Sort(BySymbol(candles))

// Print the sorted candles to demonstrate the order
for _, candle := range candles {
	fmt.Printf("Symbol: %s, Close: %.2f\n", candle.Symbol, candle.Close)
}

Output​

Symbol: AAPL, Close: 152.00
Symbol: GOOGL, Close: 1205.00
Symbol: MSFT, Close: 252.00

Len​

func (a BySymbol) Len() int

Less​

func (a BySymbol) Less(i, j int) bool

Swap​

func (a BySymbol) Swap(i, j int)

ByVWAP​

type ByVWAP []Candle

ByVWAP implements sort.Interface for []Candle based on the VWAP field.

// Assuming the Candle struct has at least a VWAP (Volume Weighted Average Price) field of type float64
candles := []Candle{
	{VWAP: 10.5},
	{VWAP: 8.2},
	{VWAP: 9.7},
}

// Sorting the slice of Candle instances by their VWAP field in ascending order
sort.Sort(ByVWAP(candles))

// Printing out the sorted VWAP values to demonstrate the order
for _, candle := range candles {
	fmt.Printf("%.1f\n", candle.VWAP)
}

Output​

8.2
9.7
10.5

Len​

func (a ByVWAP) Len() int

Less​

func (a ByVWAP) Less(i, j int) bool

Swap​

func (a ByVWAP) Swap(i, j int)

ByVolume​

type ByVolume []Candle

ByVolume implements sort.Interface for []Candle based on the Volume field.

// Assuming the Candle struct has at least a Volume field of type int
candles := []Candle{
	{Volume: 300},
	{Volume: 100},
	{Volume: 200},
}

// Sorting the slice of Candle instances by their Volume field in ascending order
sort.Sort(ByVolume(candles))

// Printing out the sorted volumes to demonstrate the order
for _, candle := range candles {
	fmt.Println(candle.Volume)
}

Output​

100
200
300

Len​

func (a ByVolume) Len() int

Less​

func (a ByVolume) Less(i, j int) bool

Swap​

func (a ByVolume) Swap(i, j int)