sectors

package
v0.1.3 Latest Latest
Warning

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

Go to latest
Published: Jun 28, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package sectors contains the generated, typed client for the Sectors Financial API v2 plus thin hand-written helpers (auth, base URL).

The *.gen.go files are produced by oapi-codegen from ../../sectors-schema.json. Regenerate with `go generate ./...` after updating the spec.

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.1 DO NOT EDIT.

Index

Constants

View Source
const (
	ApiKeyAuthScopes aPIKeyAuthContextKey = "ApiKeyAuth.Scopes"
)
View Source
const CacheHeader = "X-Sectors-Cache"

CacheHeader is set on responses served (or filled) by the cache transport so outer layers (e.g. verbose logging) can tell hits from misses.

View Source
const DefaultBaseURL = "https://api.sectors.app"

DefaultBaseURL is the production Sectors Financial API server.

Variables

This section is empty.

Functions

func NewBrokerActivityRetrieveRequest

func NewBrokerActivityRetrieveRequest(server string, brokerCode string, params *BrokerActivityRetrieveParams) (*http.Request, error)

NewBrokerActivityRetrieveRequest generates requests for BrokerActivityRetrieve

func NewBrokerActivityTopRetrieveRequest

func NewBrokerActivityTopRetrieveRequest(server string, brokerCode string, params *BrokerActivityTopRetrieveParams) (*http.Request, error)

NewBrokerActivityTopRetrieveRequest generates requests for BrokerActivityTopRetrieve

func NewBrokerSummaryRetrieveRequest

func NewBrokerSummaryRetrieveRequest(server string, symbol string, params *BrokerSummaryRetrieveParams) (*http.Request, error)

NewBrokerSummaryRetrieveRequest generates requests for BrokerSummaryRetrieve

func NewBrokerSummaryTopRetrieveRequest

func NewBrokerSummaryTopRetrieveRequest(server string, symbol string, params *BrokerSummaryTopRetrieveParams) (*http.Request, error)

NewBrokerSummaryTopRetrieveRequest generates requests for BrokerSummaryTopRetrieve

func NewBrokersRetrieveRequest

func NewBrokersRetrieveRequest(server string, params *BrokersRetrieveParams) (*http.Request, error)

NewBrokersRetrieveRequest generates requests for BrokersRetrieve

func NewBrokersTopRetrieveRequest

func NewBrokersTopRetrieveRequest(server string, params *BrokersTopRetrieveParams) (*http.Request, error)

NewBrokersTopRetrieveRequest generates requests for BrokersTopRetrieve

func NewCacheTransport

func NewCacheTransport(base http.RoundTripper, cfg CacheConfig) http.RoundTripper

NewCacheTransport wraps base with an on-disk GET cache. A response is served from disk while fresh; otherwise the request goes through and a 2xx result is stored. Non-GET requests pass straight through.

func NewCompaniesListCompaniesWithSegmentsListRequest

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

NewCompaniesListCompaniesWithSegmentsListRequest generates requests for CompaniesListCompaniesWithSegmentsList

func NewCompaniesRetrieveRequest

func NewCompaniesRetrieveRequest(server string, params *CompaniesRetrieveParams) (*http.Request, error)

NewCompaniesRetrieveRequest generates requests for CompaniesRetrieve

func NewCompaniesTopChangesRetrieveRequest

func NewCompaniesTopChangesRetrieveRequest(server string, params *CompaniesTopChangesRetrieveParams) (*http.Request, error)

NewCompaniesTopChangesRetrieveRequest generates requests for CompaniesTopChangesRetrieve

func NewCompanyCorporateActionsRetrieveRequest

func NewCompanyCorporateActionsRetrieveRequest(server string, symbol string) (*http.Request, error)

NewCompanyCorporateActionsRetrieveRequest generates requests for CompanyCorporateActionsRetrieve

func NewCompanyGetQuarterlyFinancialDatesRetrieveRequest

func NewCompanyGetQuarterlyFinancialDatesRetrieveRequest(server string, symbol string) (*http.Request, error)

NewCompanyGetQuarterlyFinancialDatesRetrieveRequest generates requests for CompanyGetQuarterlyFinancialDatesRetrieve

func NewCompanyGetSegmentsRetrieveRequest

func NewCompanyGetSegmentsRetrieveRequest(server string, symbol string, params *CompanyGetSegmentsRetrieveParams) (*http.Request, error)

NewCompanyGetSegmentsRetrieveRequest generates requests for CompanyGetSegmentsRetrieve

func NewCompanyReportRetrieve2Request

func NewCompanyReportRetrieve2Request(server string, symbol string, params *CompanyReportRetrieve2Params) (*http.Request, error)

NewCompanyReportRetrieve2Request generates requests for CompanyReportRetrieve2

func NewCompanyShareholdersCompositionRetrieveRequest

func NewCompanyShareholdersCompositionRetrieveRequest(server string, symbol string, params *CompanyShareholdersCompositionRetrieveParams) (*http.Request, error)

NewCompanyShareholdersCompositionRetrieveRequest generates requests for CompanyShareholdersCompositionRetrieve

func NewDailyRetrieveRequest

func NewDailyRetrieveRequest(server string, symbol string, params *DailyRetrieveParams) (*http.Request, error)

NewDailyRetrieveRequest generates requests for DailyRetrieve

func NewDryRunTransport

func NewDryRunTransport() http.RoundTripper

NewDryRunTransport returns a transport that echoes requests instead of sending.

func NewFilingsRetrieveRequest

func NewFilingsRetrieveRequest(server string, params *FilingsRetrieveParams) (*http.Request, error)

NewFilingsRetrieveRequest generates requests for FilingsRetrieve

func NewFinancialsQuarterlyRetrieveRequest

func NewFinancialsQuarterlyRetrieveRequest(server string, symbol string, params *FinancialsQuarterlyRetrieveParams) (*http.Request, error)

NewFinancialsQuarterlyRetrieveRequest generates requests for FinancialsQuarterlyRetrieve

func NewForeignFlowRetrieveRequest

func NewForeignFlowRetrieveRequest(server string, symbol string, params *ForeignFlowRetrieveParams) (*http.Request, error)

NewForeignFlowRetrieveRequest generates requests for ForeignFlowRetrieve

func NewFreeFloatRetrieveRequest

func NewFreeFloatRetrieveRequest(server string, params *FreeFloatRetrieveParams) (*http.Request, error)

NewFreeFloatRetrieveRequest generates requests for FreeFloatRetrieve

func NewIDXTotalRetrieveRequest

func NewIDXTotalRetrieveRequest(server string, params *IDXTotalRetrieveParams) (*http.Request, error)

NewIDXTotalRetrieveRequest generates requests for IDXTotalRetrieve

func NewIndexDailyRetrieveRequest

func NewIndexDailyRetrieveRequest(server string, indexCode string, params *IndexDailyRetrieveParams) (*http.Request, error)

NewIndexDailyRetrieveRequest generates requests for IndexDailyRetrieve

func NewIndustriesListRequest

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

NewIndustriesListRequest generates requests for IndustriesList

func NewKLSECompaniesListRequest

func NewKLSECompaniesListRequest(server string, params *KLSECompaniesListParams) (*http.Request, error)

NewKLSECompaniesListRequest generates requests for KLSECompaniesList

func NewKLSECompaniesTopRetrieveRequest

func NewKLSECompaniesTopRetrieveRequest(server string, params *KLSECompaniesTopRetrieveParams) (*http.Request, error)

NewKLSECompaniesTopRetrieveRequest generates requests for KLSECompaniesTopRetrieve

func NewKLSECompanyReportRetrieve2Request

func NewKLSECompanyReportRetrieve2Request(server string, symbol string, params *KLSECompanyReportRetrieve2Params) (*http.Request, error)

NewKLSECompanyReportRetrieve2Request generates requests for KLSECompanyReportRetrieve2

func NewKLSESectorsListRequest

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

NewKLSESectorsListRequest generates requests for KLSESectorsList

func NewListingPerformanceRetrieveRequest

func NewListingPerformanceRetrieveRequest(server string, symbol string) (*http.Request, error)

NewListingPerformanceRetrieveRequest generates requests for ListingPerformanceRetrieve

func NewLogTransport

func NewLogTransport(base http.RoundTripper, w io.Writer) http.RoundTripper

NewLogTransport wraps base to emit request traces to w. Use for --verbose.

func NewMiningCommoditiesPriceRetrieveRequest

func NewMiningCommoditiesPriceRetrieveRequest(server string, commodityName string, params *MiningCommoditiesPriceRetrieveParams) (*http.Request, error)

NewMiningCommoditiesPriceRetrieveRequest generates requests for MiningCommoditiesPriceRetrieve

func NewMiningCommoditiesRetrieveRequest

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

NewMiningCommoditiesRetrieveRequest generates requests for MiningCommoditiesRetrieve

func NewMiningCompaniesFinancialsRetrieveRequest

func NewMiningCompaniesFinancialsRetrieveRequest(server string, slug string, params *MiningCompaniesFinancialsRetrieveParams) (*http.Request, error)

NewMiningCompaniesFinancialsRetrieveRequest generates requests for MiningCompaniesFinancialsRetrieve

func NewMiningCompaniesOwnershipRetrieveRequest

func NewMiningCompaniesOwnershipRetrieveRequest(server string, slug string) (*http.Request, error)

NewMiningCompaniesOwnershipRetrieveRequest generates requests for MiningCompaniesOwnershipRetrieve

func NewMiningCompaniesPerformanceRetrieveRequest

func NewMiningCompaniesPerformanceRetrieveRequest(server string, slug string, params *MiningCompaniesPerformanceRetrieveParams) (*http.Request, error)

NewMiningCompaniesPerformanceRetrieveRequest generates requests for MiningCompaniesPerformanceRetrieve

func NewMiningCompaniesRetrieve2Request

func NewMiningCompaniesRetrieve2Request(server string, slug string) (*http.Request, error)

NewMiningCompaniesRetrieve2Request generates requests for MiningCompaniesRetrieve2

func NewMiningCompaniesRetrieveRequest

func NewMiningCompaniesRetrieveRequest(server string, params *MiningCompaniesRetrieveParams) (*http.Request, error)

NewMiningCompaniesRetrieveRequest generates requests for MiningCompaniesRetrieve

func NewMiningContractsRetrieveRequest

func NewMiningContractsRetrieveRequest(server string, params *MiningContractsRetrieveParams) (*http.Request, error)

NewMiningContractsRetrieveRequest generates requests for MiningContractsRetrieve

func NewMiningExportsRetrieveRequest

func NewMiningExportsRetrieveRequest(server string, params *MiningExportsRetrieveParams) (*http.Request, error)

NewMiningExportsRetrieveRequest generates requests for MiningExportsRetrieve

func NewMiningGlobalCommodityRetrieveRequest

func NewMiningGlobalCommodityRetrieveRequest(server string, params *MiningGlobalCommodityRetrieveParams) (*http.Request, error)

NewMiningGlobalCommodityRetrieveRequest generates requests for MiningGlobalCommodityRetrieve

func NewMiningLicenseAuctionsRetrieve2Request

func NewMiningLicenseAuctionsRetrieve2Request(server string, wiupCode string) (*http.Request, error)

NewMiningLicenseAuctionsRetrieve2Request generates requests for MiningLicenseAuctionsRetrieve2

func NewMiningLicenseAuctionsRetrieveRequest

func NewMiningLicenseAuctionsRetrieveRequest(server string, params *MiningLicenseAuctionsRetrieveParams) (*http.Request, error)

NewMiningLicenseAuctionsRetrieveRequest generates requests for MiningLicenseAuctionsRetrieve

func NewMiningLicensesRetrieveRequest

func NewMiningLicensesRetrieveRequest(server string, params *MiningLicensesRetrieveParams) (*http.Request, error)

NewMiningLicensesRetrieveRequest generates requests for MiningLicensesRetrieve

func NewMiningResourcesReservesRetrieve2Request

func NewMiningResourcesReservesRetrieve2Request(server string, province string, params *MiningResourcesReservesRetrieve2Params) (*http.Request, error)

NewMiningResourcesReservesRetrieve2Request generates requests for MiningResourcesReservesRetrieve2

func NewMiningResourcesReservesRetrieveRequest

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

NewMiningResourcesReservesRetrieveRequest generates requests for MiningResourcesReservesRetrieve

func NewMiningSalesDestinationRetrieveRequest

func NewMiningSalesDestinationRetrieveRequest(server string, slug string, params *MiningSalesDestinationRetrieveParams) (*http.Request, error)

NewMiningSalesDestinationRetrieveRequest generates requests for MiningSalesDestinationRetrieve

func NewMiningSitesRetrieve2Request

func NewMiningSitesRetrieve2Request(server string, slug string) (*http.Request, error)

NewMiningSitesRetrieve2Request generates requests for MiningSitesRetrieve2

func NewMiningSitesRetrieveRequest

func NewMiningSitesRetrieveRequest(server string, params *MiningSitesRetrieveParams) (*http.Request, error)

NewMiningSitesRetrieveRequest generates requests for MiningSitesRetrieve

func NewMiningTotalProductionRetrieveRequest

func NewMiningTotalProductionRetrieveRequest(server string, params *MiningTotalProductionRetrieveParams) (*http.Request, error)

NewMiningTotalProductionRetrieveRequest generates requests for MiningTotalProductionRetrieve

func NewMostTradedRetrieveRequest

func NewMostTradedRetrieveRequest(server string, params *MostTradedRetrieveParams) (*http.Request, error)

NewMostTradedRetrieveRequest generates requests for MostTradedRetrieve

func NewNewsRetrieveRequest

func NewNewsRetrieveRequest(server string, params *NewsRetrieveParams) (*http.Request, error)

NewNewsRetrieveRequest generates requests for NewsRetrieve

func NewRetryTransport

func NewRetryTransport(base http.RoundTripper, maxRetries int, maxWait time.Duration) http.RoundTripper

NewRetryTransport wraps base with retry behavior. maxRetries <= 0 disables retries and returns base unchanged. A nil base uses http.DefaultTransport.

func NewSGXBuybacksRetrieveRequest

func NewSGXBuybacksRetrieveRequest(server string, params *SGXBuybacksRetrieveParams) (*http.Request, error)

NewSGXBuybacksRetrieveRequest generates requests for SGXBuybacksRetrieve

func NewSGXCompaniesRetrieveRequest

func NewSGXCompaniesRetrieveRequest(server string, params *SGXCompaniesRetrieveParams) (*http.Request, error)

NewSGXCompaniesRetrieveRequest generates requests for SGXCompaniesRetrieve

func NewSGXCompaniesTopRetrieveRequest

func NewSGXCompaniesTopRetrieveRequest(server string, params *SGXCompaniesTopRetrieveParams) (*http.Request, error)

NewSGXCompaniesTopRetrieveRequest generates requests for SGXCompaniesTopRetrieve

func NewSGXCompanyReportRetrieve2Request

func NewSGXCompanyReportRetrieve2Request(server string, symbol string, params *SGXCompanyReportRetrieve2Params) (*http.Request, error)

NewSGXCompanyReportRetrieve2Request generates requests for SGXCompanyReportRetrieve2

func NewSGXDailyRetrieveRequest

func NewSGXDailyRetrieveRequest(server string, symbol string, params *SGXDailyRetrieveParams) (*http.Request, error)

NewSGXDailyRetrieveRequest generates requests for SGXDailyRetrieve

func NewSGXFilingsRetrieveRequest

func NewSGXFilingsRetrieveRequest(server string, params *SGXFilingsRetrieveParams) (*http.Request, error)

NewSGXFilingsRetrieveRequest generates requests for SGXFilingsRetrieve

func NewSGXNewsRetrieveRequest

func NewSGXNewsRetrieveRequest(server string, params *SGXNewsRetrieveParams) (*http.Request, error)

NewSGXNewsRetrieveRequest generates requests for SGXNewsRetrieve

func NewSGXSectorsListRequest

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

NewSGXSectorsListRequest generates requests for SGXSectorsList

func NewSGXShortSellRetrieveRequest

func NewSGXShortSellRetrieveRequest(server string, params *SGXShortSellRetrieveParams) (*http.Request, error)

NewSGXShortSellRetrieveRequest generates requests for SGXShortSellRetrieve

func NewSGXTagsRetrieveRequest

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

NewSGXTagsRetrieveRequest generates requests for SGXTagsRetrieve

func NewSubindustriesListRequest

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

NewSubindustriesListRequest generates requests for SubindustriesList

func NewSubsectorReportRetrieve2Request

func NewSubsectorReportRetrieve2Request(server string, subSector string, params *SubsectorReportRetrieve2Params) (*http.Request, error)

NewSubsectorReportRetrieve2Request generates requests for SubsectorReportRetrieve2

func NewSubsectorsListRequest

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

NewSubsectorsListRequest generates requests for SubsectorsList

func NewSuspensionsRetrieveRequest

func NewSuspensionsRetrieveRequest(server string, params *SuspensionsRetrieveParams) (*http.Request, error)

NewSuspensionsRetrieveRequest generates requests for SuspensionsRetrieve

func NewTagsListRequest

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

NewTagsListRequest generates requests for TagsList

Types

type BrokerActivityRetrieveParams

type BrokerActivityRetrieveParams struct {
	// Symbol Optional filter to a single stock ticker (e.g. `BBCA`).
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Start Start date (YYYY-MM-DD). Default: end - 14 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date (YYYY-MM-DD). Default: today.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

BrokerActivityRetrieveParams defines parameters for BrokerActivityRetrieve.

type BrokerActivityRetrieveResponse

type BrokerActivityRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseBrokerActivityRetrieveResponse

func ParseBrokerActivityRetrieveResponse(rsp *http.Response) (*BrokerActivityRetrieveResponse, error)

ParseBrokerActivityRetrieveResponse parses an HTTP response from a BrokerActivityRetrieveWithResponse call

func (BrokerActivityRetrieveResponse) ContentType

func (r BrokerActivityRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokerActivityRetrieveResponse) Status

Status returns HTTPResponse.Status

func (BrokerActivityRetrieveResponse) StatusCode

func (r BrokerActivityRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrokerActivityTopRetrieveParams

type BrokerActivityTopRetrieveParams struct {
	// Start Start date (YYYY-MM-DD). Default: end - 30 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date (YYYY-MM-DD). Default: today.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// NBrokers How many accumulations and distributions to return each (default 10, max 100).
	NBrokers *int `form:"n_brokers,omitempty" json:"n_brokers,omitempty"`
}

BrokerActivityTopRetrieveParams defines parameters for BrokerActivityTopRetrieve.

type BrokerActivityTopRetrieveResponse

type BrokerActivityTopRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseBrokerActivityTopRetrieveResponse

func ParseBrokerActivityTopRetrieveResponse(rsp *http.Response) (*BrokerActivityTopRetrieveResponse, error)

ParseBrokerActivityTopRetrieveResponse parses an HTTP response from a BrokerActivityTopRetrieveWithResponse call

func (BrokerActivityTopRetrieveResponse) ContentType

func (r BrokerActivityTopRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokerActivityTopRetrieveResponse) Status

Status returns HTTPResponse.Status

func (BrokerActivityTopRetrieveResponse) StatusCode

func (r BrokerActivityTopRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrokerSummaryRetrieveParams

type BrokerSummaryRetrieveParams struct {
	// BrokerCode Optional filter to a single broker code (e.g. `MG`).
	BrokerCode *string `form:"broker_code,omitempty" json:"broker_code,omitempty"`

	// Start Start date (YYYY-MM-DD). Default: end - 14 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date (YYYY-MM-DD). Default: today.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

BrokerSummaryRetrieveParams defines parameters for BrokerSummaryRetrieve.

type BrokerSummaryRetrieveResponse

type BrokerSummaryRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseBrokerSummaryRetrieveResponse

func ParseBrokerSummaryRetrieveResponse(rsp *http.Response) (*BrokerSummaryRetrieveResponse, error)

ParseBrokerSummaryRetrieveResponse parses an HTTP response from a BrokerSummaryRetrieveWithResponse call

func (BrokerSummaryRetrieveResponse) ContentType

func (r BrokerSummaryRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokerSummaryRetrieveResponse) Status

Status returns HTTPResponse.Status

func (BrokerSummaryRetrieveResponse) StatusCode

func (r BrokerSummaryRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrokerSummaryTopRetrieveParams

type BrokerSummaryTopRetrieveParams struct {
	// Start Start date (YYYY-MM-DD). Default: end - 30 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date (YYYY-MM-DD). Default: today.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Cohort Filter brokers by cohort (case-insensitive). Default `all`.
	Cohort *BrokerSummaryTopRetrieveParamsCohort `form:"cohort,omitempty" json:"cohort,omitempty"`

	// NBrokers How many buyers and sellers to return each (default 10, max 100).
	NBrokers *int `form:"n_brokers,omitempty" json:"n_brokers,omitempty"`

	// Origin Filter brokers by origin. Default `all`.
	Origin *BrokerSummaryTopRetrieveParamsOrigin `form:"origin,omitempty" json:"origin,omitempty"`
}

BrokerSummaryTopRetrieveParams defines parameters for BrokerSummaryTopRetrieve.

type BrokerSummaryTopRetrieveParamsCohort

type BrokerSummaryTopRetrieveParamsCohort string

BrokerSummaryTopRetrieveParamsCohort defines parameters for BrokerSummaryTopRetrieve.

const (
	BrokerSummaryTopRetrieveParamsCohortAll           BrokerSummaryTopRetrieveParamsCohort = "all"
	BrokerSummaryTopRetrieveParamsCohortInstitutional BrokerSummaryTopRetrieveParamsCohort = "institutional"
	BrokerSummaryTopRetrieveParamsCohortMixed         BrokerSummaryTopRetrieveParamsCohort = "mixed"
	BrokerSummaryTopRetrieveParamsCohortRetail        BrokerSummaryTopRetrieveParamsCohort = "retail"
	BrokerSummaryTopRetrieveParamsCohortUnknown       BrokerSummaryTopRetrieveParamsCohort = "unknown"
)

Defines values for BrokerSummaryTopRetrieveParamsCohort.

func (BrokerSummaryTopRetrieveParamsCohort) Valid

Valid indicates whether the value is a known member of the BrokerSummaryTopRetrieveParamsCohort enum.

type BrokerSummaryTopRetrieveParamsOrigin

type BrokerSummaryTopRetrieveParamsOrigin string

BrokerSummaryTopRetrieveParamsOrigin defines parameters for BrokerSummaryTopRetrieve.

const (
	BrokerSummaryTopRetrieveParamsOriginAll      BrokerSummaryTopRetrieveParamsOrigin = "all"
	BrokerSummaryTopRetrieveParamsOriginDomestic BrokerSummaryTopRetrieveParamsOrigin = "domestic"
	BrokerSummaryTopRetrieveParamsOriginForeign  BrokerSummaryTopRetrieveParamsOrigin = "foreign"
)

Defines values for BrokerSummaryTopRetrieveParamsOrigin.

func (BrokerSummaryTopRetrieveParamsOrigin) Valid

Valid indicates whether the value is a known member of the BrokerSummaryTopRetrieveParamsOrigin enum.

type BrokerSummaryTopRetrieveResponse

type BrokerSummaryTopRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseBrokerSummaryTopRetrieveResponse

func ParseBrokerSummaryTopRetrieveResponse(rsp *http.Response) (*BrokerSummaryTopRetrieveResponse, error)

ParseBrokerSummaryTopRetrieveResponse parses an HTTP response from a BrokerSummaryTopRetrieveWithResponse call

func (BrokerSummaryTopRetrieveResponse) ContentType

func (r BrokerSummaryTopRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokerSummaryTopRetrieveResponse) Status

Status returns HTTPResponse.Status

func (BrokerSummaryTopRetrieveResponse) StatusCode

func (r BrokerSummaryTopRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrokersRetrieveParams

type BrokersRetrieveParams struct {
	// Cohort Optional filter by broker cohort (case-insensitive).
	Cohort *BrokersRetrieveParamsCohort `form:"cohort,omitempty" json:"cohort,omitempty"`

	// Origin Optional filter by broker origin.
	Origin *BrokersRetrieveParamsOrigin `form:"origin,omitempty" json:"origin,omitempty"`
}

BrokersRetrieveParams defines parameters for BrokersRetrieve.

type BrokersRetrieveParamsCohort

type BrokersRetrieveParamsCohort string

BrokersRetrieveParamsCohort defines parameters for BrokersRetrieve.

const (
	BrokersRetrieveParamsCohortInstitutional BrokersRetrieveParamsCohort = "institutional"
	BrokersRetrieveParamsCohortMixed         BrokersRetrieveParamsCohort = "mixed"
	BrokersRetrieveParamsCohortRetail        BrokersRetrieveParamsCohort = "retail"
	BrokersRetrieveParamsCohortUnknown       BrokersRetrieveParamsCohort = "unknown"
)

Defines values for BrokersRetrieveParamsCohort.

func (BrokersRetrieveParamsCohort) Valid

Valid indicates whether the value is a known member of the BrokersRetrieveParamsCohort enum.

type BrokersRetrieveParamsOrigin

type BrokersRetrieveParamsOrigin string

BrokersRetrieveParamsOrigin defines parameters for BrokersRetrieve.

const (
	BrokersRetrieveParamsOriginDomestic BrokersRetrieveParamsOrigin = "domestic"
	BrokersRetrieveParamsOriginForeign  BrokersRetrieveParamsOrigin = "foreign"
)

Defines values for BrokersRetrieveParamsOrigin.

func (BrokersRetrieveParamsOrigin) Valid

Valid indicates whether the value is a known member of the BrokersRetrieveParamsOrigin enum.

type BrokersRetrieveResponse

type BrokersRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseBrokersRetrieveResponse

func ParseBrokersRetrieveResponse(rsp *http.Response) (*BrokersRetrieveResponse, error)

ParseBrokersRetrieveResponse parses an HTTP response from a BrokersRetrieveWithResponse call

func (BrokersRetrieveResponse) ContentType

func (r BrokersRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokersRetrieveResponse) Status

func (r BrokersRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (BrokersRetrieveResponse) StatusCode

func (r BrokersRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BrokersTopRetrieveParams

type BrokersTopRetrieveParams struct {
	// Cohort Filter by broker cohort (case-insensitive). Default `all`.
	Cohort *BrokersTopRetrieveParamsCohort `form:"cohort,omitempty" json:"cohort,omitempty"`

	// Date Target date (YYYY-MM-DD). Default: latest available.
	Date *string `form:"date,omitempty" json:"date,omitempty"`

	// Metric `gross` ranks by total buy + sell value; `net` ranks by absolute net flow. Default `gross`.
	Metric *BrokersTopRetrieveParamsMetric `form:"metric,omitempty" json:"metric,omitempty"`

	// NBrokers How many brokers to return. Default: all matching (typically ~80). Max 200.
	NBrokers *int `form:"n_brokers,omitempty" json:"n_brokers,omitempty"`

	// Origin Filter by broker origin. Default `all`.
	Origin *BrokersTopRetrieveParamsOrigin `form:"origin,omitempty" json:"origin,omitempty"`
}

BrokersTopRetrieveParams defines parameters for BrokersTopRetrieve.

type BrokersTopRetrieveParamsCohort

type BrokersTopRetrieveParamsCohort string

BrokersTopRetrieveParamsCohort defines parameters for BrokersTopRetrieve.

const (
	BrokersTopRetrieveParamsCohortAll           BrokersTopRetrieveParamsCohort = "all"
	BrokersTopRetrieveParamsCohortInstitutional BrokersTopRetrieveParamsCohort = "institutional"
	BrokersTopRetrieveParamsCohortMixed         BrokersTopRetrieveParamsCohort = "mixed"
	BrokersTopRetrieveParamsCohortRetail        BrokersTopRetrieveParamsCohort = "retail"
	BrokersTopRetrieveParamsCohortUnknown       BrokersTopRetrieveParamsCohort = "unknown"
)

Defines values for BrokersTopRetrieveParamsCohort.

func (BrokersTopRetrieveParamsCohort) Valid

Valid indicates whether the value is a known member of the BrokersTopRetrieveParamsCohort enum.

type BrokersTopRetrieveParamsMetric

type BrokersTopRetrieveParamsMetric string

BrokersTopRetrieveParamsMetric defines parameters for BrokersTopRetrieve.

const (
	Gross BrokersTopRetrieveParamsMetric = "gross"
	Net   BrokersTopRetrieveParamsMetric = "net"
)

Defines values for BrokersTopRetrieveParamsMetric.

func (BrokersTopRetrieveParamsMetric) Valid

Valid indicates whether the value is a known member of the BrokersTopRetrieveParamsMetric enum.

type BrokersTopRetrieveParamsOrigin

type BrokersTopRetrieveParamsOrigin string

BrokersTopRetrieveParamsOrigin defines parameters for BrokersTopRetrieve.

const (
	BrokersTopRetrieveParamsOriginAll      BrokersTopRetrieveParamsOrigin = "all"
	BrokersTopRetrieveParamsOriginDomestic BrokersTopRetrieveParamsOrigin = "domestic"
	BrokersTopRetrieveParamsOriginForeign  BrokersTopRetrieveParamsOrigin = "foreign"
)

Defines values for BrokersTopRetrieveParamsOrigin.

func (BrokersTopRetrieveParamsOrigin) Valid

Valid indicates whether the value is a known member of the BrokersTopRetrieveParamsOrigin enum.

type BrokersTopRetrieveResponse

type BrokersTopRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseBrokersTopRetrieveResponse

func ParseBrokersTopRetrieveResponse(rsp *http.Response) (*BrokersTopRetrieveResponse, error)

ParseBrokersTopRetrieveResponse parses an HTTP response from a BrokersTopRetrieveWithResponse call

func (BrokersTopRetrieveResponse) ContentType

func (r BrokersTopRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BrokersTopRetrieveResponse) Status

Status returns HTTPResponse.Status

func (BrokersTopRetrieveResponse) StatusCode

func (r BrokersTopRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CacheConfig

type CacheConfig struct {
	Dir string        // directory for cache files
	TTL time.Duration // 0 = classify per endpoint; >0 = uniform TTL
}

CacheConfig configures the on-disk response cache.

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) BrokerActivityRetrieve

func (c *Client) BrokerActivityRetrieve(ctx context.Context, brokerCode string, params *BrokerActivityRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BrokerActivityTopRetrieve

func (c *Client) BrokerActivityTopRetrieve(ctx context.Context, brokerCode string, params *BrokerActivityTopRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BrokerSummaryRetrieve

func (c *Client) BrokerSummaryRetrieve(ctx context.Context, symbol string, params *BrokerSummaryRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BrokerSummaryTopRetrieve

func (c *Client) BrokerSummaryTopRetrieve(ctx context.Context, symbol string, params *BrokerSummaryTopRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BrokersRetrieve

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

func (*Client) BrokersTopRetrieve

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

func (*Client) CompaniesListCompaniesWithSegmentsList

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

func (*Client) CompaniesRetrieve

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

func (*Client) CompaniesTopChangesRetrieve

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

func (*Client) CompanyCorporateActionsRetrieve

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

func (*Client) CompanyGetQuarterlyFinancialDatesRetrieve

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

func (*Client) CompanyGetSegmentsRetrieve

func (c *Client) CompanyGetSegmentsRetrieve(ctx context.Context, symbol string, params *CompanyGetSegmentsRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompanyReportRetrieve2

func (c *Client) CompanyReportRetrieve2(ctx context.Context, symbol string, params *CompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompanyShareholdersCompositionRetrieve

func (c *Client) CompanyShareholdersCompositionRetrieve(ctx context.Context, symbol string, params *CompanyShareholdersCompositionRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DailyRetrieve

func (c *Client) DailyRetrieve(ctx context.Context, symbol string, params *DailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FilingsRetrieve

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

func (*Client) FinancialsQuarterlyRetrieve

func (c *Client) FinancialsQuarterlyRetrieve(ctx context.Context, symbol string, params *FinancialsQuarterlyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ForeignFlowRetrieve

func (c *Client) ForeignFlowRetrieve(ctx context.Context, symbol string, params *ForeignFlowRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) FreeFloatRetrieve

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

func (*Client) IDXTotalRetrieve

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

func (*Client) IndexDailyRetrieve

func (c *Client) IndexDailyRetrieve(ctx context.Context, indexCode string, params *IndexDailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) IndustriesList

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

func (*Client) KLSECompaniesList

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

func (*Client) KLSECompaniesTopRetrieve

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

func (*Client) KLSECompanyReportRetrieve2

func (c *Client) KLSECompanyReportRetrieve2(ctx context.Context, symbol string, params *KLSECompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) KLSESectorsList

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

func (*Client) ListingPerformanceRetrieve

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

func (*Client) MiningCommoditiesPriceRetrieve

func (c *Client) MiningCommoditiesPriceRetrieve(ctx context.Context, commodityName string, params *MiningCommoditiesPriceRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MiningCommoditiesRetrieve

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

func (*Client) MiningCompaniesFinancialsRetrieve

func (c *Client) MiningCompaniesFinancialsRetrieve(ctx context.Context, slug string, params *MiningCompaniesFinancialsRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MiningCompaniesOwnershipRetrieve

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

func (*Client) MiningCompaniesPerformanceRetrieve

func (c *Client) MiningCompaniesPerformanceRetrieve(ctx context.Context, slug string, params *MiningCompaniesPerformanceRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MiningCompaniesRetrieve

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

func (*Client) MiningCompaniesRetrieve2

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

func (*Client) MiningContractsRetrieve

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

func (*Client) MiningExportsRetrieve

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

func (*Client) MiningGlobalCommodityRetrieve

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

func (*Client) MiningLicenseAuctionsRetrieve

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

func (*Client) MiningLicenseAuctionsRetrieve2

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

func (*Client) MiningLicensesRetrieve

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

func (*Client) MiningResourcesReservesRetrieve

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

func (*Client) MiningResourcesReservesRetrieve2

func (c *Client) MiningResourcesReservesRetrieve2(ctx context.Context, province string, params *MiningResourcesReservesRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MiningSalesDestinationRetrieve

func (c *Client) MiningSalesDestinationRetrieve(ctx context.Context, slug string, params *MiningSalesDestinationRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) MiningSitesRetrieve

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

func (*Client) MiningSitesRetrieve2

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

func (*Client) MiningTotalProductionRetrieve

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

func (*Client) MostTradedRetrieve

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

func (*Client) NewsRetrieve

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

func (*Client) SGXBuybacksRetrieve

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

func (*Client) SGXCompaniesRetrieve

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

func (*Client) SGXCompaniesTopRetrieve

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

func (*Client) SGXCompanyReportRetrieve2

func (c *Client) SGXCompanyReportRetrieve2(ctx context.Context, symbol string, params *SGXCompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SGXDailyRetrieve

func (c *Client) SGXDailyRetrieve(ctx context.Context, symbol string, params *SGXDailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SGXFilingsRetrieve

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

func (*Client) SGXNewsRetrieve

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

func (*Client) SGXSectorsList

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

func (*Client) SGXShortSellRetrieve

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

func (*Client) SGXTagsRetrieve

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

func (*Client) SubindustriesList

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

func (*Client) SubsectorReportRetrieve2

func (c *Client) SubsectorReportRetrieve2(ctx context.Context, subSector string, params *SubsectorReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubsectorsList

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

func (*Client) SuspensionsRetrieve

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

func (*Client) TagsList

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

type ClientInterface

type ClientInterface interface {
	// BrokerActivityRetrieve request
	BrokerActivityRetrieve(ctx context.Context, brokerCode string, params *BrokerActivityRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BrokerActivityTopRetrieve request
	BrokerActivityTopRetrieve(ctx context.Context, brokerCode string, params *BrokerActivityTopRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BrokerSummaryRetrieve request
	BrokerSummaryRetrieve(ctx context.Context, symbol string, params *BrokerSummaryRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BrokerSummaryTopRetrieve request
	BrokerSummaryTopRetrieve(ctx context.Context, symbol string, params *BrokerSummaryTopRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

	// CompanyCorporateActionsRetrieve request
	CompanyCorporateActionsRetrieve(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompanyGetSegmentsRetrieve request
	CompanyGetSegmentsRetrieve(ctx context.Context, symbol string, params *CompanyGetSegmentsRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompanyGetQuarterlyFinancialDatesRetrieve request
	CompanyGetQuarterlyFinancialDatesRetrieve(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompanyReportRetrieve2 request
	CompanyReportRetrieve2(ctx context.Context, symbol string, params *CompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompanyShareholdersCompositionRetrieve request
	CompanyShareholdersCompositionRetrieve(ctx context.Context, symbol string, params *CompanyShareholdersCompositionRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DailyRetrieve request
	DailyRetrieve(ctx context.Context, symbol string, params *DailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// FinancialsQuarterlyRetrieve request
	FinancialsQuarterlyRetrieve(ctx context.Context, symbol string, params *FinancialsQuarterlyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ForeignFlowRetrieve request
	ForeignFlowRetrieve(ctx context.Context, symbol string, params *ForeignFlowRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// IndexDailyRetrieve request
	IndexDailyRetrieve(ctx context.Context, indexCode string, params *IndexDailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	// KLSECompanyReportRetrieve2 request
	KLSECompanyReportRetrieve2(ctx context.Context, symbol string, params *KLSECompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// ListingPerformanceRetrieve request
	ListingPerformanceRetrieve(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// MiningCommoditiesPriceRetrieve request
	MiningCommoditiesPriceRetrieve(ctx context.Context, commodityName string, params *MiningCommoditiesPriceRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// MiningCompaniesFinancialsRetrieve request
	MiningCompaniesFinancialsRetrieve(ctx context.Context, slug string, params *MiningCompaniesFinancialsRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MiningCompaniesOwnershipRetrieve request
	MiningCompaniesOwnershipRetrieve(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MiningCompaniesPerformanceRetrieve request
	MiningCompaniesPerformanceRetrieve(ctx context.Context, slug string, params *MiningCompaniesPerformanceRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MiningCompaniesRetrieve2 request
	MiningCompaniesRetrieve2(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

	// MiningLicenseAuctionsRetrieve2 request
	MiningLicenseAuctionsRetrieve2(ctx context.Context, wiupCode string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// MiningResourcesReservesRetrieve2 request
	MiningResourcesReservesRetrieve2(ctx context.Context, province string, params *MiningResourcesReservesRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MiningSalesDestinationRetrieve request
	MiningSalesDestinationRetrieve(ctx context.Context, slug string, params *MiningSalesDestinationRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// MiningSitesRetrieve2 request
	MiningSitesRetrieve2(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

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

	// SGXCompanyReportRetrieve2 request
	SGXCompanyReportRetrieve2(ctx context.Context, symbol string, params *SGXCompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SGXDailyRetrieve request
	SGXDailyRetrieve(ctx context.Context, symbol string, params *SGXDailyRetrieveParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

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

	// SubsectorReportRetrieve2 request
	SubsectorReportRetrieve2(ctx context.Context, subSector string, params *SubsectorReportRetrieve2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// TagsList request
	TagsList(ctx context.Context, 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 New

func New(baseURL, apiKey string, httpClient *http.Client) (*ClientWithResponses, error)

New constructs a typed Sectors API client with API-key authentication.

apiKey is sent verbatim in the `Authorization` header on every request, per the API's ApiKeyAuth security scheme. If baseURL is empty, DefaultBaseURL is used. A nil httpClient falls back to the generated client's default.

func NewClientWithResponses

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

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

func (*ClientWithResponses) BrokerActivityRetrieveWithResponse

func (c *ClientWithResponses) BrokerActivityRetrieveWithResponse(ctx context.Context, brokerCode string, params *BrokerActivityRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerActivityRetrieveResponse, error)

BrokerActivityRetrieveWithResponse request returning *BrokerActivityRetrieveResponse

func (*ClientWithResponses) BrokerActivityTopRetrieveWithResponse

func (c *ClientWithResponses) BrokerActivityTopRetrieveWithResponse(ctx context.Context, brokerCode string, params *BrokerActivityTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerActivityTopRetrieveResponse, error)

BrokerActivityTopRetrieveWithResponse request returning *BrokerActivityTopRetrieveResponse

func (*ClientWithResponses) BrokerSummaryRetrieveWithResponse

func (c *ClientWithResponses) BrokerSummaryRetrieveWithResponse(ctx context.Context, symbol string, params *BrokerSummaryRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerSummaryRetrieveResponse, error)

BrokerSummaryRetrieveWithResponse request returning *BrokerSummaryRetrieveResponse

func (*ClientWithResponses) BrokerSummaryTopRetrieveWithResponse

func (c *ClientWithResponses) BrokerSummaryTopRetrieveWithResponse(ctx context.Context, symbol string, params *BrokerSummaryTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerSummaryTopRetrieveResponse, error)

BrokerSummaryTopRetrieveWithResponse request returning *BrokerSummaryTopRetrieveResponse

func (*ClientWithResponses) BrokersRetrieveWithResponse

func (c *ClientWithResponses) BrokersRetrieveWithResponse(ctx context.Context, params *BrokersRetrieveParams, reqEditors ...RequestEditorFn) (*BrokersRetrieveResponse, error)

BrokersRetrieveWithResponse request returning *BrokersRetrieveResponse

func (*ClientWithResponses) BrokersTopRetrieveWithResponse

func (c *ClientWithResponses) BrokersTopRetrieveWithResponse(ctx context.Context, params *BrokersTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokersTopRetrieveResponse, error)

BrokersTopRetrieveWithResponse request returning *BrokersTopRetrieveResponse

func (*ClientWithResponses) CompaniesListCompaniesWithSegmentsListWithResponse

func (c *ClientWithResponses) CompaniesListCompaniesWithSegmentsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CompaniesListCompaniesWithSegmentsListResponse, error)

CompaniesListCompaniesWithSegmentsListWithResponse request returning *CompaniesListCompaniesWithSegmentsListResponse

func (*ClientWithResponses) CompaniesRetrieveWithResponse

func (c *ClientWithResponses) CompaniesRetrieveWithResponse(ctx context.Context, params *CompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*CompaniesRetrieveResponse, error)

CompaniesRetrieveWithResponse request returning *CompaniesRetrieveResponse

func (*ClientWithResponses) CompaniesTopChangesRetrieveWithResponse

func (c *ClientWithResponses) CompaniesTopChangesRetrieveWithResponse(ctx context.Context, params *CompaniesTopChangesRetrieveParams, reqEditors ...RequestEditorFn) (*CompaniesTopChangesRetrieveResponse, error)

CompaniesTopChangesRetrieveWithResponse request returning *CompaniesTopChangesRetrieveResponse

func (*ClientWithResponses) CompanyCorporateActionsRetrieveWithResponse

func (c *ClientWithResponses) CompanyCorporateActionsRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*CompanyCorporateActionsRetrieveResponse, error)

CompanyCorporateActionsRetrieveWithResponse request returning *CompanyCorporateActionsRetrieveResponse

func (*ClientWithResponses) CompanyGetQuarterlyFinancialDatesRetrieveWithResponse

func (c *ClientWithResponses) CompanyGetQuarterlyFinancialDatesRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*CompanyGetQuarterlyFinancialDatesRetrieveResponse, error)

CompanyGetQuarterlyFinancialDatesRetrieveWithResponse request returning *CompanyGetQuarterlyFinancialDatesRetrieveResponse

func (*ClientWithResponses) CompanyGetSegmentsRetrieveWithResponse

func (c *ClientWithResponses) CompanyGetSegmentsRetrieveWithResponse(ctx context.Context, symbol string, params *CompanyGetSegmentsRetrieveParams, reqEditors ...RequestEditorFn) (*CompanyGetSegmentsRetrieveResponse, error)

CompanyGetSegmentsRetrieveWithResponse request returning *CompanyGetSegmentsRetrieveResponse

func (*ClientWithResponses) CompanyReportRetrieve2WithResponse

func (c *ClientWithResponses) CompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *CompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*CompanyReportRetrieve2Response, error)

CompanyReportRetrieve2WithResponse request returning *CompanyReportRetrieve2Response

func (*ClientWithResponses) CompanyShareholdersCompositionRetrieveWithResponse

func (c *ClientWithResponses) CompanyShareholdersCompositionRetrieveWithResponse(ctx context.Context, symbol string, params *CompanyShareholdersCompositionRetrieveParams, reqEditors ...RequestEditorFn) (*CompanyShareholdersCompositionRetrieveResponse, error)

CompanyShareholdersCompositionRetrieveWithResponse request returning *CompanyShareholdersCompositionRetrieveResponse

func (*ClientWithResponses) DailyRetrieveWithResponse

func (c *ClientWithResponses) DailyRetrieveWithResponse(ctx context.Context, symbol string, params *DailyRetrieveParams, reqEditors ...RequestEditorFn) (*DailyRetrieveResponse, error)

DailyRetrieveWithResponse request returning *DailyRetrieveResponse

func (*ClientWithResponses) FilingsRetrieveWithResponse

func (c *ClientWithResponses) FilingsRetrieveWithResponse(ctx context.Context, params *FilingsRetrieveParams, reqEditors ...RequestEditorFn) (*FilingsRetrieveResponse, error)

FilingsRetrieveWithResponse request returning *FilingsRetrieveResponse

func (*ClientWithResponses) FinancialsQuarterlyRetrieveWithResponse

func (c *ClientWithResponses) FinancialsQuarterlyRetrieveWithResponse(ctx context.Context, symbol string, params *FinancialsQuarterlyRetrieveParams, reqEditors ...RequestEditorFn) (*FinancialsQuarterlyRetrieveResponse, error)

FinancialsQuarterlyRetrieveWithResponse request returning *FinancialsQuarterlyRetrieveResponse

func (*ClientWithResponses) ForeignFlowRetrieveWithResponse

func (c *ClientWithResponses) ForeignFlowRetrieveWithResponse(ctx context.Context, symbol string, params *ForeignFlowRetrieveParams, reqEditors ...RequestEditorFn) (*ForeignFlowRetrieveResponse, error)

ForeignFlowRetrieveWithResponse request returning *ForeignFlowRetrieveResponse

func (*ClientWithResponses) FreeFloatRetrieveWithResponse

func (c *ClientWithResponses) FreeFloatRetrieveWithResponse(ctx context.Context, params *FreeFloatRetrieveParams, reqEditors ...RequestEditorFn) (*FreeFloatRetrieveResponse, error)

FreeFloatRetrieveWithResponse request returning *FreeFloatRetrieveResponse

func (*ClientWithResponses) IDXTotalRetrieveWithResponse

func (c *ClientWithResponses) IDXTotalRetrieveWithResponse(ctx context.Context, params *IDXTotalRetrieveParams, reqEditors ...RequestEditorFn) (*IDXTotalRetrieveResponse, error)

IDXTotalRetrieveWithResponse request returning *IDXTotalRetrieveResponse

func (*ClientWithResponses) IndexDailyRetrieveWithResponse

func (c *ClientWithResponses) IndexDailyRetrieveWithResponse(ctx context.Context, indexCode string, params *IndexDailyRetrieveParams, reqEditors ...RequestEditorFn) (*IndexDailyRetrieveResponse, error)

IndexDailyRetrieveWithResponse request returning *IndexDailyRetrieveResponse

func (*ClientWithResponses) IndustriesListWithResponse

func (c *ClientWithResponses) IndustriesListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*IndustriesListResponse, error)

IndustriesListWithResponse request returning *IndustriesListResponse

func (*ClientWithResponses) KLSECompaniesListWithResponse

func (c *ClientWithResponses) KLSECompaniesListWithResponse(ctx context.Context, params *KLSECompaniesListParams, reqEditors ...RequestEditorFn) (*KLSECompaniesListResponse, error)

KLSECompaniesListWithResponse request returning *KLSECompaniesListResponse

func (*ClientWithResponses) KLSECompaniesTopRetrieveWithResponse

func (c *ClientWithResponses) KLSECompaniesTopRetrieveWithResponse(ctx context.Context, params *KLSECompaniesTopRetrieveParams, reqEditors ...RequestEditorFn) (*KLSECompaniesTopRetrieveResponse, error)

KLSECompaniesTopRetrieveWithResponse request returning *KLSECompaniesTopRetrieveResponse

func (*ClientWithResponses) KLSECompanyReportRetrieve2WithResponse

func (c *ClientWithResponses) KLSECompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *KLSECompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*KLSECompanyReportRetrieve2Response, error)

KLSECompanyReportRetrieve2WithResponse request returning *KLSECompanyReportRetrieve2Response

func (*ClientWithResponses) KLSESectorsListWithResponse

func (c *ClientWithResponses) KLSESectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*KLSESectorsListResponse, error)

KLSESectorsListWithResponse request returning *KLSESectorsListResponse

func (*ClientWithResponses) ListingPerformanceRetrieveWithResponse

func (c *ClientWithResponses) ListingPerformanceRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*ListingPerformanceRetrieveResponse, error)

ListingPerformanceRetrieveWithResponse request returning *ListingPerformanceRetrieveResponse

func (*ClientWithResponses) MiningCommoditiesPriceRetrieveWithResponse

func (c *ClientWithResponses) MiningCommoditiesPriceRetrieveWithResponse(ctx context.Context, commodityName string, params *MiningCommoditiesPriceRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCommoditiesPriceRetrieveResponse, error)

MiningCommoditiesPriceRetrieveWithResponse request returning *MiningCommoditiesPriceRetrieveResponse

func (*ClientWithResponses) MiningCommoditiesRetrieveWithResponse

func (c *ClientWithResponses) MiningCommoditiesRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MiningCommoditiesRetrieveResponse, error)

MiningCommoditiesRetrieveWithResponse request returning *MiningCommoditiesRetrieveResponse

func (*ClientWithResponses) MiningCompaniesFinancialsRetrieveWithResponse

func (c *ClientWithResponses) MiningCompaniesFinancialsRetrieveWithResponse(ctx context.Context, slug string, params *MiningCompaniesFinancialsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesFinancialsRetrieveResponse, error)

MiningCompaniesFinancialsRetrieveWithResponse request returning *MiningCompaniesFinancialsRetrieveResponse

func (*ClientWithResponses) MiningCompaniesOwnershipRetrieveWithResponse

func (c *ClientWithResponses) MiningCompaniesOwnershipRetrieveWithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningCompaniesOwnershipRetrieveResponse, error)

MiningCompaniesOwnershipRetrieveWithResponse request returning *MiningCompaniesOwnershipRetrieveResponse

func (*ClientWithResponses) MiningCompaniesPerformanceRetrieveWithResponse

func (c *ClientWithResponses) MiningCompaniesPerformanceRetrieveWithResponse(ctx context.Context, slug string, params *MiningCompaniesPerformanceRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesPerformanceRetrieveResponse, error)

MiningCompaniesPerformanceRetrieveWithResponse request returning *MiningCompaniesPerformanceRetrieveResponse

func (*ClientWithResponses) MiningCompaniesRetrieve2WithResponse

func (c *ClientWithResponses) MiningCompaniesRetrieve2WithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningCompaniesRetrieve2Response, error)

MiningCompaniesRetrieve2WithResponse request returning *MiningCompaniesRetrieve2Response

func (*ClientWithResponses) MiningCompaniesRetrieveWithResponse

func (c *ClientWithResponses) MiningCompaniesRetrieveWithResponse(ctx context.Context, params *MiningCompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesRetrieveResponse, error)

MiningCompaniesRetrieveWithResponse request returning *MiningCompaniesRetrieveResponse

func (*ClientWithResponses) MiningContractsRetrieveWithResponse

func (c *ClientWithResponses) MiningContractsRetrieveWithResponse(ctx context.Context, params *MiningContractsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningContractsRetrieveResponse, error)

MiningContractsRetrieveWithResponse request returning *MiningContractsRetrieveResponse

func (*ClientWithResponses) MiningExportsRetrieveWithResponse

func (c *ClientWithResponses) MiningExportsRetrieveWithResponse(ctx context.Context, params *MiningExportsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningExportsRetrieveResponse, error)

MiningExportsRetrieveWithResponse request returning *MiningExportsRetrieveResponse

func (*ClientWithResponses) MiningGlobalCommodityRetrieveWithResponse

func (c *ClientWithResponses) MiningGlobalCommodityRetrieveWithResponse(ctx context.Context, params *MiningGlobalCommodityRetrieveParams, reqEditors ...RequestEditorFn) (*MiningGlobalCommodityRetrieveResponse, error)

MiningGlobalCommodityRetrieveWithResponse request returning *MiningGlobalCommodityRetrieveResponse

func (*ClientWithResponses) MiningLicenseAuctionsRetrieve2WithResponse

func (c *ClientWithResponses) MiningLicenseAuctionsRetrieve2WithResponse(ctx context.Context, wiupCode string, reqEditors ...RequestEditorFn) (*MiningLicenseAuctionsRetrieve2Response, error)

MiningLicenseAuctionsRetrieve2WithResponse request returning *MiningLicenseAuctionsRetrieve2Response

func (*ClientWithResponses) MiningLicenseAuctionsRetrieveWithResponse

func (c *ClientWithResponses) MiningLicenseAuctionsRetrieveWithResponse(ctx context.Context, params *MiningLicenseAuctionsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningLicenseAuctionsRetrieveResponse, error)

MiningLicenseAuctionsRetrieveWithResponse request returning *MiningLicenseAuctionsRetrieveResponse

func (*ClientWithResponses) MiningLicensesRetrieveWithResponse

func (c *ClientWithResponses) MiningLicensesRetrieveWithResponse(ctx context.Context, params *MiningLicensesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningLicensesRetrieveResponse, error)

MiningLicensesRetrieveWithResponse request returning *MiningLicensesRetrieveResponse

func (*ClientWithResponses) MiningResourcesReservesRetrieve2WithResponse

func (c *ClientWithResponses) MiningResourcesReservesRetrieve2WithResponse(ctx context.Context, province string, params *MiningResourcesReservesRetrieve2Params, reqEditors ...RequestEditorFn) (*MiningResourcesReservesRetrieve2Response, error)

MiningResourcesReservesRetrieve2WithResponse request returning *MiningResourcesReservesRetrieve2Response

func (*ClientWithResponses) MiningResourcesReservesRetrieveWithResponse

func (c *ClientWithResponses) MiningResourcesReservesRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MiningResourcesReservesRetrieveResponse, error)

MiningResourcesReservesRetrieveWithResponse request returning *MiningResourcesReservesRetrieveResponse

func (*ClientWithResponses) MiningSalesDestinationRetrieveWithResponse

func (c *ClientWithResponses) MiningSalesDestinationRetrieveWithResponse(ctx context.Context, slug string, params *MiningSalesDestinationRetrieveParams, reqEditors ...RequestEditorFn) (*MiningSalesDestinationRetrieveResponse, error)

MiningSalesDestinationRetrieveWithResponse request returning *MiningSalesDestinationRetrieveResponse

func (*ClientWithResponses) MiningSitesRetrieve2WithResponse

func (c *ClientWithResponses) MiningSitesRetrieve2WithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningSitesRetrieve2Response, error)

MiningSitesRetrieve2WithResponse request returning *MiningSitesRetrieve2Response

func (*ClientWithResponses) MiningSitesRetrieveWithResponse

func (c *ClientWithResponses) MiningSitesRetrieveWithResponse(ctx context.Context, params *MiningSitesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningSitesRetrieveResponse, error)

MiningSitesRetrieveWithResponse request returning *MiningSitesRetrieveResponse

func (*ClientWithResponses) MiningTotalProductionRetrieveWithResponse

func (c *ClientWithResponses) MiningTotalProductionRetrieveWithResponse(ctx context.Context, params *MiningTotalProductionRetrieveParams, reqEditors ...RequestEditorFn) (*MiningTotalProductionRetrieveResponse, error)

MiningTotalProductionRetrieveWithResponse request returning *MiningTotalProductionRetrieveResponse

func (*ClientWithResponses) MostTradedRetrieveWithResponse

func (c *ClientWithResponses) MostTradedRetrieveWithResponse(ctx context.Context, params *MostTradedRetrieveParams, reqEditors ...RequestEditorFn) (*MostTradedRetrieveResponse, error)

MostTradedRetrieveWithResponse request returning *MostTradedRetrieveResponse

func (*ClientWithResponses) NewsRetrieveWithResponse

func (c *ClientWithResponses) NewsRetrieveWithResponse(ctx context.Context, params *NewsRetrieveParams, reqEditors ...RequestEditorFn) (*NewsRetrieveResponse, error)

NewsRetrieveWithResponse request returning *NewsRetrieveResponse

func (*ClientWithResponses) SGXBuybacksRetrieveWithResponse

func (c *ClientWithResponses) SGXBuybacksRetrieveWithResponse(ctx context.Context, params *SGXBuybacksRetrieveParams, reqEditors ...RequestEditorFn) (*SGXBuybacksRetrieveResponse, error)

SGXBuybacksRetrieveWithResponse request returning *SGXBuybacksRetrieveResponse

func (*ClientWithResponses) SGXCompaniesRetrieveWithResponse

func (c *ClientWithResponses) SGXCompaniesRetrieveWithResponse(ctx context.Context, params *SGXCompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*SGXCompaniesRetrieveResponse, error)

SGXCompaniesRetrieveWithResponse request returning *SGXCompaniesRetrieveResponse

func (*ClientWithResponses) SGXCompaniesTopRetrieveWithResponse

func (c *ClientWithResponses) SGXCompaniesTopRetrieveWithResponse(ctx context.Context, params *SGXCompaniesTopRetrieveParams, reqEditors ...RequestEditorFn) (*SGXCompaniesTopRetrieveResponse, error)

SGXCompaniesTopRetrieveWithResponse request returning *SGXCompaniesTopRetrieveResponse

func (*ClientWithResponses) SGXCompanyReportRetrieve2WithResponse

func (c *ClientWithResponses) SGXCompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *SGXCompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*SGXCompanyReportRetrieve2Response, error)

SGXCompanyReportRetrieve2WithResponse request returning *SGXCompanyReportRetrieve2Response

func (*ClientWithResponses) SGXDailyRetrieveWithResponse

func (c *ClientWithResponses) SGXDailyRetrieveWithResponse(ctx context.Context, symbol string, params *SGXDailyRetrieveParams, reqEditors ...RequestEditorFn) (*SGXDailyRetrieveResponse, error)

SGXDailyRetrieveWithResponse request returning *SGXDailyRetrieveResponse

func (*ClientWithResponses) SGXFilingsRetrieveWithResponse

func (c *ClientWithResponses) SGXFilingsRetrieveWithResponse(ctx context.Context, params *SGXFilingsRetrieveParams, reqEditors ...RequestEditorFn) (*SGXFilingsRetrieveResponse, error)

SGXFilingsRetrieveWithResponse request returning *SGXFilingsRetrieveResponse

func (*ClientWithResponses) SGXNewsRetrieveWithResponse

func (c *ClientWithResponses) SGXNewsRetrieveWithResponse(ctx context.Context, params *SGXNewsRetrieveParams, reqEditors ...RequestEditorFn) (*SGXNewsRetrieveResponse, error)

SGXNewsRetrieveWithResponse request returning *SGXNewsRetrieveResponse

func (*ClientWithResponses) SGXSectorsListWithResponse

func (c *ClientWithResponses) SGXSectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SGXSectorsListResponse, error)

SGXSectorsListWithResponse request returning *SGXSectorsListResponse

func (*ClientWithResponses) SGXShortSellRetrieveWithResponse

func (c *ClientWithResponses) SGXShortSellRetrieveWithResponse(ctx context.Context, params *SGXShortSellRetrieveParams, reqEditors ...RequestEditorFn) (*SGXShortSellRetrieveResponse, error)

SGXShortSellRetrieveWithResponse request returning *SGXShortSellRetrieveResponse

func (*ClientWithResponses) SGXTagsRetrieveWithResponse

func (c *ClientWithResponses) SGXTagsRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SGXTagsRetrieveResponse, error)

SGXTagsRetrieveWithResponse request returning *SGXTagsRetrieveResponse

func (*ClientWithResponses) SubindustriesListWithResponse

func (c *ClientWithResponses) SubindustriesListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubindustriesListResponse, error)

SubindustriesListWithResponse request returning *SubindustriesListResponse

func (*ClientWithResponses) SubsectorReportRetrieve2WithResponse

func (c *ClientWithResponses) SubsectorReportRetrieve2WithResponse(ctx context.Context, subSector string, params *SubsectorReportRetrieve2Params, reqEditors ...RequestEditorFn) (*SubsectorReportRetrieve2Response, error)

SubsectorReportRetrieve2WithResponse request returning *SubsectorReportRetrieve2Response

func (*ClientWithResponses) SubsectorsListWithResponse

func (c *ClientWithResponses) SubsectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubsectorsListResponse, error)

SubsectorsListWithResponse request returning *SubsectorsListResponse

func (*ClientWithResponses) SuspensionsRetrieveWithResponse

func (c *ClientWithResponses) SuspensionsRetrieveWithResponse(ctx context.Context, params *SuspensionsRetrieveParams, reqEditors ...RequestEditorFn) (*SuspensionsRetrieveResponse, error)

SuspensionsRetrieveWithResponse request returning *SuspensionsRetrieveResponse

func (*ClientWithResponses) TagsListWithResponse

func (c *ClientWithResponses) TagsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*TagsListResponse, error)

TagsListWithResponse request returning *TagsListResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// BrokerActivityRetrieveWithResponse request
	BrokerActivityRetrieveWithResponse(ctx context.Context, brokerCode string, params *BrokerActivityRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerActivityRetrieveResponse, error)

	// BrokerActivityTopRetrieveWithResponse request
	BrokerActivityTopRetrieveWithResponse(ctx context.Context, brokerCode string, params *BrokerActivityTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerActivityTopRetrieveResponse, error)

	// BrokerSummaryRetrieveWithResponse request
	BrokerSummaryRetrieveWithResponse(ctx context.Context, symbol string, params *BrokerSummaryRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerSummaryRetrieveResponse, error)

	// BrokerSummaryTopRetrieveWithResponse request
	BrokerSummaryTopRetrieveWithResponse(ctx context.Context, symbol string, params *BrokerSummaryTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokerSummaryTopRetrieveResponse, error)

	// BrokersRetrieveWithResponse request
	BrokersRetrieveWithResponse(ctx context.Context, params *BrokersRetrieveParams, reqEditors ...RequestEditorFn) (*BrokersRetrieveResponse, error)

	// BrokersTopRetrieveWithResponse request
	BrokersTopRetrieveWithResponse(ctx context.Context, params *BrokersTopRetrieveParams, reqEditors ...RequestEditorFn) (*BrokersTopRetrieveResponse, error)

	// CompaniesRetrieveWithResponse request
	CompaniesRetrieveWithResponse(ctx context.Context, params *CompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*CompaniesRetrieveResponse, error)

	// CompaniesListCompaniesWithSegmentsListWithResponse request
	CompaniesListCompaniesWithSegmentsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CompaniesListCompaniesWithSegmentsListResponse, error)

	// CompaniesTopChangesRetrieveWithResponse request
	CompaniesTopChangesRetrieveWithResponse(ctx context.Context, params *CompaniesTopChangesRetrieveParams, reqEditors ...RequestEditorFn) (*CompaniesTopChangesRetrieveResponse, error)

	// CompanyCorporateActionsRetrieveWithResponse request
	CompanyCorporateActionsRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*CompanyCorporateActionsRetrieveResponse, error)

	// CompanyGetSegmentsRetrieveWithResponse request
	CompanyGetSegmentsRetrieveWithResponse(ctx context.Context, symbol string, params *CompanyGetSegmentsRetrieveParams, reqEditors ...RequestEditorFn) (*CompanyGetSegmentsRetrieveResponse, error)

	// CompanyGetQuarterlyFinancialDatesRetrieveWithResponse request
	CompanyGetQuarterlyFinancialDatesRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*CompanyGetQuarterlyFinancialDatesRetrieveResponse, error)

	// CompanyReportRetrieve2WithResponse request
	CompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *CompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*CompanyReportRetrieve2Response, error)

	// CompanyShareholdersCompositionRetrieveWithResponse request
	CompanyShareholdersCompositionRetrieveWithResponse(ctx context.Context, symbol string, params *CompanyShareholdersCompositionRetrieveParams, reqEditors ...RequestEditorFn) (*CompanyShareholdersCompositionRetrieveResponse, error)

	// DailyRetrieveWithResponse request
	DailyRetrieveWithResponse(ctx context.Context, symbol string, params *DailyRetrieveParams, reqEditors ...RequestEditorFn) (*DailyRetrieveResponse, error)

	// FilingsRetrieveWithResponse request
	FilingsRetrieveWithResponse(ctx context.Context, params *FilingsRetrieveParams, reqEditors ...RequestEditorFn) (*FilingsRetrieveResponse, error)

	// FinancialsQuarterlyRetrieveWithResponse request
	FinancialsQuarterlyRetrieveWithResponse(ctx context.Context, symbol string, params *FinancialsQuarterlyRetrieveParams, reqEditors ...RequestEditorFn) (*FinancialsQuarterlyRetrieveResponse, error)

	// ForeignFlowRetrieveWithResponse request
	ForeignFlowRetrieveWithResponse(ctx context.Context, symbol string, params *ForeignFlowRetrieveParams, reqEditors ...RequestEditorFn) (*ForeignFlowRetrieveResponse, error)

	// FreeFloatRetrieveWithResponse request
	FreeFloatRetrieveWithResponse(ctx context.Context, params *FreeFloatRetrieveParams, reqEditors ...RequestEditorFn) (*FreeFloatRetrieveResponse, error)

	// IDXTotalRetrieveWithResponse request
	IDXTotalRetrieveWithResponse(ctx context.Context, params *IDXTotalRetrieveParams, reqEditors ...RequestEditorFn) (*IDXTotalRetrieveResponse, error)

	// IndexDailyRetrieveWithResponse request
	IndexDailyRetrieveWithResponse(ctx context.Context, indexCode string, params *IndexDailyRetrieveParams, reqEditors ...RequestEditorFn) (*IndexDailyRetrieveResponse, error)

	// IndustriesListWithResponse request
	IndustriesListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*IndustriesListResponse, error)

	// KLSECompaniesListWithResponse request
	KLSECompaniesListWithResponse(ctx context.Context, params *KLSECompaniesListParams, reqEditors ...RequestEditorFn) (*KLSECompaniesListResponse, error)

	// KLSECompaniesTopRetrieveWithResponse request
	KLSECompaniesTopRetrieveWithResponse(ctx context.Context, params *KLSECompaniesTopRetrieveParams, reqEditors ...RequestEditorFn) (*KLSECompaniesTopRetrieveResponse, error)

	// KLSECompanyReportRetrieve2WithResponse request
	KLSECompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *KLSECompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*KLSECompanyReportRetrieve2Response, error)

	// KLSESectorsListWithResponse request
	KLSESectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*KLSESectorsListResponse, error)

	// ListingPerformanceRetrieveWithResponse request
	ListingPerformanceRetrieveWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*ListingPerformanceRetrieveResponse, error)

	// MiningCommoditiesRetrieveWithResponse request
	MiningCommoditiesRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MiningCommoditiesRetrieveResponse, error)

	// MiningCommoditiesPriceRetrieveWithResponse request
	MiningCommoditiesPriceRetrieveWithResponse(ctx context.Context, commodityName string, params *MiningCommoditiesPriceRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCommoditiesPriceRetrieveResponse, error)

	// MiningCompaniesRetrieveWithResponse request
	MiningCompaniesRetrieveWithResponse(ctx context.Context, params *MiningCompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesRetrieveResponse, error)

	// MiningCompaniesFinancialsRetrieveWithResponse request
	MiningCompaniesFinancialsRetrieveWithResponse(ctx context.Context, slug string, params *MiningCompaniesFinancialsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesFinancialsRetrieveResponse, error)

	// MiningCompaniesOwnershipRetrieveWithResponse request
	MiningCompaniesOwnershipRetrieveWithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningCompaniesOwnershipRetrieveResponse, error)

	// MiningCompaniesPerformanceRetrieveWithResponse request
	MiningCompaniesPerformanceRetrieveWithResponse(ctx context.Context, slug string, params *MiningCompaniesPerformanceRetrieveParams, reqEditors ...RequestEditorFn) (*MiningCompaniesPerformanceRetrieveResponse, error)

	// MiningCompaniesRetrieve2WithResponse request
	MiningCompaniesRetrieve2WithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningCompaniesRetrieve2Response, error)

	// MiningContractsRetrieveWithResponse request
	MiningContractsRetrieveWithResponse(ctx context.Context, params *MiningContractsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningContractsRetrieveResponse, error)

	// MiningExportsRetrieveWithResponse request
	MiningExportsRetrieveWithResponse(ctx context.Context, params *MiningExportsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningExportsRetrieveResponse, error)

	// MiningGlobalCommodityRetrieveWithResponse request
	MiningGlobalCommodityRetrieveWithResponse(ctx context.Context, params *MiningGlobalCommodityRetrieveParams, reqEditors ...RequestEditorFn) (*MiningGlobalCommodityRetrieveResponse, error)

	// MiningLicenseAuctionsRetrieveWithResponse request
	MiningLicenseAuctionsRetrieveWithResponse(ctx context.Context, params *MiningLicenseAuctionsRetrieveParams, reqEditors ...RequestEditorFn) (*MiningLicenseAuctionsRetrieveResponse, error)

	// MiningLicenseAuctionsRetrieve2WithResponse request
	MiningLicenseAuctionsRetrieve2WithResponse(ctx context.Context, wiupCode string, reqEditors ...RequestEditorFn) (*MiningLicenseAuctionsRetrieve2Response, error)

	// MiningLicensesRetrieveWithResponse request
	MiningLicensesRetrieveWithResponse(ctx context.Context, params *MiningLicensesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningLicensesRetrieveResponse, error)

	// MiningResourcesReservesRetrieveWithResponse request
	MiningResourcesReservesRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MiningResourcesReservesRetrieveResponse, error)

	// MiningResourcesReservesRetrieve2WithResponse request
	MiningResourcesReservesRetrieve2WithResponse(ctx context.Context, province string, params *MiningResourcesReservesRetrieve2Params, reqEditors ...RequestEditorFn) (*MiningResourcesReservesRetrieve2Response, error)

	// MiningSalesDestinationRetrieveWithResponse request
	MiningSalesDestinationRetrieveWithResponse(ctx context.Context, slug string, params *MiningSalesDestinationRetrieveParams, reqEditors ...RequestEditorFn) (*MiningSalesDestinationRetrieveResponse, error)

	// MiningSitesRetrieveWithResponse request
	MiningSitesRetrieveWithResponse(ctx context.Context, params *MiningSitesRetrieveParams, reqEditors ...RequestEditorFn) (*MiningSitesRetrieveResponse, error)

	// MiningSitesRetrieve2WithResponse request
	MiningSitesRetrieve2WithResponse(ctx context.Context, slug string, reqEditors ...RequestEditorFn) (*MiningSitesRetrieve2Response, error)

	// MiningTotalProductionRetrieveWithResponse request
	MiningTotalProductionRetrieveWithResponse(ctx context.Context, params *MiningTotalProductionRetrieveParams, reqEditors ...RequestEditorFn) (*MiningTotalProductionRetrieveResponse, error)

	// MostTradedRetrieveWithResponse request
	MostTradedRetrieveWithResponse(ctx context.Context, params *MostTradedRetrieveParams, reqEditors ...RequestEditorFn) (*MostTradedRetrieveResponse, error)

	// NewsRetrieveWithResponse request
	NewsRetrieveWithResponse(ctx context.Context, params *NewsRetrieveParams, reqEditors ...RequestEditorFn) (*NewsRetrieveResponse, error)

	// SGXBuybacksRetrieveWithResponse request
	SGXBuybacksRetrieveWithResponse(ctx context.Context, params *SGXBuybacksRetrieveParams, reqEditors ...RequestEditorFn) (*SGXBuybacksRetrieveResponse, error)

	// SGXCompaniesRetrieveWithResponse request
	SGXCompaniesRetrieveWithResponse(ctx context.Context, params *SGXCompaniesRetrieveParams, reqEditors ...RequestEditorFn) (*SGXCompaniesRetrieveResponse, error)

	// SGXCompaniesTopRetrieveWithResponse request
	SGXCompaniesTopRetrieveWithResponse(ctx context.Context, params *SGXCompaniesTopRetrieveParams, reqEditors ...RequestEditorFn) (*SGXCompaniesTopRetrieveResponse, error)

	// SGXCompanyReportRetrieve2WithResponse request
	SGXCompanyReportRetrieve2WithResponse(ctx context.Context, symbol string, params *SGXCompanyReportRetrieve2Params, reqEditors ...RequestEditorFn) (*SGXCompanyReportRetrieve2Response, error)

	// SGXDailyRetrieveWithResponse request
	SGXDailyRetrieveWithResponse(ctx context.Context, symbol string, params *SGXDailyRetrieveParams, reqEditors ...RequestEditorFn) (*SGXDailyRetrieveResponse, error)

	// SGXFilingsRetrieveWithResponse request
	SGXFilingsRetrieveWithResponse(ctx context.Context, params *SGXFilingsRetrieveParams, reqEditors ...RequestEditorFn) (*SGXFilingsRetrieveResponse, error)

	// SGXNewsRetrieveWithResponse request
	SGXNewsRetrieveWithResponse(ctx context.Context, params *SGXNewsRetrieveParams, reqEditors ...RequestEditorFn) (*SGXNewsRetrieveResponse, error)

	// SGXSectorsListWithResponse request
	SGXSectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SGXSectorsListResponse, error)

	// SGXShortSellRetrieveWithResponse request
	SGXShortSellRetrieveWithResponse(ctx context.Context, params *SGXShortSellRetrieveParams, reqEditors ...RequestEditorFn) (*SGXShortSellRetrieveResponse, error)

	// SGXTagsRetrieveWithResponse request
	SGXTagsRetrieveWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SGXTagsRetrieveResponse, error)

	// SubindustriesListWithResponse request
	SubindustriesListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubindustriesListResponse, error)

	// SubsectorReportRetrieve2WithResponse request
	SubsectorReportRetrieve2WithResponse(ctx context.Context, subSector string, params *SubsectorReportRetrieve2Params, reqEditors ...RequestEditorFn) (*SubsectorReportRetrieve2Response, error)

	// SubsectorsListWithResponse request
	SubsectorsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SubsectorsListResponse, error)

	// SuspensionsRetrieveWithResponse request
	SuspensionsRetrieveWithResponse(ctx context.Context, params *SuspensionsRetrieveParams, reqEditors ...RequestEditorFn) (*SuspensionsRetrieveResponse, error)

	// TagsListWithResponse request
	TagsListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*TagsListResponse, error)
}

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

type CompaniesListCompaniesWithSegmentsListResponse

type CompaniesListCompaniesWithSegmentsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseCompaniesListCompaniesWithSegmentsListResponse

func ParseCompaniesListCompaniesWithSegmentsListResponse(rsp *http.Response) (*CompaniesListCompaniesWithSegmentsListResponse, error)

ParseCompaniesListCompaniesWithSegmentsListResponse parses an HTTP response from a CompaniesListCompaniesWithSegmentsListWithResponse call

func (CompaniesListCompaniesWithSegmentsListResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompaniesListCompaniesWithSegmentsListResponse) Status

Status returns HTTPResponse.Status

func (CompaniesListCompaniesWithSegmentsListResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CompaniesRetrieveParams

type CompaniesRetrieveParams struct {
	// Where SQL-like conditions for advanced filtering. Ignored if `q` is present. Supports operators `=`, `!=`, `>`, `>=`, `<`, `<=`, `like`, `in` combined with `and`/`or`. Use bracket notation for yearly fields: `revenue[2024] > 1000000000000`. Supports arithmetic on both sides: `revenue[2024] / total_assets[2024] > 0.5`.
	Where *string `form:"where,omitempty" json:"where,omitempty"`

	// Q A natural language query (e.g. `top 10 tech companies by revenue in 2023`). When `q` is provided, all other query parameters (`where`, `order_by`, etc.) are ignored as the LLM will generate them.
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// OrderBy Field to sort results by. Use `-` prefix for descending order (e.g. `-market_cap`). Supports arithmetic expressions (e.g. `-(earnings[2024]/earnings[2023])`). Ignored if `q` is present.
	OrderBy *string `form:"order_by,omitempty" json:"order_by,omitempty"`

	// Desc Sort in descending order. Ignored if `q` is present.
	Desc *bool `form:"desc,omitempty" json:"desc,omitempty"`

	// Limit Maximum number of results to return. Max: 200. Ignored if `q` is present.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip for pagination. Ignored if `q` is present.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// IncludeQueryValues If `true`, the response includes a `query_values` object showing the interpreted year and country extracted from the query.
	IncludeQueryValues *bool `form:"include_query_values,omitempty" json:"include_query_values,omitempty"`
}

CompaniesRetrieveParams defines parameters for CompaniesRetrieve.

type CompaniesRetrieveResponse

type CompaniesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseCompaniesRetrieveResponse

func ParseCompaniesRetrieveResponse(rsp *http.Response) (*CompaniesRetrieveResponse, error)

ParseCompaniesRetrieveResponse parses an HTTP response from a CompaniesRetrieveWithResponse call

func (CompaniesRetrieveResponse) ContentType

func (r CompaniesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompaniesRetrieveResponse) Status

func (r CompaniesRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (CompaniesRetrieveResponse) StatusCode

func (r CompaniesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompaniesTopChangesRetrieveParams

type CompaniesTopChangesRetrieveParams struct {
	// SubSector Filter by kebab-case subsector slug. E.g. `banks`. Get valid values from the [Subsectors](./helper-list/subsectors) endpoint.
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// NStock Number of companies per period. Default 5, max 10.
	NStock *int `form:"n_stock,omitempty" json:"n_stock,omitempty"`

	// Classifications Comma-separated. Choices: `top_gainers`, `top_losers`. Default: both.
	Classifications *string `form:"classifications,omitempty" json:"classifications,omitempty"`

	// Periods Comma-separated periods. Choices: `1d`, `7d`, `14d`, `30d`, `365d`. Default: all.
	Periods *string `form:"periods,omitempty" json:"periods,omitempty"`

	// MinMcapBillion Minimum market cap filter in billion IDR. Default 5000.
	MinMcapBillion *int `form:"min_mcap_billion,omitempty" json:"min_mcap_billion,omitempty"`
}

CompaniesTopChangesRetrieveParams defines parameters for CompaniesTopChangesRetrieve.

type CompaniesTopChangesRetrieveResponse

type CompaniesTopChangesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseCompaniesTopChangesRetrieveResponse

func ParseCompaniesTopChangesRetrieveResponse(rsp *http.Response) (*CompaniesTopChangesRetrieveResponse, error)

ParseCompaniesTopChangesRetrieveResponse parses an HTTP response from a CompaniesTopChangesRetrieveWithResponse call

func (CompaniesTopChangesRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompaniesTopChangesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (CompaniesTopChangesRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CompanyCorporateActionsRetrieveResponse

type CompanyCorporateActionsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseCompanyCorporateActionsRetrieveResponse

func ParseCompanyCorporateActionsRetrieveResponse(rsp *http.Response) (*CompanyCorporateActionsRetrieveResponse, error)

ParseCompanyCorporateActionsRetrieveResponse parses an HTTP response from a CompanyCorporateActionsRetrieveWithResponse call

func (CompanyCorporateActionsRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompanyCorporateActionsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (CompanyCorporateActionsRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CompanyGetQuarterlyFinancialDatesRetrieveResponse

type CompanyGetQuarterlyFinancialDatesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseCompanyGetQuarterlyFinancialDatesRetrieveResponse

func ParseCompanyGetQuarterlyFinancialDatesRetrieveResponse(rsp *http.Response) (*CompanyGetQuarterlyFinancialDatesRetrieveResponse, error)

ParseCompanyGetQuarterlyFinancialDatesRetrieveResponse parses an HTTP response from a CompanyGetQuarterlyFinancialDatesRetrieveWithResponse call

func (CompanyGetQuarterlyFinancialDatesRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompanyGetQuarterlyFinancialDatesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (CompanyGetQuarterlyFinancialDatesRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CompanyGetSegmentsRetrieveParams

type CompanyGetSegmentsRetrieveParams struct {
	// FinancialYear Financial year to retrieve. Defaults to the latest available year.
	FinancialYear *int `form:"financial_year,omitempty" json:"financial_year,omitempty"`
}

CompanyGetSegmentsRetrieveParams defines parameters for CompanyGetSegmentsRetrieve.

type CompanyGetSegmentsRetrieveResponse

type CompanyGetSegmentsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseCompanyGetSegmentsRetrieveResponse

func ParseCompanyGetSegmentsRetrieveResponse(rsp *http.Response) (*CompanyGetSegmentsRetrieveResponse, error)

ParseCompanyGetSegmentsRetrieveResponse parses an HTTP response from a CompanyGetSegmentsRetrieveWithResponse call

func (CompanyGetSegmentsRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompanyGetSegmentsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (CompanyGetSegmentsRetrieveResponse) StatusCode

func (r CompanyGetSegmentsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompanyReportRetrieve2Params

type CompanyReportRetrieve2Params struct {
	// Sections Comma-separated list of sections to include. Default: all. Options: `overview`, `valuation`, `future`, `peers`, `financials`, `dividend`, `management`, `ownership`.
	Sections *string `form:"sections,omitempty" json:"sections,omitempty"`
}

CompanyReportRetrieve2Params defines parameters for CompanyReportRetrieve2.

type CompanyReportRetrieve2Response

type CompanyReportRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseCompanyReportRetrieve2Response

func ParseCompanyReportRetrieve2Response(rsp *http.Response) (*CompanyReportRetrieve2Response, error)

ParseCompanyReportRetrieve2Response parses an HTTP response from a CompanyReportRetrieve2WithResponse call

func (CompanyReportRetrieve2Response) ContentType

func (r CompanyReportRetrieve2Response) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompanyReportRetrieve2Response) Status

Status returns HTTPResponse.Status

func (CompanyReportRetrieve2Response) StatusCode

func (r CompanyReportRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CompanyShareholdersCompositionRetrieveParams

type CompanyShareholdersCompositionRetrieveParams struct {
	// Year Calendar year (e.g. `2025`). Defaults to the current year. Data is available from 2021; earlier years return an empty `data` array. Future years are rejected.
	Year *int `form:"year,omitempty" json:"year,omitempty"`
}

CompanyShareholdersCompositionRetrieveParams defines parameters for CompanyShareholdersCompositionRetrieve.

type CompanyShareholdersCompositionRetrieveResponse

type CompanyShareholdersCompositionRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseCompanyShareholdersCompositionRetrieveResponse

func ParseCompanyShareholdersCompositionRetrieveResponse(rsp *http.Response) (*CompanyShareholdersCompositionRetrieveResponse, error)

ParseCompanyShareholdersCompositionRetrieveResponse parses an HTTP response from a CompanyShareholdersCompositionRetrieveWithResponse call

func (CompanyShareholdersCompositionRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CompanyShareholdersCompositionRetrieveResponse) Status

Status returns HTTPResponse.Status

func (CompanyShareholdersCompositionRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DailyRetrieveParams

type DailyRetrieveParams struct {
	// Start Start date in `YYYY-MM-DD` format. Defaults to 30 days before `end`. Wider ranges are clamped to the most recent 90 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Defaults to today. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

DailyRetrieveParams defines parameters for DailyRetrieve.

type DailyRetrieveResponse

type DailyRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseDailyRetrieveResponse

func ParseDailyRetrieveResponse(rsp *http.Response) (*DailyRetrieveResponse, error)

ParseDailyRetrieveResponse parses an HTTP response from a DailyRetrieveWithResponse call

func (DailyRetrieveResponse) ContentType

func (r DailyRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DailyRetrieveResponse) Status

func (r DailyRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (DailyRetrieveResponse) StatusCode

func (r DailyRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FilingsRetrieveParams

type FilingsRetrieveParams struct {
	// Symbol IDX symbol symbol to filter by. E.g. `BBCA`, `BMRI`.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Sector Kebab-case sector slug. E.g. `healthcare`, `financials`. Get valid values from the [Subsectors](../helper-list/subsectors) endpoint.
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// SubSector Kebab-case subsector slug. E.g. `banks`, `tobacco`. Get valid values from the [Subsectors](../helper-list/subsectors) endpoint.
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `timestamp`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// TransactionType Filter by transaction direction: `buy`, `sell`, or `others`.
	TransactionType *FilingsRetrieveParamsTransactionType `form:"transaction_type,omitempty" json:"transaction_type,omitempty"`

	// Tags Comma-separated tag slugs. E.g. `Bullish,insider-trading`. Get valid values from the [News Tags](../helper-list/tags) endpoint.
	Tags *string `form:"tags,omitempty" json:"tags,omitempty"`

	// HolderType Filter by holder type (case-insensitive).
	HolderType *FilingsRetrieveParamsHolderType `form:"holder_type,omitempty" json:"holder_type,omitempty"`
}

FilingsRetrieveParams defines parameters for FilingsRetrieve.

type FilingsRetrieveParamsHolderType

type FilingsRetrieveParamsHolderType string

FilingsRetrieveParamsHolderType defines parameters for FilingsRetrieve.

const (
	FilingsRetrieveParamsHolderTypeCorporateInvestor FilingsRetrieveParamsHolderType = "corporate-investor"
	FilingsRetrieveParamsHolderTypeInsider           FilingsRetrieveParamsHolderType = "insider"
	FilingsRetrieveParamsHolderTypeInstitution       FilingsRetrieveParamsHolderType = "institution"
)

Defines values for FilingsRetrieveParamsHolderType.

func (FilingsRetrieveParamsHolderType) Valid

Valid indicates whether the value is a known member of the FilingsRetrieveParamsHolderType enum.

type FilingsRetrieveParamsTransactionType

type FilingsRetrieveParamsTransactionType string

FilingsRetrieveParamsTransactionType defines parameters for FilingsRetrieve.

const (
	FilingsRetrieveParamsTransactionTypeBuy    FilingsRetrieveParamsTransactionType = "buy"
	FilingsRetrieveParamsTransactionTypeOthers FilingsRetrieveParamsTransactionType = "others"
	FilingsRetrieveParamsTransactionTypeSell   FilingsRetrieveParamsTransactionType = "sell"
)

Defines values for FilingsRetrieveParamsTransactionType.

func (FilingsRetrieveParamsTransactionType) Valid

Valid indicates whether the value is a known member of the FilingsRetrieveParamsTransactionType enum.

type FilingsRetrieveResponse

type FilingsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseFilingsRetrieveResponse

func ParseFilingsRetrieveResponse(rsp *http.Response) (*FilingsRetrieveResponse, error)

ParseFilingsRetrieveResponse parses an HTTP response from a FilingsRetrieveWithResponse call

func (FilingsRetrieveResponse) ContentType

func (r FilingsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FilingsRetrieveResponse) Status

func (r FilingsRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (FilingsRetrieveResponse) StatusCode

func (r FilingsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FinancialsQuarterlyRetrieveParams

type FinancialsQuarterlyRetrieveParams struct {
	// ReportDate Specific report date (YYYY-MM-DD). Use the [Quarterly Financial Dates](../helper-list/company-quarterly-dates) endpoint to get valid values.
	ReportDate *string `form:"report_date,omitempty" json:"report_date,omitempty"`

	// Approx If `true` (default), use approximate quarter matching when an exact date is not found.
	Approx *bool `form:"approx,omitempty" json:"approx,omitempty"`

	// NQuarters Number of most recent quarters to return.
	NQuarters *int `form:"n_quarters,omitempty" json:"n_quarters,omitempty"`
}

FinancialsQuarterlyRetrieveParams defines parameters for FinancialsQuarterlyRetrieve.

type FinancialsQuarterlyRetrieveResponse

type FinancialsQuarterlyRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseFinancialsQuarterlyRetrieveResponse

func ParseFinancialsQuarterlyRetrieveResponse(rsp *http.Response) (*FinancialsQuarterlyRetrieveResponse, error)

ParseFinancialsQuarterlyRetrieveResponse parses an HTTP response from a FinancialsQuarterlyRetrieveWithResponse call

func (FinancialsQuarterlyRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FinancialsQuarterlyRetrieveResponse) Status

Status returns HTTPResponse.Status

func (FinancialsQuarterlyRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ForeignFlowRetrieveParams

type ForeignFlowRetrieveParams struct {
	// Start Start date (YYYY-MM-DD). Default: end - 30 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date (YYYY-MM-DD). Default: today.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

ForeignFlowRetrieveParams defines parameters for ForeignFlowRetrieve.

type ForeignFlowRetrieveResponse

type ForeignFlowRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseForeignFlowRetrieveResponse

func ParseForeignFlowRetrieveResponse(rsp *http.Response) (*ForeignFlowRetrieveResponse, error)

ParseForeignFlowRetrieveResponse parses an HTTP response from a ForeignFlowRetrieveWithResponse call

func (ForeignFlowRetrieveResponse) ContentType

func (r ForeignFlowRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ForeignFlowRetrieveResponse) Status

Status returns HTTPResponse.Status

func (ForeignFlowRetrieveResponse) StatusCode

func (r ForeignFlowRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FreeFloatRetrieveParams

type FreeFloatRetrieveParams struct {
	// Sector Kebab-case sector slug. E.g. `infrastructures`, `healthcare`, `transportation-logistic`. Retrieve valid values from the [Subsectors](./helper-list/subsectors) endpoint.
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// SubSector Kebab-case subsector slug. E.g. `banks`, `basic-materials`, `food-beverage`. Retrieve valid values from the [Subsectors](./helper-list/subsectors) endpoint.
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// Industry Kebab-case industry slug. E.g. `oil-gas`, `electrical`, `chemicals`. Retrieve valid values from the [Industries](./helper-list/industries) endpoint.
	Industry *string `form:"industry,omitempty" json:"industry,omitempty"`

	// SubIndustry Kebab-case sub-industry slug. E.g. `coal-production`, `gold`, `healthcare-providers`. Retrieve valid values from the [Subindustries](./helper-list/subindustries) endpoint.
	SubIndustry *string `form:"sub_industry,omitempty" json:"sub_industry,omitempty"`
}

FreeFloatRetrieveParams defines parameters for FreeFloatRetrieve.

type FreeFloatRetrieveResponse

type FreeFloatRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseFreeFloatRetrieveResponse

func ParseFreeFloatRetrieveResponse(rsp *http.Response) (*FreeFloatRetrieveResponse, error)

ParseFreeFloatRetrieveResponse parses an HTTP response from a FreeFloatRetrieveWithResponse call

func (FreeFloatRetrieveResponse) ContentType

func (r FreeFloatRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FreeFloatRetrieveResponse) Status

func (r FreeFloatRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (FreeFloatRetrieveResponse) StatusCode

func (r FreeFloatRetrieveResponse) 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 IDXTotalRetrieveParams

type IDXTotalRetrieveParams struct {
	// Start Start date in `YYYY-MM-DD` format. Earliest valid: `2021-01-01`. Defaults to 30 days before `end`. Wider ranges are clamped to the most recent 90 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Defaults to today. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

IDXTotalRetrieveParams defines parameters for IDXTotalRetrieve.

type IDXTotalRetrieveResponse

type IDXTotalRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseIDXTotalRetrieveResponse

func ParseIDXTotalRetrieveResponse(rsp *http.Response) (*IDXTotalRetrieveResponse, error)

ParseIDXTotalRetrieveResponse parses an HTTP response from a IDXTotalRetrieveWithResponse call

func (IDXTotalRetrieveResponse) ContentType

func (r IDXTotalRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IDXTotalRetrieveResponse) Status

func (r IDXTotalRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (IDXTotalRetrieveResponse) StatusCode

func (r IDXTotalRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IndexDailyRetrieveParams

type IndexDailyRetrieveParams struct {
	// Start Start date in `YYYY-MM-DD` format. Defaults to 30 days before `end`. Wider ranges are clamped to the most recent 90 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Defaults to today. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

IndexDailyRetrieveParams defines parameters for IndexDailyRetrieve.

type IndexDailyRetrieveResponse

type IndexDailyRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseIndexDailyRetrieveResponse

func ParseIndexDailyRetrieveResponse(rsp *http.Response) (*IndexDailyRetrieveResponse, error)

ParseIndexDailyRetrieveResponse parses an HTTP response from a IndexDailyRetrieveWithResponse call

func (IndexDailyRetrieveResponse) ContentType

func (r IndexDailyRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IndexDailyRetrieveResponse) Status

Status returns HTTPResponse.Status

func (IndexDailyRetrieveResponse) StatusCode

func (r IndexDailyRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IndustriesListResponse

type IndustriesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseIndustriesListResponse

func ParseIndustriesListResponse(rsp *http.Response) (*IndustriesListResponse, error)

ParseIndustriesListResponse parses an HTTP response from a IndustriesListWithResponse call

func (IndustriesListResponse) ContentType

func (r IndustriesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IndustriesListResponse) Status

func (r IndustriesListResponse) Status() string

Status returns HTTPResponse.Status

func (IndustriesListResponse) StatusCode

func (r IndustriesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KLSECompaniesListParams

type KLSECompaniesListParams struct {
	// Sector Kebab-case sector slug. E.g. `financials`, `healthcare`. Get valid values from the [KLSE Sectors](../malaysia/klse-sectors) endpoint.
	Sector string `form:"sector" json:"sector"`
}

KLSECompaniesListParams defines parameters for KLSECompaniesList.

type KLSECompaniesListResponse

type KLSECompaniesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseKLSECompaniesListResponse

func ParseKLSECompaniesListResponse(rsp *http.Response) (*KLSECompaniesListResponse, error)

ParseKLSECompaniesListResponse parses an HTTP response from a KLSECompaniesListWithResponse call

func (KLSECompaniesListResponse) ContentType

func (r KLSECompaniesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KLSECompaniesListResponse) Status

func (r KLSECompaniesListResponse) Status() string

Status returns HTTPResponse.Status

func (KLSECompaniesListResponse) StatusCode

func (r KLSECompaniesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KLSECompaniesTopRetrieveParams

type KLSECompaniesTopRetrieveParams struct {
	// Sector Filter by sector slug. E.g. `financials`, `healthcare`. Default: all sectors.
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// NStock Number of top companies to return per classification. Max 10. Default: 5.
	NStock *int `form:"n_stock,omitempty" json:"n_stock,omitempty"`

	// Classifications Comma-separated list of classifications. Options: `dividend_yield`, `revenue`, `earnings`, `market_cap`, `pe`. Default: all.
	Classifications *string `form:"classifications,omitempty" json:"classifications,omitempty"`

	// MinMcapMillion Minimum market cap in million MYR. Default: 1000.
	MinMcapMillion *int `form:"min_mcap_million,omitempty" json:"min_mcap_million,omitempty"`
}

KLSECompaniesTopRetrieveParams defines parameters for KLSECompaniesTopRetrieve.

type KLSECompaniesTopRetrieveResponse

type KLSECompaniesTopRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseKLSECompaniesTopRetrieveResponse

func ParseKLSECompaniesTopRetrieveResponse(rsp *http.Response) (*KLSECompaniesTopRetrieveResponse, error)

ParseKLSECompaniesTopRetrieveResponse parses an HTTP response from a KLSECompaniesTopRetrieveWithResponse call

func (KLSECompaniesTopRetrieveResponse) ContentType

func (r KLSECompaniesTopRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KLSECompaniesTopRetrieveResponse) Status

Status returns HTTPResponse.Status

func (KLSECompaniesTopRetrieveResponse) StatusCode

func (r KLSECompaniesTopRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KLSECompanyReportRetrieve2Params

type KLSECompanyReportRetrieve2Params struct {
	// Sections Comma-separated sections to include. Options: `overview`, `valuation`, `financials`, `dividend`. Default: all sections.
	Sections *string `form:"sections,omitempty" json:"sections,omitempty"`
}

KLSECompanyReportRetrieve2Params defines parameters for KLSECompanyReportRetrieve2.

type KLSECompanyReportRetrieve2Response

type KLSECompanyReportRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseKLSECompanyReportRetrieve2Response

func ParseKLSECompanyReportRetrieve2Response(rsp *http.Response) (*KLSECompanyReportRetrieve2Response, error)

ParseKLSECompanyReportRetrieve2Response parses an HTTP response from a KLSECompanyReportRetrieve2WithResponse call

func (KLSECompanyReportRetrieve2Response) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KLSECompanyReportRetrieve2Response) Status

Status returns HTTPResponse.Status

func (KLSECompanyReportRetrieve2Response) StatusCode

func (r KLSECompanyReportRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KLSESectorsListResponse

type KLSESectorsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseKLSESectorsListResponse

func ParseKLSESectorsListResponse(rsp *http.Response) (*KLSESectorsListResponse, error)

ParseKLSESectorsListResponse parses an HTTP response from a KLSESectorsListWithResponse call

func (KLSESectorsListResponse) ContentType

func (r KLSESectorsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KLSESectorsListResponse) Status

func (r KLSESectorsListResponse) Status() string

Status returns HTTPResponse.Status

func (KLSESectorsListResponse) StatusCode

func (r KLSESectorsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListingPerformanceRetrieveResponse

type ListingPerformanceRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseListingPerformanceRetrieveResponse

func ParseListingPerformanceRetrieveResponse(rsp *http.Response) (*ListingPerformanceRetrieveResponse, error)

ParseListingPerformanceRetrieveResponse parses an HTTP response from a ListingPerformanceRetrieveWithResponse call

func (ListingPerformanceRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListingPerformanceRetrieveResponse) Status

Status returns HTTPResponse.Status

func (ListingPerformanceRetrieveResponse) StatusCode

func (r ListingPerformanceRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningCommoditiesPriceRetrieveParams

type MiningCommoditiesPriceRetrieveParams struct {
	// StartYear Start year (e.g., `2022`). Defaults to current year − 2.
	StartYear *int `form:"start_year,omitempty" json:"start_year,omitempty"`

	// EndYear End year inclusive (e.g., `2024`). Defaults to current year. Maximum 3-year range from `start_year`.
	EndYear *int `form:"end_year,omitempty" json:"end_year,omitempty"`
}

MiningCommoditiesPriceRetrieveParams defines parameters for MiningCommoditiesPriceRetrieve.

type MiningCommoditiesPriceRetrieveResponse

type MiningCommoditiesPriceRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningCommoditiesPriceRetrieveResponse

func ParseMiningCommoditiesPriceRetrieveResponse(rsp *http.Response) (*MiningCommoditiesPriceRetrieveResponse, error)

ParseMiningCommoditiesPriceRetrieveResponse parses an HTTP response from a MiningCommoditiesPriceRetrieveWithResponse call

func (MiningCommoditiesPriceRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCommoditiesPriceRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCommoditiesPriceRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningCommoditiesRetrieveResponse

type MiningCommoditiesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseMiningCommoditiesRetrieveResponse

func ParseMiningCommoditiesRetrieveResponse(rsp *http.Response) (*MiningCommoditiesRetrieveResponse, error)

ParseMiningCommoditiesRetrieveResponse parses an HTTP response from a MiningCommoditiesRetrieveWithResponse call

func (MiningCommoditiesRetrieveResponse) ContentType

func (r MiningCommoditiesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCommoditiesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCommoditiesRetrieveResponse) StatusCode

func (r MiningCommoditiesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningCompaniesFinancialsRetrieveParams

type MiningCompaniesFinancialsRetrieveParams struct {
	// Year Year to retrieve. Defaults to the latest available year.
	Year *int `form:"year,omitempty" json:"year,omitempty"`
}

MiningCompaniesFinancialsRetrieveParams defines parameters for MiningCompaniesFinancialsRetrieve.

type MiningCompaniesFinancialsRetrieveResponse

type MiningCompaniesFinancialsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningCompaniesFinancialsRetrieveResponse

func ParseMiningCompaniesFinancialsRetrieveResponse(rsp *http.Response) (*MiningCompaniesFinancialsRetrieveResponse, error)

ParseMiningCompaniesFinancialsRetrieveResponse parses an HTTP response from a MiningCompaniesFinancialsRetrieveWithResponse call

func (MiningCompaniesFinancialsRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCompaniesFinancialsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCompaniesFinancialsRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningCompaniesOwnershipRetrieveResponse

type MiningCompaniesOwnershipRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningCompaniesOwnershipRetrieveResponse

func ParseMiningCompaniesOwnershipRetrieveResponse(rsp *http.Response) (*MiningCompaniesOwnershipRetrieveResponse, error)

ParseMiningCompaniesOwnershipRetrieveResponse parses an HTTP response from a MiningCompaniesOwnershipRetrieveWithResponse call

func (MiningCompaniesOwnershipRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCompaniesOwnershipRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCompaniesOwnershipRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningCompaniesPerformanceRetrieveParams

type MiningCompaniesPerformanceRetrieveParams struct {
	// CommodityType Filter by commodity. E.g. `Coal`, `Nickel`. Case-insensitive.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Year Year to retrieve. Defaults to the latest available year.
	Year *int `form:"year,omitempty" json:"year,omitempty"`
}

MiningCompaniesPerformanceRetrieveParams defines parameters for MiningCompaniesPerformanceRetrieve.

type MiningCompaniesPerformanceRetrieveResponse

type MiningCompaniesPerformanceRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningCompaniesPerformanceRetrieveResponse

func ParseMiningCompaniesPerformanceRetrieveResponse(rsp *http.Response) (*MiningCompaniesPerformanceRetrieveResponse, error)

ParseMiningCompaniesPerformanceRetrieveResponse parses an HTTP response from a MiningCompaniesPerformanceRetrieveWithResponse call

func (MiningCompaniesPerformanceRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCompaniesPerformanceRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCompaniesPerformanceRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningCompaniesRetrieve2Response

type MiningCompaniesRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningCompaniesRetrieve2Response

func ParseMiningCompaniesRetrieve2Response(rsp *http.Response) (*MiningCompaniesRetrieve2Response, error)

ParseMiningCompaniesRetrieve2Response parses an HTTP response from a MiningCompaniesRetrieve2WithResponse call

func (MiningCompaniesRetrieve2Response) ContentType

func (r MiningCompaniesRetrieve2Response) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCompaniesRetrieve2Response) Status

Status returns HTTPResponse.Status

func (MiningCompaniesRetrieve2Response) StatusCode

func (r MiningCompaniesRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningCompaniesRetrieveParams

type MiningCompaniesRetrieveParams struct {
	// CommodityType Filter by commodity. E.g. `Coal`, `Nickel`, `Gold`.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Limit Results per page. Default 20.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Items to skip for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Keyword Search across company name, IDX symbol, slug, and key operations (case-insensitive).
	Keyword *string `form:"keyword,omitempty" json:"keyword,omitempty"`

	// CompanyType Filter by company type. E.g. `Holding`, `Subsidiary`.
	CompanyType *string `form:"company_type,omitempty" json:"company_type,omitempty"`

	// HasFinancials If `true`, return only companies with financial data available.
	HasFinancials *bool `form:"has_financials,omitempty" json:"has_financials,omitempty"`
}

MiningCompaniesRetrieveParams defines parameters for MiningCompaniesRetrieve.

type MiningCompaniesRetrieveResponse

type MiningCompaniesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseMiningCompaniesRetrieveResponse

func ParseMiningCompaniesRetrieveResponse(rsp *http.Response) (*MiningCompaniesRetrieveResponse, error)

ParseMiningCompaniesRetrieveResponse parses an HTTP response from a MiningCompaniesRetrieveWithResponse call

func (MiningCompaniesRetrieveResponse) ContentType

func (r MiningCompaniesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningCompaniesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningCompaniesRetrieveResponse) StatusCode

func (r MiningCompaniesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningContractsRetrieveParams

type MiningContractsRetrieveParams struct {
	// Contractor Filter by contractor company slug.
	Contractor *string `form:"contractor,omitempty" json:"contractor,omitempty"`

	// MineOwner Filter by mine owner company slug.
	MineOwner *string `form:"mine_owner,omitempty" json:"mine_owner,omitempty"`
}

MiningContractsRetrieveParams defines parameters for MiningContractsRetrieve.

type MiningContractsRetrieveResponse

type MiningContractsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseMiningContractsRetrieveResponse

func ParseMiningContractsRetrieveResponse(rsp *http.Response) (*MiningContractsRetrieveResponse, error)

ParseMiningContractsRetrieveResponse parses an HTTP response from a MiningContractsRetrieveWithResponse call

func (MiningContractsRetrieveResponse) ContentType

func (r MiningContractsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningContractsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningContractsRetrieveResponse) StatusCode

func (r MiningContractsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningExportsRetrieveParams

type MiningExportsRetrieveParams struct {
	// CommodityType The commodity to analyze (e.g., `Gold`, `Coal`).
	CommodityType string `form:"commodity_type" json:"commodity_type"`

	// Year The year to analyze export data for (e.g., `2024`).
	Year int `form:"year" json:"year"`

	// Limit Number of top countries to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

MiningExportsRetrieveParams defines parameters for MiningExportsRetrieve.

type MiningExportsRetrieveResponse

type MiningExportsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningExportsRetrieveResponse

func ParseMiningExportsRetrieveResponse(rsp *http.Response) (*MiningExportsRetrieveResponse, error)

ParseMiningExportsRetrieveResponse parses an HTTP response from a MiningExportsRetrieveWithResponse call

func (MiningExportsRetrieveResponse) ContentType

func (r MiningExportsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningExportsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningExportsRetrieveResponse) StatusCode

func (r MiningExportsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningGlobalCommodityRetrieveParams

type MiningGlobalCommodityRetrieveParams struct {
	// CommodityType Filter by commodity type. Required if `country` not provided.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Country Filter by country (exact match, e.g., `Australia`). Required if `commodity_type` not provided.
	Country *string `form:"country,omitempty" json:"country,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

MiningGlobalCommodityRetrieveParams defines parameters for MiningGlobalCommodityRetrieve.

type MiningGlobalCommodityRetrieveResponse

type MiningGlobalCommodityRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseMiningGlobalCommodityRetrieveResponse

func ParseMiningGlobalCommodityRetrieveResponse(rsp *http.Response) (*MiningGlobalCommodityRetrieveResponse, error)

ParseMiningGlobalCommodityRetrieveResponse parses an HTTP response from a MiningGlobalCommodityRetrieveWithResponse call

func (MiningGlobalCommodityRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningGlobalCommodityRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningGlobalCommodityRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningLicenseAuctionsRetrieve2Response

type MiningLicenseAuctionsRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningLicenseAuctionsRetrieve2Response

func ParseMiningLicenseAuctionsRetrieve2Response(rsp *http.Response) (*MiningLicenseAuctionsRetrieve2Response, error)

ParseMiningLicenseAuctionsRetrieve2Response parses an HTTP response from a MiningLicenseAuctionsRetrieve2WithResponse call

func (MiningLicenseAuctionsRetrieve2Response) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningLicenseAuctionsRetrieve2Response) Status

Status returns HTTPResponse.Status

func (MiningLicenseAuctionsRetrieve2Response) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningLicenseAuctionsRetrieveParams

type MiningLicenseAuctionsRetrieveParams struct {
	// Province Filter by province (e.g., `Sulawesi Selatan`). Case-insensitive.
	Province *string `form:"province,omitempty" json:"province,omitempty"`

	// CommodityType Filter by commodity (e.g., `Nickel`, `Coal`). Case-insensitive.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// OrderBy Sort field. Prefix with `-` for descending. Default: `-winner_date`.
	OrderBy *MiningLicenseAuctionsRetrieveParamsOrderBy `form:"order_by,omitempty" json:"order_by,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// AreaType Filter by area type (e.g., `WIUPK`). Case-insensitive.
	AreaType *string `form:"area_type,omitempty" json:"area_type,omitempty"`

	// Status Filter by auction status (e.g., `Lelang Selesai`). Case-insensitive.
	Status *string `form:"status,omitempty" json:"status,omitempty"`

	// Participant Filter auctions where a company name (partial match) participated.
	Participant *string `form:"participant,omitempty" json:"participant,omitempty"`

	// Qualified When `true`, only return auctions where the `participant` passed qualification. Requires `participant`.
	Qualified *bool `form:"qualified,omitempty" json:"qualified,omitempty"`

	// MinParticipants Only return auctions with at least this many participants.
	MinParticipants *int `form:"min_participants,omitempty" json:"min_participants,omitempty"`
}

MiningLicenseAuctionsRetrieveParams defines parameters for MiningLicenseAuctionsRetrieve.

type MiningLicenseAuctionsRetrieveParamsOrderBy

type MiningLicenseAuctionsRetrieveParamsOrderBy string

MiningLicenseAuctionsRetrieveParamsOrderBy defines parameters for MiningLicenseAuctionsRetrieve.

const (
	MiningLicenseAuctionsRetrieveParamsOrderByCommodityType         MiningLicenseAuctionsRetrieveParamsOrderBy = "commodity_type"
	MiningLicenseAuctionsRetrieveParamsOrderByLicensedAreaHa        MiningLicenseAuctionsRetrieveParamsOrderBy = "licensed_area_ha"
	MiningLicenseAuctionsRetrieveParamsOrderByMinusCommodityType    MiningLicenseAuctionsRetrieveParamsOrderBy = "-commodity_type"
	MiningLicenseAuctionsRetrieveParamsOrderByMinusLicensedAreaHa   MiningLicenseAuctionsRetrieveParamsOrderBy = "-licensed_area_ha"
	MiningLicenseAuctionsRetrieveParamsOrderByMinusParticipantCount MiningLicenseAuctionsRetrieveParamsOrderBy = "-participant_count"
	MiningLicenseAuctionsRetrieveParamsOrderByMinusWinnerDate       MiningLicenseAuctionsRetrieveParamsOrderBy = "-winner_date"
	MiningLicenseAuctionsRetrieveParamsOrderByParticipantCount      MiningLicenseAuctionsRetrieveParamsOrderBy = "participant_count"
	MiningLicenseAuctionsRetrieveParamsOrderByWinnerDate            MiningLicenseAuctionsRetrieveParamsOrderBy = "winner_date"
)

Defines values for MiningLicenseAuctionsRetrieveParamsOrderBy.

func (MiningLicenseAuctionsRetrieveParamsOrderBy) Valid

Valid indicates whether the value is a known member of the MiningLicenseAuctionsRetrieveParamsOrderBy enum.

type MiningLicenseAuctionsRetrieveResponse

type MiningLicenseAuctionsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseMiningLicenseAuctionsRetrieveResponse

func ParseMiningLicenseAuctionsRetrieveResponse(rsp *http.Response) (*MiningLicenseAuctionsRetrieveResponse, error)

ParseMiningLicenseAuctionsRetrieveResponse parses an HTTP response from a MiningLicenseAuctionsRetrieveWithResponse call

func (MiningLicenseAuctionsRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningLicenseAuctionsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningLicenseAuctionsRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningLicensesRetrieveParams

type MiningLicensesRetrieveParams struct {
	// Province Filter by province. Exact match.
	Province *string `form:"province,omitempty" json:"province,omitempty"`

	// CommodityType Filter by commodity. Case-insensitive.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Company Filter by company slug.
	Company *string `form:"company,omitempty" json:"company,omitempty"`

	// OrderBy Sort field. Prefix with `-` for descending. Default: `license_expiry_date`.
	OrderBy *MiningLicensesRetrieveParamsOrderBy `form:"order_by,omitempty" json:"order_by,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// ExpiringSoon Set to `true` to find licenses expiring within the next 365 days.
	ExpiringSoon *bool `form:"expiring_soon,omitempty" json:"expiring_soon,omitempty"`

	// LicenseType Filter by license type (e.g., `IUP`, `IUPK`). Case-insensitive.
	LicenseType *string `form:"license_type,omitempty" json:"license_type,omitempty"`

	// Activity Filter by activity stage (e.g., `Eksplorasi`, `Operasi Produksi`). Case-insensitive.
	Activity *string `form:"activity,omitempty" json:"activity,omitempty"`

	// Cnc Filter by Clear & Clean status. Case-insensitive.
	Cnc *bool `form:"cnc,omitempty" json:"cnc,omitempty"`
}

MiningLicensesRetrieveParams defines parameters for MiningLicensesRetrieve.

type MiningLicensesRetrieveParamsOrderBy

type MiningLicensesRetrieveParamsOrderBy string

MiningLicensesRetrieveParamsOrderBy defines parameters for MiningLicensesRetrieve.

const (
	MiningLicensesRetrieveParamsOrderByCommodityType             MiningLicensesRetrieveParamsOrderBy = "commodity_type"
	MiningLicensesRetrieveParamsOrderByLicenseEffectiveDate      MiningLicensesRetrieveParamsOrderBy = "license_effective_date"
	MiningLicensesRetrieveParamsOrderByLicenseExpiryDate         MiningLicensesRetrieveParamsOrderBy = "license_expiry_date"
	MiningLicensesRetrieveParamsOrderByLicensedAreaHa            MiningLicensesRetrieveParamsOrderBy = "licensed_area_ha"
	MiningLicensesRetrieveParamsOrderByMinusCommodityType        MiningLicensesRetrieveParamsOrderBy = "-commodity_type"
	MiningLicensesRetrieveParamsOrderByMinusLicenseEffectiveDate MiningLicensesRetrieveParamsOrderBy = "-license_effective_date"
	MiningLicensesRetrieveParamsOrderByMinusLicenseExpiryDate    MiningLicensesRetrieveParamsOrderBy = "-license_expiry_date"
	MiningLicensesRetrieveParamsOrderByMinusLicensedAreaHa       MiningLicensesRetrieveParamsOrderBy = "-licensed_area_ha"
)

Defines values for MiningLicensesRetrieveParamsOrderBy.

func (MiningLicensesRetrieveParamsOrderBy) Valid

Valid indicates whether the value is a known member of the MiningLicensesRetrieveParamsOrderBy enum.

type MiningLicensesRetrieveResponse

type MiningLicensesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseMiningLicensesRetrieveResponse

func ParseMiningLicensesRetrieveResponse(rsp *http.Response) (*MiningLicensesRetrieveResponse, error)

ParseMiningLicensesRetrieveResponse parses an HTTP response from a MiningLicensesRetrieveWithResponse call

func (MiningLicensesRetrieveResponse) ContentType

func (r MiningLicensesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningLicensesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningLicensesRetrieveResponse) StatusCode

func (r MiningLicensesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningResourcesReservesRetrieve2Params

type MiningResourcesReservesRetrieve2Params struct {
	// CommodityType Restrict results to a specific commodity.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Year Restrict results to a specific year.
	Year *int `form:"year,omitempty" json:"year,omitempty"`
}

MiningResourcesReservesRetrieve2Params defines parameters for MiningResourcesReservesRetrieve2.

type MiningResourcesReservesRetrieve2Response

type MiningResourcesReservesRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningResourcesReservesRetrieve2Response

func ParseMiningResourcesReservesRetrieve2Response(rsp *http.Response) (*MiningResourcesReservesRetrieve2Response, error)

ParseMiningResourcesReservesRetrieve2Response parses an HTTP response from a MiningResourcesReservesRetrieve2WithResponse call

func (MiningResourcesReservesRetrieve2Response) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningResourcesReservesRetrieve2Response) Status

Status returns HTTPResponse.Status

func (MiningResourcesReservesRetrieve2Response) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningResourcesReservesRetrieveResponse

type MiningResourcesReservesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseMiningResourcesReservesRetrieveResponse

func ParseMiningResourcesReservesRetrieveResponse(rsp *http.Response) (*MiningResourcesReservesRetrieveResponse, error)

ParseMiningResourcesReservesRetrieveResponse parses an HTTP response from a MiningResourcesReservesRetrieveWithResponse call

func (MiningResourcesReservesRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningResourcesReservesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningResourcesReservesRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningSalesDestinationRetrieveParams

type MiningSalesDestinationRetrieveParams struct {
	// Year The year to retrieve. Defaults to the latest available year.
	Year *int `form:"year,omitempty" json:"year,omitempty"`
}

MiningSalesDestinationRetrieveParams defines parameters for MiningSalesDestinationRetrieve.

type MiningSalesDestinationRetrieveResponse

type MiningSalesDestinationRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningSalesDestinationRetrieveResponse

func ParseMiningSalesDestinationRetrieveResponse(rsp *http.Response) (*MiningSalesDestinationRetrieveResponse, error)

ParseMiningSalesDestinationRetrieveResponse parses an HTTP response from a MiningSalesDestinationRetrieveWithResponse call

func (MiningSalesDestinationRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningSalesDestinationRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningSalesDestinationRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MiningSitesRetrieve2Response

type MiningSitesRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningSitesRetrieve2Response

func ParseMiningSitesRetrieve2Response(rsp *http.Response) (*MiningSitesRetrieve2Response, error)

ParseMiningSitesRetrieve2Response parses an HTTP response from a MiningSitesRetrieve2WithResponse call

func (MiningSitesRetrieve2Response) ContentType

func (r MiningSitesRetrieve2Response) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningSitesRetrieve2Response) Status

Status returns HTTPResponse.Status

func (MiningSitesRetrieve2Response) StatusCode

func (r MiningSitesRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningSitesRetrieveParams

type MiningSitesRetrieveParams struct {
	// Province Filter by exact province name (e.g., `Kalimantan Timur`).
	Province *string `form:"province,omitempty" json:"province,omitempty"`

	// CommodityType Filter by commodity type. Case-insensitive.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Company Filter by company slug.
	Company *string `form:"company,omitempty" json:"company,omitempty"`

	// Year Filter by reporting year.
	Year *int `form:"year,omitempty" json:"year,omitempty"`

	// OrderBy Sort field. Prefix with `-` for descending. Default: `-year`.
	OrderBy *MiningSitesRetrieveParamsOrderBy `form:"order_by,omitempty" json:"order_by,omitempty"`

	// MinProduction Filter for sites with `production_volume` ≥ this value.
	MinProduction *float64 `form:"min_production,omitempty" json:"min_production,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

MiningSitesRetrieveParams defines parameters for MiningSitesRetrieve.

type MiningSitesRetrieveParamsOrderBy

type MiningSitesRetrieveParamsOrderBy string

MiningSitesRetrieveParamsOrderBy defines parameters for MiningSitesRetrieve.

const (
	MinusProductionVolume MiningSitesRetrieveParamsOrderBy = "-production_volume"
	MinusStripRatio       MiningSitesRetrieveParamsOrderBy = "-strip_ratio"
	MinusYear             MiningSitesRetrieveParamsOrderBy = "-year"
	ProductionVolume      MiningSitesRetrieveParamsOrderBy = "production_volume"
	StripRatio            MiningSitesRetrieveParamsOrderBy = "strip_ratio"
	Year                  MiningSitesRetrieveParamsOrderBy = "year"
)

Defines values for MiningSitesRetrieveParamsOrderBy.

func (MiningSitesRetrieveParamsOrderBy) Valid

Valid indicates whether the value is a known member of the MiningSitesRetrieveParamsOrderBy enum.

type MiningSitesRetrieveResponse

type MiningSitesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseMiningSitesRetrieveResponse

func ParseMiningSitesRetrieveResponse(rsp *http.Response) (*MiningSitesRetrieveResponse, error)

ParseMiningSitesRetrieveResponse parses an HTTP response from a MiningSitesRetrieveWithResponse call

func (MiningSitesRetrieveResponse) ContentType

func (r MiningSitesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningSitesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningSitesRetrieveResponse) StatusCode

func (r MiningSitesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MiningTotalProductionRetrieveParams

type MiningTotalProductionRetrieveParams struct {
	// CommodityType The commodity to analyze (e.g., `Coal`). Required.
	CommodityType string `form:"commodity_type" json:"commodity_type"`
}

MiningTotalProductionRetrieveParams defines parameters for MiningTotalProductionRetrieve.

type MiningTotalProductionRetrieveResponse

type MiningTotalProductionRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseMiningTotalProductionRetrieveResponse

func ParseMiningTotalProductionRetrieveResponse(rsp *http.Response) (*MiningTotalProductionRetrieveResponse, error)

ParseMiningTotalProductionRetrieveResponse parses an HTTP response from a MiningTotalProductionRetrieveWithResponse call

func (MiningTotalProductionRetrieveResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MiningTotalProductionRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MiningTotalProductionRetrieveResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MostTradedRetrieveParams

type MostTradedRetrieveParams struct {
	// SubSector Filter by kebab-case subsector slug. E.g. `banks`. Get valid values from the [Subsectors](./helper-list/subsectors) endpoint.
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Defaults to 30 days before `end`. Wider ranges are clamped to the most recent 90 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Defaults to today. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Adjusted If `true`, rank by volume × closing price instead of raw volume.
	Adjusted *bool `form:"adjusted,omitempty" json:"adjusted,omitempty"`

	// NStock Number of tickers per day. Default 5, max 10.
	NStock *int `form:"n_stock,omitempty" json:"n_stock,omitempty"`
}

MostTradedRetrieveParams defines parameters for MostTradedRetrieve.

type MostTradedRetrieveResponse

type MostTradedRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseMostTradedRetrieveResponse

func ParseMostTradedRetrieveResponse(rsp *http.Response) (*MostTradedRetrieveResponse, error)

ParseMostTradedRetrieveResponse parses an HTTP response from a MostTradedRetrieveWithResponse call

func (MostTradedRetrieveResponse) ContentType

func (r MostTradedRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MostTradedRetrieveResponse) Status

Status returns HTTPResponse.Status

func (MostTradedRetrieveResponse) StatusCode

func (r MostTradedRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NewsRetrieveParams

type NewsRetrieveParams struct {
	// Sector **IDX only.** Comma-separated sector slugs (kebab-case).
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// SubSector **IDX only.** Comma-separated subsector slugs (kebab-case).
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// CommodityType **Mining only.** Filter by commodity type. E.g. `Coal`, `Nickel`.
	CommodityType *string `form:"commodity_type,omitempty" json:"commodity_type,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `timestamp`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Items per page. Max 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Items to skip for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Tags **IDX only.** Comma-separated tag slugs. Get valid values from the [News Tags](../helper-list/tags) endpoint.
	Tags *string `form:"tags,omitempty" json:"tags,omitempty"`

	// Extension Data source. Default `idx`.
	Extension *NewsRetrieveParamsExtension `form:"extension,omitempty" json:"extension,omitempty"`

	// Keyword Case-insensitive substring match on article title. Works for both IDX and mining.
	Keyword *string `form:"keyword,omitempty" json:"keyword,omitempty"`

	// Symbols **IDX only.** Comma-separated IDX symbols. E.g. `BBCA,BBRI`.
	Symbols *string `form:"symbols,omitempty" json:"symbols,omitempty"`
}

NewsRetrieveParams defines parameters for NewsRetrieve.

type NewsRetrieveParamsExtension

type NewsRetrieveParamsExtension string

NewsRetrieveParamsExtension defines parameters for NewsRetrieve.

const (
	IDX    NewsRetrieveParamsExtension = "idx"
	Mining NewsRetrieveParamsExtension = "mining"
)

Defines values for NewsRetrieveParamsExtension.

func (NewsRetrieveParamsExtension) Valid

Valid indicates whether the value is a known member of the NewsRetrieveParamsExtension enum.

type NewsRetrieveResponse

type NewsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseNewsRetrieveResponse

func ParseNewsRetrieveResponse(rsp *http.Response) (*NewsRetrieveResponse, error)

ParseNewsRetrieveResponse parses an HTTP response from a NewsRetrieveWithResponse call

func (NewsRetrieveResponse) ContentType

func (r NewsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (NewsRetrieveResponse) Status

func (r NewsRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (NewsRetrieveResponse) StatusCode

func (r NewsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SGXBuybacksRetrieveParams

type SGXBuybacksRetrieveParams struct {
	// Symbol SGX symbol to filter by. E.g. `D05`, `U11`.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `purchase_date`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Items per page. Max 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

SGXBuybacksRetrieveParams defines parameters for SGXBuybacksRetrieve.

type SGXBuybacksRetrieveResponse

type SGXBuybacksRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXBuybacksRetrieveResponse

func ParseSGXBuybacksRetrieveResponse(rsp *http.Response) (*SGXBuybacksRetrieveResponse, error)

ParseSGXBuybacksRetrieveResponse parses an HTTP response from a SGXBuybacksRetrieveWithResponse call

func (SGXBuybacksRetrieveResponse) ContentType

func (r SGXBuybacksRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXBuybacksRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SGXBuybacksRetrieveResponse) StatusCode

func (r SGXBuybacksRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXCompaniesRetrieveParams

type SGXCompaniesRetrieveParams struct {
	// Where SQL-like conditions for advanced filtering. Ignored if `q` is present. Supports operators `=`, `!=`, `>`, `>=`, `<`, `<=`, `like`, `in` combined with `and`/`or`. Use bracket notation for yearly fields: `revenue[2024] > 1000000000`. Supports arithmetic on both sides: `earnings[2024] / earnings[2023] > 1.25`.
	Where *string `form:"where,omitempty" json:"where,omitempty"`

	// Q A natural language query (e.g. `top 5 SGX banks by market cap`). When `q` is provided, all other query parameters (`where`, `order_by`, etc.) are ignored as the LLM will generate them.
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// OrderBy Field to sort results by. Use `-` prefix for descending order (e.g. `-market_cap`). Supports arithmetic expressions (e.g. `-(earnings[2024]/earnings[2023])`). Ignored if `q` is present.
	OrderBy *string `form:"order_by,omitempty" json:"order_by,omitempty"`

	// Desc Sort in descending order. Ignored if `q` is present.
	Desc *bool `form:"desc,omitempty" json:"desc,omitempty"`

	// Limit Maximum number of results to return. Max: 200. Ignored if `q` is present.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip for pagination. Ignored if `q` is present.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// IncludeQueryValues If `true`, the response includes a `query_values` object showing the field values used in filtering/sorting.
	IncludeQueryValues *bool `form:"include_query_values,omitempty" json:"include_query_values,omitempty"`
}

SGXCompaniesRetrieveParams defines parameters for SGXCompaniesRetrieve.

type SGXCompaniesRetrieveResponse

type SGXCompaniesRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseSGXCompaniesRetrieveResponse

func ParseSGXCompaniesRetrieveResponse(rsp *http.Response) (*SGXCompaniesRetrieveResponse, error)

ParseSGXCompaniesRetrieveResponse parses an HTTP response from a SGXCompaniesRetrieveWithResponse call

func (SGXCompaniesRetrieveResponse) ContentType

func (r SGXCompaniesRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXCompaniesRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SGXCompaniesRetrieveResponse) StatusCode

func (r SGXCompaniesRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXCompaniesTopRetrieveParams

type SGXCompaniesTopRetrieveParams struct {
	// Sector Filter by sector slug. E.g. `financial-services`, `technology`. Default: all sectors.
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// NStock Number of top companies to return per classification. Max 10. Default: 5.
	NStock *int `form:"n_stock,omitempty" json:"n_stock,omitempty"`

	// Classifications Comma-separated list of classifications. Options: `dividend_yield`, `revenue`, `earnings`, `market_cap`, `pe`. Default: all.
	Classifications *string `form:"classifications,omitempty" json:"classifications,omitempty"`

	// MinMcapMillion Minimum market cap in million SGD. Default: 1000.
	MinMcapMillion *int `form:"min_mcap_million,omitempty" json:"min_mcap_million,omitempty"`
}

SGXCompaniesTopRetrieveParams defines parameters for SGXCompaniesTopRetrieve.

type SGXCompaniesTopRetrieveResponse

type SGXCompaniesTopRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseSGXCompaniesTopRetrieveResponse

func ParseSGXCompaniesTopRetrieveResponse(rsp *http.Response) (*SGXCompaniesTopRetrieveResponse, error)

ParseSGXCompaniesTopRetrieveResponse parses an HTTP response from a SGXCompaniesTopRetrieveWithResponse call

func (SGXCompaniesTopRetrieveResponse) ContentType

func (r SGXCompaniesTopRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXCompaniesTopRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SGXCompaniesTopRetrieveResponse) StatusCode

func (r SGXCompaniesTopRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXCompanyReportRetrieve2Params

type SGXCompanyReportRetrieve2Params struct {
	// Sections Comma-separated sections to include. Options: `overview`, `valuation`, `financials`, `dividend`. Default: all sections.
	Sections *string `form:"sections,omitempty" json:"sections,omitempty"`
}

SGXCompanyReportRetrieve2Params defines parameters for SGXCompanyReportRetrieve2.

type SGXCompanyReportRetrieve2Response

type SGXCompanyReportRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseSGXCompanyReportRetrieve2Response

func ParseSGXCompanyReportRetrieve2Response(rsp *http.Response) (*SGXCompanyReportRetrieve2Response, error)

ParseSGXCompanyReportRetrieve2Response parses an HTTP response from a SGXCompanyReportRetrieve2WithResponse call

func (SGXCompanyReportRetrieve2Response) ContentType

func (r SGXCompanyReportRetrieve2Response) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXCompanyReportRetrieve2Response) Status

Status returns HTTPResponse.Status

func (SGXCompanyReportRetrieve2Response) StatusCode

func (r SGXCompanyReportRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXDailyRetrieveParams

type SGXDailyRetrieveParams struct {
	// Start Start date in `YYYY-MM-DD` format. Defaults to 30 days before `end`. Wider ranges are clamped to the most recent 90 days.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Defaults to today. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`
}

SGXDailyRetrieveParams defines parameters for SGXDailyRetrieve.

type SGXDailyRetrieveResponse

type SGXDailyRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON404      *interface{}
	JSON429      *interface{}
}

func ParseSGXDailyRetrieveResponse

func ParseSGXDailyRetrieveResponse(rsp *http.Response) (*SGXDailyRetrieveResponse, error)

ParseSGXDailyRetrieveResponse parses an HTTP response from a SGXDailyRetrieveWithResponse call

func (SGXDailyRetrieveResponse) ContentType

func (r SGXDailyRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXDailyRetrieveResponse) Status

func (r SGXDailyRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (SGXDailyRetrieveResponse) StatusCode

func (r SGXDailyRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXFilingsRetrieveParams

type SGXFilingsRetrieveParams struct {
	// Symbol SGX symbol to filter by. E.g. `D05`, `U11`.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `timestamp`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Number of results to return. Maximum: 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of results to skip for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// TransactionType Filter by transaction type (case-insensitive).
	TransactionType *SGXFilingsRetrieveParamsTransactionType `form:"transaction_type,omitempty" json:"transaction_type,omitempty"`

	// HolderType Filter by holder type (case-insensitive).
	HolderType *SGXFilingsRetrieveParamsHolderType `form:"holder_type,omitempty" json:"holder_type,omitempty"`
}

SGXFilingsRetrieveParams defines parameters for SGXFilingsRetrieve.

type SGXFilingsRetrieveParamsHolderType

type SGXFilingsRetrieveParamsHolderType string

SGXFilingsRetrieveParamsHolderType defines parameters for SGXFilingsRetrieve.

const (
	SGXFilingsRetrieveParamsHolderTypeInsider     SGXFilingsRetrieveParamsHolderType = "insider"
	SGXFilingsRetrieveParamsHolderTypeInstitution SGXFilingsRetrieveParamsHolderType = "institution"
)

Defines values for SGXFilingsRetrieveParamsHolderType.

func (SGXFilingsRetrieveParamsHolderType) Valid

Valid indicates whether the value is a known member of the SGXFilingsRetrieveParamsHolderType enum.

type SGXFilingsRetrieveParamsTransactionType

type SGXFilingsRetrieveParamsTransactionType string

SGXFilingsRetrieveParamsTransactionType defines parameters for SGXFilingsRetrieve.

const (
	SGXFilingsRetrieveParamsTransactionTypeAward    SGXFilingsRetrieveParamsTransactionType = "award"
	SGXFilingsRetrieveParamsTransactionTypeBuy      SGXFilingsRetrieveParamsTransactionType = "buy"
	SGXFilingsRetrieveParamsTransactionTypeOthers   SGXFilingsRetrieveParamsTransactionType = "others"
	SGXFilingsRetrieveParamsTransactionTypeSell     SGXFilingsRetrieveParamsTransactionType = "sell"
	SGXFilingsRetrieveParamsTransactionTypeTransfer SGXFilingsRetrieveParamsTransactionType = "transfer"
)

Defines values for SGXFilingsRetrieveParamsTransactionType.

func (SGXFilingsRetrieveParamsTransactionType) Valid

Valid indicates whether the value is a known member of the SGXFilingsRetrieveParamsTransactionType enum.

type SGXFilingsRetrieveResponse

type SGXFilingsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXFilingsRetrieveResponse

func ParseSGXFilingsRetrieveResponse(rsp *http.Response) (*SGXFilingsRetrieveResponse, error)

ParseSGXFilingsRetrieveResponse parses an HTTP response from a SGXFilingsRetrieveWithResponse call

func (SGXFilingsRetrieveResponse) ContentType

func (r SGXFilingsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXFilingsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SGXFilingsRetrieveResponse) StatusCode

func (r SGXFilingsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXNewsRetrieveParams

type SGXNewsRetrieveParams struct {
	// Sector Filter by sector (case-insensitive).
	Sector *string `form:"sector,omitempty" json:"sector,omitempty"`

	// SubSector Filter by sub-sector (case-insensitive).
	SubSector *string `form:"sub_sector,omitempty" json:"sub_sector,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `timestamp`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Items per page. Max 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Tags Comma-separated tag slugs. Get values from [SGX Tags](../singapore/sgx-tags).
	Tags *string `form:"tags,omitempty" json:"tags,omitempty"`

	// Symbols Comma-separated SGX symbols. E.g. `D05,U11`.
	Symbols *string `form:"symbols,omitempty" json:"symbols,omitempty"`
}

SGXNewsRetrieveParams defines parameters for SGXNewsRetrieve.

type SGXNewsRetrieveResponse

type SGXNewsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXNewsRetrieveResponse

func ParseSGXNewsRetrieveResponse(rsp *http.Response) (*SGXNewsRetrieveResponse, error)

ParseSGXNewsRetrieveResponse parses an HTTP response from a SGXNewsRetrieveWithResponse call

func (SGXNewsRetrieveResponse) ContentType

func (r SGXNewsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXNewsRetrieveResponse) Status

func (r SGXNewsRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (SGXNewsRetrieveResponse) StatusCode

func (r SGXNewsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXSectorsListResponse

type SGXSectorsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXSectorsListResponse

func ParseSGXSectorsListResponse(rsp *http.Response) (*SGXSectorsListResponse, error)

ParseSGXSectorsListResponse parses an HTTP response from a SGXSectorsListWithResponse call

func (SGXSectorsListResponse) ContentType

func (r SGXSectorsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXSectorsListResponse) Status

func (r SGXSectorsListResponse) Status() string

Status returns HTTPResponse.Status

func (SGXSectorsListResponse) StatusCode

func (r SGXSectorsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXShortSellRetrieveParams

type SGXShortSellRetrieveParams struct {
	// Symbol SGX symbol to filter by. E.g. `D05`, `U11`.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `date`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Items per page. Max 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

SGXShortSellRetrieveParams defines parameters for SGXShortSellRetrieve.

type SGXShortSellRetrieveResponse

type SGXShortSellRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXShortSellRetrieveResponse

func ParseSGXShortSellRetrieveResponse(rsp *http.Response) (*SGXShortSellRetrieveResponse, error)

ParseSGXShortSellRetrieveResponse parses an HTTP response from a SGXShortSellRetrieveWithResponse call

func (SGXShortSellRetrieveResponse) ContentType

func (r SGXShortSellRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXShortSellRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SGXShortSellRetrieveResponse) StatusCode

func (r SGXShortSellRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SGXTagsRetrieveResponse

type SGXTagsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSGXTagsRetrieveResponse

func ParseSGXTagsRetrieveResponse(rsp *http.Response) (*SGXTagsRetrieveResponse, error)

ParseSGXTagsRetrieveResponse parses an HTTP response from a SGXTagsRetrieveWithResponse call

func (SGXTagsRetrieveResponse) ContentType

func (r SGXTagsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SGXTagsRetrieveResponse) Status

func (r SGXTagsRetrieveResponse) Status() string

Status returns HTTPResponse.Status

func (SGXTagsRetrieveResponse) StatusCode

func (r SGXTagsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubindustriesListResponse

type SubindustriesListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSubindustriesListResponse

func ParseSubindustriesListResponse(rsp *http.Response) (*SubindustriesListResponse, error)

ParseSubindustriesListResponse parses an HTTP response from a SubindustriesListWithResponse call

func (SubindustriesListResponse) ContentType

func (r SubindustriesListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubindustriesListResponse) Status

func (r SubindustriesListResponse) Status() string

Status returns HTTPResponse.Status

func (SubindustriesListResponse) StatusCode

func (r SubindustriesListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubsectorReportRetrieve2Params

type SubsectorReportRetrieve2Params struct {
	// Sections Comma-separated sections to include. Default: all. Options: `statistics`, `market_cap`, `stability`, `valuation`, `growth`, `companies`.
	Sections *string `form:"sections,omitempty" json:"sections,omitempty"`
}

SubsectorReportRetrieve2Params defines parameters for SubsectorReportRetrieve2.

type SubsectorReportRetrieve2Response

type SubsectorReportRetrieve2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON400      *interface{}
	JSON429      *interface{}
}

func ParseSubsectorReportRetrieve2Response

func ParseSubsectorReportRetrieve2Response(rsp *http.Response) (*SubsectorReportRetrieve2Response, error)

ParseSubsectorReportRetrieve2Response parses an HTTP response from a SubsectorReportRetrieve2WithResponse call

func (SubsectorReportRetrieve2Response) ContentType

func (r SubsectorReportRetrieve2Response) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubsectorReportRetrieve2Response) Status

Status returns HTTPResponse.Status

func (SubsectorReportRetrieve2Response) StatusCode

func (r SubsectorReportRetrieve2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubsectorsListResponse

type SubsectorsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSubsectorsListResponse

func ParseSubsectorsListResponse(rsp *http.Response) (*SubsectorsListResponse, error)

ParseSubsectorsListResponse parses an HTTP response from a SubsectorsListWithResponse call

func (SubsectorsListResponse) ContentType

func (r SubsectorsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubsectorsListResponse) Status

func (r SubsectorsListResponse) Status() string

Status returns HTTPResponse.Status

func (SubsectorsListResponse) StatusCode

func (r SubsectorsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SuspensionsRetrieveParams

type SuspensionsRetrieveParams struct {
	// Symbol Optional filter by IDX symbol (case-insensitive). E.g. `BBCA`, `GOTO`.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// Start Start date in `YYYY-MM-DD` format. Optional; if omitted, no lower bound is applied. Filters on `suspension_date`.
	Start *string `form:"start,omitempty" json:"start,omitempty"`

	// End End date in `YYYY-MM-DD` format. Optional; if omitted, no upper bound is applied. Future dates return 400.
	End *string `form:"end,omitempty" json:"end,omitempty"`

	// Limit Items per page. Max 30.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Number of items to skip.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

SuspensionsRetrieveParams defines parameters for SuspensionsRetrieve.

type SuspensionsRetrieveResponse

type SuspensionsRetrieveResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseSuspensionsRetrieveResponse

func ParseSuspensionsRetrieveResponse(rsp *http.Response) (*SuspensionsRetrieveResponse, error)

ParseSuspensionsRetrieveResponse parses an HTTP response from a SuspensionsRetrieveWithResponse call

func (SuspensionsRetrieveResponse) ContentType

func (r SuspensionsRetrieveResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SuspensionsRetrieveResponse) Status

Status returns HTTPResponse.Status

func (SuspensionsRetrieveResponse) StatusCode

func (r SuspensionsRetrieveResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TagsListResponse

type TagsListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
	JSON429      *interface{}
}

func ParseTagsListResponse

func ParseTagsListResponse(rsp *http.Response) (*TagsListResponse, error)

ParseTagsListResponse parses an HTTP response from a TagsListWithResponse call

func (TagsListResponse) ContentType

func (r TagsListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TagsListResponse) Status

func (r TagsListResponse) Status() string

Status returns HTTPResponse.Status

func (TagsListResponse) StatusCode

func (r TagsListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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