kalshi

README

go-kalshi

Unofficial Go client for Kalshi, generated from the API specs Kalshi publishes. I'm not affiliated with Kalshi.

Directory	Package	API	Generator
/ (repo root)	kalshi	Trade REST API, https://external-api.kalshi.com/trade-api/v2	oapi-codegen
ws/	kalshiws	Market data WebSocket, wss://external-api-ws.kalshi.com/trade-api/ws/v2	gen-asyncapi
perpsws/	kalshiperpsws	Perps WebSocket, wss://external-api-margin-ws.kalshi.com/trade-api/ws/v2/margin	gen-asyncapi
auth/	kalshiauth	Request signing for all of the above	hand-written

The REST client lives in the repo root; the WebSocket clients and the signer are subpackages. client.gen.go in the root and everything in ws/ and perpsws/ except gen.go, the generator configs and the tests is generated. Don't edit it by hand, regenerate it.

Contents

• Install
• Auth
• REST
• WebSocket
• Regenerating
• Agent integrations
• Development
• License

Install

go get github.com/psyb0t/go-kalshi

Auth

Kalshi signs requests instead of sending a bearer token. Every private call carries KALSHI-ACCESS-KEY (the API key ID), KALSHI-ACCESS-TIMESTAMP (milliseconds) and KALSHI-ACCESS-SIGNATURE, a base64 RSA-PSS SHA-256 signature of timestamp + method + path, with the path taken without its query string. Ed25519 keys work too.

kalshiauth.ParsePrivateKeyPEM reads the key file Kalshi gives you. kalshiauth.NewSigner wraps it: RequestEditor signs REST requests, and Headers returns the headers for the WebSocket handshake.

REST

Every endpoint in the spec has a typed method on ClientWithResponses. Public endpoints such as GetMarketsWithResponse work without the signer.

package main

import (
	"context"
	"os"

	"github.com/psyb0t/go-kalshi"
	"github.com/psyb0t/go-kalshi/auth"
)

func main() {
	pemKey := []byte(os.Getenv("KALSHI_PRIVATE_KEY"))

	key, err := kalshiauth.ParsePrivateKeyPEM(pemKey)
	if err != nil {
		panic(err)
	}

	signer, err := kalshiauth.NewSigner(os.Getenv("KALSHI_API_KEY_ID"), key)
	if err != nil {
		panic(err)
	}

	client, err := kalshi.NewClientWithResponses(
		"https://external-api.kalshi.com/trade-api/v2",
		kalshi.WithRequestEditorFn(signer.RequestEditor),
	)
	if err != nil {
		panic(err)
	}

	res, err := client.GetBalanceWithResponse(
		context.Background(),
		&kalshi.GetBalanceParams{},
	)
	if err != nil {
		panic(err)
	}

	_ = res.JSON200
}

The demo environment lives at https://external-api.demo.kalshi.co/trade-api/v2.

The full API, with the spec's descriptions as doc comments, is in the Go reference and in go doc github.com/psyb0t/go-kalshi (add /ws, /perpsws or /auth for the subpackages).

WebSocket

kalshiws sends the subscribe, unsubscribe, list and update commands, and decodes the orderbook, ticker, trade, fill, position, lifecycle, RFQ, order and index pushes plus the command responses. Every message is checked against Kalshi's schema both ways. kalshiperpsws does the same for the perps channels.

package main

import (
	"context"
	"log/slog"
	"net/http"
	"os"

	"github.com/psyb0t/gen-asyncapi/asyncapirt/gorillaws"
	"github.com/psyb0t/go-kalshi/auth"
	"github.com/psyb0t/go-kalshi/ws"
)

type handler struct {
	kalshiws.UnimplementedHandler
}

func (handler) HandleTicker(
	ctx context.Context,
	ticker kalshiws.TickerPayload,
) error {
	slog.InfoContext(ctx, "ticker",
		"market", ticker.Msg.MarketTicker,
		"price", ticker.Msg.PriceDollars,
	)

	return nil
}

func main() {
	ctx := context.Background()
	pemKey := []byte(os.Getenv("KALSHI_PRIVATE_KEY"))

	key, err := kalshiauth.ParsePrivateKeyPEM(pemKey)
	if err != nil {
		panic(err)
	}

	signer, err := kalshiauth.NewSigner(os.Getenv("KALSHI_API_KEY_ID"), key)
	if err != nil {
		panic(err)
	}

	header, err := signer.Headers(http.MethodGet, kalshiauth.WebSocketPath)
	if err != nil {
		panic(err)
	}

	options := make([]gorillaws.Option, 0, len(header))
	for name := range header {
		options = append(options, gorillaws.WithHeader(name, header.Get(name)))
	}

	conn, err := gorillaws.Dial(ctx, kalshiws.ServerProductionURL, options...)
	if err != nil {
		panic(err)
	}

	client := kalshiws.NewClient(conn)

	defer func() {
		if err := client.Close(); err != nil {
			slog.WarnContext(ctx, "close", "error", err)
		}
	}()

	err = client.SendSubscribe(ctx, kalshiws.SubscribeCommandPayload{
		ID: 1,
		Params: kalshiws.SubscribeCommandPayloadParams{
			Channels: []kalshiws.SubscribeCommandPayloadParamsChannelsItem{
				kalshiws.SubscribeCommandPayloadParamsChannelsItemTicker,
			},
			MarketTickers: []kalshiws.MarketTicker{"HIGHNY-22DEC23-B53.5"},
		},
	})
	if err != nil {
		panic(err)
	}

	if err := client.Run(ctx, handler{}); err != nil {
		panic(err)
	}
}

Pushes are told apart by their type field. A frame with a type the spec doesn't list fails with asyncapirt.ErrUnknownMessage and goes to HandleUnknownMessage. Kalshi's heartbeat is a WebSocket ping control frame, which gorilla/websocket answers on its own, so the ping and pong messages in the spec never reach the handler.

Regenerating

Kalshi's specs are not committed. make generate downloads the current OpenAPI and AsyncAPI documents into the gitignored api/ directory and regenerates all three packages:

make generate

Each package's gen.go declares its own steps, so make generate is just go generate ./...:

• The root gen.go downloads openapi.yaml and runs oapi-codegen with config.yaml and overlay.yaml. The overlay turns one optional time.Time field from omitempty into omitzero.
• ws/gen.go and perpsws/gen.go download asyncapi.yaml and perps_asyncapi.yaml, run scripts/match-client-spec.sh, and run gen-asyncapi. Kalshi's AsyncAPI documents describe the server, so the match step swaps every operation's send and receive to get the client side. It also drops the market ticker pattern ^[A-Z0-9-]+$, which rejects real tickers such as FED-23DEC-T3.00.

.github/workflows/regen.yml does the same every day in CI. When the new spec changes the client, it runs make lint, make test and make sec. If a check fails, Claude edits the code and the checks run again, up to three times, and a review step reads the result. A passing change is committed with a CHANGELOG entry and tagged as the next release: a patch version for fixes and additions, a minor version for breaking changes.

Agent integrations

The skill teaches a coding agent how to use go-kalshi when it writes Go. It works in any agent that reads .agents/skills/, and installs natively in the clients below.

Claude Code

claude plugin marketplace add psyb0t/agents
claude plugin install go-kalshi@psyb0t

Codex

codex plugin marketplace add psyb0t/agents
codex plugin add go-kalshi@psyb0t

Codex also picks the skill up with no install in any checkout of this repo.

OpenClaw

The skill is published to ClawHub on every release:

openclaw skills install @psyb0t/go-kalshi

Development

Every command runs in the Dockerfile.dev image. The host needs only Docker and Make.

make help      # list targets
make dep       # go mod tidy + vendor
make lint      # shellcheck, shfmt, go fix, golangci-lint
make test      # go test -race
make sec       # gitleaks, govulncheck, semgrep
make generate  # download the specs and regenerate

License

MIT. The generated code comes from Kalshi's published API specifications. Kalshi labels its AsyncAPI documents proprietary, so the specifications themselves are not redistributed here.

Documentation

Overview

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

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

Package kalshi is a Go client for the Kalshi Trade REST API, generated with oapi-codegen from the OpenAPI document Kalshi publishes.

Index

• func NewAcceptBlockTradeProposalRequest(server string, blockTradeProposalId string, ...) (*http.Request, error)
• func NewAcceptBlockTradeProposalRequestWithBody(server string, blockTradeProposalId string, contentType string, body io.Reader) (*http.Request, error)
• func NewAcceptQuoteRequest(server string, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody) (*http.Request, error)
• func NewAcceptQuoteRequestWithBody(server string, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)
• func NewAcceptRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Request, error)
• func NewAcceptRFQQuoteRequestWithBody(server string, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*http.Request, error)
• func NewAmendOrderV2Request(server string, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*http.Request, error)
• func NewAmendOrderV2RequestWithBody(server string, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*http.Request, error)
• func NewApplySubaccountTransferRequest(server string, body ApplySubaccountTransferJSONRequestBody) (*http.Request, error)
• func NewApplySubaccountTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewBatchCancelOrdersV2Request(server string, body BatchCancelOrdersV2JSONRequestBody) (*http.Request, error)
• func NewBatchCancelOrdersV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewBatchCreateOrdersV2Request(server string, body BatchCreateOrdersV2JSONRequestBody) (*http.Request, error)
• func NewBatchCreateOrdersV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewBatchGetMarketCandlesticksRequest(server string, params *BatchGetMarketCandlesticksParams) (*http.Request, error)
• func NewCancelAllOrdersRequest(server string, params *CancelAllOrdersParams) (*http.Request, error)
• func NewCancelOrderV2Request(server string, orderId OrderIdPath, params *CancelOrderV2Params) (*http.Request, error)
• func NewConfirmQuoteRequest(server string, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody) (*http.Request, error)
• func NewConfirmQuoteRequestWithBody(server string, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)
• func NewConfirmRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Request, error)
• func NewConfirmRFQQuoteRequestWithBody(server string, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*http.Request, error)
• func NewCreateApiKeyRequest(server string, body CreateApiKeyJSONRequestBody) (*http.Request, error)
• func NewCreateApiKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateFCMPositionTransferRequest(server string, body CreateFCMPositionTransferJSONRequestBody) (*http.Request, error)
• func NewCreateFCMPositionTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateFCMSubtraderRequest(server string, body CreateFCMSubtraderJSONRequestBody) (*http.Request, error)
• func NewCreateFCMSubtraderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateMarketInMultivariateEventCollectionRequest(server string, collectionTicker string, ...) (*http.Request, error)
• func NewCreateMarketInMultivariateEventCollectionRequestWithBody(server string, collectionTicker string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateOrderGroupRequest(server string, body CreateOrderGroupJSONRequestBody) (*http.Request, error)
• func NewCreateOrderGroupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateOrderV2Request(server string, body CreateOrderV2JSONRequestBody) (*http.Request, error)
• func NewCreateOrderV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateQuoteRequest(server string, body CreateQuoteJSONRequestBody) (*http.Request, error)
• func NewCreateQuoteRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateRFQRequest(server string, body CreateRFQJSONRequestBody) (*http.Request, error)
• func NewCreateRFQRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewCreateSubaccountRequest(server string, body CreateSubaccountJSONRequestBody) (*http.Request, error)
• func NewCreateSubaccountRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewDecreaseOrderV2Request(server string, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*http.Request, error)
• func NewDecreaseOrderV2RequestWithBody(server string, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*http.Request, error)
• func NewDeleteApiKeyRequest(server string, apiKey string) (*http.Request, error)
• func NewDeleteFCMEventContractDailyCapRequest(server string, params *DeleteFCMEventContractDailyCapParams) (*http.Request, error)
• func NewDeleteOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams) (*http.Request, error)
• func NewDeleteQuoteRequest(server string, quoteId QuoteIdPath) (*http.Request, error)
• func NewDeleteRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath) (*http.Request, error)
• func NewDeleteRFQRequest(server string, rfqId RfqIdPath) (*http.Request, error)
• func NewGenerateApiKeyRequest(server string, body GenerateApiKeyJSONRequestBody) (*http.Request, error)
• func NewGenerateApiKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewGetAccountApiLimitsRequest(server string) (*http.Request, error)
• func NewGetAccountApiUsageLevelVolumeProgressRequest(server string) (*http.Request, error)
• func NewGetAccountEndpointCostsRequest(server string) (*http.Request, error)
• func NewGetApiKeysRequest(server string, params *GetApiKeysParams) (*http.Request, error)
• func NewGetBalanceRequest(server string, params *GetBalanceParams) (*http.Request, error)
• func NewGetBlockTradeProposalsRequest(server string, params *GetBlockTradeProposalsParams) (*http.Request, error)
• func NewGetCommunicationsIDRequest(server string) (*http.Request, error)
• func NewGetDepositsRequest(server string, params *GetDepositsParams) (*http.Request, error)
• func NewGetEventFeeChangesRequest(server string, params *GetEventFeeChangesParams) (*http.Request, error)
• func NewGetEventForecastPercentilesHistoryRequest(server string, seriesTicker string, ticker string, ...) (*http.Request, error)
• func NewGetEventLiveDataRequest(server string, eventTicker string, params *GetEventLiveDataParams) (*http.Request, error)
• func NewGetEventMetadataRequest(server string, eventTicker string) (*http.Request, error)
• func NewGetEventRequest(server string, eventTicker string, params *GetEventParams) (*http.Request, error)
• func NewGetEventsRequest(server string, params *GetEventsParams) (*http.Request, error)
• func NewGetExchangeScheduleRequest(server string) (*http.Request, error)
• func NewGetExchangeStatusRequest(server string) (*http.Request, error)
• func NewGetFCMEventContractDailyCapRequest(server string, params *GetFCMEventContractDailyCapParams) (*http.Request, error)
• func NewGetFCMFillsRequest(server string, params *GetFCMFillsParams) (*http.Request, error)
• func NewGetFCMOrdersRequest(server string, params *GetFCMOrdersParams) (*http.Request, error)
• func NewGetFCMPositionsRequest(server string, params *GetFCMPositionsParams) (*http.Request, error)
• func NewGetFCMSubtraderBlockedCategoriesRequest(server string, params *GetFCMSubtraderBlockedCategoriesParams) (*http.Request, error)
• func NewGetFillsHistoricalRequest(server string, params *GetFillsHistoricalParams) (*http.Request, error)
• func NewGetFillsRequest(server string, params *GetFillsParams) (*http.Request, error)
• func NewGetFiltersForSportsRequest(server string) (*http.Request, error)
• func NewGetGameStatsRequest(server string, milestoneId string) (*http.Request, error)
• func NewGetHistoricalCutoffRequest(server string) (*http.Request, error)
• func NewGetHistoricalMarketRequest(server string, ticker TickerPath) (*http.Request, error)
• func NewGetHistoricalMarketsRequest(server string, params *GetHistoricalMarketsParams) (*http.Request, error)
• func NewGetHistoricalOrdersRequest(server string, params *GetHistoricalOrdersParams) (*http.Request, error)
• func NewGetHistoricalPositionsRequest(server string, params *GetHistoricalPositionsParams) (*http.Request, error)
• func NewGetIncentiveProgramsRequest(server string, params *GetIncentiveProgramsParams) (*http.Request, error)
• func NewGetIntraExchangeInstanceTransferRequest(server string, transferId string) (*http.Request, error)
• func NewGetIntraExchangeInstanceTransfersRequest(server string, params *GetIntraExchangeInstanceTransfersParams) (*http.Request, error)
• func NewGetLiveDataByMilestoneRequest(server string, milestoneId string, params *GetLiveDataByMilestoneParams) (*http.Request, error)
• func NewGetLiveDataRequest(server string, pType string, milestoneId string, params *GetLiveDataParams) (*http.Request, error)
• func NewGetLiveDatasRequest(server string, params *GetLiveDatasParams) (*http.Request, error)
• func NewGetMarketCandlesticksByEventRequest(server string, seriesTicker string, ticker string, ...) (*http.Request, error)
• func NewGetMarketCandlesticksHistoricalRequest(server string, ticker string, params *GetMarketCandlesticksHistoricalParams) (*http.Request, error)
• func NewGetMarketCandlesticksRequest(server string, seriesTicker string, ticker string, ...) (*http.Request, error)
• func NewGetMarketOrderbookRequest(server string, ticker TickerPath, params *GetMarketOrderbookParams) (*http.Request, error)
• func NewGetMarketOrderbooksRequest(server string, params *GetMarketOrderbooksParams) (*http.Request, error)
• func NewGetMarketRequest(server string, ticker TickerPath) (*http.Request, error)
• func NewGetMarketsRequest(server string, params *GetMarketsParams) (*http.Request, error)
• func NewGetMilestoneRequest(server string, milestoneId string) (*http.Request, error)
• func NewGetMilestonesRequest(server string, params *GetMilestonesParams) (*http.Request, error)
• func NewGetMultivariateEventCollectionRequest(server string, collectionTicker string) (*http.Request, error)
• func NewGetMultivariateEventCollectionsRequest(server string, params *GetMultivariateEventCollectionsParams) (*http.Request, error)
• func NewGetMultivariateEventsRequest(server string, params *GetMultivariateEventsParams) (*http.Request, error)
• func NewGetOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams) (*http.Request, error)
• func NewGetOrderGroupsRequest(server string, params *GetOrderGroupsParams) (*http.Request, error)
• func NewGetOrderQueuePositionRequest(server string, orderId OrderIdPath) (*http.Request, error)
• func NewGetOrderQueuePositionsRequest(server string, params *GetOrderQueuePositionsParams) (*http.Request, error)
• func NewGetOrderRequest(server string, orderId OrderIdPath) (*http.Request, error)
• func NewGetOrdersRequest(server string, params *GetOrdersParams) (*http.Request, error)
• func NewGetPortfolioRestingOrderTotalValueRequest(server string) (*http.Request, error)
• func NewGetPositionsRequest(server string, params *GetPositionsParams) (*http.Request, error)
• func NewGetQuoteRequest(server string, quoteId QuoteIdPath) (*http.Request, error)
• func NewGetQuotesRequest(server string, params *GetQuotesParams) (*http.Request, error)
• func NewGetRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath) (*http.Request, error)
• func NewGetRFQRequest(server string, rfqId RfqIdPath) (*http.Request, error)
• func NewGetRFQsRequest(server string, params *GetRFQsParams) (*http.Request, error)
• func NewGetSeriesFeeChangesRequest(server string, params *GetSeriesFeeChangesParams) (*http.Request, error)
• func NewGetSeriesListRequest(server string, params *GetSeriesListParams) (*http.Request, error)
• func NewGetSeriesRequest(server string, seriesTicker string, params *GetSeriesParams) (*http.Request, error)
• func NewGetSettlementsRequest(server string, params *GetSettlementsParams) (*http.Request, error)
• func NewGetStructuredTargetRequest(server string, structuredTargetId string) (*http.Request, error)
• func NewGetStructuredTargetsRequest(server string, params *GetStructuredTargetsParams) (*http.Request, error)
• func NewGetSubaccountBalancesRequest(server string) (*http.Request, error)
• func NewGetSubaccountNettingRequest(server string) (*http.Request, error)
• func NewGetSubaccountTransfersRequest(server string, params *GetSubaccountTransfersParams) (*http.Request, error)
• func NewGetTagsForSeriesCategoriesRequest(server string) (*http.Request, error)
• func NewGetTargetBalanceAllocationRequest(server string) (*http.Request, error)
• func NewGetTradesHistoricalRequest(server string, params *GetTradesHistoricalParams) (*http.Request, error)
• func NewGetTradesRequest(server string, params *GetTradesParams) (*http.Request, error)
• func NewGetUserDataTimestampRequest(server string) (*http.Request, error)
• func NewGetWeatherIndexCalibrationsRequest(server string, city string) (*http.Request, error)
• func NewGetWeatherIndexRequest(server string, city string, params *GetWeatherIndexParams) (*http.Request, error)
• func NewGetWithdrawalsRequest(server string, params *GetWithdrawalsParams) (*http.Request, error)
• func NewIntraExchangeInstanceTransferRequest(server string, body IntraExchangeInstanceTransferJSONRequestBody) (*http.Request, error)
• func NewIntraExchangeInstanceTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewListFCMSubtradersRequest(server string) (*http.Request, error)
• func NewProposeBlockTradeRequest(server string, body ProposeBlockTradeJSONRequestBody) (*http.Request, error)
• func NewProposeBlockTradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewResetOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, ...) (*http.Request, error)
• func NewResetOrderGroupRequestWithBody(server string, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, ...) (*http.Request, error)
• func NewSetTargetBalanceAllocationRequest(server string, body SetTargetBalanceAllocationJSONRequestBody) (*http.Request, error)
• func NewSetTargetBalanceAllocationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewTriggerOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, ...) (*http.Request, error)
• func NewTriggerOrderGroupRequestWithBody(server string, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, ...) (*http.Request, error)
• func NewUpdateFCMEventContractDailyCapRequest(server string, body UpdateFCMEventContractDailyCapJSONRequestBody) (*http.Request, error)
• func NewUpdateFCMEventContractDailyCapRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewUpdateFCMSubtraderBlockedCategoriesRequest(server string, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody) (*http.Request, error)
• func NewUpdateFCMSubtraderBlockedCategoriesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewUpdateOrderGroupLimitRequest(server string, orderGroupId OrderGroupIdPath, ...) (*http.Request, error)
• func NewUpdateOrderGroupLimitRequestWithBody(server string, orderGroupId OrderGroupIdPath, ...) (*http.Request, error)
• func NewUpdateSubaccountNettingRequest(server string, body UpdateSubaccountNettingJSONRequestBody) (*http.Request, error)
• func NewUpdateSubaccountNettingRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
• func NewUpgradeAccountApiUsageLevelRequest(server string) (*http.Request, error)
• type AcceptBlockTradeProposalJSONRequestBody
• type AcceptBlockTradeProposalRequest
• type AcceptBlockTradeProposalResponse
  • func ParseAcceptBlockTradeProposalResponse(rsp *http.Response) (*AcceptBlockTradeProposalResponse, error)
  • func (r AcceptBlockTradeProposalResponse) ContentType() string
  • func (r AcceptBlockTradeProposalResponse) GetBody() []byte
  • func (r AcceptBlockTradeProposalResponse) GetJSON400() *BadRequestError
  • func (r AcceptBlockTradeProposalResponse) GetJSON401() *UnauthorizedError
  • func (r AcceptBlockTradeProposalResponse) GetJSON404() *NotFoundError
  • func (r AcceptBlockTradeProposalResponse) GetJSON500() *InternalServerError
  • func (r AcceptBlockTradeProposalResponse) Status() string
  • func (r AcceptBlockTradeProposalResponse) StatusCode() int
• type AcceptQuoteJSONRequestBody
• type AcceptQuoteRequest
• type AcceptQuoteRequestAcceptedSide
  • func (e AcceptQuoteRequestAcceptedSide) Valid() bool
• type AcceptQuoteResponse
  • func ParseAcceptQuoteResponse(rsp *http.Response) (*AcceptQuoteResponse, error)
  • func (r AcceptQuoteResponse) ContentType() string
  • func (r AcceptQuoteResponse) GetBody() []byte
  • func (r AcceptQuoteResponse) GetJSON400() *BadRequestError
  • func (r AcceptQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r AcceptQuoteResponse) GetJSON404() *NotFoundError
  • func (r AcceptQuoteResponse) GetJSON500() *InternalServerError
  • func (r AcceptQuoteResponse) Status() string
  • func (r AcceptQuoteResponse) StatusCode() int
• type AcceptRFQQuoteJSONRequestBody
• type AcceptRFQQuoteResponse
  • func ParseAcceptRFQQuoteResponse(rsp *http.Response) (*AcceptRFQQuoteResponse, error)
  • func (r AcceptRFQQuoteResponse) ContentType() string
  • func (r AcceptRFQQuoteResponse) GetBody() []byte
  • func (r AcceptRFQQuoteResponse) GetJSON400() *BadRequestError
  • func (r AcceptRFQQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r AcceptRFQQuoteResponse) GetJSON404() *NotFoundError
  • func (r AcceptRFQQuoteResponse) GetJSON500() *InternalServerError
  • func (r AcceptRFQQuoteResponse) Status() string
  • func (r AcceptRFQQuoteResponse) StatusCode() int
• type AccountApiUsageLevelVolumeGoal
• type AccountApiUsageLevelVolumeProgress
• type AmendOrderV2JSONRequestBody
• type AmendOrderV2Params
• type AmendOrderV2Request
• type AmendOrderV2Response
• type AmendOrderV2Response2
  • func ParseAmendOrderV2Response2(rsp *http.Response) (*AmendOrderV2Response2, error)
  • func (r AmendOrderV2Response2) ContentType() string
  • func (r AmendOrderV2Response2) GetBody() []byte
  • func (r AmendOrderV2Response2) GetJSON200() *AmendOrderV2Response
  • func (r AmendOrderV2Response2) GetJSON400() *BadRequestError
  • func (r AmendOrderV2Response2) GetJSON401() *UnauthorizedError
  • func (r AmendOrderV2Response2) GetJSON403() *ForbiddenError
  • func (r AmendOrderV2Response2) GetJSON404() *NotFoundError
  • func (r AmendOrderV2Response2) GetJSON500() *InternalServerError
  • func (r AmendOrderV2Response2) GetJSON503() *ServiceUnavailableError
  • func (r AmendOrderV2Response2) Status() string
  • func (r AmendOrderV2Response2) StatusCode() int
• type ApiKey
• type ApiKeyScope
  • func (e ApiKeyScope) Valid() bool
• type ApiKeyType
  • func (e ApiKeyType) Valid() bool
• type ApiUsageLevelGrant
• type ApplySubaccountTransferJSONRequestBody
• type ApplySubaccountTransferRequest
• type ApplySubaccountTransferResponse
• type ApplySubaccountTransferResponse2
  • func ParseApplySubaccountTransferResponse2(rsp *http.Response) (*ApplySubaccountTransferResponse2, error)
  • func (r ApplySubaccountTransferResponse2) ContentType() string
  • func (r ApplySubaccountTransferResponse2) GetBody() []byte
  • func (r ApplySubaccountTransferResponse2) GetJSON200() *ApplySubaccountTransferResponse
  • func (r ApplySubaccountTransferResponse2) GetJSON400() *BadRequestError
  • func (r ApplySubaccountTransferResponse2) GetJSON401() *UnauthorizedError
  • func (r ApplySubaccountTransferResponse2) GetJSON500() *InternalServerError
  • func (r ApplySubaccountTransferResponse2) Status() string
  • func (r ApplySubaccountTransferResponse2) StatusCode() int
• type AssociatedEvent
• type BadRequestError
• type BatchCancelOrdersV2JSONRequestBody
• type BatchCancelOrdersV2Request
• type BatchCancelOrdersV2Response
• type BatchCancelOrdersV2Response2
  • func ParseBatchCancelOrdersV2Response2(rsp *http.Response) (*BatchCancelOrdersV2Response2, error)
  • func (r BatchCancelOrdersV2Response2) ContentType() string
  • func (r BatchCancelOrdersV2Response2) GetBody() []byte
  • func (r BatchCancelOrdersV2Response2) GetJSON200() *BatchCancelOrdersV2Response
  • func (r BatchCancelOrdersV2Response2) GetJSON400() *BadRequestError
  • func (r BatchCancelOrdersV2Response2) GetJSON401() *UnauthorizedError
  • func (r BatchCancelOrdersV2Response2) GetJSON403() *ForbiddenError
  • func (r BatchCancelOrdersV2Response2) GetJSON500() *InternalServerError
  • func (r BatchCancelOrdersV2Response2) Status() string
  • func (r BatchCancelOrdersV2Response2) StatusCode() int
• type BatchCreateOrdersV2JSONRequestBody
• type BatchCreateOrdersV2Request
• type BatchCreateOrdersV2Response
• type BatchCreateOrdersV2Response2
  • func ParseBatchCreateOrdersV2Response2(rsp *http.Response) (*BatchCreateOrdersV2Response2, error)
  • func (r BatchCreateOrdersV2Response2) ContentType() string
  • func (r BatchCreateOrdersV2Response2) GetBody() []byte
  • func (r BatchCreateOrdersV2Response2) GetJSON201() *BatchCreateOrdersV2Response
  • func (r BatchCreateOrdersV2Response2) GetJSON400() *BadRequestError
  • func (r BatchCreateOrdersV2Response2) GetJSON401() *UnauthorizedError
  • func (r BatchCreateOrdersV2Response2) GetJSON403() *ForbiddenError
  • func (r BatchCreateOrdersV2Response2) GetJSON500() *InternalServerError
  • func (r BatchCreateOrdersV2Response2) Status() string
  • func (r BatchCreateOrdersV2Response2) StatusCode() int
• type BatchGetMarketCandlesticksParams
• type BatchGetMarketCandlesticksResponse
• type BatchGetMarketCandlesticksResponse2
  • func ParseBatchGetMarketCandlesticksResponse2(rsp *http.Response) (*BatchGetMarketCandlesticksResponse2, error)
  • func (r BatchGetMarketCandlesticksResponse2) ContentType() string
  • func (r BatchGetMarketCandlesticksResponse2) GetBody() []byte
  • func (r BatchGetMarketCandlesticksResponse2) GetJSON200() *BatchGetMarketCandlesticksResponse
  • func (r BatchGetMarketCandlesticksResponse2) Status() string
  • func (r BatchGetMarketCandlesticksResponse2) StatusCode() int
• type BidAskDistribution
• type BidAskDistributionHistorical
• type BlockTradeProposal
• type BlockTradeProposalMakerSide
  • func (e BlockTradeProposalMakerSide) Valid() bool
• type BookSide
  • func (e BookSide) Valid() bool
• type BucketLimit
• type CancelAllOrdersParams
• type CancelAllOrdersResponse
  • func ParseCancelAllOrdersResponse(rsp *http.Response) (*CancelAllOrdersResponse, error)
  • func (r CancelAllOrdersResponse) ContentType() string
  • func (r CancelAllOrdersResponse) GetBody() []byte
  • func (r CancelAllOrdersResponse) GetJSON401() *UnauthorizedError
  • func (r CancelAllOrdersResponse) GetJSON429() *RateLimitError
  • func (r CancelAllOrdersResponse) GetJSON500() *InternalServerError
  • func (r CancelAllOrdersResponse) Status() string
  • func (r CancelAllOrdersResponse) StatusCode() int
• type CancelOrderV2Params
• type CancelOrderV2Response
• type CancelOrderV2Response2
  • func ParseCancelOrderV2Response2(rsp *http.Response) (*CancelOrderV2Response2, error)
  • func (r CancelOrderV2Response2) ContentType() string
  • func (r CancelOrderV2Response2) GetBody() []byte
  • func (r CancelOrderV2Response2) GetJSON200() *CancelOrderV2Response
  • func (r CancelOrderV2Response2) GetJSON401() *UnauthorizedError
  • func (r CancelOrderV2Response2) GetJSON404() *NotFoundError
  • func (r CancelOrderV2Response2) GetJSON500() *InternalServerError
  • func (r CancelOrderV2Response2) Status() string
  • func (r CancelOrderV2Response2) StatusCode() int
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) AcceptBlockTradeProposal(ctx context.Context, blockTradeProposalId string, ...) (*http.Response, error)
  • func (c *Client) AcceptBlockTradeProposalWithBody(ctx context.Context, blockTradeProposalId string, contentType string, ...) (*http.Response, error)
  • func (c *Client) AcceptQuote(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) AcceptQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) AcceptRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Response, error)
  • func (c *Client) AcceptRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*http.Response, error)
  • func (c *Client) AmendOrderV2(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*http.Response, error)
  • func (c *Client) AmendOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*http.Response, error)
  • func (c *Client) ApplySubaccountTransfer(ctx context.Context, body ApplySubaccountTransferJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) ApplySubaccountTransferWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) BatchCancelOrdersV2(ctx context.Context, body BatchCancelOrdersV2JSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) BatchCancelOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) BatchCreateOrdersV2(ctx context.Context, body BatchCreateOrdersV2JSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) BatchCreateOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) BatchGetMarketCandlesticks(ctx context.Context, params *BatchGetMarketCandlesticksParams, ...) (*http.Response, error)
  • func (c *Client) CancelAllOrders(ctx context.Context, params *CancelAllOrdersParams, ...) (*http.Response, error)
  • func (c *Client) CancelOrderV2(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, ...) (*http.Response, error)
  • func (c *Client) ConfirmQuote(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) ConfirmQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) ConfirmRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Response, error)
  • func (c *Client) ConfirmRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*http.Response, error)
  • func (c *Client) CreateApiKey(ctx context.Context, body CreateApiKeyJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateFCMPositionTransfer(ctx context.Context, body CreateFCMPositionTransferJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateFCMPositionTransferWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateFCMSubtrader(ctx context.Context, body CreateFCMSubtraderJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateFCMSubtraderWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateMarketInMultivariateEventCollection(ctx context.Context, collectionTicker string, ...) (*http.Response, error)
  • func (c *Client) CreateMarketInMultivariateEventCollectionWithBody(ctx context.Context, collectionTicker string, contentType string, ...) (*http.Response, error)
  • func (c *Client) CreateOrderGroup(ctx context.Context, body CreateOrderGroupJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateOrderGroupWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateOrderV2(ctx context.Context, body CreateOrderV2JSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateOrderV2WithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateQuote(ctx context.Context, body CreateQuoteJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateQuoteWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateRFQ(ctx context.Context, body CreateRFQJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateRFQWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) CreateSubaccount(ctx context.Context, body CreateSubaccountJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) CreateSubaccountWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) DecreaseOrderV2(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*http.Response, error)
  • func (c *Client) DecreaseOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*http.Response, error)
  • func (c *Client) DeleteApiKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) DeleteFCMEventContractDailyCap(ctx context.Context, params *DeleteFCMEventContractDailyCapParams, ...) (*http.Response, error)
  • func (c *Client) DeleteOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) DeleteQuote(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) DeleteRFQ(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) DeleteRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Response, error)
  • func (c *Client) GenerateApiKey(ctx context.Context, body GenerateApiKeyJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) GenerateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) GetAccountApiLimits(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetAccountApiUsageLevelVolumeProgress(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetAccountEndpointCosts(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetApiKeys(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetBalance(ctx context.Context, params *GetBalanceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetBlockTradeProposals(ctx context.Context, params *GetBlockTradeProposalsParams, ...) (*http.Response, error)
  • func (c *Client) GetCommunicationsID(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetDeposits(ctx context.Context, params *GetDepositsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetEvent(ctx context.Context, eventTicker string, params *GetEventParams, ...) (*http.Response, error)
  • func (c *Client) GetEventFeeChanges(ctx context.Context, params *GetEventFeeChangesParams, ...) (*http.Response, error)
  • func (c *Client) GetEventForecastPercentilesHistory(ctx context.Context, seriesTicker string, ticker string, ...) (*http.Response, error)
  • func (c *Client) GetEventLiveData(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, ...) (*http.Response, error)
  • func (c *Client) GetEventMetadata(ctx context.Context, eventTicker string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetEvents(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetExchangeSchedule(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetExchangeStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetFCMEventContractDailyCap(ctx context.Context, params *GetFCMEventContractDailyCapParams, ...) (*http.Response, error)
  • func (c *Client) GetFCMFills(ctx context.Context, params *GetFCMFillsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetFCMOrders(ctx context.Context, params *GetFCMOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetFCMPositions(ctx context.Context, params *GetFCMPositionsParams, ...) (*http.Response, error)
  • func (c *Client) GetFCMSubtraderBlockedCategories(ctx context.Context, params *GetFCMSubtraderBlockedCategoriesParams, ...) (*http.Response, error)
  • func (c *Client) GetFills(ctx context.Context, params *GetFillsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetFillsHistorical(ctx context.Context, params *GetFillsHistoricalParams, ...) (*http.Response, error)
  • func (c *Client) GetFiltersForSports(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetGameStats(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetHistoricalCutoff(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetHistoricalMarket(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetHistoricalMarkets(ctx context.Context, params *GetHistoricalMarketsParams, ...) (*http.Response, error)
  • func (c *Client) GetHistoricalOrders(ctx context.Context, params *GetHistoricalOrdersParams, ...) (*http.Response, error)
  • func (c *Client) GetHistoricalPositions(ctx context.Context, params *GetHistoricalPositionsParams, ...) (*http.Response, error)
  • func (c *Client) GetIncentivePrograms(ctx context.Context, params *GetIncentiveProgramsParams, ...) (*http.Response, error)
  • func (c *Client) GetIntraExchangeInstanceTransfer(ctx context.Context, transferId string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetIntraExchangeInstanceTransfers(ctx context.Context, params *GetIntraExchangeInstanceTransfersParams, ...) (*http.Response, error)
  • func (c *Client) GetLiveData(ctx context.Context, pType string, milestoneId string, ...) (*http.Response, error)
  • func (c *Client) GetLiveDataByMilestone(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, ...) (*http.Response, error)
  • func (c *Client) GetLiveDatas(ctx context.Context, params *GetLiveDatasParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetMarket(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetMarketCandlesticks(ctx context.Context, seriesTicker string, ticker string, ...) (*http.Response, error)
  • func (c *Client) GetMarketCandlesticksByEvent(ctx context.Context, seriesTicker string, ticker string, ...) (*http.Response, error)
  • func (c *Client) GetMarketCandlesticksHistorical(ctx context.Context, ticker string, ...) (*http.Response, error)
  • func (c *Client) GetMarketOrderbook(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, ...) (*http.Response, error)
  • func (c *Client) GetMarketOrderbooks(ctx context.Context, params *GetMarketOrderbooksParams, ...) (*http.Response, error)
  • func (c *Client) GetMarkets(ctx context.Context, params *GetMarketsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetMilestone(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetMilestones(ctx context.Context, params *GetMilestonesParams, ...) (*http.Response, error)
  • func (c *Client) GetMultivariateEventCollection(ctx context.Context, collectionTicker string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetMultivariateEventCollections(ctx context.Context, params *GetMultivariateEventCollectionsParams, ...) (*http.Response, error)
  • func (c *Client) GetMultivariateEvents(ctx context.Context, params *GetMultivariateEventsParams, ...) (*http.Response, error)
  • func (c *Client) GetOrder(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) GetOrderGroups(ctx context.Context, params *GetOrderGroupsParams, ...) (*http.Response, error)
  • func (c *Client) GetOrderQueuePosition(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetOrderQueuePositions(ctx context.Context, params *GetOrderQueuePositionsParams, ...) (*http.Response, error)
  • func (c *Client) GetOrders(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetPortfolioRestingOrderTotalValue(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetPositions(ctx context.Context, params *GetPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetQuote(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetQuotes(ctx context.Context, params *GetQuotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetRFQ(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*http.Response, error)
  • func (c *Client) GetRFQs(ctx context.Context, params *GetRFQsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetSeries(ctx context.Context, seriesTicker string, params *GetSeriesParams, ...) (*http.Response, error)
  • func (c *Client) GetSeriesFeeChanges(ctx context.Context, params *GetSeriesFeeChangesParams, ...) (*http.Response, error)
  • func (c *Client) GetSeriesList(ctx context.Context, params *GetSeriesListParams, ...) (*http.Response, error)
  • func (c *Client) GetSettlements(ctx context.Context, params *GetSettlementsParams, ...) (*http.Response, error)
  • func (c *Client) GetStructuredTarget(ctx context.Context, structuredTargetId string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetStructuredTargets(ctx context.Context, params *GetStructuredTargetsParams, ...) (*http.Response, error)
  • func (c *Client) GetSubaccountBalances(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetSubaccountNetting(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetSubaccountTransfers(ctx context.Context, params *GetSubaccountTransfersParams, ...) (*http.Response, error)
  • func (c *Client) GetTagsForSeriesCategories(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetTargetBalanceAllocation(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetTrades(ctx context.Context, params *GetTradesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetTradesHistorical(ctx context.Context, params *GetTradesHistoricalParams, ...) (*http.Response, error)
  • func (c *Client) GetUserDataTimestamp(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetWeatherIndex(ctx context.Context, city string, params *GetWeatherIndexParams, ...) (*http.Response, error)
  • func (c *Client) GetWeatherIndexCalibrations(ctx context.Context, city string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) GetWithdrawals(ctx context.Context, params *GetWithdrawalsParams, ...) (*http.Response, error)
  • func (c *Client) IntraExchangeInstanceTransfer(ctx context.Context, body IntraExchangeInstanceTransferJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) IntraExchangeInstanceTransferWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) ListFCMSubtraders(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) ProposeBlockTrade(ctx context.Context, body ProposeBlockTradeJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) ProposeBlockTradeWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) ResetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) ResetOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) SetTargetBalanceAllocation(ctx context.Context, body SetTargetBalanceAllocationJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) SetTargetBalanceAllocationWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) TriggerOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) TriggerOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) UpdateFCMEventContractDailyCap(ctx context.Context, body UpdateFCMEventContractDailyCapJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) UpdateFCMEventContractDailyCapWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) UpdateFCMSubtraderBlockedCategories(ctx context.Context, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) UpdateFCMSubtraderBlockedCategoriesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) UpdateOrderGroupLimit(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) UpdateOrderGroupLimitWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*http.Response, error)
  • func (c *Client) UpdateSubaccountNetting(ctx context.Context, body UpdateSubaccountNettingJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) UpdateSubaccountNettingWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) UpgradeAccountApiUsageLevel(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
• type ClientInterface
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer HttpRequestDoer) ClientOption
  • func WithRequestEditorFn(fn RequestEditorFn) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func (c *ClientWithResponses) AcceptBlockTradeProposalWithBodyWithResponse(ctx context.Context, blockTradeProposalId string, contentType string, ...) (*AcceptBlockTradeProposalResponse, error)
  • func (c *ClientWithResponses) AcceptBlockTradeProposalWithResponse(ctx context.Context, blockTradeProposalId string, ...) (*AcceptBlockTradeProposalResponse, error)
  • func (c *ClientWithResponses) AcceptQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, ...) (*AcceptQuoteResponse, error)
  • func (c *ClientWithResponses) AcceptQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, ...) (*AcceptQuoteResponse, error)
  • func (c *ClientWithResponses) AcceptRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*AcceptRFQQuoteResponse, error)
  • func (c *ClientWithResponses) AcceptRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*AcceptRFQQuoteResponse, error)
  • func (c *ClientWithResponses) AmendOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*AmendOrderV2Response2, error)
  • func (c *ClientWithResponses) AmendOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, ...) (*AmendOrderV2Response2, error)
  • func (c *ClientWithResponses) ApplySubaccountTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ApplySubaccountTransferResponse2, error)
  • func (c *ClientWithResponses) ApplySubaccountTransferWithResponse(ctx context.Context, body ApplySubaccountTransferJSONRequestBody, ...) (*ApplySubaccountTransferResponse2, error)
  • func (c *ClientWithResponses) BatchCancelOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*BatchCancelOrdersV2Response2, error)
  • func (c *ClientWithResponses) BatchCancelOrdersV2WithResponse(ctx context.Context, body BatchCancelOrdersV2JSONRequestBody, ...) (*BatchCancelOrdersV2Response2, error)
  • func (c *ClientWithResponses) BatchCreateOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*BatchCreateOrdersV2Response2, error)
  • func (c *ClientWithResponses) BatchCreateOrdersV2WithResponse(ctx context.Context, body BatchCreateOrdersV2JSONRequestBody, ...) (*BatchCreateOrdersV2Response2, error)
  • func (c *ClientWithResponses) BatchGetMarketCandlesticksWithResponse(ctx context.Context, params *BatchGetMarketCandlesticksParams, ...) (*BatchGetMarketCandlesticksResponse2, error)
  • func (c *ClientWithResponses) CancelAllOrdersWithResponse(ctx context.Context, params *CancelAllOrdersParams, ...) (*CancelAllOrdersResponse, error)
  • func (c *ClientWithResponses) CancelOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, ...) (*CancelOrderV2Response2, error)
  • func (c *ClientWithResponses) ConfirmQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, ...) (*ConfirmQuoteResponse, error)
  • func (c *ClientWithResponses) ConfirmQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, ...) (*ConfirmQuoteResponse, error)
  • func (c *ClientWithResponses) ConfirmRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, ...) (*ConfirmRFQQuoteResponse, error)
  • func (c *ClientWithResponses) ConfirmRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*ConfirmRFQQuoteResponse, error)
  • func (c *ClientWithResponses) CreateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateApiKeyResponse2, error)
  • func (c *ClientWithResponses) CreateApiKeyWithResponse(ctx context.Context, body CreateApiKeyJSONRequestBody, ...) (*CreateApiKeyResponse2, error)
  • func (c *ClientWithResponses) CreateFCMPositionTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateFCMPositionTransferResponse2, error)
  • func (c *ClientWithResponses) CreateFCMPositionTransferWithResponse(ctx context.Context, body CreateFCMPositionTransferJSONRequestBody, ...) (*CreateFCMPositionTransferResponse2, error)
  • func (c *ClientWithResponses) CreateFCMSubtraderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateFCMSubtraderResponse2, error)
  • func (c *ClientWithResponses) CreateFCMSubtraderWithResponse(ctx context.Context, body CreateFCMSubtraderJSONRequestBody, ...) (*CreateFCMSubtraderResponse2, error)
  • func (c *ClientWithResponses) CreateMarketInMultivariateEventCollectionWithBodyWithResponse(ctx context.Context, collectionTicker string, contentType string, ...) (*CreateMarketInMultivariateEventCollectionResponse2, error)
  • func (c *ClientWithResponses) CreateMarketInMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, ...) (*CreateMarketInMultivariateEventCollectionResponse2, error)
  • func (c *ClientWithResponses) CreateOrderGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateOrderGroupResponse2, error)
  • func (c *ClientWithResponses) CreateOrderGroupWithResponse(ctx context.Context, body CreateOrderGroupJSONRequestBody, ...) (*CreateOrderGroupResponse2, error)
  • func (c *ClientWithResponses) CreateOrderV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateOrderV2Response2, error)
  • func (c *ClientWithResponses) CreateOrderV2WithResponse(ctx context.Context, body CreateOrderV2JSONRequestBody, ...) (*CreateOrderV2Response2, error)
  • func (c *ClientWithResponses) CreateQuoteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateQuoteResponse2, error)
  • func (c *ClientWithResponses) CreateQuoteWithResponse(ctx context.Context, body CreateQuoteJSONRequestBody, ...) (*CreateQuoteResponse2, error)
  • func (c *ClientWithResponses) CreateRFQWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateRFQResponse2, error)
  • func (c *ClientWithResponses) CreateRFQWithResponse(ctx context.Context, body CreateRFQJSONRequestBody, ...) (*CreateRFQResponse2, error)
  • func (c *ClientWithResponses) CreateSubaccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateSubaccountResponse2, error)
  • func (c *ClientWithResponses) CreateSubaccountWithResponse(ctx context.Context, body CreateSubaccountJSONRequestBody, ...) (*CreateSubaccountResponse2, error)
  • func (c *ClientWithResponses) DecreaseOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*DecreaseOrderV2Response2, error)
  • func (c *ClientWithResponses) DecreaseOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, ...) (*DecreaseOrderV2Response2, error)
  • func (c *ClientWithResponses) DeleteApiKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteApiKeyResponse, error)
  • func (c *ClientWithResponses) DeleteFCMEventContractDailyCapWithResponse(ctx context.Context, params *DeleteFCMEventContractDailyCapParams, ...) (*DeleteFCMEventContractDailyCapResponse, error)
  • func (c *ClientWithResponses) DeleteOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*DeleteOrderGroupResponse, error)
  • func (c *ClientWithResponses) DeleteQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*DeleteQuoteResponse, error)
  • func (c *ClientWithResponses) DeleteRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*DeleteRFQQuoteResponse, error)
  • func (c *ClientWithResponses) DeleteRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*DeleteRFQResponse, error)
  • func (c *ClientWithResponses) GenerateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*GenerateApiKeyResponse2, error)
  • func (c *ClientWithResponses) GenerateApiKeyWithResponse(ctx context.Context, body GenerateApiKeyJSONRequestBody, ...) (*GenerateApiKeyResponse2, error)
  • func (c *ClientWithResponses) GetAccountApiLimitsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiLimitsResponse2, error)
  • func (c *ClientWithResponses) GetAccountApiUsageLevelVolumeProgressWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiUsageLevelVolumeProgressResponse2, error)
  • func (c *ClientWithResponses) GetAccountEndpointCostsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountEndpointCostsResponse2, error)
  • func (c *ClientWithResponses) GetApiKeysWithResponse(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*GetApiKeysResponse2, error)
  • func (c *ClientWithResponses) GetBalanceWithResponse(ctx context.Context, params *GetBalanceParams, reqEditors ...RequestEditorFn) (*GetBalanceResponse2, error)
  • func (c *ClientWithResponses) GetBlockTradeProposalsWithResponse(ctx context.Context, params *GetBlockTradeProposalsParams, ...) (*GetBlockTradeProposalsResponse2, error)
  • func (c *ClientWithResponses) GetCommunicationsIDWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCommunicationsIDResponse2, error)
  • func (c *ClientWithResponses) GetDepositsWithResponse(ctx context.Context, params *GetDepositsParams, reqEditors ...RequestEditorFn) (*GetDepositsResponse2, error)
  • func (c *ClientWithResponses) GetEventFeeChangesWithResponse(ctx context.Context, params *GetEventFeeChangesParams, ...) (*GetEventFeeChangesResponse2, error)
  • func (c *ClientWithResponses) GetEventForecastPercentilesHistoryWithResponse(ctx context.Context, seriesTicker string, ticker string, ...) (*GetEventForecastPercentilesHistoryResponse2, error)
  • func (c *ClientWithResponses) GetEventLiveDataWithResponse(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, ...) (*GetEventLiveDataResponse2, error)
  • func (c *ClientWithResponses) GetEventMetadataWithResponse(ctx context.Context, eventTicker string, reqEditors ...RequestEditorFn) (*GetEventMetadataResponse2, error)
  • func (c *ClientWithResponses) GetEventWithResponse(ctx context.Context, eventTicker string, params *GetEventParams, ...) (*GetEventResponse2, error)
  • func (c *ClientWithResponses) GetEventsWithResponse(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsResponse2, error)
  • func (c *ClientWithResponses) GetExchangeScheduleWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeScheduleResponse2, error)
  • func (c *ClientWithResponses) GetExchangeStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeStatusResponse, error)
  • func (c *ClientWithResponses) GetFCMEventContractDailyCapWithResponse(ctx context.Context, params *GetFCMEventContractDailyCapParams, ...) (*GetFCMEventContractDailyCapResponse2, error)
  • func (c *ClientWithResponses) GetFCMFillsWithResponse(ctx context.Context, params *GetFCMFillsParams, reqEditors ...RequestEditorFn) (*GetFCMFillsResponse, error)
  • func (c *ClientWithResponses) GetFCMOrdersWithResponse(ctx context.Context, params *GetFCMOrdersParams, reqEditors ...RequestEditorFn) (*GetFCMOrdersResponse, error)
  • func (c *ClientWithResponses) GetFCMPositionsWithResponse(ctx context.Context, params *GetFCMPositionsParams, ...) (*GetFCMPositionsResponse, error)
  • func (c *ClientWithResponses) GetFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, params *GetFCMSubtraderBlockedCategoriesParams, ...) (*GetFCMSubtraderBlockedCategoriesResponse2, error)
  • func (c *ClientWithResponses) GetFillsHistoricalWithResponse(ctx context.Context, params *GetFillsHistoricalParams, ...) (*GetFillsHistoricalResponse, error)
  • func (c *ClientWithResponses) GetFillsWithResponse(ctx context.Context, params *GetFillsParams, reqEditors ...RequestEditorFn) (*GetFillsResponse2, error)
  • func (c *ClientWithResponses) GetFiltersForSportsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFiltersForSportsResponse, error)
  • func (c *ClientWithResponses) GetGameStatsWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetGameStatsResponse2, error)
  • func (c *ClientWithResponses) GetHistoricalCutoffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHistoricalCutoffResponse2, error)
  • func (c *ClientWithResponses) GetHistoricalMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetHistoricalMarketResponse, error)
  • func (c *ClientWithResponses) GetHistoricalMarketsWithResponse(ctx context.Context, params *GetHistoricalMarketsParams, ...) (*GetHistoricalMarketsResponse, error)
  • func (c *ClientWithResponses) GetHistoricalOrdersWithResponse(ctx context.Context, params *GetHistoricalOrdersParams, ...) (*GetHistoricalOrdersResponse, error)
  • func (c *ClientWithResponses) GetHistoricalPositionsWithResponse(ctx context.Context, params *GetHistoricalPositionsParams, ...) (*GetHistoricalPositionsResponse, error)
  • func (c *ClientWithResponses) GetIncentiveProgramsWithResponse(ctx context.Context, params *GetIncentiveProgramsParams, ...) (*GetIncentiveProgramsResponse2, error)
  • func (c *ClientWithResponses) GetIntraExchangeInstanceTransferWithResponse(ctx context.Context, transferId string, reqEditors ...RequestEditorFn) (*GetIntraExchangeInstanceTransferResponse2, error)
  • func (c *ClientWithResponses) GetIntraExchangeInstanceTransfersWithResponse(ctx context.Context, params *GetIntraExchangeInstanceTransfersParams, ...) (*GetIntraExchangeInstanceTransfersResponse2, error)
  • func (c *ClientWithResponses) GetLiveDataByMilestoneWithResponse(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, ...) (*GetLiveDataByMilestoneResponse, error)
  • func (c *ClientWithResponses) GetLiveDataWithResponse(ctx context.Context, pType string, milestoneId string, ...) (*GetLiveDataResponse2, error)
  • func (c *ClientWithResponses) GetLiveDatasWithResponse(ctx context.Context, params *GetLiveDatasParams, reqEditors ...RequestEditorFn) (*GetLiveDatasResponse2, error)
  • func (c *ClientWithResponses) GetMarketCandlesticksByEventWithResponse(ctx context.Context, seriesTicker string, ticker string, ...) (*GetMarketCandlesticksByEventResponse, error)
  • func (c *ClientWithResponses) GetMarketCandlesticksHistoricalWithResponse(ctx context.Context, ticker string, ...) (*GetMarketCandlesticksHistoricalResponse2, error)
  • func (c *ClientWithResponses) GetMarketCandlesticksWithResponse(ctx context.Context, seriesTicker string, ticker string, ...) (*GetMarketCandlesticksResponse2, error)
  • func (c *ClientWithResponses) GetMarketOrderbookWithResponse(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, ...) (*GetMarketOrderbookResponse2, error)
  • func (c *ClientWithResponses) GetMarketOrderbooksWithResponse(ctx context.Context, params *GetMarketOrderbooksParams, ...) (*GetMarketOrderbooksResponse2, error)
  • func (c *ClientWithResponses) GetMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetMarketResponse2, error)
  • func (c *ClientWithResponses) GetMarketsWithResponse(ctx context.Context, params *GetMarketsParams, reqEditors ...RequestEditorFn) (*GetMarketsResponse2, error)
  • func (c *ClientWithResponses) GetMilestoneWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetMilestoneResponse2, error)
  • func (c *ClientWithResponses) GetMilestonesWithResponse(ctx context.Context, params *GetMilestonesParams, ...) (*GetMilestonesResponse2, error)
  • func (c *ClientWithResponses) GetMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, reqEditors ...RequestEditorFn) (*GetMultivariateEventCollectionResponse2, error)
  • func (c *ClientWithResponses) GetMultivariateEventCollectionsWithResponse(ctx context.Context, params *GetMultivariateEventCollectionsParams, ...) (*GetMultivariateEventCollectionsResponse2, error)
  • func (c *ClientWithResponses) GetMultivariateEventsWithResponse(ctx context.Context, params *GetMultivariateEventsParams, ...) (*GetMultivariateEventsResponse2, error)
  • func (c *ClientWithResponses) GetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*GetOrderGroupResponse2, error)
  • func (c *ClientWithResponses) GetOrderGroupsWithResponse(ctx context.Context, params *GetOrderGroupsParams, ...) (*GetOrderGroupsResponse2, error)
  • func (c *ClientWithResponses) GetOrderQueuePositionWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderQueuePositionResponse2, error)
  • func (c *ClientWithResponses) GetOrderQueuePositionsWithResponse(ctx context.Context, params *GetOrderQueuePositionsParams, ...) (*GetOrderQueuePositionsResponse2, error)
  • func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderResponse2, error)
  • func (c *ClientWithResponses) GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*GetOrdersResponse2, error)
  • func (c *ClientWithResponses) GetPortfolioRestingOrderTotalValueWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPortfolioRestingOrderTotalValueResponse2, error)
  • func (c *ClientWithResponses) GetPositionsWithResponse(ctx context.Context, params *GetPositionsParams, reqEditors ...RequestEditorFn) (*GetPositionsResponse2, error)
  • func (c *ClientWithResponses) GetQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*GetQuoteResponse2, error)
  • func (c *ClientWithResponses) GetQuotesWithResponse(ctx context.Context, params *GetQuotesParams, reqEditors ...RequestEditorFn) (*GetQuotesResponse2, error)
  • func (c *ClientWithResponses) GetRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, ...) (*GetRFQQuoteResponse, error)
  • func (c *ClientWithResponses) GetRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*GetRFQResponse2, error)
  • func (c *ClientWithResponses) GetRFQsWithResponse(ctx context.Context, params *GetRFQsParams, reqEditors ...RequestEditorFn) (*GetRFQsResponse2, error)
  • func (c *ClientWithResponses) GetSeriesFeeChangesWithResponse(ctx context.Context, params *GetSeriesFeeChangesParams, ...) (*GetSeriesFeeChangesResponse2, error)
  • func (c *ClientWithResponses) GetSeriesListWithResponse(ctx context.Context, params *GetSeriesListParams, ...) (*GetSeriesListResponse2, error)
  • func (c *ClientWithResponses) GetSeriesWithResponse(ctx context.Context, seriesTicker string, params *GetSeriesParams, ...) (*GetSeriesResponse2, error)
  • func (c *ClientWithResponses) GetSettlementsWithResponse(ctx context.Context, params *GetSettlementsParams, ...) (*GetSettlementsResponse2, error)
  • func (c *ClientWithResponses) GetStructuredTargetWithResponse(ctx context.Context, structuredTargetId string, reqEditors ...RequestEditorFn) (*GetStructuredTargetResponse2, error)
  • func (c *ClientWithResponses) GetStructuredTargetsWithResponse(ctx context.Context, params *GetStructuredTargetsParams, ...) (*GetStructuredTargetsResponse2, error)
  • func (c *ClientWithResponses) GetSubaccountBalancesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountBalancesResponse2, error)
  • func (c *ClientWithResponses) GetSubaccountNettingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountNettingResponse2, error)
  • func (c *ClientWithResponses) GetSubaccountTransfersWithResponse(ctx context.Context, params *GetSubaccountTransfersParams, ...) (*GetSubaccountTransfersResponse2, error)
  • func (c *ClientWithResponses) GetTagsForSeriesCategoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTagsForSeriesCategoriesResponse2, error)
  • func (c *ClientWithResponses) GetTargetBalanceAllocationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTargetBalanceAllocationResponse2, error)
  • func (c *ClientWithResponses) GetTradesHistoricalWithResponse(ctx context.Context, params *GetTradesHistoricalParams, ...) (*GetTradesHistoricalResponse, error)
  • func (c *ClientWithResponses) GetTradesWithResponse(ctx context.Context, params *GetTradesParams, reqEditors ...RequestEditorFn) (*GetTradesResponse2, error)
  • func (c *ClientWithResponses) GetUserDataTimestampWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetUserDataTimestampResponse2, error)
  • func (c *ClientWithResponses) GetWeatherIndexCalibrationsWithResponse(ctx context.Context, city string, reqEditors ...RequestEditorFn) (*GetWeatherIndexCalibrationsResponse2, error)
  • func (c *ClientWithResponses) GetWeatherIndexWithResponse(ctx context.Context, city string, params *GetWeatherIndexParams, ...) (*GetWeatherIndexResponse2, error)
  • func (c *ClientWithResponses) GetWithdrawalsWithResponse(ctx context.Context, params *GetWithdrawalsParams, ...) (*GetWithdrawalsResponse2, error)
  • func (c *ClientWithResponses) IntraExchangeInstanceTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*IntraExchangeInstanceTransferResponse2, error)
  • func (c *ClientWithResponses) IntraExchangeInstanceTransferWithResponse(ctx context.Context, body IntraExchangeInstanceTransferJSONRequestBody, ...) (*IntraExchangeInstanceTransferResponse2, error)
  • func (c *ClientWithResponses) ListFCMSubtradersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListFCMSubtradersResponse2, error)
  • func (c *ClientWithResponses) ProposeBlockTradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ProposeBlockTradeResponse2, error)
  • func (c *ClientWithResponses) ProposeBlockTradeWithResponse(ctx context.Context, body ProposeBlockTradeJSONRequestBody, ...) (*ProposeBlockTradeResponse2, error)
  • func (c *ClientWithResponses) ResetOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*ResetOrderGroupResponse, error)
  • func (c *ClientWithResponses) ResetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*ResetOrderGroupResponse, error)
  • func (c *ClientWithResponses) SetTargetBalanceAllocationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SetTargetBalanceAllocationResponse, error)
  • func (c *ClientWithResponses) SetTargetBalanceAllocationWithResponse(ctx context.Context, body SetTargetBalanceAllocationJSONRequestBody, ...) (*SetTargetBalanceAllocationResponse, error)
  • func (c *ClientWithResponses) TriggerOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*TriggerOrderGroupResponse, error)
  • func (c *ClientWithResponses) TriggerOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*TriggerOrderGroupResponse, error)
  • func (c *ClientWithResponses) UpdateFCMEventContractDailyCapWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UpdateFCMEventContractDailyCapResponse, error)
  • func (c *ClientWithResponses) UpdateFCMEventContractDailyCapWithResponse(ctx context.Context, body UpdateFCMEventContractDailyCapJSONRequestBody, ...) (*UpdateFCMEventContractDailyCapResponse, error)
  • func (c *ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)
  • func (c *ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody, ...) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)
  • func (c *ClientWithResponses) UpdateOrderGroupLimitWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*UpdateOrderGroupLimitResponse, error)
  • func (c *ClientWithResponses) UpdateOrderGroupLimitWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, ...) (*UpdateOrderGroupLimitResponse, error)
  • func (c *ClientWithResponses) UpdateSubaccountNettingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UpdateSubaccountNettingResponse, error)
  • func (c *ClientWithResponses) UpdateSubaccountNettingWithResponse(ctx context.Context, body UpdateSubaccountNettingJSONRequestBody, ...) (*UpdateSubaccountNettingResponse, error)
  • func (c *ClientWithResponses) UpgradeAccountApiUsageLevelWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UpgradeAccountApiUsageLevelResponse, error)
• type ClientWithResponsesInterface
• type ConfirmQuoteJSONRequestBody
• type ConfirmQuoteResponse
  • func ParseConfirmQuoteResponse(rsp *http.Response) (*ConfirmQuoteResponse, error)
  • func (r ConfirmQuoteResponse) ContentType() string
  • func (r ConfirmQuoteResponse) GetBody() []byte
  • func (r ConfirmQuoteResponse) GetJSON400() *BadRequestError
  • func (r ConfirmQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r ConfirmQuoteResponse) GetJSON404() *NotFoundError
  • func (r ConfirmQuoteResponse) GetJSON500() *InternalServerError
  • func (r ConfirmQuoteResponse) Status() string
  • func (r ConfirmQuoteResponse) StatusCode() int
• type ConfirmRFQQuoteJSONRequestBody
• type ConfirmRFQQuoteResponse
  • func ParseConfirmRFQQuoteResponse(rsp *http.Response) (*ConfirmRFQQuoteResponse, error)
  • func (r ConfirmRFQQuoteResponse) ContentType() string
  • func (r ConfirmRFQQuoteResponse) GetBody() []byte
  • func (r ConfirmRFQQuoteResponse) GetJSON400() *BadRequestError
  • func (r ConfirmRFQQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r ConfirmRFQQuoteResponse) GetJSON404() *NotFoundError
  • func (r ConfirmRFQQuoteResponse) GetJSON500() *InternalServerError
  • func (r ConfirmRFQQuoteResponse) Status() string
  • func (r ConfirmRFQQuoteResponse) StatusCode() int
• type ConflictError
• type CountFilterQuery
• type CreateApiKeyJSONRequestBody
• type CreateApiKeyRequest
• type CreateApiKeyResponse
• type CreateApiKeyResponse2
  • func ParseCreateApiKeyResponse2(rsp *http.Response) (*CreateApiKeyResponse2, error)
  • func (r CreateApiKeyResponse2) ContentType() string
  • func (r CreateApiKeyResponse2) GetBody() []byte
  • func (r CreateApiKeyResponse2) GetJSON201() *CreateApiKeyResponse
  • func (r CreateApiKeyResponse2) Status() string
  • func (r CreateApiKeyResponse2) StatusCode() int
• type CreateFCMPositionTransferJSONRequestBody
• type CreateFCMPositionTransferRequest
• type CreateFCMPositionTransferResponse
• type CreateFCMPositionTransferResponse2
  • func ParseCreateFCMPositionTransferResponse2(rsp *http.Response) (*CreateFCMPositionTransferResponse2, error)
  • func (r CreateFCMPositionTransferResponse2) ContentType() string
  • func (r CreateFCMPositionTransferResponse2) GetBody() []byte
  • func (r CreateFCMPositionTransferResponse2) GetJSON201() *CreateFCMPositionTransferResponse
  • func (r CreateFCMPositionTransferResponse2) GetJSON400() *BadRequestError
  • func (r CreateFCMPositionTransferResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateFCMPositionTransferResponse2) GetJSON403() *ForbiddenError
  • func (r CreateFCMPositionTransferResponse2) GetJSON404() *NotFoundError
  • func (r CreateFCMPositionTransferResponse2) GetJSON409() *ConflictError
  • func (r CreateFCMPositionTransferResponse2) GetJSON429() *RateLimitError
  • func (r CreateFCMPositionTransferResponse2) GetJSON500() *InternalServerError
  • func (r CreateFCMPositionTransferResponse2) Status() string
  • func (r CreateFCMPositionTransferResponse2) StatusCode() int
• type CreateFCMSubtraderJSONRequestBody
• type CreateFCMSubtraderRequest
• type CreateFCMSubtraderResponse
• type CreateFCMSubtraderResponse2
  • func ParseCreateFCMSubtraderResponse2(rsp *http.Response) (*CreateFCMSubtraderResponse2, error)
  • func (r CreateFCMSubtraderResponse2) ContentType() string
  • func (r CreateFCMSubtraderResponse2) GetBody() []byte
  • func (r CreateFCMSubtraderResponse2) GetJSON201() *CreateFCMSubtraderResponse
  • func (r CreateFCMSubtraderResponse2) GetJSON400() *BadRequestError
  • func (r CreateFCMSubtraderResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateFCMSubtraderResponse2) GetJSON403() *ForbiddenError
  • func (r CreateFCMSubtraderResponse2) GetJSON409() *ConflictError
  • func (r CreateFCMSubtraderResponse2) GetJSON500() *InternalServerError
  • func (r CreateFCMSubtraderResponse2) Status() string
  • func (r CreateFCMSubtraderResponse2) StatusCode() int
• type CreateMarketInMultivariateEventCollectionJSONRequestBody
• type CreateMarketInMultivariateEventCollectionRequest
• type CreateMarketInMultivariateEventCollectionResponse
• type CreateMarketInMultivariateEventCollectionResponse2
  • func ParseCreateMarketInMultivariateEventCollectionResponse2(rsp *http.Response) (*CreateMarketInMultivariateEventCollectionResponse2, error)
  • func (r CreateMarketInMultivariateEventCollectionResponse2) ContentType() string
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetBody() []byte
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON200() *CreateMarketInMultivariateEventCollectionResponse
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON400() *BadRequestError
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON429() *RateLimitError
  • func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON500() *InternalServerError
  • func (r CreateMarketInMultivariateEventCollectionResponse2) Status() string
  • func (r CreateMarketInMultivariateEventCollectionResponse2) StatusCode() int
• type CreateOrderGroupJSONRequestBody
• type CreateOrderGroupRequest
• type CreateOrderGroupResponse
• type CreateOrderGroupResponse2
  • func ParseCreateOrderGroupResponse2(rsp *http.Response) (*CreateOrderGroupResponse2, error)
  • func (r CreateOrderGroupResponse2) ContentType() string
  • func (r CreateOrderGroupResponse2) GetBody() []byte
  • func (r CreateOrderGroupResponse2) GetJSON201() *CreateOrderGroupResponse
  • func (r CreateOrderGroupResponse2) GetJSON400() *BadRequestError
  • func (r CreateOrderGroupResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateOrderGroupResponse2) GetJSON500() *InternalServerError
  • func (r CreateOrderGroupResponse2) Status() string
  • func (r CreateOrderGroupResponse2) StatusCode() int
• type CreateOrderV2JSONRequestBody
• type CreateOrderV2Request
• type CreateOrderV2RequestTimeInForce
  • func (e CreateOrderV2RequestTimeInForce) Valid() bool
• type CreateOrderV2Response
• type CreateOrderV2Response2
  • func ParseCreateOrderV2Response2(rsp *http.Response) (*CreateOrderV2Response2, error)
  • func (r CreateOrderV2Response2) ContentType() string
  • func (r CreateOrderV2Response2) GetBody() []byte
  • func (r CreateOrderV2Response2) GetJSON201() *CreateOrderV2Response
  • func (r CreateOrderV2Response2) GetJSON400() *BadRequestError
  • func (r CreateOrderV2Response2) GetJSON401() *UnauthorizedError
  • func (r CreateOrderV2Response2) GetJSON403() *ForbiddenError
  • func (r CreateOrderV2Response2) GetJSON409() *ConflictError
  • func (r CreateOrderV2Response2) GetJSON429() *RateLimitError
  • func (r CreateOrderV2Response2) GetJSON500() *InternalServerError
  • func (r CreateOrderV2Response2) GetJSON503() *ServiceUnavailableError
  • func (r CreateOrderV2Response2) Status() string
  • func (r CreateOrderV2Response2) StatusCode() int
• type CreateQuoteJSONRequestBody
• type CreateQuoteRequest
• type CreateQuoteResponse
• type CreateQuoteResponse2
  • func ParseCreateQuoteResponse2(rsp *http.Response) (*CreateQuoteResponse2, error)
  • func (r CreateQuoteResponse2) ContentType() string
  • func (r CreateQuoteResponse2) GetBody() []byte
  • func (r CreateQuoteResponse2) GetJSON201() *CreateQuoteResponse
  • func (r CreateQuoteResponse2) GetJSON400() *BadRequestError
  • func (r CreateQuoteResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateQuoteResponse2) GetJSON500() *InternalServerError
  • func (r CreateQuoteResponse2) Status() string
  • func (r CreateQuoteResponse2) StatusCode() int
• type CreateRFQJSONRequestBody
• type CreateRFQRequest
• type CreateRFQResponse
• type CreateRFQResponse2
  • func ParseCreateRFQResponse2(rsp *http.Response) (*CreateRFQResponse2, error)
  • func (r CreateRFQResponse2) ContentType() string
  • func (r CreateRFQResponse2) GetBody() []byte
  • func (r CreateRFQResponse2) GetJSON201() *CreateRFQResponse
  • func (r CreateRFQResponse2) GetJSON400() *BadRequestError
  • func (r CreateRFQResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateRFQResponse2) GetJSON409() *ConflictError
  • func (r CreateRFQResponse2) GetJSON500() *InternalServerError
  • func (r CreateRFQResponse2) Status() string
  • func (r CreateRFQResponse2) StatusCode() int
• type CreateSubaccountJSONRequestBody
• type CreateSubaccountRequest
• type CreateSubaccountResponse
• type CreateSubaccountResponse2
  • func ParseCreateSubaccountResponse2(rsp *http.Response) (*CreateSubaccountResponse2, error)
  • func (r CreateSubaccountResponse2) ContentType() string
  • func (r CreateSubaccountResponse2) GetBody() []byte
  • func (r CreateSubaccountResponse2) GetJSON201() *CreateSubaccountResponse
  • func (r CreateSubaccountResponse2) GetJSON400() *BadRequestError
  • func (r CreateSubaccountResponse2) GetJSON401() *UnauthorizedError
  • func (r CreateSubaccountResponse2) GetJSON500() *InternalServerError
  • func (r CreateSubaccountResponse2) Status() string
  • func (r CreateSubaccountResponse2) StatusCode() int
• type CursorQuery
• type DailySchedule
• type DecreaseOrderV2JSONRequestBody
• type DecreaseOrderV2Params
• type DecreaseOrderV2Request
• type DecreaseOrderV2Response
• type DecreaseOrderV2Response2
  • func ParseDecreaseOrderV2Response2(rsp *http.Response) (*DecreaseOrderV2Response2, error)
  • func (r DecreaseOrderV2Response2) ContentType() string
  • func (r DecreaseOrderV2Response2) GetBody() []byte
  • func (r DecreaseOrderV2Response2) GetJSON200() *DecreaseOrderV2Response
  • func (r DecreaseOrderV2Response2) GetJSON400() *BadRequestError
  • func (r DecreaseOrderV2Response2) GetJSON401() *UnauthorizedError
  • func (r DecreaseOrderV2Response2) GetJSON404() *NotFoundError
  • func (r DecreaseOrderV2Response2) GetJSON500() *InternalServerError
  • func (r DecreaseOrderV2Response2) Status() string
  • func (r DecreaseOrderV2Response2) StatusCode() int
• type DeleteApiKeyResponse
  • func ParseDeleteApiKeyResponse(rsp *http.Response) (*DeleteApiKeyResponse, error)
  • func (r DeleteApiKeyResponse) ContentType() string
  • func (r DeleteApiKeyResponse) GetBody() []byte
  • func (r DeleteApiKeyResponse) Status() string
  • func (r DeleteApiKeyResponse) StatusCode() int
• type DeleteFCMEventContractDailyCapParams
• type DeleteFCMEventContractDailyCapResponse
  • func ParseDeleteFCMEventContractDailyCapResponse(rsp *http.Response) (*DeleteFCMEventContractDailyCapResponse, error)
  • func (r DeleteFCMEventContractDailyCapResponse) ContentType() string
  • func (r DeleteFCMEventContractDailyCapResponse) GetBody() []byte
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON200() *EmptyResponse
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON400() *BadRequestError
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON401() *UnauthorizedError
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON403() *ForbiddenError
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON404() *NotFoundError
  • func (r DeleteFCMEventContractDailyCapResponse) GetJSON500() *InternalServerError
  • func (r DeleteFCMEventContractDailyCapResponse) Status() string
  • func (r DeleteFCMEventContractDailyCapResponse) StatusCode() int
• type DeleteOrderGroupParams
• type DeleteOrderGroupResponse
  • func ParseDeleteOrderGroupResponse(rsp *http.Response) (*DeleteOrderGroupResponse, error)
  • func (r DeleteOrderGroupResponse) ContentType() string
  • func (r DeleteOrderGroupResponse) GetBody() []byte
  • func (r DeleteOrderGroupResponse) GetJSON200() *EmptyResponse
  • func (r DeleteOrderGroupResponse) GetJSON401() *UnauthorizedError
  • func (r DeleteOrderGroupResponse) GetJSON404() *NotFoundError
  • func (r DeleteOrderGroupResponse) GetJSON500() *InternalServerError
  • func (r DeleteOrderGroupResponse) Status() string
  • func (r DeleteOrderGroupResponse) StatusCode() int
• type DeleteQuoteResponse
  • func ParseDeleteQuoteResponse(rsp *http.Response) (*DeleteQuoteResponse, error)
  • func (r DeleteQuoteResponse) ContentType() string
  • func (r DeleteQuoteResponse) GetBody() []byte
  • func (r DeleteQuoteResponse) GetJSON400() *BadRequestError
  • func (r DeleteQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r DeleteQuoteResponse) GetJSON404() *NotFoundError
  • func (r DeleteQuoteResponse) GetJSON500() *InternalServerError
  • func (r DeleteQuoteResponse) Status() string
  • func (r DeleteQuoteResponse) StatusCode() int
• type DeleteRFQQuoteResponse
  • func ParseDeleteRFQQuoteResponse(rsp *http.Response) (*DeleteRFQQuoteResponse, error)
  • func (r DeleteRFQQuoteResponse) ContentType() string
  • func (r DeleteRFQQuoteResponse) GetBody() []byte
  • func (r DeleteRFQQuoteResponse) GetJSON400() *BadRequestError
  • func (r DeleteRFQQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r DeleteRFQQuoteResponse) GetJSON404() *NotFoundError
  • func (r DeleteRFQQuoteResponse) GetJSON500() *InternalServerError
  • func (r DeleteRFQQuoteResponse) Status() string
  • func (r DeleteRFQQuoteResponse) StatusCode() int
• type DeleteRFQResponse
  • func ParseDeleteRFQResponse(rsp *http.Response) (*DeleteRFQResponse, error)
  • func (r DeleteRFQResponse) ContentType() string
  • func (r DeleteRFQResponse) GetBody() []byte
  • func (r DeleteRFQResponse) GetJSON400() *BadRequestError
  • func (r DeleteRFQResponse) GetJSON401() *UnauthorizedError
  • func (r DeleteRFQResponse) GetJSON404() *NotFoundError
  • func (r DeleteRFQResponse) GetJSON500() *InternalServerError
  • func (r DeleteRFQResponse) Status() string
  • func (r DeleteRFQResponse) StatusCode() int
• type Deposit
• type DepositStatus
  • func (e DepositStatus) Valid() bool
• type DepositType
  • func (e DepositType) Valid() bool
• type EmptyResponse
• type EndpointTokenCost
• type ErrorResponse
• type EventData
• type EventFeeChange
• type EventLiveData
• type EventPosition
• type EventTickersQuery
• type ExchangeIndex
• type ExchangeIndexFilterQuery
• type ExchangeIndexQuery
• type ExchangeIndexStatus
• type ExchangeInstance
  • func (e ExchangeInstance) Valid() bool
• type ExchangeStatus
• type FCMSubtrader
• type FcmFill
• type FeeType
  • func (e FeeType) Valid() bool
• type Fill
• type FillAction
  • func (e FillAction) Valid() bool
• type FillSide
  • func (e FillSide) Valid() bool
• type FixedPointCount
• type FixedPointDollars
• type ForbiddenError
• type ForecastPercentilesPoint
• type GenerateApiKeyJSONRequestBody
• type GenerateApiKeyRequest
• type GenerateApiKeyResponse
• type GenerateApiKeyResponse2
  • func ParseGenerateApiKeyResponse2(rsp *http.Response) (*GenerateApiKeyResponse2, error)
  • func (r GenerateApiKeyResponse2) ContentType() string
  • func (r GenerateApiKeyResponse2) GetBody() []byte
  • func (r GenerateApiKeyResponse2) GetJSON201() *GenerateApiKeyResponse
  • func (r GenerateApiKeyResponse2) Status() string
  • func (r GenerateApiKeyResponse2) StatusCode() int
• type GetAccountApiLimitsResponse
• type GetAccountApiLimitsResponse2
  • func ParseGetAccountApiLimitsResponse2(rsp *http.Response) (*GetAccountApiLimitsResponse2, error)
  • func (r GetAccountApiLimitsResponse2) ContentType() string
  • func (r GetAccountApiLimitsResponse2) GetBody() []byte
  • func (r GetAccountApiLimitsResponse2) GetJSON200() *GetAccountApiLimitsResponse
  • func (r GetAccountApiLimitsResponse2) Status() string
  • func (r GetAccountApiLimitsResponse2) StatusCode() int
• type GetAccountApiUsageLevelVolumeProgressResponse
• type GetAccountApiUsageLevelVolumeProgressResponse2
  • func ParseGetAccountApiUsageLevelVolumeProgressResponse2(rsp *http.Response) (*GetAccountApiUsageLevelVolumeProgressResponse2, error)
  • func (r GetAccountApiUsageLevelVolumeProgressResponse2) ContentType() string
  • func (r GetAccountApiUsageLevelVolumeProgressResponse2) GetBody() []byte
  • func (r GetAccountApiUsageLevelVolumeProgressResponse2) GetJSON200() *GetAccountApiUsageLevelVolumeProgressResponse
  • func (r GetAccountApiUsageLevelVolumeProgressResponse2) Status() string
  • func (r GetAccountApiUsageLevelVolumeProgressResponse2) StatusCode() int
• type GetAccountEndpointCostsResponse
• type GetAccountEndpointCostsResponse2
  • func ParseGetAccountEndpointCostsResponse2(rsp *http.Response) (*GetAccountEndpointCostsResponse2, error)
  • func (r GetAccountEndpointCostsResponse2) ContentType() string
  • func (r GetAccountEndpointCostsResponse2) GetBody() []byte
  • func (r GetAccountEndpointCostsResponse2) GetJSON200() *GetAccountEndpointCostsResponse
  • func (r GetAccountEndpointCostsResponse2) Status() string
  • func (r GetAccountEndpointCostsResponse2) StatusCode() int
• type GetApiKeysParams
• type GetApiKeysResponse
• type GetApiKeysResponse2
  • func ParseGetApiKeysResponse2(rsp *http.Response) (*GetApiKeysResponse2, error)
  • func (r GetApiKeysResponse2) ContentType() string
  • func (r GetApiKeysResponse2) GetBody() []byte
  • func (r GetApiKeysResponse2) GetJSON200() *GetApiKeysResponse
  • func (r GetApiKeysResponse2) Status() string
  • func (r GetApiKeysResponse2) StatusCode() int
• type GetBalanceParams
• type GetBalanceResponse
• type GetBalanceResponse2
  • func ParseGetBalanceResponse2(rsp *http.Response) (*GetBalanceResponse2, error)
  • func (r GetBalanceResponse2) ContentType() string
  • func (r GetBalanceResponse2) GetBody() []byte
  • func (r GetBalanceResponse2) GetJSON200() *GetBalanceResponse
  • func (r GetBalanceResponse2) GetJSON401() *UnauthorizedError
  • func (r GetBalanceResponse2) GetJSON500() *InternalServerError
  • func (r GetBalanceResponse2) Status() string
  • func (r GetBalanceResponse2) StatusCode() int
• type GetBlockTradeProposalsParams
• type GetBlockTradeProposalsResponse
• type GetBlockTradeProposalsResponse2
  • func ParseGetBlockTradeProposalsResponse2(rsp *http.Response) (*GetBlockTradeProposalsResponse2, error)
  • func (r GetBlockTradeProposalsResponse2) ContentType() string
  • func (r GetBlockTradeProposalsResponse2) GetBody() []byte
  • func (r GetBlockTradeProposalsResponse2) GetJSON200() *GetBlockTradeProposalsResponse
  • func (r GetBlockTradeProposalsResponse2) GetJSON400() *BadRequestError
  • func (r GetBlockTradeProposalsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetBlockTradeProposalsResponse2) GetJSON500() *InternalServerError
  • func (r GetBlockTradeProposalsResponse2) Status() string
  • func (r GetBlockTradeProposalsResponse2) StatusCode() int
• type GetCommunicationsIDResponse
• type GetCommunicationsIDResponse2
  • func ParseGetCommunicationsIDResponse2(rsp *http.Response) (*GetCommunicationsIDResponse2, error)
  • func (r GetCommunicationsIDResponse2) ContentType() string
  • func (r GetCommunicationsIDResponse2) GetBody() []byte
  • func (r GetCommunicationsIDResponse2) GetJSON200() *GetCommunicationsIDResponse
  • func (r GetCommunicationsIDResponse2) GetJSON401() *UnauthorizedError
  • func (r GetCommunicationsIDResponse2) GetJSON500() *InternalServerError
  • func (r GetCommunicationsIDResponse2) Status() string
  • func (r GetCommunicationsIDResponse2) StatusCode() int
• type GetDepositsParams
• type GetDepositsResponse
• type GetDepositsResponse2
  • func ParseGetDepositsResponse2(rsp *http.Response) (*GetDepositsResponse2, error)
  • func (r GetDepositsResponse2) ContentType() string
  • func (r GetDepositsResponse2) GetBody() []byte
  • func (r GetDepositsResponse2) GetJSON200() *GetDepositsResponse
  • func (r GetDepositsResponse2) GetJSON400() *BadRequestError
  • func (r GetDepositsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetDepositsResponse2) GetJSON500() *InternalServerError
  • func (r GetDepositsResponse2) Status() string
  • func (r GetDepositsResponse2) StatusCode() int
• type GetEventCandlesticksResponse
• type GetEventFeeChangesParams
• type GetEventFeeChangesResponse
• type GetEventFeeChangesResponse2
  • func ParseGetEventFeeChangesResponse2(rsp *http.Response) (*GetEventFeeChangesResponse2, error)
  • func (r GetEventFeeChangesResponse2) ContentType() string
  • func (r GetEventFeeChangesResponse2) GetBody() []byte
  • func (r GetEventFeeChangesResponse2) GetJSON200() *GetEventFeeChangesResponse
  • func (r GetEventFeeChangesResponse2) GetJSON400() *BadRequestError
  • func (r GetEventFeeChangesResponse2) GetJSON500() *InternalServerError
  • func (r GetEventFeeChangesResponse2) Status() string
  • func (r GetEventFeeChangesResponse2) StatusCode() int
• type GetEventForecastPercentilesHistoryParams
• type GetEventForecastPercentilesHistoryParamsPeriodInterval
  • func (e GetEventForecastPercentilesHistoryParamsPeriodInterval) Valid() bool
• type GetEventForecastPercentilesHistoryResponse
• type GetEventForecastPercentilesHistoryResponse2
  • func ParseGetEventForecastPercentilesHistoryResponse2(rsp *http.Response) (*GetEventForecastPercentilesHistoryResponse2, error)
  • func (r GetEventForecastPercentilesHistoryResponse2) ContentType() string
  • func (r GetEventForecastPercentilesHistoryResponse2) GetBody() []byte
  • func (r GetEventForecastPercentilesHistoryResponse2) GetJSON200() *GetEventForecastPercentilesHistoryResponse
  • func (r GetEventForecastPercentilesHistoryResponse2) Status() string
  • func (r GetEventForecastPercentilesHistoryResponse2) StatusCode() int
• type GetEventLiveDataParams
• type GetEventLiveDataResponse
• type GetEventLiveDataResponse2
  • func ParseGetEventLiveDataResponse2(rsp *http.Response) (*GetEventLiveDataResponse2, error)
  • func (r GetEventLiveDataResponse2) ContentType() string
  • func (r GetEventLiveDataResponse2) GetBody() []byte
  • func (r GetEventLiveDataResponse2) GetJSON200() *GetEventLiveDataResponse
  • func (r GetEventLiveDataResponse2) Status() string
  • func (r GetEventLiveDataResponse2) StatusCode() int
• type GetEventMetadataResponse
• type GetEventMetadataResponse2
  • func ParseGetEventMetadataResponse2(rsp *http.Response) (*GetEventMetadataResponse2, error)
  • func (r GetEventMetadataResponse2) ContentType() string
  • func (r GetEventMetadataResponse2) GetBody() []byte
  • func (r GetEventMetadataResponse2) GetJSON200() *GetEventMetadataResponse
  • func (r GetEventMetadataResponse2) Status() string
  • func (r GetEventMetadataResponse2) StatusCode() int
• type GetEventParams
• type GetEventResponse
• type GetEventResponse2
  • func ParseGetEventResponse2(rsp *http.Response) (*GetEventResponse2, error)
  • func (r GetEventResponse2) ContentType() string
  • func (r GetEventResponse2) GetBody() []byte
  • func (r GetEventResponse2) GetJSON200() *GetEventResponse
  • func (r GetEventResponse2) Status() string
  • func (r GetEventResponse2) StatusCode() int
• type GetEventsParams
• type GetEventsParamsStatus
  • func (e GetEventsParamsStatus) Valid() bool
• type GetEventsResponse
• type GetEventsResponse2
  • func ParseGetEventsResponse2(rsp *http.Response) (*GetEventsResponse2, error)
  • func (r GetEventsResponse2) ContentType() string
  • func (r GetEventsResponse2) GetBody() []byte
  • func (r GetEventsResponse2) GetJSON200() *GetEventsResponse
  • func (r GetEventsResponse2) Status() string
  • func (r GetEventsResponse2) StatusCode() int
• type GetExchangeScheduleResponse
• type GetExchangeScheduleResponse2
  • func ParseGetExchangeScheduleResponse2(rsp *http.Response) (*GetExchangeScheduleResponse2, error)
  • func (r GetExchangeScheduleResponse2) ContentType() string
  • func (r GetExchangeScheduleResponse2) GetBody() []byte
  • func (r GetExchangeScheduleResponse2) GetJSON200() *GetExchangeScheduleResponse
  • func (r GetExchangeScheduleResponse2) Status() string
  • func (r GetExchangeScheduleResponse2) StatusCode() int
• type GetExchangeStatusResponse
  • func ParseGetExchangeStatusResponse(rsp *http.Response) (*GetExchangeStatusResponse, error)
  • func (r GetExchangeStatusResponse) ContentType() string
  • func (r GetExchangeStatusResponse) GetBody() []byte
  • func (r GetExchangeStatusResponse) GetJSON200() *ExchangeStatus
  • func (r GetExchangeStatusResponse) GetJSON500() *ExchangeStatus
  • func (r GetExchangeStatusResponse) GetJSON503() *ExchangeStatus
  • func (r GetExchangeStatusResponse) GetJSON504() *ExchangeStatus
  • func (r GetExchangeStatusResponse) Status() string
  • func (r GetExchangeStatusResponse) StatusCode() int
• type GetFCMEventContractDailyCapParams
• type GetFCMEventContractDailyCapResponse
• type GetFCMEventContractDailyCapResponse2
  • func ParseGetFCMEventContractDailyCapResponse2(rsp *http.Response) (*GetFCMEventContractDailyCapResponse2, error)
  • func (r GetFCMEventContractDailyCapResponse2) ContentType() string
  • func (r GetFCMEventContractDailyCapResponse2) GetBody() []byte
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON200() *GetFCMEventContractDailyCapResponse
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON400() *BadRequestError
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON401() *UnauthorizedError
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON403() *ForbiddenError
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON404() *NotFoundError
  • func (r GetFCMEventContractDailyCapResponse2) GetJSON500() *InternalServerError
  • func (r GetFCMEventContractDailyCapResponse2) Status() string
  • func (r GetFCMEventContractDailyCapResponse2) StatusCode() int
• type GetFCMFillsParams
• type GetFCMFillsResponse
  • func ParseGetFCMFillsResponse(rsp *http.Response) (*GetFCMFillsResponse, error)
  • func (r GetFCMFillsResponse) ContentType() string
  • func (r GetFCMFillsResponse) GetBody() []byte
  • func (r GetFCMFillsResponse) GetJSON200() *GetFcmFillsResponse
  • func (r GetFCMFillsResponse) Status() string
  • func (r GetFCMFillsResponse) StatusCode() int
• type GetFCMOrdersParams
• type GetFCMOrdersParamsStatus
  • func (e GetFCMOrdersParamsStatus) Valid() bool
• type GetFCMOrdersResponse
  • func ParseGetFCMOrdersResponse(rsp *http.Response) (*GetFCMOrdersResponse, error)
  • func (r GetFCMOrdersResponse) ContentType() string
  • func (r GetFCMOrdersResponse) GetBody() []byte
  • func (r GetFCMOrdersResponse) GetJSON200() *GetOrdersResponse
  • func (r GetFCMOrdersResponse) Status() string
  • func (r GetFCMOrdersResponse) StatusCode() int
• type GetFCMPositionsParams
• type GetFCMPositionsParamsSettlementStatus
  • func (e GetFCMPositionsParamsSettlementStatus) Valid() bool
• type GetFCMPositionsResponse
  • func ParseGetFCMPositionsResponse(rsp *http.Response) (*GetFCMPositionsResponse, error)
  • func (r GetFCMPositionsResponse) ContentType() string
  • func (r GetFCMPositionsResponse) GetBody() []byte
  • func (r GetFCMPositionsResponse) GetJSON200() *GetPositionsResponse
  • func (r GetFCMPositionsResponse) Status() string
  • func (r GetFCMPositionsResponse) StatusCode() int
• type GetFCMSubtraderBlockedCategoriesParams
• type GetFCMSubtraderBlockedCategoriesResponse
• type GetFCMSubtraderBlockedCategoriesResponse2
  • func ParseGetFCMSubtraderBlockedCategoriesResponse2(rsp *http.Response) (*GetFCMSubtraderBlockedCategoriesResponse2, error)
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) ContentType() string
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetBody() []byte
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON200() *GetFCMSubtraderBlockedCategoriesResponse
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON400() *BadRequestError
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON401() *UnauthorizedError
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON403() *ForbiddenError
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON500() *InternalServerError
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) Status() string
  • func (r GetFCMSubtraderBlockedCategoriesResponse2) StatusCode() int
• type GetFcmFillsResponse
• type GetFillsHistoricalParams
• type GetFillsHistoricalResponse
  • func ParseGetFillsHistoricalResponse(rsp *http.Response) (*GetFillsHistoricalResponse, error)
  • func (r GetFillsHistoricalResponse) ContentType() string
  • func (r GetFillsHistoricalResponse) GetBody() []byte
  • func (r GetFillsHistoricalResponse) GetJSON200() *GetFillsResponse
  • func (r GetFillsHistoricalResponse) GetJSON404() *NotFoundError
  • func (r GetFillsHistoricalResponse) Status() string
  • func (r GetFillsHistoricalResponse) StatusCode() int
• type GetFillsParams
• type GetFillsResponse
• type GetFillsResponse2
  • func ParseGetFillsResponse2(rsp *http.Response) (*GetFillsResponse2, error)
  • func (r GetFillsResponse2) ContentType() string
  • func (r GetFillsResponse2) GetBody() []byte
  • func (r GetFillsResponse2) GetJSON200() *GetFillsResponse
  • func (r GetFillsResponse2) Status() string
  • func (r GetFillsResponse2) StatusCode() int
• type GetFiltersBySportsResponse
• type GetFiltersForSportsResponse
  • func ParseGetFiltersForSportsResponse(rsp *http.Response) (*GetFiltersForSportsResponse, error)
  • func (r GetFiltersForSportsResponse) ContentType() string
  • func (r GetFiltersForSportsResponse) GetBody() []byte
  • func (r GetFiltersForSportsResponse) GetJSON200() *GetFiltersBySportsResponse
  • func (r GetFiltersForSportsResponse) Status() string
  • func (r GetFiltersForSportsResponse) StatusCode() int
• type GetGameStatsResponse
• type GetGameStatsResponse2
  • func ParseGetGameStatsResponse2(rsp *http.Response) (*GetGameStatsResponse2, error)
  • func (r GetGameStatsResponse2) ContentType() string
  • func (r GetGameStatsResponse2) GetBody() []byte
  • func (r GetGameStatsResponse2) GetJSON200() *GetGameStatsResponse
  • func (r GetGameStatsResponse2) Status() string
  • func (r GetGameStatsResponse2) StatusCode() int
• type GetHistoricalCutoffResponse
• type GetHistoricalCutoffResponse2
  • func ParseGetHistoricalCutoffResponse2(rsp *http.Response) (*GetHistoricalCutoffResponse2, error)
  • func (r GetHistoricalCutoffResponse2) ContentType() string
  • func (r GetHistoricalCutoffResponse2) GetBody() []byte
  • func (r GetHistoricalCutoffResponse2) GetJSON200() *GetHistoricalCutoffResponse
  • func (r GetHistoricalCutoffResponse2) Status() string
  • func (r GetHistoricalCutoffResponse2) StatusCode() int
• type GetHistoricalMarketResponse
  • func ParseGetHistoricalMarketResponse(rsp *http.Response) (*GetHistoricalMarketResponse, error)
  • func (r GetHistoricalMarketResponse) ContentType() string
  • func (r GetHistoricalMarketResponse) GetBody() []byte
  • func (r GetHistoricalMarketResponse) GetJSON200() *GetMarketResponse
  • func (r GetHistoricalMarketResponse) GetJSON404() *NotFoundError
  • func (r GetHistoricalMarketResponse) GetJSON500() *InternalServerError
  • func (r GetHistoricalMarketResponse) Status() string
  • func (r GetHistoricalMarketResponse) StatusCode() int
• type GetHistoricalMarketsParams
• type GetHistoricalMarketsParamsMveFilter
  • func (e GetHistoricalMarketsParamsMveFilter) Valid() bool
• type GetHistoricalMarketsResponse
  • func ParseGetHistoricalMarketsResponse(rsp *http.Response) (*GetHistoricalMarketsResponse, error)
  • func (r GetHistoricalMarketsResponse) ContentType() string
  • func (r GetHistoricalMarketsResponse) GetBody() []byte
  • func (r GetHistoricalMarketsResponse) GetJSON200() *GetMarketsResponse
  • func (r GetHistoricalMarketsResponse) GetJSON400() *BadRequestError
  • func (r GetHistoricalMarketsResponse) GetJSON500() *InternalServerError
  • func (r GetHistoricalMarketsResponse) Status() string
  • func (r GetHistoricalMarketsResponse) StatusCode() int
• type GetHistoricalOrdersParams
• type GetHistoricalOrdersResponse
  • func ParseGetHistoricalOrdersResponse(rsp *http.Response) (*GetHistoricalOrdersResponse, error)
  • func (r GetHistoricalOrdersResponse) ContentType() string
  • func (r GetHistoricalOrdersResponse) GetBody() []byte
  • func (r GetHistoricalOrdersResponse) GetJSON200() *GetOrdersResponse
  • func (r GetHistoricalOrdersResponse) GetJSON400() *BadRequestError
  • func (r GetHistoricalOrdersResponse) GetJSON401() *UnauthorizedError
  • func (r GetHistoricalOrdersResponse) GetJSON500() *InternalServerError
  • func (r GetHistoricalOrdersResponse) Status() string
  • func (r GetHistoricalOrdersResponse) StatusCode() int
• type GetHistoricalPositionsParams
• type GetHistoricalPositionsResponse
  • func ParseGetHistoricalPositionsResponse(rsp *http.Response) (*GetHistoricalPositionsResponse, error)
  • func (r GetHistoricalPositionsResponse) ContentType() string
  • func (r GetHistoricalPositionsResponse) GetBody() []byte
  • func (r GetHistoricalPositionsResponse) GetJSON200() *GetPositionsResponse
  • func (r GetHistoricalPositionsResponse) GetJSON400() *BadRequestError
  • func (r GetHistoricalPositionsResponse) GetJSON401() *UnauthorizedError
  • func (r GetHistoricalPositionsResponse) GetJSON500() *InternalServerError
  • func (r GetHistoricalPositionsResponse) Status() string
  • func (r GetHistoricalPositionsResponse) StatusCode() int
• type GetIncentiveProgramsParams
• type GetIncentiveProgramsParamsStatus
  • func (e GetIncentiveProgramsParamsStatus) Valid() bool
• type GetIncentiveProgramsParamsType
  • func (e GetIncentiveProgramsParamsType) Valid() bool
• type GetIncentiveProgramsResponse
• type GetIncentiveProgramsResponse2
  • func ParseGetIncentiveProgramsResponse2(rsp *http.Response) (*GetIncentiveProgramsResponse2, error)
  • func (r GetIncentiveProgramsResponse2) ContentType() string
  • func (r GetIncentiveProgramsResponse2) GetBody() []byte
  • func (r GetIncentiveProgramsResponse2) GetJSON200() *GetIncentiveProgramsResponse
  • func (r GetIncentiveProgramsResponse2) GetJSON400() *ErrorResponse
  • func (r GetIncentiveProgramsResponse2) GetJSON500() *ErrorResponse
  • func (r GetIncentiveProgramsResponse2) Status() string
  • func (r GetIncentiveProgramsResponse2) StatusCode() int
• type GetIntraExchangeInstanceTransferResponse
• type GetIntraExchangeInstanceTransferResponse2
  • func ParseGetIntraExchangeInstanceTransferResponse2(rsp *http.Response) (*GetIntraExchangeInstanceTransferResponse2, error)
  • func (r GetIntraExchangeInstanceTransferResponse2) ContentType() string
  • func (r GetIntraExchangeInstanceTransferResponse2) GetBody() []byte
  • func (r GetIntraExchangeInstanceTransferResponse2) GetJSON200() *GetIntraExchangeInstanceTransferResponse
  • func (r GetIntraExchangeInstanceTransferResponse2) GetJSON401() *UnauthorizedError
  • func (r GetIntraExchangeInstanceTransferResponse2) GetJSON404() *NotFoundError
  • func (r GetIntraExchangeInstanceTransferResponse2) GetJSON500() *InternalServerError
  • func (r GetIntraExchangeInstanceTransferResponse2) Status() string
  • func (r GetIntraExchangeInstanceTransferResponse2) StatusCode() int
• type GetIntraExchangeInstanceTransfersParams
• type GetIntraExchangeInstanceTransfersResponse
• type GetIntraExchangeInstanceTransfersResponse2
  • func ParseGetIntraExchangeInstanceTransfersResponse2(rsp *http.Response) (*GetIntraExchangeInstanceTransfersResponse2, error)
  • func (r GetIntraExchangeInstanceTransfersResponse2) ContentType() string
  • func (r GetIntraExchangeInstanceTransfersResponse2) GetBody() []byte
  • func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON200() *GetIntraExchangeInstanceTransfersResponse
  • func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON400() *BadRequestError
  • func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON401() *UnauthorizedError
  • func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON500() *InternalServerError
  • func (r GetIntraExchangeInstanceTransfersResponse2) Status() string
  • func (r GetIntraExchangeInstanceTransfersResponse2) StatusCode() int
• type GetLiveDataByMilestoneParams
• type GetLiveDataByMilestoneResponse
  • func ParseGetLiveDataByMilestoneResponse(rsp *http.Response) (*GetLiveDataByMilestoneResponse, error)
  • func (r GetLiveDataByMilestoneResponse) ContentType() string
  • func (r GetLiveDataByMilestoneResponse) GetBody() []byte
  • func (r GetLiveDataByMilestoneResponse) GetJSON200() *GetLiveDataResponse
  • func (r GetLiveDataByMilestoneResponse) Status() string
  • func (r GetLiveDataByMilestoneResponse) StatusCode() int
• type GetLiveDataParams
• type GetLiveDataResponse
• type GetLiveDataResponse2
  • func ParseGetLiveDataResponse2(rsp *http.Response) (*GetLiveDataResponse2, error)
  • func (r GetLiveDataResponse2) ContentType() string
  • func (r GetLiveDataResponse2) GetBody() []byte
  • func (r GetLiveDataResponse2) GetJSON200() *GetLiveDataResponse
  • func (r GetLiveDataResponse2) Status() string
  • func (r GetLiveDataResponse2) StatusCode() int
• type GetLiveDatasParams
• type GetLiveDatasResponse
• type GetLiveDatasResponse2
  • func ParseGetLiveDatasResponse2(rsp *http.Response) (*GetLiveDatasResponse2, error)
  • func (r GetLiveDatasResponse2) ContentType() string
  • func (r GetLiveDatasResponse2) GetBody() []byte
  • func (r GetLiveDatasResponse2) GetJSON200() *GetLiveDatasResponse
  • func (r GetLiveDatasResponse2) Status() string
  • func (r GetLiveDatasResponse2) StatusCode() int
• type GetMarketCandlesticksByEventParams
• type GetMarketCandlesticksByEventParamsPeriodInterval
  • func (e GetMarketCandlesticksByEventParamsPeriodInterval) Valid() bool
• type GetMarketCandlesticksByEventResponse
  • func ParseGetMarketCandlesticksByEventResponse(rsp *http.Response) (*GetMarketCandlesticksByEventResponse, error)
  • func (r GetMarketCandlesticksByEventResponse) ContentType() string
  • func (r GetMarketCandlesticksByEventResponse) GetBody() []byte
  • func (r GetMarketCandlesticksByEventResponse) GetJSON200() *GetEventCandlesticksResponse
  • func (r GetMarketCandlesticksByEventResponse) Status() string
  • func (r GetMarketCandlesticksByEventResponse) StatusCode() int
• type GetMarketCandlesticksHistoricalParams
• type GetMarketCandlesticksHistoricalParamsPeriodInterval
  • func (e GetMarketCandlesticksHistoricalParamsPeriodInterval) Valid() bool
• type GetMarketCandlesticksHistoricalResponse
• type GetMarketCandlesticksHistoricalResponse2
  • func ParseGetMarketCandlesticksHistoricalResponse2(rsp *http.Response) (*GetMarketCandlesticksHistoricalResponse2, error)
  • func (r GetMarketCandlesticksHistoricalResponse2) ContentType() string
  • func (r GetMarketCandlesticksHistoricalResponse2) GetBody() []byte
  • func (r GetMarketCandlesticksHistoricalResponse2) GetJSON200() *GetMarketCandlesticksHistoricalResponse
  • func (r GetMarketCandlesticksHistoricalResponse2) Status() string
  • func (r GetMarketCandlesticksHistoricalResponse2) StatusCode() int
• type GetMarketCandlesticksParams
• type GetMarketCandlesticksParamsPeriodInterval
  • func (e GetMarketCandlesticksParamsPeriodInterval) Valid() bool
• type GetMarketCandlesticksResponse
• type GetMarketCandlesticksResponse2
  • func ParseGetMarketCandlesticksResponse2(rsp *http.Response) (*GetMarketCandlesticksResponse2, error)
  • func (r GetMarketCandlesticksResponse2) ContentType() string
  • func (r GetMarketCandlesticksResponse2) GetBody() []byte
  • func (r GetMarketCandlesticksResponse2) GetJSON200() *GetMarketCandlesticksResponse
  • func (r GetMarketCandlesticksResponse2) Status() string
  • func (r GetMarketCandlesticksResponse2) StatusCode() int
• type GetMarketOrderbookParams
• type GetMarketOrderbookResponse
• type GetMarketOrderbookResponse2
  • func ParseGetMarketOrderbookResponse2(rsp *http.Response) (*GetMarketOrderbookResponse2, error)
  • func (r GetMarketOrderbookResponse2) ContentType() string
  • func (r GetMarketOrderbookResponse2) GetBody() []byte
  • func (r GetMarketOrderbookResponse2) GetJSON200() *GetMarketOrderbookResponse
  • func (r GetMarketOrderbookResponse2) GetJSON401() *UnauthorizedError
  • func (r GetMarketOrderbookResponse2) GetJSON404() *NotFoundError
  • func (r GetMarketOrderbookResponse2) GetJSON500() *InternalServerError
  • func (r GetMarketOrderbookResponse2) Status() string
  • func (r GetMarketOrderbookResponse2) StatusCode() int
• type GetMarketOrderbooksParams
• type GetMarketOrderbooksResponse
• type GetMarketOrderbooksResponse2
  • func ParseGetMarketOrderbooksResponse2(rsp *http.Response) (*GetMarketOrderbooksResponse2, error)
  • func (r GetMarketOrderbooksResponse2) ContentType() string
  • func (r GetMarketOrderbooksResponse2) GetBody() []byte
  • func (r GetMarketOrderbooksResponse2) GetJSON200() *GetMarketOrderbooksResponse
  • func (r GetMarketOrderbooksResponse2) GetJSON400() *BadRequestError
  • func (r GetMarketOrderbooksResponse2) GetJSON401() *UnauthorizedError
  • func (r GetMarketOrderbooksResponse2) GetJSON500() *InternalServerError
  • func (r GetMarketOrderbooksResponse2) Status() string
  • func (r GetMarketOrderbooksResponse2) StatusCode() int
• type GetMarketResponse
• type GetMarketResponse2
  • func ParseGetMarketResponse2(rsp *http.Response) (*GetMarketResponse2, error)
  • func (r GetMarketResponse2) ContentType() string
  • func (r GetMarketResponse2) GetBody() []byte
  • func (r GetMarketResponse2) GetJSON200() *GetMarketResponse
  • func (r GetMarketResponse2) Status() string
  • func (r GetMarketResponse2) StatusCode() int
• type GetMarketsParams
• type GetMarketsParamsMveFilter
  • func (e GetMarketsParamsMveFilter) Valid() bool
• type GetMarketsParamsStatus
  • func (e GetMarketsParamsStatus) Valid() bool
• type GetMarketsResponse
• type GetMarketsResponse2
  • func ParseGetMarketsResponse2(rsp *http.Response) (*GetMarketsResponse2, error)
  • func (r GetMarketsResponse2) ContentType() string
  • func (r GetMarketsResponse2) GetBody() []byte
  • func (r GetMarketsResponse2) GetJSON200() *GetMarketsResponse
  • func (r GetMarketsResponse2) Status() string
  • func (r GetMarketsResponse2) StatusCode() int
• type GetMilestoneResponse
• type GetMilestoneResponse2
  • func ParseGetMilestoneResponse2(rsp *http.Response) (*GetMilestoneResponse2, error)
  • func (r GetMilestoneResponse2) ContentType() string
  • func (r GetMilestoneResponse2) GetBody() []byte
  • func (r GetMilestoneResponse2) GetJSON200() *GetMilestoneResponse
  • func (r GetMilestoneResponse2) Status() string
  • func (r GetMilestoneResponse2) StatusCode() int
• type GetMilestonesParams
• type GetMilestonesResponse
• type GetMilestonesResponse2
  • func ParseGetMilestonesResponse2(rsp *http.Response) (*GetMilestonesResponse2, error)
  • func (r GetMilestonesResponse2) ContentType() string
  • func (r GetMilestonesResponse2) GetBody() []byte
  • func (r GetMilestonesResponse2) GetJSON200() *GetMilestonesResponse
  • func (r GetMilestonesResponse2) Status() string
  • func (r GetMilestonesResponse2) StatusCode() int
• type GetMultivariateEventCollectionResponse
• type GetMultivariateEventCollectionResponse2
  • func ParseGetMultivariateEventCollectionResponse2(rsp *http.Response) (*GetMultivariateEventCollectionResponse2, error)
  • func (r GetMultivariateEventCollectionResponse2) ContentType() string
  • func (r GetMultivariateEventCollectionResponse2) GetBody() []byte
  • func (r GetMultivariateEventCollectionResponse2) GetJSON200() *GetMultivariateEventCollectionResponse
  • func (r GetMultivariateEventCollectionResponse2) GetJSON400() *BadRequestError
  • func (r GetMultivariateEventCollectionResponse2) GetJSON404() *NotFoundError
  • func (r GetMultivariateEventCollectionResponse2) GetJSON500() *InternalServerError
  • func (r GetMultivariateEventCollectionResponse2) Status() string
  • func (r GetMultivariateEventCollectionResponse2) StatusCode() int
• type GetMultivariateEventCollectionsParams
• type GetMultivariateEventCollectionsParamsStatus
  • func (e GetMultivariateEventCollectionsParamsStatus) Valid() bool
• type GetMultivariateEventCollectionsResponse
• type GetMultivariateEventCollectionsResponse2
  • func ParseGetMultivariateEventCollectionsResponse2(rsp *http.Response) (*GetMultivariateEventCollectionsResponse2, error)
  • func (r GetMultivariateEventCollectionsResponse2) ContentType() string
  • func (r GetMultivariateEventCollectionsResponse2) GetBody() []byte
  • func (r GetMultivariateEventCollectionsResponse2) GetJSON200() *GetMultivariateEventCollectionsResponse
  • func (r GetMultivariateEventCollectionsResponse2) GetJSON400() *BadRequestError
  • func (r GetMultivariateEventCollectionsResponse2) GetJSON500() *InternalServerError
  • func (r GetMultivariateEventCollectionsResponse2) Status() string
  • func (r GetMultivariateEventCollectionsResponse2) StatusCode() int
• type GetMultivariateEventsParams
• type GetMultivariateEventsResponse
• type GetMultivariateEventsResponse2
  • func ParseGetMultivariateEventsResponse2(rsp *http.Response) (*GetMultivariateEventsResponse2, error)
  • func (r GetMultivariateEventsResponse2) ContentType() string
  • func (r GetMultivariateEventsResponse2) GetBody() []byte
  • func (r GetMultivariateEventsResponse2) GetJSON200() *GetMultivariateEventsResponse
  • func (r GetMultivariateEventsResponse2) Status() string
  • func (r GetMultivariateEventsResponse2) StatusCode() int
• type GetOrderGroupParams
• type GetOrderGroupResponse
• type GetOrderGroupResponse2
  • func ParseGetOrderGroupResponse2(rsp *http.Response) (*GetOrderGroupResponse2, error)
  • func (r GetOrderGroupResponse2) ContentType() string
  • func (r GetOrderGroupResponse2) GetBody() []byte
  • func (r GetOrderGroupResponse2) GetJSON200() *GetOrderGroupResponse
  • func (r GetOrderGroupResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrderGroupResponse2) GetJSON404() *NotFoundError
  • func (r GetOrderGroupResponse2) GetJSON500() *InternalServerError
  • func (r GetOrderGroupResponse2) Status() string
  • func (r GetOrderGroupResponse2) StatusCode() int
• type GetOrderGroupsParams
• type GetOrderGroupsResponse
• type GetOrderGroupsResponse2
  • func ParseGetOrderGroupsResponse2(rsp *http.Response) (*GetOrderGroupsResponse2, error)
  • func (r GetOrderGroupsResponse2) ContentType() string
  • func (r GetOrderGroupsResponse2) GetBody() []byte
  • func (r GetOrderGroupsResponse2) GetJSON200() *GetOrderGroupsResponse
  • func (r GetOrderGroupsResponse2) GetJSON400() *BadRequestError
  • func (r GetOrderGroupsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrderGroupsResponse2) GetJSON500() *InternalServerError
  • func (r GetOrderGroupsResponse2) Status() string
  • func (r GetOrderGroupsResponse2) StatusCode() int
• type GetOrderQueuePositionResponse
• type GetOrderQueuePositionResponse2
  • func ParseGetOrderQueuePositionResponse2(rsp *http.Response) (*GetOrderQueuePositionResponse2, error)
  • func (r GetOrderQueuePositionResponse2) ContentType() string
  • func (r GetOrderQueuePositionResponse2) GetBody() []byte
  • func (r GetOrderQueuePositionResponse2) GetJSON200() *GetOrderQueuePositionResponse
  • func (r GetOrderQueuePositionResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrderQueuePositionResponse2) GetJSON404() *NotFoundError
  • func (r GetOrderQueuePositionResponse2) GetJSON500() *InternalServerError
  • func (r GetOrderQueuePositionResponse2) Status() string
  • func (r GetOrderQueuePositionResponse2) StatusCode() int
• type GetOrderQueuePositionsParams
• type GetOrderQueuePositionsResponse
• type GetOrderQueuePositionsResponse2
  • func ParseGetOrderQueuePositionsResponse2(rsp *http.Response) (*GetOrderQueuePositionsResponse2, error)
  • func (r GetOrderQueuePositionsResponse2) ContentType() string
  • func (r GetOrderQueuePositionsResponse2) GetBody() []byte
  • func (r GetOrderQueuePositionsResponse2) GetJSON200() *GetOrderQueuePositionsResponse
  • func (r GetOrderQueuePositionsResponse2) GetJSON400() *BadRequestError
  • func (r GetOrderQueuePositionsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrderQueuePositionsResponse2) GetJSON500() *InternalServerError
  • func (r GetOrderQueuePositionsResponse2) Status() string
  • func (r GetOrderQueuePositionsResponse2) StatusCode() int
• type GetOrderResponse
• type GetOrderResponse2
  • func ParseGetOrderResponse2(rsp *http.Response) (*GetOrderResponse2, error)
  • func (r GetOrderResponse2) ContentType() string
  • func (r GetOrderResponse2) GetBody() []byte
  • func (r GetOrderResponse2) GetJSON200() *GetOrderResponse
  • func (r GetOrderResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrderResponse2) GetJSON404() *NotFoundError
  • func (r GetOrderResponse2) GetJSON500() *InternalServerError
  • func (r GetOrderResponse2) Status() string
  • func (r GetOrderResponse2) StatusCode() int
• type GetOrdersParams
• type GetOrdersResponse
• type GetOrdersResponse2
  • func ParseGetOrdersResponse2(rsp *http.Response) (*GetOrdersResponse2, error)
  • func (r GetOrdersResponse2) ContentType() string
  • func (r GetOrdersResponse2) GetBody() []byte
  • func (r GetOrdersResponse2) GetJSON200() *GetOrdersResponse
  • func (r GetOrdersResponse2) GetJSON400() *BadRequestError
  • func (r GetOrdersResponse2) GetJSON401() *UnauthorizedError
  • func (r GetOrdersResponse2) GetJSON500() *InternalServerError
  • func (r GetOrdersResponse2) Status() string
  • func (r GetOrdersResponse2) StatusCode() int
• type GetPortfolioRestingOrderTotalValueResponse
• type GetPortfolioRestingOrderTotalValueResponse2
  • func ParseGetPortfolioRestingOrderTotalValueResponse2(rsp *http.Response) (*GetPortfolioRestingOrderTotalValueResponse2, error)
  • func (r GetPortfolioRestingOrderTotalValueResponse2) ContentType() string
  • func (r GetPortfolioRestingOrderTotalValueResponse2) GetBody() []byte
  • func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON200() *GetPortfolioRestingOrderTotalValueResponse
  • func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON401() *UnauthorizedError
  • func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON500() *InternalServerError
  • func (r GetPortfolioRestingOrderTotalValueResponse2) Status() string
  • func (r GetPortfolioRestingOrderTotalValueResponse2) StatusCode() int
• type GetPositionsParams
• type GetPositionsParamsSettlementStatus
  • func (e GetPositionsParamsSettlementStatus) Valid() bool
• type GetPositionsResponse
• type GetPositionsResponse2
  • func ParseGetPositionsResponse2(rsp *http.Response) (*GetPositionsResponse2, error)
  • func (r GetPositionsResponse2) ContentType() string
  • func (r GetPositionsResponse2) GetBody() []byte
  • func (r GetPositionsResponse2) GetJSON200() *GetPositionsResponse
  • func (r GetPositionsResponse2) GetJSON400() *BadRequestError
  • func (r GetPositionsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetPositionsResponse2) GetJSON500() *InternalServerError
  • func (r GetPositionsResponse2) Status() string
  • func (r GetPositionsResponse2) StatusCode() int
• type GetQuoteResponse
• type GetQuoteResponse2
  • func ParseGetQuoteResponse2(rsp *http.Response) (*GetQuoteResponse2, error)
  • func (r GetQuoteResponse2) ContentType() string
  • func (r GetQuoteResponse2) GetBody() []byte
  • func (r GetQuoteResponse2) GetJSON200() *GetQuoteResponse
  • func (r GetQuoteResponse2) GetJSON400() *BadRequestError
  • func (r GetQuoteResponse2) GetJSON401() *UnauthorizedError
  • func (r GetQuoteResponse2) GetJSON404() *NotFoundError
  • func (r GetQuoteResponse2) GetJSON500() *InternalServerError
  • func (r GetQuoteResponse2) Status() string
  • func (r GetQuoteResponse2) StatusCode() int
• type GetQuotesParams
• type GetQuotesResponse
• type GetQuotesResponse2
  • func ParseGetQuotesResponse2(rsp *http.Response) (*GetQuotesResponse2, error)
  • func (r GetQuotesResponse2) ContentType() string
  • func (r GetQuotesResponse2) GetBody() []byte
  • func (r GetQuotesResponse2) GetJSON200() *GetQuotesResponse
  • func (r GetQuotesResponse2) GetJSON400() *BadRequestError
  • func (r GetQuotesResponse2) GetJSON401() *UnauthorizedError
  • func (r GetQuotesResponse2) GetJSON500() *InternalServerError
  • func (r GetQuotesResponse2) Status() string
  • func (r GetQuotesResponse2) StatusCode() int
• type GetRFQQuoteResponse
  • func ParseGetRFQQuoteResponse(rsp *http.Response) (*GetRFQQuoteResponse, error)
  • func (r GetRFQQuoteResponse) ContentType() string
  • func (r GetRFQQuoteResponse) GetBody() []byte
  • func (r GetRFQQuoteResponse) GetJSON200() *GetQuoteResponse
  • func (r GetRFQQuoteResponse) GetJSON400() *BadRequestError
  • func (r GetRFQQuoteResponse) GetJSON401() *UnauthorizedError
  • func (r GetRFQQuoteResponse) GetJSON404() *NotFoundError
  • func (r GetRFQQuoteResponse) GetJSON500() *InternalServerError
  • func (r GetRFQQuoteResponse) Status() string
  • func (r GetRFQQuoteResponse) StatusCode() int
• type GetRFQResponse
• type GetRFQResponse2
  • func ParseGetRFQResponse2(rsp *http.Response) (*GetRFQResponse2, error)
  • func (r GetRFQResponse2) ContentType() string
  • func (r GetRFQResponse2) GetBody() []byte
  • func (r GetRFQResponse2) GetJSON200() *GetRFQResponse
  • func (r GetRFQResponse2) GetJSON400() *BadRequestError
  • func (r GetRFQResponse2) GetJSON401() *UnauthorizedError
  • func (r GetRFQResponse2) GetJSON404() *NotFoundError
  • func (r GetRFQResponse2) GetJSON500() *InternalServerError
  • func (r GetRFQResponse2) Status() string
  • func (r GetRFQResponse2) StatusCode() int
• type GetRFQsParams
• type GetRFQsResponse
• type GetRFQsResponse2
  • func ParseGetRFQsResponse2(rsp *http.Response) (*GetRFQsResponse2, error)
  • func (r GetRFQsResponse2) ContentType() string
  • func (r GetRFQsResponse2) GetBody() []byte
  • func (r GetRFQsResponse2) GetJSON200() *GetRFQsResponse
  • func (r GetRFQsResponse2) GetJSON400() *BadRequestError
  • func (r GetRFQsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetRFQsResponse2) GetJSON500() *InternalServerError
  • func (r GetRFQsResponse2) Status() string
  • func (r GetRFQsResponse2) StatusCode() int
• type GetSeriesFeeChangesParams
• type GetSeriesFeeChangesResponse
• type GetSeriesFeeChangesResponse2
  • func ParseGetSeriesFeeChangesResponse2(rsp *http.Response) (*GetSeriesFeeChangesResponse2, error)
  • func (r GetSeriesFeeChangesResponse2) ContentType() string
  • func (r GetSeriesFeeChangesResponse2) GetBody() []byte
  • func (r GetSeriesFeeChangesResponse2) GetJSON200() *GetSeriesFeeChangesResponse
  • func (r GetSeriesFeeChangesResponse2) GetJSON400() *BadRequestError
  • func (r GetSeriesFeeChangesResponse2) GetJSON500() *InternalServerError
  • func (r GetSeriesFeeChangesResponse2) Status() string
  • func (r GetSeriesFeeChangesResponse2) StatusCode() int
• type GetSeriesListParams
• type GetSeriesListResponse
• type GetSeriesListResponse2
  • func ParseGetSeriesListResponse2(rsp *http.Response) (*GetSeriesListResponse2, error)
  • func (r GetSeriesListResponse2) ContentType() string
  • func (r GetSeriesListResponse2) GetBody() []byte
  • func (r GetSeriesListResponse2) GetJSON200() *GetSeriesListResponse
  • func (r GetSeriesListResponse2) GetJSON400() *BadRequestError
  • func (r GetSeriesListResponse2) GetJSON500() *InternalServerError
  • func (r GetSeriesListResponse2) Status() string
  • func (r GetSeriesListResponse2) StatusCode() int
• type GetSeriesParams
• type GetSeriesResponse
• type GetSeriesResponse2
  • func ParseGetSeriesResponse2(rsp *http.Response) (*GetSeriesResponse2, error)
  • func (r GetSeriesResponse2) ContentType() string
  • func (r GetSeriesResponse2) GetBody() []byte
  • func (r GetSeriesResponse2) GetJSON200() *GetSeriesResponse
  • func (r GetSeriesResponse2) GetJSON400() *BadRequestError
  • func (r GetSeriesResponse2) GetJSON500() *InternalServerError
  • func (r GetSeriesResponse2) Status() string
  • func (r GetSeriesResponse2) StatusCode() int
• type GetSettlementsParams
• type GetSettlementsResponse
• type GetSettlementsResponse2
  • func ParseGetSettlementsResponse2(rsp *http.Response) (*GetSettlementsResponse2, error)
  • func (r GetSettlementsResponse2) ContentType() string
  • func (r GetSettlementsResponse2) GetBody() []byte
  • func (r GetSettlementsResponse2) GetJSON200() *GetSettlementsResponse
  • func (r GetSettlementsResponse2) GetJSON400() *BadRequestError
  • func (r GetSettlementsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetSettlementsResponse2) GetJSON500() *InternalServerError
  • func (r GetSettlementsResponse2) Status() string
  • func (r GetSettlementsResponse2) StatusCode() int
• type GetStructuredTargetResponse
• type GetStructuredTargetResponse2
  • func ParseGetStructuredTargetResponse2(rsp *http.Response) (*GetStructuredTargetResponse2, error)
  • func (r GetStructuredTargetResponse2) ContentType() string
  • func (r GetStructuredTargetResponse2) GetBody() []byte
  • func (r GetStructuredTargetResponse2) GetJSON200() *GetStructuredTargetResponse
  • func (r GetStructuredTargetResponse2) Status() string
  • func (r GetStructuredTargetResponse2) StatusCode() int
• type GetStructuredTargetsParams
• type GetStructuredTargetsResponse
• type GetStructuredTargetsResponse2
  • func ParseGetStructuredTargetsResponse2(rsp *http.Response) (*GetStructuredTargetsResponse2, error)
  • func (r GetStructuredTargetsResponse2) ContentType() string
  • func (r GetStructuredTargetsResponse2) GetBody() []byte
  • func (r GetStructuredTargetsResponse2) GetJSON200() *GetStructuredTargetsResponse
  • func (r GetStructuredTargetsResponse2) Status() string
  • func (r GetStructuredTargetsResponse2) StatusCode() int
• type GetSubaccountBalancesResponse
• type GetSubaccountBalancesResponse2
  • func ParseGetSubaccountBalancesResponse2(rsp *http.Response) (*GetSubaccountBalancesResponse2, error)
  • func (r GetSubaccountBalancesResponse2) ContentType() string
  • func (r GetSubaccountBalancesResponse2) GetBody() []byte
  • func (r GetSubaccountBalancesResponse2) GetJSON200() *GetSubaccountBalancesResponse
  • func (r GetSubaccountBalancesResponse2) GetJSON401() *UnauthorizedError
  • func (r GetSubaccountBalancesResponse2) GetJSON500() *InternalServerError
  • func (r GetSubaccountBalancesResponse2) Status() string
  • func (r GetSubaccountBalancesResponse2) StatusCode() int
• type GetSubaccountNettingResponse
• type GetSubaccountNettingResponse2
  • func ParseGetSubaccountNettingResponse2(rsp *http.Response) (*GetSubaccountNettingResponse2, error)
  • func (r GetSubaccountNettingResponse2) ContentType() string
  • func (r GetSubaccountNettingResponse2) GetBody() []byte
  • func (r GetSubaccountNettingResponse2) GetJSON200() *GetSubaccountNettingResponse
  • func (r GetSubaccountNettingResponse2) GetJSON401() *UnauthorizedError
  • func (r GetSubaccountNettingResponse2) GetJSON500() *InternalServerError
  • func (r GetSubaccountNettingResponse2) Status() string
  • func (r GetSubaccountNettingResponse2) StatusCode() int
• type GetSubaccountTransfersParams
• type GetSubaccountTransfersResponse
• type GetSubaccountTransfersResponse2
  • func ParseGetSubaccountTransfersResponse2(rsp *http.Response) (*GetSubaccountTransfersResponse2, error)
  • func (r GetSubaccountTransfersResponse2) ContentType() string
  • func (r GetSubaccountTransfersResponse2) GetBody() []byte
  • func (r GetSubaccountTransfersResponse2) GetJSON200() *GetSubaccountTransfersResponse
  • func (r GetSubaccountTransfersResponse2) GetJSON401() *UnauthorizedError
  • func (r GetSubaccountTransfersResponse2) GetJSON500() *InternalServerError
  • func (r GetSubaccountTransfersResponse2) Status() string
  • func (r GetSubaccountTransfersResponse2) StatusCode() int
• type GetTagsForSeriesCategoriesResponse
• type GetTagsForSeriesCategoriesResponse2
  • func ParseGetTagsForSeriesCategoriesResponse2(rsp *http.Response) (*GetTagsForSeriesCategoriesResponse2, error)
  • func (r GetTagsForSeriesCategoriesResponse2) ContentType() string
  • func (r GetTagsForSeriesCategoriesResponse2) GetBody() []byte
  • func (r GetTagsForSeriesCategoriesResponse2) GetJSON200() *GetTagsForSeriesCategoriesResponse
  • func (r GetTagsForSeriesCategoriesResponse2) Status() string
  • func (r GetTagsForSeriesCategoriesResponse2) StatusCode() int
• type GetTargetBalanceAllocationResponse
• type GetTargetBalanceAllocationResponse2
  • func ParseGetTargetBalanceAllocationResponse2(rsp *http.Response) (*GetTargetBalanceAllocationResponse2, error)
  • func (r GetTargetBalanceAllocationResponse2) ContentType() string
  • func (r GetTargetBalanceAllocationResponse2) GetBody() []byte
  • func (r GetTargetBalanceAllocationResponse2) GetJSON200() *GetTargetBalanceAllocationResponse
  • func (r GetTargetBalanceAllocationResponse2) GetJSON401() *UnauthorizedError
  • func (r GetTargetBalanceAllocationResponse2) GetJSON403() *ForbiddenError
  • func (r GetTargetBalanceAllocationResponse2) GetJSON500() *InternalServerError
  • func (r GetTargetBalanceAllocationResponse2) Status() string
  • func (r GetTargetBalanceAllocationResponse2) StatusCode() int
• type GetTradesHistoricalParams
• type GetTradesHistoricalResponse
  • func ParseGetTradesHistoricalResponse(rsp *http.Response) (*GetTradesHistoricalResponse, error)
  • func (r GetTradesHistoricalResponse) ContentType() string
  • func (r GetTradesHistoricalResponse) GetBody() []byte
  • func (r GetTradesHistoricalResponse) GetJSON200() *GetTradesResponse
  • func (r GetTradesHistoricalResponse) GetJSON400() *BadRequestError
  • func (r GetTradesHistoricalResponse) GetJSON404() *NotFoundError
  • func (r GetTradesHistoricalResponse) GetJSON500() *InternalServerError
  • func (r GetTradesHistoricalResponse) Status() string
  • func (r GetTradesHistoricalResponse) StatusCode() int
• type GetTradesParams
• type GetTradesResponse
• type GetTradesResponse2
  • func ParseGetTradesResponse2(rsp *http.Response) (*GetTradesResponse2, error)
  • func (r GetTradesResponse2) ContentType() string
  • func (r GetTradesResponse2) GetBody() []byte
  • func (r GetTradesResponse2) GetJSON200() *GetTradesResponse
  • func (r GetTradesResponse2) Status() string
  • func (r GetTradesResponse2) StatusCode() int
• type GetUserDataTimestampResponse
• type GetUserDataTimestampResponse2
  • func ParseGetUserDataTimestampResponse2(rsp *http.Response) (*GetUserDataTimestampResponse2, error)
  • func (r GetUserDataTimestampResponse2) ContentType() string
  • func (r GetUserDataTimestampResponse2) GetBody() []byte
  • func (r GetUserDataTimestampResponse2) GetJSON200() *GetUserDataTimestampResponse
  • func (r GetUserDataTimestampResponse2) Status() string
  • func (r GetUserDataTimestampResponse2) StatusCode() int
• type GetWeatherIndexCalibrationsResponse
• type GetWeatherIndexCalibrationsResponse2
  • func ParseGetWeatherIndexCalibrationsResponse2(rsp *http.Response) (*GetWeatherIndexCalibrationsResponse2, error)
  • func (r GetWeatherIndexCalibrationsResponse2) ContentType() string
  • func (r GetWeatherIndexCalibrationsResponse2) GetBody() []byte
  • func (r GetWeatherIndexCalibrationsResponse2) GetJSON200() *GetWeatherIndexCalibrationsResponse
  • func (r GetWeatherIndexCalibrationsResponse2) Status() string
  • func (r GetWeatherIndexCalibrationsResponse2) StatusCode() int
• type GetWeatherIndexParams
• type GetWeatherIndexResponse
• type GetWeatherIndexResponse2
  • func ParseGetWeatherIndexResponse2(rsp *http.Response) (*GetWeatherIndexResponse2, error)
  • func (r GetWeatherIndexResponse2) ContentType() string
  • func (r GetWeatherIndexResponse2) GetBody() []byte
  • func (r GetWeatherIndexResponse2) GetJSON200() *GetWeatherIndexResponse
  • func (r GetWeatherIndexResponse2) Status() string
  • func (r GetWeatherIndexResponse2) StatusCode() int
• type GetWithdrawalsParams
• type GetWithdrawalsResponse
• type GetWithdrawalsResponse2
  • func ParseGetWithdrawalsResponse2(rsp *http.Response) (*GetWithdrawalsResponse2, error)
  • func (r GetWithdrawalsResponse2) ContentType() string
  • func (r GetWithdrawalsResponse2) GetBody() []byte
  • func (r GetWithdrawalsResponse2) GetJSON200() *GetWithdrawalsResponse
  • func (r GetWithdrawalsResponse2) GetJSON400() *BadRequestError
  • func (r GetWithdrawalsResponse2) GetJSON401() *UnauthorizedError
  • func (r GetWithdrawalsResponse2) GetJSON500() *InternalServerError
  • func (r GetWithdrawalsResponse2) Status() string
  • func (r GetWithdrawalsResponse2) StatusCode() int
• type HttpRequestDoer
• type IncentiveProgram
• type IncentiveProgramIncentiveType
  • func (e IncentiveProgramIncentiveType) Valid() bool
• type IndexedBalance
• type InternalServerError
• type IntraExchangeInstanceTransfer
• type IntraExchangeInstanceTransferJSONRequestBody
• type IntraExchangeInstanceTransferRequest
• type IntraExchangeInstanceTransferResponse
• type IntraExchangeInstanceTransferResponse2
  • func ParseIntraExchangeInstanceTransferResponse2(rsp *http.Response) (*IntraExchangeInstanceTransferResponse2, error)
  • func (r IntraExchangeInstanceTransferResponse2) ContentType() string
  • func (r IntraExchangeInstanceTransferResponse2) GetBody() []byte
  • func (r IntraExchangeInstanceTransferResponse2) GetJSON200() *IntraExchangeInstanceTransferResponse
  • func (r IntraExchangeInstanceTransferResponse2) GetJSON400() *BadRequestError
  • func (r IntraExchangeInstanceTransferResponse2) GetJSON401() *UnauthorizedError
  • func (r IntraExchangeInstanceTransferResponse2) GetJSON403() *ForbiddenError
  • func (r IntraExchangeInstanceTransferResponse2) GetJSON500() *InternalServerError
  • func (r IntraExchangeInstanceTransferResponse2) Status() string
  • func (r IntraExchangeInstanceTransferResponse2) StatusCode() int
• type IntraExchangeInstanceTransferStatus
  • func (e IntraExchangeInstanceTransferStatus) Valid() bool
• type IsBlockTradeQuery
• type LimitQuery
• type ListFCMSubtradersResponse
• type ListFCMSubtradersResponse2
  • func ParseListFCMSubtradersResponse2(rsp *http.Response) (*ListFCMSubtradersResponse2, error)
  • func (r ListFCMSubtradersResponse2) ContentType() string
  • func (r ListFCMSubtradersResponse2) GetBody() []byte
  • func (r ListFCMSubtradersResponse2) GetJSON200() *ListFCMSubtradersResponse
  • func (r ListFCMSubtradersResponse2) GetJSON401() *UnauthorizedError
  • func (r ListFCMSubtradersResponse2) GetJSON403() *ForbiddenError
  • func (r ListFCMSubtradersResponse2) GetJSON500() *InternalServerError
  • func (r ListFCMSubtradersResponse2) Status() string
  • func (r ListFCMSubtradersResponse2) StatusCode() int
• type LiveData
• type MaintenanceWindow
• type Market
• type MarketCandlestick
• type MarketCandlestickHistorical
• type MarketCandlesticksResponse
• type MarketLimitQuery
• type MarketMarketType
  • func (e MarketMarketType) Valid() bool
• type MarketMetadata
• type MarketOrderbookFp
• type MarketPosition
• type MarketResult
  • func (e MarketResult) Valid() bool
• type MarketSettlementBoundsType
  • func (e MarketSettlementBoundsType) Valid() bool
• type MarketStatus
  • func (e MarketStatus) Valid() bool
• type MarketStatusQuery
  • func (e MarketStatusQuery) Valid() bool
• type MarketStrikeType
  • func (e MarketStrikeType) Valid() bool
• type MarketTickerQuery
• type MaxCloseTsQuery
• type MaxCreatedTsQuery
• type MaxSettledTsQuery
• type MaxTsQuery
• type MaxUpdatedTsQuery
• type Milestone
• type MinCloseTsQuery
• type MinCreatedTsQuery
• type MinSettledTsQuery
• type MinTsQuery
• type MinUpdatedTsQuery
• type MultipleEventTickerQuery
• type MultivariateEventCollection
• type MveFilterQuery
  • func (e MveFilterQuery) Valid() bool
• type MveHistoricalFilterQuery
  • func (e MveHistoricalFilterQuery) Valid() bool
• type MveSelectedLeg
• type NotFoundError
• type Order
• type OrderAction
  • func (e OrderAction) Valid() bool
• type OrderGroup
• type OrderGroupIdPath
• type OrderIdPath
• type OrderIdQuery
• type OrderOutcomeSide
  • func (e OrderOutcomeSide) Valid() bool
• type OrderQueuePosition
• type OrderSide
  • func (e OrderSide) Valid() bool
• type OrderStatus
  • func (e OrderStatus) Valid() bool
• type OrderType
  • func (e OrderType) Valid() bool
• type OrderbookCountFp
• type OutcomeSide
  • func (e OutcomeSide) Valid() bool
• type PercentilePoint
• type PlayByPlay
• type PositionSettlementStatusQuery
  • func (e PositionSettlementStatusQuery) Valid() bool
• type PositionsCursorQuery
• type PositionsLimitQuery
• type PriceDistribution
• type PriceDistributionHistorical
• type PriceLevelDollarsCountFp
• type PriceRange
• type ProposeBlockTradeJSONRequestBody
• type ProposeBlockTradeRequest
• type ProposeBlockTradeRequestMakerSide
  • func (e ProposeBlockTradeRequestMakerSide) Valid() bool
• type ProposeBlockTradeResponse
• type ProposeBlockTradeResponse2
  • func ParseProposeBlockTradeResponse2(rsp *http.Response) (*ProposeBlockTradeResponse2, error)
  • func (r ProposeBlockTradeResponse2) ContentType() string
  • func (r ProposeBlockTradeResponse2) GetBody() []byte
  • func (r ProposeBlockTradeResponse2) GetJSON201() *ProposeBlockTradeResponse
  • func (r ProposeBlockTradeResponse2) GetJSON400() *BadRequestError
  • func (r ProposeBlockTradeResponse2) GetJSON401() *UnauthorizedError
  • func (r ProposeBlockTradeResponse2) GetJSON403() *ForbiddenError
  • func (r ProposeBlockTradeResponse2) GetJSON500() *InternalServerError
  • func (r ProposeBlockTradeResponse2) Status() string
  • func (r ProposeBlockTradeResponse2) StatusCode() int
• type Quote
• type QuoteAcceptedSide
  • func (e QuoteAcceptedSide) Valid() bool
• type QuoteIdPath
• type QuoteStatus
  • func (e QuoteStatus) Valid() bool
• type RFQ
• type RFQStatus
  • func (e RFQStatus) Valid() bool
• type RateLimitError
• type RequestEditorFn
• type ResetOrderGroupJSONRequestBody
• type ResetOrderGroupParams
• type ResetOrderGroupResponse
  • func ParseResetOrderGroupResponse(rsp *http.Response) (*ResetOrderGroupResponse, error)
  • func (r ResetOrderGroupResponse) ContentType() string
  • func (r ResetOrderGroupResponse) GetBody() []byte
  • func (r ResetOrderGroupResponse) GetJSON200() *EmptyResponse
  • func (r ResetOrderGroupResponse) GetJSON401() *UnauthorizedError
  • func (r ResetOrderGroupResponse) GetJSON404() *NotFoundError
  • func (r ResetOrderGroupResponse) GetJSON500() *InternalServerError
  • func (r ResetOrderGroupResponse) Status() string
  • func (r ResetOrderGroupResponse) StatusCode() int
• type RestingMarginReservation
  • func (e RestingMarginReservation) Valid() bool
• type RfqIdPath
• type Schedule
• type ScopeList
• type SelfTradePreventionType
  • func (e SelfTradePreventionType) Valid() bool
• type Series
• type SeriesFeeChange
• type SeriesTickerQuery
• type ServiceUnavailableError
• type SetTargetBalanceAllocationJSONRequestBody
• type SetTargetBalanceAllocationRequest
• type SetTargetBalanceAllocationResponse
  • func ParseSetTargetBalanceAllocationResponse(rsp *http.Response) (*SetTargetBalanceAllocationResponse, error)
  • func (r SetTargetBalanceAllocationResponse) ContentType() string
  • func (r SetTargetBalanceAllocationResponse) GetBody() []byte
  • func (r SetTargetBalanceAllocationResponse) GetJSON200() *EmptyResponse
  • func (r SetTargetBalanceAllocationResponse) GetJSON400() *BadRequestError
  • func (r SetTargetBalanceAllocationResponse) GetJSON401() *UnauthorizedError
  • func (r SetTargetBalanceAllocationResponse) GetJSON403() *ForbiddenError
  • func (r SetTargetBalanceAllocationResponse) GetJSON500() *InternalServerError
  • func (r SetTargetBalanceAllocationResponse) Status() string
  • func (r SetTargetBalanceAllocationResponse) StatusCode() int
• type Settlement
• type SettlementMarketResult
  • func (e SettlementMarketResult) Valid() bool
• type SettlementSource
• type SingleEventTickerQuery
• type SportFilterDetails
• type StatusQuery
• type StructuredTarget
• type SubaccountBalance
• type SubaccountNettingConfig
• type SubaccountQuery
• type SubaccountQueryDefaultPrimary
• type SubaccountTransfer
• type TargetBalanceAllocation
• type TargetBalanceAllocationInput
• type TickerPair
• type TickerPairSide
  • func (e TickerPairSide) Valid() bool
• type TickerPath
• type TickerQuery
• type TickersQuery
• type Trade
• type TradeTakerOutcomeSide
  • func (e TradeTakerOutcomeSide) Valid() bool
• type TradeTakerSide
  • func (e TradeTakerSide) Valid() bool
• type TransfersLimitQuery
• type TriggerOrderGroupJSONRequestBody
• type TriggerOrderGroupParams
• type TriggerOrderGroupResponse
  • func ParseTriggerOrderGroupResponse(rsp *http.Response) (*TriggerOrderGroupResponse, error)
  • func (r TriggerOrderGroupResponse) ContentType() string
  • func (r TriggerOrderGroupResponse) GetBody() []byte
  • func (r TriggerOrderGroupResponse) GetJSON200() *EmptyResponse
  • func (r TriggerOrderGroupResponse) GetJSON401() *UnauthorizedError
  • func (r TriggerOrderGroupResponse) GetJSON404() *NotFoundError
  • func (r TriggerOrderGroupResponse) GetJSON500() *InternalServerError
  • func (r TriggerOrderGroupResponse) Status() string
  • func (r TriggerOrderGroupResponse) StatusCode() int
• type UnauthorizedError
• type UpdateFCMEventContractDailyCapJSONRequestBody
• type UpdateFCMEventContractDailyCapRequest
• type UpdateFCMEventContractDailyCapResponse
  • func ParseUpdateFCMEventContractDailyCapResponse(rsp *http.Response) (*UpdateFCMEventContractDailyCapResponse, error)
  • func (r UpdateFCMEventContractDailyCapResponse) ContentType() string
  • func (r UpdateFCMEventContractDailyCapResponse) GetBody() []byte
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON200() *EmptyResponse
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON400() *BadRequestError
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON401() *UnauthorizedError
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON403() *ForbiddenError
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON404() *NotFoundError
  • func (r UpdateFCMEventContractDailyCapResponse) GetJSON500() *InternalServerError
  • func (r UpdateFCMEventContractDailyCapResponse) Status() string
  • func (r UpdateFCMEventContractDailyCapResponse) StatusCode() int
• type UpdateFCMSubtraderBlockedCategoriesJSONRequestBody
• type UpdateFCMSubtraderBlockedCategoriesRequest
• type UpdateFCMSubtraderBlockedCategoriesResponse
• type UpdateFCMSubtraderBlockedCategoriesResponse2
  • func ParseUpdateFCMSubtraderBlockedCategoriesResponse2(rsp *http.Response) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) ContentType() string
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetBody() []byte
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON200() *UpdateFCMSubtraderBlockedCategoriesResponse
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON400() *BadRequestError
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON401() *UnauthorizedError
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON403() *ForbiddenError
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON404() *NotFoundError
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON500() *InternalServerError
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) Status() string
  • func (r UpdateFCMSubtraderBlockedCategoriesResponse2) StatusCode() int
• type UpdateOrderGroupLimitJSONRequestBody
• type UpdateOrderGroupLimitParams
• type UpdateOrderGroupLimitRequest
• type UpdateOrderGroupLimitResponse
  • func ParseUpdateOrderGroupLimitResponse(rsp *http.Response) (*UpdateOrderGroupLimitResponse, error)
  • func (r UpdateOrderGroupLimitResponse) ContentType() string
  • func (r UpdateOrderGroupLimitResponse) GetBody() []byte
  • func (r UpdateOrderGroupLimitResponse) GetJSON200() *EmptyResponse
  • func (r UpdateOrderGroupLimitResponse) GetJSON400() *BadRequestError
  • func (r UpdateOrderGroupLimitResponse) GetJSON401() *UnauthorizedError
  • func (r UpdateOrderGroupLimitResponse) GetJSON404() *NotFoundError
  • func (r UpdateOrderGroupLimitResponse) GetJSON500() *InternalServerError
  • func (r UpdateOrderGroupLimitResponse) Status() string
  • func (r UpdateOrderGroupLimitResponse) StatusCode() int
• type UpdateSubaccountNettingJSONRequestBody
• type UpdateSubaccountNettingRequest
• type UpdateSubaccountNettingResponse
  • func ParseUpdateSubaccountNettingResponse(rsp *http.Response) (*UpdateSubaccountNettingResponse, error)
  • func (r UpdateSubaccountNettingResponse) ContentType() string
  • func (r UpdateSubaccountNettingResponse) GetBody() []byte
  • func (r UpdateSubaccountNettingResponse) GetJSON400() *BadRequestError
  • func (r UpdateSubaccountNettingResponse) GetJSON401() *UnauthorizedError
  • func (r UpdateSubaccountNettingResponse) GetJSON500() *InternalServerError
  • func (r UpdateSubaccountNettingResponse) Status() string
  • func (r UpdateSubaccountNettingResponse) StatusCode() int
• type UpgradeAccountApiUsageLevelResponse
  • func ParseUpgradeAccountApiUsageLevelResponse(rsp *http.Response) (*UpgradeAccountApiUsageLevelResponse, error)
  • func (r UpgradeAccountApiUsageLevelResponse) ContentType() string
  • func (r UpgradeAccountApiUsageLevelResponse) GetBody() []byte
  • func (r UpgradeAccountApiUsageLevelResponse) Status() string
  • func (r UpgradeAccountApiUsageLevelResponse) StatusCode() int
• type UserFilter
  • func (e UserFilter) Valid() bool
• type WeatherIndexCalibration
• type WeatherIndexCalibrationStation
• type WeatherIndexPoint
• type WeatherIndexStationReading
• type WeeklySchedule
• type Withdrawal
• type WithdrawalLimitQuery
• type WithdrawalStatus
  • func (e WithdrawalStatus) Valid() bool
• type WithdrawalType
  • func (e WithdrawalType) Valid() bool

Functions

func NewAcceptBlockTradeProposalRequest

func NewAcceptBlockTradeProposalRequest(server string, blockTradeProposalId string, body AcceptBlockTradeProposalJSONRequestBody) (*http.Request, error)

NewAcceptBlockTradeProposalRequest calls the generic AcceptBlockTradeProposal builder with application/json body

func NewAcceptBlockTradeProposalRequestWithBody

func NewAcceptBlockTradeProposalRequestWithBody(server string, blockTradeProposalId string, contentType string, body io.Reader) (*http.Request, error)

NewAcceptBlockTradeProposalRequestWithBody constructs an http.Request for the AcceptBlockTradeProposal method, with any body, and a specified content type

func NewAcceptQuoteRequest

func NewAcceptQuoteRequest(server string, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody) (*http.Request, error)

NewAcceptQuoteRequest calls the generic AcceptQuote builder with application/json body

func NewAcceptQuoteRequestWithBody

func NewAcceptQuoteRequestWithBody(server string, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)

NewAcceptQuoteRequestWithBody constructs an http.Request for the AcceptQuote method, with any body, and a specified content type

func NewAcceptRFQQuoteRequest

func NewAcceptRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath, body AcceptRFQQuoteJSONRequestBody) (*http.Request, error)

NewAcceptRFQQuoteRequest calls the generic AcceptRFQQuote builder with application/json body

func NewAcceptRFQQuoteRequestWithBody

func NewAcceptRFQQuoteRequestWithBody(server string, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)

NewAcceptRFQQuoteRequestWithBody constructs an http.Request for the AcceptRFQQuote method, with any body, and a specified content type

func NewAmendOrderV2Request

func NewAmendOrderV2Request(server string, orderId OrderIdPath, params *AmendOrderV2Params, body AmendOrderV2JSONRequestBody) (*http.Request, error)

NewAmendOrderV2Request calls the generic AmendOrderV2 builder with application/json body

func NewAmendOrderV2RequestWithBody

func NewAmendOrderV2RequestWithBody(server string, orderId OrderIdPath, params *AmendOrderV2Params, contentType string, body io.Reader) (*http.Request, error)

NewAmendOrderV2RequestWithBody constructs an http.Request for the AmendOrderV2 method, with any body, and a specified content type

func NewApplySubaccountTransferRequest

func NewApplySubaccountTransferRequest(server string, body ApplySubaccountTransferJSONRequestBody) (*http.Request, error)

NewApplySubaccountTransferRequest calls the generic ApplySubaccountTransfer builder with application/json body

func NewApplySubaccountTransferRequestWithBody

func NewApplySubaccountTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewApplySubaccountTransferRequestWithBody constructs an http.Request for the ApplySubaccountTransfer method, with any body, and a specified content type

func NewBatchCancelOrdersV2Request

func NewBatchCancelOrdersV2Request(server string, body BatchCancelOrdersV2JSONRequestBody) (*http.Request, error)

NewBatchCancelOrdersV2Request calls the generic BatchCancelOrdersV2 builder with application/json body

func NewBatchCancelOrdersV2RequestWithBody

func NewBatchCancelOrdersV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBatchCancelOrdersV2RequestWithBody constructs an http.Request for the BatchCancelOrdersV2 method, with any body, and a specified content type

func NewBatchCreateOrdersV2Request

func NewBatchCreateOrdersV2Request(server string, body BatchCreateOrdersV2JSONRequestBody) (*http.Request, error)

NewBatchCreateOrdersV2Request calls the generic BatchCreateOrdersV2 builder with application/json body

func NewBatchCreateOrdersV2RequestWithBody

func NewBatchCreateOrdersV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBatchCreateOrdersV2RequestWithBody constructs an http.Request for the BatchCreateOrdersV2 method, with any body, and a specified content type

func NewBatchGetMarketCandlesticksRequest

func NewBatchGetMarketCandlesticksRequest(server string, params *BatchGetMarketCandlesticksParams) (*http.Request, error)

NewBatchGetMarketCandlesticksRequest constructs an http.Request for the BatchGetMarketCandlesticks method

func NewCancelAllOrdersRequest

func NewCancelAllOrdersRequest(server string, params *CancelAllOrdersParams) (*http.Request, error)

NewCancelAllOrdersRequest constructs an http.Request for the CancelAllOrders method

func NewCancelOrderV2Request

func NewCancelOrderV2Request(server string, orderId OrderIdPath, params *CancelOrderV2Params) (*http.Request, error)

NewCancelOrderV2Request constructs an http.Request for the CancelOrderV2 method

func NewConfirmQuoteRequest

func NewConfirmQuoteRequest(server string, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody) (*http.Request, error)

NewConfirmQuoteRequest calls the generic ConfirmQuote builder with application/json body

func NewConfirmQuoteRequestWithBody

func NewConfirmQuoteRequestWithBody(server string, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)

NewConfirmQuoteRequestWithBody constructs an http.Request for the ConfirmQuote method, with any body, and a specified content type

func NewConfirmRFQQuoteRequest

func NewConfirmRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath, body ConfirmRFQQuoteJSONRequestBody) (*http.Request, error)

NewConfirmRFQQuoteRequest calls the generic ConfirmRFQQuote builder with application/json body

func NewConfirmRFQQuoteRequestWithBody

func NewConfirmRFQQuoteRequestWithBody(server string, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader) (*http.Request, error)

NewConfirmRFQQuoteRequestWithBody constructs an http.Request for the ConfirmRFQQuote method, with any body, and a specified content type

func NewCreateApiKeyRequest

func NewCreateApiKeyRequest(server string, body CreateApiKeyJSONRequestBody) (*http.Request, error)

NewCreateApiKeyRequest calls the generic CreateApiKey builder with application/json body

func NewCreateApiKeyRequestWithBody

func NewCreateApiKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateApiKeyRequestWithBody constructs an http.Request for the CreateApiKey method, with any body, and a specified content type

func NewCreateFCMPositionTransferRequest

func NewCreateFCMPositionTransferRequest(server string, body CreateFCMPositionTransferJSONRequestBody) (*http.Request, error)

NewCreateFCMPositionTransferRequest calls the generic CreateFCMPositionTransfer builder with application/json body

func NewCreateFCMPositionTransferRequestWithBody

func NewCreateFCMPositionTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateFCMPositionTransferRequestWithBody constructs an http.Request for the CreateFCMPositionTransfer method, with any body, and a specified content type

func NewCreateFCMSubtraderRequest

func NewCreateFCMSubtraderRequest(server string, body CreateFCMSubtraderJSONRequestBody) (*http.Request, error)

NewCreateFCMSubtraderRequest calls the generic CreateFCMSubtrader builder with application/json body

func NewCreateFCMSubtraderRequestWithBody

func NewCreateFCMSubtraderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateFCMSubtraderRequestWithBody constructs an http.Request for the CreateFCMSubtrader method, with any body, and a specified content type

func NewCreateMarketInMultivariateEventCollectionRequest

func NewCreateMarketInMultivariateEventCollectionRequest(server string, collectionTicker string, body CreateMarketInMultivariateEventCollectionJSONRequestBody) (*http.Request, error)

NewCreateMarketInMultivariateEventCollectionRequest calls the generic CreateMarketInMultivariateEventCollection builder with application/json body

func NewCreateMarketInMultivariateEventCollectionRequestWithBody

func NewCreateMarketInMultivariateEventCollectionRequestWithBody(server string, collectionTicker string, contentType string, body io.Reader) (*http.Request, error)

NewCreateMarketInMultivariateEventCollectionRequestWithBody constructs an http.Request for the CreateMarketInMultivariateEventCollection method, with any body, and a specified content type

func NewCreateOrderGroupRequest

func NewCreateOrderGroupRequest(server string, body CreateOrderGroupJSONRequestBody) (*http.Request, error)

NewCreateOrderGroupRequest calls the generic CreateOrderGroup builder with application/json body

func NewCreateOrderGroupRequestWithBody

func NewCreateOrderGroupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrderGroupRequestWithBody constructs an http.Request for the CreateOrderGroup method, with any body, and a specified content type

func NewCreateOrderV2Request

func NewCreateOrderV2Request(server string, body CreateOrderV2JSONRequestBody) (*http.Request, error)

NewCreateOrderV2Request calls the generic CreateOrderV2 builder with application/json body

func NewCreateOrderV2RequestWithBody

func NewCreateOrderV2RequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrderV2RequestWithBody constructs an http.Request for the CreateOrderV2 method, with any body, and a specified content type

func NewCreateQuoteRequest

func NewCreateQuoteRequest(server string, body CreateQuoteJSONRequestBody) (*http.Request, error)

NewCreateQuoteRequest calls the generic CreateQuote builder with application/json body

func NewCreateQuoteRequestWithBody

func NewCreateQuoteRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateQuoteRequestWithBody constructs an http.Request for the CreateQuote method, with any body, and a specified content type

func NewCreateRFQRequest

func NewCreateRFQRequest(server string, body CreateRFQJSONRequestBody) (*http.Request, error)

NewCreateRFQRequest calls the generic CreateRFQ builder with application/json body

func NewCreateRFQRequestWithBody

func NewCreateRFQRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRFQRequestWithBody constructs an http.Request for the CreateRFQ method, with any body, and a specified content type

func NewCreateSubaccountRequest

func NewCreateSubaccountRequest(server string, body CreateSubaccountJSONRequestBody) (*http.Request, error)

NewCreateSubaccountRequest calls the generic CreateSubaccount builder with application/json body

func NewCreateSubaccountRequestWithBody

func NewCreateSubaccountRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateSubaccountRequestWithBody constructs an http.Request for the CreateSubaccount method, with any body, and a specified content type

func NewDecreaseOrderV2Request

func NewDecreaseOrderV2Request(server string, orderId OrderIdPath, params *DecreaseOrderV2Params, body DecreaseOrderV2JSONRequestBody) (*http.Request, error)

NewDecreaseOrderV2Request calls the generic DecreaseOrderV2 builder with application/json body

func NewDecreaseOrderV2RequestWithBody

func NewDecreaseOrderV2RequestWithBody(server string, orderId OrderIdPath, params *DecreaseOrderV2Params, contentType string, body io.Reader) (*http.Request, error)

NewDecreaseOrderV2RequestWithBody constructs an http.Request for the DecreaseOrderV2 method, with any body, and a specified content type

func NewDeleteApiKeyRequest

func NewDeleteApiKeyRequest(server string, apiKey string) (*http.Request, error)

NewDeleteApiKeyRequest constructs an http.Request for the DeleteApiKey method

func NewDeleteFCMEventContractDailyCapRequest

func NewDeleteFCMEventContractDailyCapRequest(server string, params *DeleteFCMEventContractDailyCapParams) (*http.Request, error)

NewDeleteFCMEventContractDailyCapRequest constructs an http.Request for the DeleteFCMEventContractDailyCap method

func NewDeleteOrderGroupRequest

func NewDeleteOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams) (*http.Request, error)

NewDeleteOrderGroupRequest constructs an http.Request for the DeleteOrderGroup method

func NewDeleteQuoteRequest

func NewDeleteQuoteRequest(server string, quoteId QuoteIdPath) (*http.Request, error)

NewDeleteQuoteRequest constructs an http.Request for the DeleteQuote method

func NewDeleteRFQQuoteRequest

func NewDeleteRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath) (*http.Request, error)

NewDeleteRFQQuoteRequest constructs an http.Request for the DeleteRFQQuote method

func NewDeleteRFQRequest

func NewDeleteRFQRequest(server string, rfqId RfqIdPath) (*http.Request, error)

NewDeleteRFQRequest constructs an http.Request for the DeleteRFQ method

func NewGenerateApiKeyRequest

func NewGenerateApiKeyRequest(server string, body GenerateApiKeyJSONRequestBody) (*http.Request, error)

NewGenerateApiKeyRequest calls the generic GenerateApiKey builder with application/json body

func NewGenerateApiKeyRequestWithBody

func NewGenerateApiKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewGenerateApiKeyRequestWithBody constructs an http.Request for the GenerateApiKey method, with any body, and a specified content type

func NewGetAccountApiLimitsRequest

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

NewGetAccountApiLimitsRequest constructs an http.Request for the GetAccountApiLimits method

func NewGetAccountApiUsageLevelVolumeProgressRequest

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

NewGetAccountApiUsageLevelVolumeProgressRequest constructs an http.Request for the GetAccountApiUsageLevelVolumeProgress method

func NewGetAccountEndpointCostsRequest

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

NewGetAccountEndpointCostsRequest constructs an http.Request for the GetAccountEndpointCosts method

func NewGetApiKeysRequest

func NewGetApiKeysRequest(server string, params *GetApiKeysParams) (*http.Request, error)

NewGetApiKeysRequest constructs an http.Request for the GetApiKeys method

func NewGetBalanceRequest

func NewGetBalanceRequest(server string, params *GetBalanceParams) (*http.Request, error)

NewGetBalanceRequest constructs an http.Request for the GetBalance method

func NewGetBlockTradeProposalsRequest

func NewGetBlockTradeProposalsRequest(server string, params *GetBlockTradeProposalsParams) (*http.Request, error)

NewGetBlockTradeProposalsRequest constructs an http.Request for the GetBlockTradeProposals method

func NewGetCommunicationsIDRequest

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

NewGetCommunicationsIDRequest constructs an http.Request for the GetCommunicationsID method

func NewGetDepositsRequest

func NewGetDepositsRequest(server string, params *GetDepositsParams) (*http.Request, error)

NewGetDepositsRequest constructs an http.Request for the GetDeposits method

func NewGetEventFeeChangesRequest

func NewGetEventFeeChangesRequest(server string, params *GetEventFeeChangesParams) (*http.Request, error)

NewGetEventFeeChangesRequest constructs an http.Request for the GetEventFeeChanges method

func NewGetEventForecastPercentilesHistoryRequest

func NewGetEventForecastPercentilesHistoryRequest(server string, seriesTicker string, ticker string, params *GetEventForecastPercentilesHistoryParams) (*http.Request, error)

NewGetEventForecastPercentilesHistoryRequest constructs an http.Request for the GetEventForecastPercentilesHistory method

func NewGetEventLiveDataRequest

func NewGetEventLiveDataRequest(server string, eventTicker string, params *GetEventLiveDataParams) (*http.Request, error)

NewGetEventLiveDataRequest constructs an http.Request for the GetEventLiveData method

func NewGetEventMetadataRequest

func NewGetEventMetadataRequest(server string, eventTicker string) (*http.Request, error)

NewGetEventMetadataRequest constructs an http.Request for the GetEventMetadata method

func NewGetEventRequest

func NewGetEventRequest(server string, eventTicker string, params *GetEventParams) (*http.Request, error)

NewGetEventRequest constructs an http.Request for the GetEvent method

func NewGetEventsRequest

func NewGetEventsRequest(server string, params *GetEventsParams) (*http.Request, error)

NewGetEventsRequest constructs an http.Request for the GetEvents method

func NewGetExchangeScheduleRequest

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

NewGetExchangeScheduleRequest constructs an http.Request for the GetExchangeSchedule method

func NewGetExchangeStatusRequest

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

NewGetExchangeStatusRequest constructs an http.Request for the GetExchangeStatus method

func NewGetFCMEventContractDailyCapRequest

func NewGetFCMEventContractDailyCapRequest(server string, params *GetFCMEventContractDailyCapParams) (*http.Request, error)

NewGetFCMEventContractDailyCapRequest constructs an http.Request for the GetFCMEventContractDailyCap method

func NewGetFCMFillsRequest

func NewGetFCMFillsRequest(server string, params *GetFCMFillsParams) (*http.Request, error)

NewGetFCMFillsRequest constructs an http.Request for the GetFCMFills method

func NewGetFCMOrdersRequest

func NewGetFCMOrdersRequest(server string, params *GetFCMOrdersParams) (*http.Request, error)

NewGetFCMOrdersRequest constructs an http.Request for the GetFCMOrders method

func NewGetFCMPositionsRequest

func NewGetFCMPositionsRequest(server string, params *GetFCMPositionsParams) (*http.Request, error)

NewGetFCMPositionsRequest constructs an http.Request for the GetFCMPositions method

func NewGetFCMSubtraderBlockedCategoriesRequest

func NewGetFCMSubtraderBlockedCategoriesRequest(server string, params *GetFCMSubtraderBlockedCategoriesParams) (*http.Request, error)

NewGetFCMSubtraderBlockedCategoriesRequest constructs an http.Request for the GetFCMSubtraderBlockedCategories method

func NewGetFillsHistoricalRequest

func NewGetFillsHistoricalRequest(server string, params *GetFillsHistoricalParams) (*http.Request, error)

NewGetFillsHistoricalRequest constructs an http.Request for the GetFillsHistorical method

func NewGetFillsRequest

func NewGetFillsRequest(server string, params *GetFillsParams) (*http.Request, error)

NewGetFillsRequest constructs an http.Request for the GetFills method

func NewGetFiltersForSportsRequest

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

NewGetFiltersForSportsRequest constructs an http.Request for the GetFiltersForSports method

func NewGetGameStatsRequest

func NewGetGameStatsRequest(server string, milestoneId string) (*http.Request, error)

NewGetGameStatsRequest constructs an http.Request for the GetGameStats method

func NewGetHistoricalCutoffRequest

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

NewGetHistoricalCutoffRequest constructs an http.Request for the GetHistoricalCutoff method

func NewGetHistoricalMarketRequest

func NewGetHistoricalMarketRequest(server string, ticker TickerPath) (*http.Request, error)

NewGetHistoricalMarketRequest constructs an http.Request for the GetHistoricalMarket method

func NewGetHistoricalMarketsRequest

func NewGetHistoricalMarketsRequest(server string, params *GetHistoricalMarketsParams) (*http.Request, error)

NewGetHistoricalMarketsRequest constructs an http.Request for the GetHistoricalMarkets method

func NewGetHistoricalOrdersRequest

func NewGetHistoricalOrdersRequest(server string, params *GetHistoricalOrdersParams) (*http.Request, error)

NewGetHistoricalOrdersRequest constructs an http.Request for the GetHistoricalOrders method

func NewGetHistoricalPositionsRequest

func NewGetHistoricalPositionsRequest(server string, params *GetHistoricalPositionsParams) (*http.Request, error)

NewGetHistoricalPositionsRequest constructs an http.Request for the GetHistoricalPositions method

func NewGetIncentiveProgramsRequest

func NewGetIncentiveProgramsRequest(server string, params *GetIncentiveProgramsParams) (*http.Request, error)

NewGetIncentiveProgramsRequest constructs an http.Request for the GetIncentivePrograms method

func NewGetIntraExchangeInstanceTransferRequest

func NewGetIntraExchangeInstanceTransferRequest(server string, transferId string) (*http.Request, error)

NewGetIntraExchangeInstanceTransferRequest constructs an http.Request for the GetIntraExchangeInstanceTransfer method

func NewGetIntraExchangeInstanceTransfersRequest

func NewGetIntraExchangeInstanceTransfersRequest(server string, params *GetIntraExchangeInstanceTransfersParams) (*http.Request, error)

NewGetIntraExchangeInstanceTransfersRequest constructs an http.Request for the GetIntraExchangeInstanceTransfers method

func NewGetLiveDataByMilestoneRequest

func NewGetLiveDataByMilestoneRequest(server string, milestoneId string, params *GetLiveDataByMilestoneParams) (*http.Request, error)

NewGetLiveDataByMilestoneRequest constructs an http.Request for the GetLiveDataByMilestone method

func NewGetLiveDataRequest

func NewGetLiveDataRequest(server string, pType string, milestoneId string, params *GetLiveDataParams) (*http.Request, error)

NewGetLiveDataRequest constructs an http.Request for the GetLiveData method

func NewGetLiveDatasRequest

func NewGetLiveDatasRequest(server string, params *GetLiveDatasParams) (*http.Request, error)

NewGetLiveDatasRequest constructs an http.Request for the GetLiveDatas method

func NewGetMarketCandlesticksByEventRequest

func NewGetMarketCandlesticksByEventRequest(server string, seriesTicker string, ticker string, params *GetMarketCandlesticksByEventParams) (*http.Request, error)

NewGetMarketCandlesticksByEventRequest constructs an http.Request for the GetMarketCandlesticksByEvent method

func NewGetMarketCandlesticksHistoricalRequest

func NewGetMarketCandlesticksHistoricalRequest(server string, ticker string, params *GetMarketCandlesticksHistoricalParams) (*http.Request, error)

NewGetMarketCandlesticksHistoricalRequest constructs an http.Request for the GetMarketCandlesticksHistorical method

func NewGetMarketCandlesticksRequest

func NewGetMarketCandlesticksRequest(server string, seriesTicker string, ticker string, params *GetMarketCandlesticksParams) (*http.Request, error)

NewGetMarketCandlesticksRequest constructs an http.Request for the GetMarketCandlesticks method

func NewGetMarketOrderbookRequest

func NewGetMarketOrderbookRequest(server string, ticker TickerPath, params *GetMarketOrderbookParams) (*http.Request, error)

NewGetMarketOrderbookRequest constructs an http.Request for the GetMarketOrderbook method

func NewGetMarketOrderbooksRequest

func NewGetMarketOrderbooksRequest(server string, params *GetMarketOrderbooksParams) (*http.Request, error)

NewGetMarketOrderbooksRequest constructs an http.Request for the GetMarketOrderbooks method

func NewGetMarketRequest

func NewGetMarketRequest(server string, ticker TickerPath) (*http.Request, error)

NewGetMarketRequest constructs an http.Request for the GetMarket method

func NewGetMarketsRequest

func NewGetMarketsRequest(server string, params *GetMarketsParams) (*http.Request, error)

NewGetMarketsRequest constructs an http.Request for the GetMarkets method

func NewGetMilestoneRequest

func NewGetMilestoneRequest(server string, milestoneId string) (*http.Request, error)

NewGetMilestoneRequest constructs an http.Request for the GetMilestone method

func NewGetMilestonesRequest

func NewGetMilestonesRequest(server string, params *GetMilestonesParams) (*http.Request, error)

NewGetMilestonesRequest constructs an http.Request for the GetMilestones method

func NewGetMultivariateEventCollectionRequest

func NewGetMultivariateEventCollectionRequest(server string, collectionTicker string) (*http.Request, error)

NewGetMultivariateEventCollectionRequest constructs an http.Request for the GetMultivariateEventCollection method

func NewGetMultivariateEventCollectionsRequest

func NewGetMultivariateEventCollectionsRequest(server string, params *GetMultivariateEventCollectionsParams) (*http.Request, error)

NewGetMultivariateEventCollectionsRequest constructs an http.Request for the GetMultivariateEventCollections method

func NewGetMultivariateEventsRequest

func NewGetMultivariateEventsRequest(server string, params *GetMultivariateEventsParams) (*http.Request, error)

NewGetMultivariateEventsRequest constructs an http.Request for the GetMultivariateEvents method

func NewGetOrderGroupRequest

func NewGetOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams) (*http.Request, error)

NewGetOrderGroupRequest constructs an http.Request for the GetOrderGroup method

func NewGetOrderGroupsRequest

func NewGetOrderGroupsRequest(server string, params *GetOrderGroupsParams) (*http.Request, error)

NewGetOrderGroupsRequest constructs an http.Request for the GetOrderGroups method

func NewGetOrderQueuePositionRequest

func NewGetOrderQueuePositionRequest(server string, orderId OrderIdPath) (*http.Request, error)

NewGetOrderQueuePositionRequest constructs an http.Request for the GetOrderQueuePosition method

func NewGetOrderQueuePositionsRequest

func NewGetOrderQueuePositionsRequest(server string, params *GetOrderQueuePositionsParams) (*http.Request, error)

NewGetOrderQueuePositionsRequest constructs an http.Request for the GetOrderQueuePositions method

func NewGetOrderRequest

func NewGetOrderRequest(server string, orderId OrderIdPath) (*http.Request, error)

NewGetOrderRequest constructs an http.Request for the GetOrder method

func NewGetOrdersRequest

func NewGetOrdersRequest(server string, params *GetOrdersParams) (*http.Request, error)

NewGetOrdersRequest constructs an http.Request for the GetOrders method

func NewGetPortfolioRestingOrderTotalValueRequest

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

NewGetPortfolioRestingOrderTotalValueRequest constructs an http.Request for the GetPortfolioRestingOrderTotalValue method

func NewGetPositionsRequest

func NewGetPositionsRequest(server string, params *GetPositionsParams) (*http.Request, error)

NewGetPositionsRequest constructs an http.Request for the GetPositions method

func NewGetQuoteRequest

func NewGetQuoteRequest(server string, quoteId QuoteIdPath) (*http.Request, error)

NewGetQuoteRequest constructs an http.Request for the GetQuote method

func NewGetQuotesRequest

func NewGetQuotesRequest(server string, params *GetQuotesParams) (*http.Request, error)

NewGetQuotesRequest constructs an http.Request for the GetQuotes method

func NewGetRFQQuoteRequest

func NewGetRFQQuoteRequest(server string, rfqId RfqIdPath, quoteId QuoteIdPath) (*http.Request, error)

NewGetRFQQuoteRequest constructs an http.Request for the GetRFQQuote method

func NewGetRFQRequest

func NewGetRFQRequest(server string, rfqId RfqIdPath) (*http.Request, error)

NewGetRFQRequest constructs an http.Request for the GetRFQ method

func NewGetRFQsRequest

func NewGetRFQsRequest(server string, params *GetRFQsParams) (*http.Request, error)

NewGetRFQsRequest constructs an http.Request for the GetRFQs method

func NewGetSeriesFeeChangesRequest

func NewGetSeriesFeeChangesRequest(server string, params *GetSeriesFeeChangesParams) (*http.Request, error)

NewGetSeriesFeeChangesRequest constructs an http.Request for the GetSeriesFeeChanges method

func NewGetSeriesListRequest

func NewGetSeriesListRequest(server string, params *GetSeriesListParams) (*http.Request, error)

NewGetSeriesListRequest constructs an http.Request for the GetSeriesList method

func NewGetSeriesRequest

func NewGetSeriesRequest(server string, seriesTicker string, params *GetSeriesParams) (*http.Request, error)

NewGetSeriesRequest constructs an http.Request for the GetSeries method

func NewGetSettlementsRequest

func NewGetSettlementsRequest(server string, params *GetSettlementsParams) (*http.Request, error)

NewGetSettlementsRequest constructs an http.Request for the GetSettlements method

func NewGetStructuredTargetRequest

func NewGetStructuredTargetRequest(server string, structuredTargetId string) (*http.Request, error)

NewGetStructuredTargetRequest constructs an http.Request for the GetStructuredTarget method

func NewGetStructuredTargetsRequest

func NewGetStructuredTargetsRequest(server string, params *GetStructuredTargetsParams) (*http.Request, error)

NewGetStructuredTargetsRequest constructs an http.Request for the GetStructuredTargets method

func NewGetSubaccountBalancesRequest

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

NewGetSubaccountBalancesRequest constructs an http.Request for the GetSubaccountBalances method

func NewGetSubaccountNettingRequest

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

NewGetSubaccountNettingRequest constructs an http.Request for the GetSubaccountNetting method

func NewGetSubaccountTransfersRequest

func NewGetSubaccountTransfersRequest(server string, params *GetSubaccountTransfersParams) (*http.Request, error)

NewGetSubaccountTransfersRequest constructs an http.Request for the GetSubaccountTransfers method

func NewGetTagsForSeriesCategoriesRequest

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

NewGetTagsForSeriesCategoriesRequest constructs an http.Request for the GetTagsForSeriesCategories method

func NewGetTargetBalanceAllocationRequest

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

NewGetTargetBalanceAllocationRequest constructs an http.Request for the GetTargetBalanceAllocation method

func NewGetTradesHistoricalRequest

func NewGetTradesHistoricalRequest(server string, params *GetTradesHistoricalParams) (*http.Request, error)

NewGetTradesHistoricalRequest constructs an http.Request for the GetTradesHistorical method

func NewGetTradesRequest

func NewGetTradesRequest(server string, params *GetTradesParams) (*http.Request, error)

NewGetTradesRequest constructs an http.Request for the GetTrades method

func NewGetUserDataTimestampRequest

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

NewGetUserDataTimestampRequest constructs an http.Request for the GetUserDataTimestamp method

func NewGetWeatherIndexCalibrationsRequest

func NewGetWeatherIndexCalibrationsRequest(server string, city string) (*http.Request, error)

NewGetWeatherIndexCalibrationsRequest constructs an http.Request for the GetWeatherIndexCalibrations method

func NewGetWeatherIndexRequest

func NewGetWeatherIndexRequest(server string, city string, params *GetWeatherIndexParams) (*http.Request, error)

NewGetWeatherIndexRequest constructs an http.Request for the GetWeatherIndex method

func NewGetWithdrawalsRequest

func NewGetWithdrawalsRequest(server string, params *GetWithdrawalsParams) (*http.Request, error)

NewGetWithdrawalsRequest constructs an http.Request for the GetWithdrawals method

func NewIntraExchangeInstanceTransferRequest

func NewIntraExchangeInstanceTransferRequest(server string, body IntraExchangeInstanceTransferJSONRequestBody) (*http.Request, error)

NewIntraExchangeInstanceTransferRequest calls the generic IntraExchangeInstanceTransfer builder with application/json body

func NewIntraExchangeInstanceTransferRequestWithBody

func NewIntraExchangeInstanceTransferRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewIntraExchangeInstanceTransferRequestWithBody constructs an http.Request for the IntraExchangeInstanceTransfer method, with any body, and a specified content type

func NewListFCMSubtradersRequest

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

NewListFCMSubtradersRequest constructs an http.Request for the ListFCMSubtraders method

func NewProposeBlockTradeRequest

func NewProposeBlockTradeRequest(server string, body ProposeBlockTradeJSONRequestBody) (*http.Request, error)

NewProposeBlockTradeRequest calls the generic ProposeBlockTrade builder with application/json body

func NewProposeBlockTradeRequestWithBody

func NewProposeBlockTradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewProposeBlockTradeRequestWithBody constructs an http.Request for the ProposeBlockTrade method, with any body, and a specified content type

func NewResetOrderGroupRequest

func NewResetOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, body ResetOrderGroupJSONRequestBody) (*http.Request, error)

NewResetOrderGroupRequest calls the generic ResetOrderGroup builder with application/json body

func NewResetOrderGroupRequestWithBody

func NewResetOrderGroupRequestWithBody(server string, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, contentType string, body io.Reader) (*http.Request, error)

NewResetOrderGroupRequestWithBody constructs an http.Request for the ResetOrderGroup method, with any body, and a specified content type

func NewSetTargetBalanceAllocationRequest

func NewSetTargetBalanceAllocationRequest(server string, body SetTargetBalanceAllocationJSONRequestBody) (*http.Request, error)

NewSetTargetBalanceAllocationRequest calls the generic SetTargetBalanceAllocation builder with application/json body

func NewSetTargetBalanceAllocationRequestWithBody

func NewSetTargetBalanceAllocationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSetTargetBalanceAllocationRequestWithBody constructs an http.Request for the SetTargetBalanceAllocation method, with any body, and a specified content type

func NewTriggerOrderGroupRequest

func NewTriggerOrderGroupRequest(server string, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, body TriggerOrderGroupJSONRequestBody) (*http.Request, error)

NewTriggerOrderGroupRequest calls the generic TriggerOrderGroup builder with application/json body

func NewTriggerOrderGroupRequestWithBody

func NewTriggerOrderGroupRequestWithBody(server string, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, contentType string, body io.Reader) (*http.Request, error)

NewTriggerOrderGroupRequestWithBody constructs an http.Request for the TriggerOrderGroup method, with any body, and a specified content type

func NewUpdateFCMEventContractDailyCapRequest

func NewUpdateFCMEventContractDailyCapRequest(server string, body UpdateFCMEventContractDailyCapJSONRequestBody) (*http.Request, error)

NewUpdateFCMEventContractDailyCapRequest calls the generic UpdateFCMEventContractDailyCap builder with application/json body

func NewUpdateFCMEventContractDailyCapRequestWithBody

func NewUpdateFCMEventContractDailyCapRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateFCMEventContractDailyCapRequestWithBody constructs an http.Request for the UpdateFCMEventContractDailyCap method, with any body, and a specified content type

func NewUpdateFCMSubtraderBlockedCategoriesRequest

func NewUpdateFCMSubtraderBlockedCategoriesRequest(server string, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody) (*http.Request, error)

NewUpdateFCMSubtraderBlockedCategoriesRequest calls the generic UpdateFCMSubtraderBlockedCategories builder with application/json body

func NewUpdateFCMSubtraderBlockedCategoriesRequestWithBody

func NewUpdateFCMSubtraderBlockedCategoriesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateFCMSubtraderBlockedCategoriesRequestWithBody constructs an http.Request for the UpdateFCMSubtraderBlockedCategories method, with any body, and a specified content type

func NewUpdateOrderGroupLimitRequest

func NewUpdateOrderGroupLimitRequest(server string, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, body UpdateOrderGroupLimitJSONRequestBody) (*http.Request, error)

NewUpdateOrderGroupLimitRequest calls the generic UpdateOrderGroupLimit builder with application/json body

func NewUpdateOrderGroupLimitRequestWithBody

func NewUpdateOrderGroupLimitRequestWithBody(server string, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateOrderGroupLimitRequestWithBody constructs an http.Request for the UpdateOrderGroupLimit method, with any body, and a specified content type

func NewUpdateSubaccountNettingRequest

func NewUpdateSubaccountNettingRequest(server string, body UpdateSubaccountNettingJSONRequestBody) (*http.Request, error)

NewUpdateSubaccountNettingRequest calls the generic UpdateSubaccountNetting builder with application/json body

func NewUpdateSubaccountNettingRequestWithBody

func NewUpdateSubaccountNettingRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSubaccountNettingRequestWithBody constructs an http.Request for the UpdateSubaccountNetting method, with any body, and a specified content type

func NewUpgradeAccountApiUsageLevelRequest

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

NewUpgradeAccountApiUsageLevelRequest constructs an http.Request for the UpgradeAccountApiUsageLevel method

Types

type AcceptBlockTradeProposalJSONRequestBody

type AcceptBlockTradeProposalJSONRequestBody = AcceptBlockTradeProposalRequest

AcceptBlockTradeProposalJSONRequestBody defines body for AcceptBlockTradeProposal for application/json ContentType.

type AcceptBlockTradeProposalRequest

type AcceptBlockTradeProposalRequest struct {
	// Subaccount User-managed subaccount number to accept as (0 for primary, 1-63 for numbered subaccounts). Provide either this or subtrader_id, not both.
	Subaccount *int `json:"subaccount,omitempty"`

	// SubtraderId Subtrader ID to accept as. Provide either this or subaccount, not both.
	SubtraderId string `json:"subtrader_id,omitempty"`
}

AcceptBlockTradeProposalRequest defines model for AcceptBlockTradeProposalRequest.

type AcceptBlockTradeProposalResponse

type AcceptBlockTradeProposalResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseAcceptBlockTradeProposalResponse

func ParseAcceptBlockTradeProposalResponse(rsp *http.Response) (*AcceptBlockTradeProposalResponse, error)

ParseAcceptBlockTradeProposalResponse parses an HTTP response from a AcceptBlockTradeProposalWithResponse call

func (AcceptBlockTradeProposalResponse) ContentType

func (r AcceptBlockTradeProposalResponse) ContentType() string

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

func (AcceptBlockTradeProposalResponse) GetBody

func (r AcceptBlockTradeProposalResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AcceptBlockTradeProposalResponse) GetJSON400

func (r AcceptBlockTradeProposalResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AcceptBlockTradeProposalResponse) GetJSON401

func (r AcceptBlockTradeProposalResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AcceptBlockTradeProposalResponse) GetJSON404

func (r AcceptBlockTradeProposalResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AcceptBlockTradeProposalResponse) GetJSON500

func (r AcceptBlockTradeProposalResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (AcceptBlockTradeProposalResponse) Status

func (r AcceptBlockTradeProposalResponse) Status() string

Status returns HTTPResponse.Status

func (AcceptBlockTradeProposalResponse) StatusCode

func (r AcceptBlockTradeProposalResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AcceptQuoteJSONRequestBody

type AcceptQuoteJSONRequestBody = AcceptQuoteRequest

AcceptQuoteJSONRequestBody defines body for AcceptQuote for application/json ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type AcceptQuoteRequest

type AcceptQuoteRequest struct {
	// AcceptedSide The side of the quote to accept (yes or no)
	AcceptedSide AcceptQuoteRequestAcceptedSide `json:"accepted_side"`
}

AcceptQuoteRequest defines model for AcceptQuoteRequest.

type AcceptQuoteRequestAcceptedSide

type AcceptQuoteRequestAcceptedSide string

AcceptQuoteRequestAcceptedSide The side of the quote to accept (yes or no)

const (
	AcceptQuoteRequestAcceptedSideNo  AcceptQuoteRequestAcceptedSide = "no"
	AcceptQuoteRequestAcceptedSideYes AcceptQuoteRequestAcceptedSide = "yes"
)

Defines values for AcceptQuoteRequestAcceptedSide.

func (AcceptQuoteRequestAcceptedSide) Valid

func (e AcceptQuoteRequestAcceptedSide) Valid() bool

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

type AcceptQuoteResponse

type AcceptQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseAcceptQuoteResponse

func ParseAcceptQuoteResponse(rsp *http.Response) (*AcceptQuoteResponse, error)

ParseAcceptQuoteResponse parses an HTTP response from a AcceptQuoteWithResponse call

func (AcceptQuoteResponse) ContentType

func (r AcceptQuoteResponse) ContentType() string

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

func (AcceptQuoteResponse) GetBody

func (r AcceptQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AcceptQuoteResponse) GetJSON400

func (r AcceptQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AcceptQuoteResponse) GetJSON401

func (r AcceptQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AcceptQuoteResponse) GetJSON404

func (r AcceptQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AcceptQuoteResponse) GetJSON500

func (r AcceptQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (AcceptQuoteResponse) Status

func (r AcceptQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (AcceptQuoteResponse) StatusCode

func (r AcceptQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AcceptRFQQuoteJSONRequestBody

type AcceptRFQQuoteJSONRequestBody = AcceptQuoteRequest

AcceptRFQQuoteJSONRequestBody defines body for AcceptRFQQuote for application/json ContentType.

type AcceptRFQQuoteResponse

type AcceptRFQQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseAcceptRFQQuoteResponse

func ParseAcceptRFQQuoteResponse(rsp *http.Response) (*AcceptRFQQuoteResponse, error)

ParseAcceptRFQQuoteResponse parses an HTTP response from a AcceptRFQQuoteWithResponse call

func (AcceptRFQQuoteResponse) ContentType

func (r AcceptRFQQuoteResponse) ContentType() string

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

func (AcceptRFQQuoteResponse) GetBody

func (r AcceptRFQQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AcceptRFQQuoteResponse) GetJSON400

func (r AcceptRFQQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AcceptRFQQuoteResponse) GetJSON401

func (r AcceptRFQQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AcceptRFQQuoteResponse) GetJSON404

func (r AcceptRFQQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AcceptRFQQuoteResponse) GetJSON500

func (r AcceptRFQQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (AcceptRFQQuoteResponse) Status

func (r AcceptRFQQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (AcceptRFQQuoteResponse) StatusCode

func (r AcceptRFQQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AccountApiUsageLevelVolumeGoal

type AccountApiUsageLevelVolumeGoal struct {
	// EarnVolumeGoalFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	EarnVolumeGoalFp FixedPointCount `json:"earn_volume_goal_fp"`

	// KeepVolumeGoalFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	KeepVolumeGoalFp FixedPointCount `json:"keep_volume_goal_fp"`

	// Level API usage level for this Predictions volume goal.
	//
	// Example: expert
	Level string `json:"level"`
}

AccountApiUsageLevelVolumeGoal defines model for AccountApiUsageLevelVolumeGoal.

type AccountApiUsageLevelVolumeProgress

type AccountApiUsageLevelVolumeProgress struct {
	// ComputedTs Unix timestamp (seconds) when this progress was computed; trailing_30d_volume_fp covers the trailing 30 days ending at this time.
	ComputedTs int64                            `json:"computed_ts"`
	Goals      []AccountApiUsageLevelVolumeGoal `json:"goals"`

	// Trailing30dVolumeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	Trailing30dVolumeFp FixedPointCount `json:"trailing_30d_volume_fp"`
}

AccountApiUsageLevelVolumeProgress defines model for AccountApiUsageLevelVolumeProgress.

type AmendOrderV2JSONRequestBody

type AmendOrderV2JSONRequestBody = AmendOrderV2Request

AmendOrderV2JSONRequestBody defines body for AmendOrderV2 for application/json ContentType.

type AmendOrderV2Params

type AmendOrderV2Params struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

AmendOrderV2Params defines parameters for AmendOrderV2.

type AmendOrderV2Request

type AmendOrderV2Request struct {
	// ClientOrderId The original client-specified order ID to be amended
	ClientOrderId string `json:"client_order_id,omitempty"`

	// Count Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	Count FixedPointCount `json:"count"`

	// ExchangeIndex Exchange shard index. If omitted, auto-routes when ticker is provided; otherwise defaults to 0. Use -1 to require auto-routing by ticker.
	ExchangeIndex *ExchangeIndex `json:"exchange_index,omitempty"`

	// ExpirationTime New Unix expiration timestamp in seconds. Omit to preserve the current expiry, or use 0 to remove it (good-till-canceled). A nonzero expiry must be in the future. Send the current price and total quantity for an expiry-only amendment; this preserves queue position.
	ExpirationTime *int64 `json:"expiration_time,omitempty"`

	// Price Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Price FixedPointDollars `json:"price"`

	// Side Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)
	Side BookSide `json:"side" validate:"required,oneof=bid ask"`

	// Ticker Market ticker
	Ticker string `json:"ticker" validate:"required,min=1"`

	// UpdatedClientOrderId The new client-specified order ID after amendment
	UpdatedClientOrderId string `json:"updated_client_order_id,omitempty"`
}

AmendOrderV2Request Example: {"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","count":"8.00","exchange_index":0,"price":"0.5700","side":"bid","ticker":"HIGHNY-24JAN01-T60","updated_client_order_id":"2a0e3fc9-b593-4aa3-96e5-82f7f7566c2a"}

type AmendOrderV2Response

type AmendOrderV2Response struct {
	// AverageFeePaid Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	AverageFeePaid *FixedPointDollars `json:"average_fee_paid"`

	// AverageFillPrice Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	AverageFillPrice *FixedPointDollars `json:"average_fill_price"`
	ClientOrderId    *string            `json:"client_order_id,omitempty"`

	// FillCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	FillCount *FixedPointCount `json:"fill_count"`
	OrderId   string           `json:"order_id"`

	// RemainingCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	RemainingCount *FixedPointCount `json:"remaining_count"`

	// TsMs Matching engine timestamp at which the amend was processed, as Unix epoch milliseconds.
	TsMs int64 `json:"ts_ms"`
}

AmendOrderV2Response Example: {"client_order_id":"2a0e3fc9-b593-4aa3-96e5-82f7f7566c2a","fill_count":"0.00","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","remaining_count":"8.00","ts_ms":1715793690123}

type AmendOrderV2Response2

type AmendOrderV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AmendOrderV2Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ServiceUnavailableError
}

func ParseAmendOrderV2Response2

func ParseAmendOrderV2Response2(rsp *http.Response) (*AmendOrderV2Response2, error)

ParseAmendOrderV2Response2 parses an HTTP response from a AmendOrderV2WithResponse call

func (AmendOrderV2Response2) ContentType

func (r AmendOrderV2Response2) ContentType() string

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

func (AmendOrderV2Response2) GetBody

func (r AmendOrderV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (AmendOrderV2Response2) GetJSON200

func (r AmendOrderV2Response2) GetJSON200() *AmendOrderV2Response

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (AmendOrderV2Response2) GetJSON400

func (r AmendOrderV2Response2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (AmendOrderV2Response2) GetJSON401

func (r AmendOrderV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (AmendOrderV2Response2) GetJSON403

func (r AmendOrderV2Response2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (AmendOrderV2Response2) GetJSON404

func (r AmendOrderV2Response2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (AmendOrderV2Response2) GetJSON500

func (r AmendOrderV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (AmendOrderV2Response2) GetJSON503

func (r AmendOrderV2Response2) GetJSON503() *ServiceUnavailableError

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (AmendOrderV2Response2) Status

func (r AmendOrderV2Response2) Status() string

Status returns HTTPResponse.Status

func (AmendOrderV2Response2) StatusCode

func (r AmendOrderV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ApiKey

type ApiKey struct {
	// ApiKeyId Unique identifier for the API key
	ApiKeyId string `json:"api_key_id"`

	// FcmSubtraderId If set, the API key is bound to this single FCM subtrader ({fcm_user_id}_{suffix}) and is usable only as that institution's trading credential - FIX sessions and subtrader-scoped margin WebSocket sessions; every REST endpoint is denied. Absent/null means the key carries no subtrader binding.
	FcmSubtraderId *string `json:"fcm_subtrader_id,omitempty"`

	// Name User-provided name for the API key
	Name string `json:"name"`

	// Scopes List of scopes granted to this API key.
	Scopes []ApiKeyScope `json:"scopes"`

	// Subaccount If set, the API key is restricted to this single sub-account and may only read and trade on it. Absent/null means the key is unrestricted.
	Subaccount *int `json:"subaccount,omitempty"`
}

ApiKey defines model for ApiKey.

type ApiKeyScope

type ApiKeyScope string

ApiKeyScope Scope granted to an API key. Parent scopes grant broad access; for example, `read` grants all read endpoints and `write` grants all write endpoints. Child scopes such as `read::block_trade_accept`, `read::portfolio_balance`, `write::trade`, `write::transfer`, `write::fcm_risk` (FCM subtrader creation, trading blocks, daily premium caps, and margin caps), and `write::block_trade_accept` grant only their specific endpoint group and can be granted without the parent scope.

const (
	ApiKeyScopeApiKeyScopeRead                  ApiKeyScope = "read"
	ApiKeyScopeApiKeyScopeReadBlockTradeAccept  ApiKeyScope = "read::block_trade_accept"
	ApiKeyScopeApiKeyScopeReadPortfolioBalance  ApiKeyScope = "read::portfolio_balance"
	ApiKeyScopeApiKeyScopeWrite                 ApiKeyScope = "write"
	ApiKeyScopeApiKeyScopeWriteBlockTradeAccept ApiKeyScope = "write::block_trade_accept"
	ApiKeyScopeApiKeyScopeWriteFCMRisk          ApiKeyScope = "write::fcm_risk"
	ApiKeyScopeApiKeyScopeWriteTrade            ApiKeyScope = "write::trade"
	ApiKeyScopeApiKeyScopeWriteTransfer         ApiKeyScope = "write::transfer"
)

Defines values for ApiKeyScope.

func (ApiKeyScope) Valid

func (e ApiKeyScope) Valid() bool

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

type ApiKeyType

type ApiKeyType string

ApiKeyType Signature algorithm of an API key pair. `rsa` - 2048-bit RSA; requests are signed with RSA-PSS SHA-256. `ed25519` - Ed25519 (RFC 8032) signatures over the same pre-sign text, with lower client-side signing cost. Defaults to `rsa` when omitted from a generate request, for compatibility with existing clients.

const (
	ApiKeyTypeApiKeyTypeEd25519 ApiKeyType = "ed25519"
	ApiKeyTypeApiKeyTypeRsa     ApiKeyType = "rsa"
)

Defines values for ApiKeyType.

func (ApiKeyType) Valid

func (e ApiKeyType) Valid() bool

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

type ApiUsageLevelGrant

type ApiUsageLevelGrant struct {
	// ExchangeInstance The exchange instance type
	ExchangeInstance ExchangeInstance `json:"exchange_instance"`

	// ExpiresTs Unix timestamp (seconds) when the grant expires. Absent for permanent grants.
	ExpiresTs *int64 `json:"expires_ts,omitempty"`

	// Level API usage level this grant confers (for example, expert, premier, paragon, prime, or prestige).
	//
	// Example: prestige
	Level string `json:"level"`

	// Source How the grant was created: "volume" (earned from trading volume) or "manual" (assigned by Kalshi).
	Source string `json:"source"`
}

ApiUsageLevelGrant defines model for ApiUsageLevelGrant.

type ApplySubaccountTransferJSONRequestBody

type ApplySubaccountTransferJSONRequestBody = ApplySubaccountTransferRequest

ApplySubaccountTransferJSONRequestBody defines body for ApplySubaccountTransfer for application/json ContentType.

type ApplySubaccountTransferRequest

type ApplySubaccountTransferRequest struct {
	// AmountCents Amount to transfer in cents.
	AmountCents int64 `json:"amount_cents"`

	// ClientTransferId Unique client-provided transfer ID for idempotency.
	ClientTransferId openapi_types.UUID `json:"client_transfer_id" validate:"required"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0 if unspecified.
	ExchangeIndex ExchangeIndex `json:"exchange_index,omitempty" validate:"gte=0"`

	// FromSubaccount Source subaccount number (0 for primary, 1-63 for numbered subaccounts).
	FromSubaccount int `json:"from_subaccount"`

	// ToSubaccount Destination subaccount number (0 for primary, 1-63 for numbered subaccounts).
	ToSubaccount int `json:"to_subaccount"`
}

ApplySubaccountTransferRequest defines model for ApplySubaccountTransferRequest.

type ApplySubaccountTransferResponse

type ApplySubaccountTransferResponse = map[string]interface{}

ApplySubaccountTransferResponse Empty response indicating successful transfer.

type ApplySubaccountTransferResponse2

type ApplySubaccountTransferResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ApplySubaccountTransferResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseApplySubaccountTransferResponse2

func ParseApplySubaccountTransferResponse2(rsp *http.Response) (*ApplySubaccountTransferResponse2, error)

ParseApplySubaccountTransferResponse2 parses an HTTP response from a ApplySubaccountTransferWithResponse call

func (ApplySubaccountTransferResponse2) ContentType

func (r ApplySubaccountTransferResponse2) ContentType() string

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

func (ApplySubaccountTransferResponse2) GetBody

func (r ApplySubaccountTransferResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (ApplySubaccountTransferResponse2) GetJSON200

func (r ApplySubaccountTransferResponse2) GetJSON200() *ApplySubaccountTransferResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ApplySubaccountTransferResponse2) GetJSON400

func (r ApplySubaccountTransferResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ApplySubaccountTransferResponse2) GetJSON401

func (r ApplySubaccountTransferResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ApplySubaccountTransferResponse2) GetJSON500

func (r ApplySubaccountTransferResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ApplySubaccountTransferResponse2) Status

func (r ApplySubaccountTransferResponse2) Status() string

Status returns HTTPResponse.Status

func (ApplySubaccountTransferResponse2) StatusCode

func (r ApplySubaccountTransferResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AssociatedEvent

type AssociatedEvent struct {
	// ActiveQuoters List of active quoters for this event.
	ActiveQuoters []string `json:"active_quoters"`

	// IsYesOnly Whether only the 'yes' side can be used for this event.
	IsYesOnly bool `json:"is_yes_only"`

	// SizeMax Maximum number of markets from this event (inclusive). Null means no limit.
	SizeMax *int32 `json:"size_max,omitempty"`

	// SizeMin Minimum number of markets from this event (inclusive). Null means no limit.
	SizeMin *int32 `json:"size_min,omitempty"`

	// Ticker The event ticker.
	Ticker string `json:"ticker"`
}

AssociatedEvent defines model for AssociatedEvent.

type BadRequestError

type BadRequestError = ErrorResponse

BadRequestError defines model for BadRequestError.

type BatchCancelOrdersV2JSONRequestBody

type BatchCancelOrdersV2JSONRequestBody = BatchCancelOrdersV2Request

BatchCancelOrdersV2JSONRequestBody defines body for BatchCancelOrdersV2 for application/json ContentType.

type BatchCancelOrdersV2Request

type BatchCancelOrdersV2Request struct {
	// Orders An array of orders to cancel, each optionally specifying a subaccount.
	Orders []struct {
		// ExchangeIndex Exchange shard index. If omitted, auto-routes when market_ticker is provided; otherwise defaults to 0. Use -1 to require auto-routing. The market_ticker field is required for auto-routing.
		ExchangeIndex *ExchangeIndex `json:"exchange_index,omitempty"`

		// MarketTicker Market ticker. Required for auto-routing when exchange_index is omitted or -1.
		MarketTicker string `json:"market_ticker,omitempty"`

		// OrderId Order ID to cancel.
		OrderId string `json:"order_id"`

		// Subaccount Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts). Subaccount-restricted API keys must omit this field or pass their locked subaccount.
		Subaccount *int `json:"subaccount,omitempty"`
	} `json:"orders" validate:"required,dive"`
}

BatchCancelOrdersV2Request Example: {"orders":[{"exchange_index":0,"order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","subaccount":0},{"exchange_index":0,"order_id":"a6d6010d-6d5f-40a1-a7e7-5501386bb621","subaccount":0}]}

type BatchCancelOrdersV2Response

type BatchCancelOrdersV2Response struct {
	Orders []struct {
		ClientOrderId *string        `json:"client_order_id,omitempty"`
		Error         *ErrorResponse `json:"error,omitempty"`

		// OrderId The order ID identifying which order this entry corresponds to.
		OrderId string `json:"order_id"`

		// ReducedBy Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
		//
		// Example: 10.00
		ReducedBy FixedPointCount `json:"reduced_by"`

		// TsMs Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds. Absent when the cancel errored.
		TsMs *int64 `json:"ts_ms"`
	} `json:"orders"`
}

BatchCancelOrdersV2Response Example: {"orders":[{"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","reduced_by":"10.00","ts_ms":1715793660456},{"client_order_id":"2a0e3fc9-b593-4aa3-96e5-82f7f7566c2a","order_id":"a6d6010d-6d5f-40a1-a7e7-5501386bb621","reduced_by":"5.00","ts_ms":1715793660789}]}

type BatchCancelOrdersV2Response2

type BatchCancelOrdersV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *BatchCancelOrdersV2Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseBatchCancelOrdersV2Response2

func ParseBatchCancelOrdersV2Response2(rsp *http.Response) (*BatchCancelOrdersV2Response2, error)

ParseBatchCancelOrdersV2Response2 parses an HTTP response from a BatchCancelOrdersV2WithResponse call

func (BatchCancelOrdersV2Response2) ContentType

func (r BatchCancelOrdersV2Response2) ContentType() string

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

func (BatchCancelOrdersV2Response2) GetBody

func (r BatchCancelOrdersV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchCancelOrdersV2Response2) GetJSON200

func (r BatchCancelOrdersV2Response2) GetJSON200() *BatchCancelOrdersV2Response

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchCancelOrdersV2Response2) GetJSON400

func (r BatchCancelOrdersV2Response2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (BatchCancelOrdersV2Response2) GetJSON401

func (r BatchCancelOrdersV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (BatchCancelOrdersV2Response2) GetJSON403

func (r BatchCancelOrdersV2Response2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (BatchCancelOrdersV2Response2) GetJSON500

func (r BatchCancelOrdersV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (BatchCancelOrdersV2Response2) Status

func (r BatchCancelOrdersV2Response2) Status() string

Status returns HTTPResponse.Status

func (BatchCancelOrdersV2Response2) StatusCode

func (r BatchCancelOrdersV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchCreateOrdersV2JSONRequestBody

type BatchCreateOrdersV2JSONRequestBody = BatchCreateOrdersV2Request

BatchCreateOrdersV2JSONRequestBody defines body for BatchCreateOrdersV2 for application/json ContentType.

type BatchCreateOrdersV2Request

type BatchCreateOrdersV2Request struct {
	Orders []CreateOrderV2Request `json:"orders" validate:"required,dive"`
}

BatchCreateOrdersV2Request Example: {"orders":[{"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","count":"10.00","exchange_index":0,"price":"0.5600","self_trade_prevention_type":"taker_at_cross","side":"bid","ticker":"HIGHNY-24JAN01-T60","time_in_force":"good_till_canceled"},{"client_order_id":"2a0e3fc9-b593-4aa3-96e5-82f7f7566c2a","count":"5.00","exchange_index":0,"price":"0.5800","self_trade_prevention_type":"maker","side":"ask","ticker":"HIGHNY-24JAN01-T60","time_in_force":"immediate_or_cancel"}]}

type BatchCreateOrdersV2Response

type BatchCreateOrdersV2Response struct {
	Orders []struct {
		// AverageFeePaid Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
		//
		// Example: 0.5600
		AverageFeePaid *FixedPointDollars `json:"average_fee_paid"`

		// AverageFillPrice Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
		//
		// Example: 0.5600
		AverageFillPrice *FixedPointDollars `json:"average_fill_price"`
		ClientOrderId    *string            `json:"client_order_id,omitempty"`
		Error            *ErrorResponse     `json:"error,omitempty"`

		// FillCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
		//
		// Example: 10.00
		FillCount *FixedPointCount `json:"fill_count"`
		OrderId   *string          `json:"order_id,omitempty"`

		// RemainingCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
		//
		// Example: 10.00
		RemainingCount *FixedPointCount `json:"remaining_count"`

		// TsMs Matching engine timestamp at which the order was processed, as Unix epoch milliseconds. Absent when the request errored.
		TsMs *int64 `json:"ts_ms"`
	} `json:"orders"`
}

BatchCreateOrdersV2Response Example: {"orders":[{"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","fill_count":"0.00","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","remaining_count":"10.00","ts_ms":1715793600123},{"average_fee_paid":"0.0012","average_fill_price":"0.5800","client_order_id":"2a0e3fc9-b593-4aa3-96e5-82f7f7566c2a","fill_count":"5.00","order_id":"a6d6010d-6d5f-40a1-a7e7-5501386bb621","remaining_count":"0.00","ts_ms":1715793600456}]}

type BatchCreateOrdersV2Response2

type BatchCreateOrdersV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *BatchCreateOrdersV2Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseBatchCreateOrdersV2Response2

func ParseBatchCreateOrdersV2Response2(rsp *http.Response) (*BatchCreateOrdersV2Response2, error)

ParseBatchCreateOrdersV2Response2 parses an HTTP response from a BatchCreateOrdersV2WithResponse call

func (BatchCreateOrdersV2Response2) ContentType

func (r BatchCreateOrdersV2Response2) ContentType() string

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

func (BatchCreateOrdersV2Response2) GetBody

func (r BatchCreateOrdersV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchCreateOrdersV2Response2) GetJSON201

func (r BatchCreateOrdersV2Response2) GetJSON201() *BatchCreateOrdersV2Response

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (BatchCreateOrdersV2Response2) GetJSON400

func (r BatchCreateOrdersV2Response2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (BatchCreateOrdersV2Response2) GetJSON401

func (r BatchCreateOrdersV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (BatchCreateOrdersV2Response2) GetJSON403

func (r BatchCreateOrdersV2Response2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (BatchCreateOrdersV2Response2) GetJSON500

func (r BatchCreateOrdersV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (BatchCreateOrdersV2Response2) Status

func (r BatchCreateOrdersV2Response2) Status() string

Status returns HTTPResponse.Status

func (BatchCreateOrdersV2Response2) StatusCode

func (r BatchCreateOrdersV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchGetMarketCandlesticksParams

type BatchGetMarketCandlesticksParams struct {
	// MarketTickers Comma-separated list of market tickers (maximum 100)
	MarketTickers string `form:"market_tickers" json:"market_tickers"`

	// StartTs Start timestamp in Unix seconds
	StartTs int64 `form:"start_ts" json:"start_ts"`

	// EndTs End timestamp in Unix seconds
	EndTs int64 `form:"end_ts" json:"end_ts"`

	// PeriodInterval Candlestick period interval in minutes
	PeriodInterval int32 `form:"period_interval" json:"period_interval"`

	// IncludeLatestBeforeStart If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by:
	// 1. Finding the most recent real candlestick before start_ts
	// 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts)
	// 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
	IncludeLatestBeforeStart *bool `form:"include_latest_before_start,omitempty" json:"include_latest_before_start,omitempty"`
}

BatchGetMarketCandlesticksParams defines parameters for BatchGetMarketCandlesticks.

type BatchGetMarketCandlesticksResponse

type BatchGetMarketCandlesticksResponse struct {
	// Markets Array of market candlestick data, one entry per requested market.
	Markets []MarketCandlesticksResponse `json:"markets"`
}

BatchGetMarketCandlesticksResponse defines model for BatchGetMarketCandlesticksResponse.

type BatchGetMarketCandlesticksResponse2

type BatchGetMarketCandlesticksResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *BatchGetMarketCandlesticksResponse
}

func ParseBatchGetMarketCandlesticksResponse2

func ParseBatchGetMarketCandlesticksResponse2(rsp *http.Response) (*BatchGetMarketCandlesticksResponse2, error)

ParseBatchGetMarketCandlesticksResponse2 parses an HTTP response from a BatchGetMarketCandlesticksWithResponse call

func (BatchGetMarketCandlesticksResponse2) ContentType

func (r BatchGetMarketCandlesticksResponse2) ContentType() string

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

func (BatchGetMarketCandlesticksResponse2) GetBody

func (r BatchGetMarketCandlesticksResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchGetMarketCandlesticksResponse2) GetJSON200

func (r BatchGetMarketCandlesticksResponse2) GetJSON200() *BatchGetMarketCandlesticksResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchGetMarketCandlesticksResponse2) Status

func (r BatchGetMarketCandlesticksResponse2) Status() string

Status returns HTTPResponse.Status

func (BatchGetMarketCandlesticksResponse2) StatusCode

func (r BatchGetMarketCandlesticksResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BidAskDistribution

type BidAskDistribution struct {
	// CloseDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	CloseDollars FixedPointDollars `json:"close_dollars"`

	// HighDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	HighDollars FixedPointDollars `json:"high_dollars"`

	// LowDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	LowDollars FixedPointDollars `json:"low_dollars"`

	// OpenDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	OpenDollars FixedPointDollars `json:"open_dollars"`
}

BidAskDistribution defines model for BidAskDistribution.

type BidAskDistributionHistorical

type BidAskDistributionHistorical struct {
	// Close Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Close FixedPointDollars `json:"close"`

	// High Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	High FixedPointDollars `json:"high"`

	// Low Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Low FixedPointDollars `json:"low"`

	// Open Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Open FixedPointDollars `json:"open"`
}

BidAskDistributionHistorical defines model for BidAskDistributionHistorical.

type BlockTradeProposal

type BlockTradeProposal struct {
	// BuyerAccepted Whether the buyer has accepted the proposal
	BuyerAccepted bool `json:"buyer_accepted"`

	// BuyerAcceptedTs Timestamp when the buyer accepted
	BuyerAcceptedTs *time.Time `json:"buyer_accepted_ts,omitempty"`

	// BuyerOrderId Order ID for the buyer after the proposal is executed
	BuyerOrderId string `json:"buyer_order_id,omitempty"`

	// BuyerSubtraderId Subtrader ID of the buyer. Empty when the authenticated user is not the buyer.
	BuyerSubtraderId string `json:"buyer_subtrader_id,omitempty"`

	// BuyerUserId User ID of the buyer. Empty when the authenticated user is not the buyer.
	BuyerUserId string `json:"buyer_user_id"`

	// Centicount Number of contracts in centicounts
	Centicount int64 `json:"centicount"`

	// CreatedTs Timestamp when the proposal was created
	CreatedTs time.Time `json:"created_ts"`

	// ExecutedTs Timestamp when the proposal was executed
	ExecutedTs *time.Time `json:"executed_ts,omitempty"`

	// ExpirationTs Expiration time of the proposal
	ExpirationTs time.Time `json:"expiration_ts"`

	// Id Unique identifier for the block trade proposal
	Id string `json:"id"`

	// MakerSide The maker side of the trade
	MakerSide BlockTradeProposalMakerSide `json:"maker_side"`

	// MarketTicker The ticker of the market for this block trade
	MarketTicker string `json:"market_ticker"`

	// PriceCentiCents Price in centi-cents
	PriceCentiCents int64 `json:"price_centi_cents"`

	// ProposerUserId User ID of the proposal creator
	ProposerUserId string `json:"proposer_user_id"`

	// SellerAccepted Whether the seller has accepted the proposal
	SellerAccepted bool `json:"seller_accepted"`

	// SellerAcceptedTs Timestamp when the seller accepted
	SellerAcceptedTs *time.Time `json:"seller_accepted_ts,omitempty"`

	// SellerOrderId Order ID for the seller after the proposal is executed
	SellerOrderId string `json:"seller_order_id,omitempty"`

	// SellerSubtraderId Subtrader ID of the seller. Empty when the authenticated user is not the seller.
	SellerSubtraderId string `json:"seller_subtrader_id,omitempty"`

	// SellerUserId User ID of the seller. Empty when the authenticated user is not the seller.
	SellerUserId string `json:"seller_user_id"`

	// Status Current status of the proposal
	Status string `json:"status"`

	// UpdatedTs Timestamp when the proposal was last updated
	UpdatedTs time.Time `json:"updated_ts"`
}

BlockTradeProposal defines model for BlockTradeProposal.

type BlockTradeProposalMakerSide

type BlockTradeProposalMakerSide string

BlockTradeProposalMakerSide The maker side of the trade

const (
	BlockTradeProposalMakerSideNo  BlockTradeProposalMakerSide = "no"
	BlockTradeProposalMakerSideYes BlockTradeProposalMakerSide = "yes"
)

Defines values for BlockTradeProposalMakerSide.

func (BlockTradeProposalMakerSide) Valid

func (e BlockTradeProposalMakerSide) Valid() bool

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

type BookSide

type BookSide string

BookSide Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)

const (
	BookSideAsk BookSide = "ask"
	BookSideBid BookSide = "bid"
)

Defines values for BookSide.

func (BookSide) Valid

func (e BookSide) Valid() bool

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

type BucketLimit

type BucketLimit struct {
	// BucketCapacity Maximum tokens the bucket can hold. When equal to refill_rate the
	// bucket holds one second of budget; larger values represent burst
	// headroom that idle clients accumulate and can spend in a single
	// pulse (e.g. write buckets at non-Basic tiers hold two seconds of
	// budget).
	BucketCapacity int `json:"bucket_capacity"`

	// RefillRate Tokens added to the bucket per second.
	RefillRate int `json:"refill_rate"`
}

BucketLimit Token-bucket budget for one rate-limit bucket. Each request deducts tokens equal to its endpoint cost; the bucket refills at refill_rate tokens per second up to bucket_capacity. A request is allowed if the bucket holds enough tokens to cover its cost; otherwise the request is rejected with HTTP 429.

type CancelAllOrdersParams

type CancelAllOrdersParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

CancelAllOrdersParams defines parameters for CancelAllOrders.

type CancelAllOrdersResponse

type CancelAllOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCancelAllOrdersResponse

func ParseCancelAllOrdersResponse(rsp *http.Response) (*CancelAllOrdersResponse, error)

ParseCancelAllOrdersResponse parses an HTTP response from a CancelAllOrdersWithResponse call

func (CancelAllOrdersResponse) ContentType

func (r CancelAllOrdersResponse) ContentType() string

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

func (CancelAllOrdersResponse) GetBody

func (r CancelAllOrdersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelAllOrdersResponse) GetJSON401

func (r CancelAllOrdersResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CancelAllOrdersResponse) GetJSON429

func (r CancelAllOrdersResponse) GetJSON429() *RateLimitError

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (CancelAllOrdersResponse) GetJSON500

func (r CancelAllOrdersResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelAllOrdersResponse) Status

func (r CancelAllOrdersResponse) Status() string

Status returns HTTPResponse.Status

func (CancelAllOrdersResponse) StatusCode

func (r CancelAllOrdersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelOrderV2Params

type CancelOrderV2Params struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Exchange shard index. If omitted, auto-routes when market_ticker is provided; otherwise defaults to 0. Use -1 to require auto-routing. The market_ticker parameter is required for auto-routing.
	ExchangeIndex *ExchangeIndex `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`

	// MarketTicker Market ticker. Required for auto-routing when exchange_index is omitted or -1.
	MarketTicker string `form:"market_ticker,omitempty" json:"market_ticker,omitempty"`
}

CancelOrderV2Params defines parameters for CancelOrderV2.

type CancelOrderV2Response

type CancelOrderV2Response struct {
	ClientOrderId *string `json:"client_order_id,omitempty"`
	OrderId       string  `json:"order_id"`

	// ReducedBy Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ReducedBy FixedPointCount `json:"reduced_by"`

	// TsMs Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.
	TsMs int64 `json:"ts_ms"`
}

CancelOrderV2Response Example: {"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","reduced_by":"10.00","ts_ms":1715793660456}

type CancelOrderV2Response2

type CancelOrderV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CancelOrderV2Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCancelOrderV2Response2

func ParseCancelOrderV2Response2(rsp *http.Response) (*CancelOrderV2Response2, error)

ParseCancelOrderV2Response2 parses an HTTP response from a CancelOrderV2WithResponse call

func (CancelOrderV2Response2) ContentType

func (r CancelOrderV2Response2) ContentType() string

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

func (CancelOrderV2Response2) GetBody

func (r CancelOrderV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelOrderV2Response2) GetJSON200

func (r CancelOrderV2Response2) GetJSON200() *CancelOrderV2Response

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CancelOrderV2Response2) GetJSON401

func (r CancelOrderV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CancelOrderV2Response2) GetJSON404

func (r CancelOrderV2Response2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CancelOrderV2Response2) GetJSON500

func (r CancelOrderV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelOrderV2Response2) Status

func (r CancelOrderV2Response2) Status() string

Status returns HTTPResponse.Status

func (CancelOrderV2Response2) StatusCode

func (r CancelOrderV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

func (c *Client) AcceptBlockTradeProposal(ctx context.Context, blockTradeProposalId string, body AcceptBlockTradeProposalJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptBlockTradeProposal Accept Block Trade Proposal

Endpoint for accepting a block trade proposal.

Takes a body of the `application/json` content type.

Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).

func (*Client) AcceptBlockTradeProposalWithBody

func (c *Client) AcceptBlockTradeProposalWithBody(ctx context.Context, blockTradeProposalId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptBlockTradeProposalWithBody Accept Block Trade Proposal

Endpoint for accepting a block trade proposal.

Takes any type of body and a specified content type.

Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).

func (*Client) AcceptQuote

func (c *Client) AcceptQuote(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptQuote Accept Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.

Takes a body of the `application/json` content type.

Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) AcceptQuoteWithBody

func (c *Client) AcceptQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptQuoteWithBody Accept Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.

Takes any type of body and a specified content type.

Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) AcceptRFQQuote

func (c *Client) AcceptRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body AcceptRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptRFQQuote Accept RFQ Quote

Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.

Takes a body of the `application/json` content type.

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).

func (*Client) AcceptRFQQuoteWithBody

func (c *Client) AcceptRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptRFQQuoteWithBody Accept RFQ Quote

Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.

Takes any type of body and a specified content type.

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).

func (*Client) AmendOrderV2

func (c *Client) AmendOrderV2(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, body AmendOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AmendOrderV2 Amend Order (V2)

Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).

func (*Client) AmendOrderV2WithBody

func (c *Client) AmendOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AmendOrderV2WithBody Amend Order (V2)

Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).

func (*Client) ApplySubaccountTransfer

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

ApplySubaccountTransfer Transfer Between Subaccounts

Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).

func (*Client) ApplySubaccountTransferWithBody

func (c *Client) ApplySubaccountTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ApplySubaccountTransferWithBody Transfer Between Subaccounts

Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).

func (*Client) BatchCancelOrdersV2

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

BatchCancelOrdersV2 Batch Cancel Orders (V2)

Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes a body of the `application/json` content type.

Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).

func (*Client) BatchCancelOrdersV2WithBody

func (c *Client) BatchCancelOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchCancelOrdersV2WithBody Batch Cancel Orders (V2)

Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes any type of body and a specified content type.

Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).

func (*Client) BatchCreateOrdersV2

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

BatchCreateOrdersV2 Batch Create Orders (V2)

Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).

func (*Client) BatchCreateOrdersV2WithBody

func (c *Client) BatchCreateOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchCreateOrdersV2WithBody Batch Create Orders (V2)

Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).

func (*Client) BatchGetMarketCandlesticks

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

BatchGetMarketCandlesticks Batch Get Market Candlesticks

Endpoint for retrieving candlestick data for multiple markets.

- Accepts up to 100 market tickers per request - Returns up to 10,000 candlesticks total across all markets - Returns candlesticks grouped by market_id - Optionally includes a synthetic initial candlestick for price continuity (see `include_latest_before_start` parameter)

Corresponds with GET /markets/candlesticks (the `BatchGetMarketCandlesticks` operationId).

func (*Client) CancelAllOrders

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

CancelAllOrders Cancel All Orders

Cancels all resting event-market orders for the authenticated Direct member across every exchange shard. If `subaccount` is omitted, matching orders may come from any subaccount. If it is provided, only orders for that subaccount are eligible. Newly placed orders may also be cancelled during the minute after the request.

Corresponds with DELETE /portfolio/events/orders (the `CancelAllOrders` operationId).

func (*Client) CancelOrderV2

func (c *Client) CancelOrderV2(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

CancelOrderV2 Cancel Order (V2)

Endpoint for cancelling event-market orders using the V2 response shape. To auto-route the cancellation, provide `market_ticker` and omit `exchange_index` or set it to `-1`. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.

Corresponds with DELETE /portfolio/events/orders/{order_id} (the `CancelOrderV2` operationId).

func (*Client) ConfirmQuote

func (c *Client) ConfirmQuote(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ConfirmQuote Confirm Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.

Takes a body of the `application/json` content type.

Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) ConfirmQuoteWithBody

func (c *Client) ConfirmQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ConfirmQuoteWithBody Confirm Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.

Takes any type of body and a specified content type.

Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) ConfirmRFQQuote

func (c *Client) ConfirmRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body ConfirmRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ConfirmRFQQuote Confirm RFQ Quote

Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.

Takes a body of the `application/json` content type.

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).

func (*Client) ConfirmRFQQuoteWithBody

func (c *Client) ConfirmRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ConfirmRFQQuoteWithBody Confirm RFQ Quote

Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.

Takes any type of body and a specified content type.

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).

func (*Client) CreateApiKey

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

CreateApiKey Create API Key

Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.

Takes a body of the `application/json` content type.

Corresponds with POST /api_keys (the `CreateApiKey` operationId).

func (*Client) CreateApiKeyWithBody

func (c *Client) CreateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateApiKeyWithBody Create API Key

Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.

Takes any type of body and a specified content type.

Corresponds with POST /api_keys (the `CreateApiKey` operationId).

func (*Client) CreateFCMPositionTransfer

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

CreateFCMPositionTransfer Create FCM Position Transfer

Endpoint for FCM members to move a position in one market from one of their subtraders into a subtrader under their FCM's error account.

**This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the error account that receives transferred positions and gives you that account's user id, which prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.

• The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader under it, which is created on first use.
• Each request moves one market for one source subtrader. To move many positions, send one request per subtrader and market.
• The transfer is booked like a trade at `price_centicents`, which is always the YES price, even when moving NO. No fee is charged and no fill is created. For YES, the error account pays the price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds the side being moved and the target subtrader holds no opposite position in that market; otherwise the positions net like a trade and the balance changes differ.
• The source's current position is not checked. A request for more than the source holds, or with the opposite sign, flips or grows the source's position.
• Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
• The market must be open, neither account may be blocked, and the error account must have enough available balance on the market's exchange index to pay for the transfer. Otherwise the request returns 409.

**Example: moving YES.** A customer subtrader holds 10 YES contracts. Send `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents): - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES. - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50. - Sending `price_centicents` 0 instead moves the position with no cash.

**Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount` -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):

• The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
• The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
• Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the error account pay the full $1 per contract ($5.00).

Takes a body of the `application/json` content type.

Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).

func (*Client) CreateFCMPositionTransferWithBody

func (c *Client) CreateFCMPositionTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateFCMPositionTransferWithBody Create FCM Position Transfer

Endpoint for FCM members to move a position in one market from one of their subtraders into a subtrader under their FCM's error account.

**This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the error account that receives transferred positions and gives you that account's user id, which prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.

• The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader under it, which is created on first use.
• Each request moves one market for one source subtrader. To move many positions, send one request per subtrader and market.
• The transfer is booked like a trade at `price_centicents`, which is always the YES price, even when moving NO. No fee is charged and no fill is created. For YES, the error account pays the price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds the side being moved and the target subtrader holds no opposite position in that market; otherwise the positions net like a trade and the balance changes differ.
• The source's current position is not checked. A request for more than the source holds, or with the opposite sign, flips or grows the source's position.
• Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
• The market must be open, neither account may be blocked, and the error account must have enough available balance on the market's exchange index to pay for the transfer. Otherwise the request returns 409.

**Example: moving YES.** A customer subtrader holds 10 YES contracts. Send `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents): - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES. - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50. - Sending `price_centicents` 0 instead moves the position with no cash.

**Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount` -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):

• The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
• The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
• Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the error account pay the full $1 per contract ($5.00).

Takes any type of body and a specified content type.

Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).

func (*Client) CreateFCMSubtrader

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

CreateFCMSubtrader Create FCM Subtrader

Endpoint for FCM members to create a subtrader on the event-contract exchange. The subtrader is registered on every exchange shard that knows the FCM; a shard provisioned later registers it lazily on the subtrader's first order there. Re-creating an existing subtrader returns 409.

Takes a body of the `application/json` content type.

Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).

func (*Client) CreateFCMSubtraderWithBody

func (c *Client) CreateFCMSubtraderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateFCMSubtraderWithBody Create FCM Subtrader

Endpoint for FCM members to create a subtrader on the event-contract exchange. The subtrader is registered on every exchange shard that knows the FCM; a shard provisioned later registers it lazily on the subtrader's first order there. Re-creating an existing subtrader returns 409.

Takes any type of body and a specified content type.

Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).

func (*Client) CreateMarketInMultivariateEventCollection

func (c *Client) CreateMarketInMultivariateEventCollection(ctx context.Context, collectionTicker string, body CreateMarketInMultivariateEventCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateMarketInMultivariateEventCollection Create Market In Multivariate Event Collection

Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.

Takes a body of the `application/json` content type.

Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).

func (*Client) CreateMarketInMultivariateEventCollectionWithBody

func (c *Client) CreateMarketInMultivariateEventCollectionWithBody(ctx context.Context, collectionTicker string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateMarketInMultivariateEventCollectionWithBody Create Market In Multivariate Event Collection

Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.

Takes any type of body and a specified content type.

Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).

func (*Client) CreateOrderGroup

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

CreateOrderGroup Create Order Group

Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).

func (*Client) CreateOrderGroupWithBody

func (c *Client) CreateOrderGroupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateOrderGroupWithBody Create Order Group

Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).

func (*Client) CreateOrderV2

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

CreateOrderV2 Create Order (V2)

Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).

func (*Client) CreateOrderV2WithBody

func (c *Client) CreateOrderV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateOrderV2WithBody Create Order (V2)

Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).

func (*Client) CreateQuote

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

CreateQuote Create Quote

Endpoint for creating a quote in response to an RFQ.

Takes a body of the `application/json` content type.

Corresponds with POST /communications/quotes (the `CreateQuote` operationId).

func (*Client) CreateQuoteWithBody

func (c *Client) CreateQuoteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateQuoteWithBody Create Quote

Endpoint for creating a quote in response to an RFQ.

Takes any type of body and a specified content type.

Corresponds with POST /communications/quotes (the `CreateQuote` operationId).

func (*Client) CreateRFQ

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

CreateRFQ Create RFQ

Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.

Takes a body of the `application/json` content type.

Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).

func (*Client) CreateRFQWithBody

func (c *Client) CreateRFQWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRFQWithBody Create RFQ

Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.

Takes any type of body and a specified content type.

Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).

func (*Client) CreateSubaccount

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

CreateSubaccount Create Subaccount

Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).

func (*Client) CreateSubaccountWithBody

func (c *Client) CreateSubaccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateSubaccountWithBody Create Subaccount

Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).

func (*Client) DecreaseOrderV2

func (c *Client) DecreaseOrderV2(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, body DecreaseOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

DecreaseOrderV2 Decrease Order (V2)

Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).

func (*Client) DecreaseOrderV2WithBody

func (c *Client) DecreaseOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

DecreaseOrderV2WithBody Decrease Order (V2)

Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).

func (*Client) DeleteApiKey

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

DeleteApiKey Delete API Key

Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.

Corresponds with DELETE /api_keys/{api_key} (the `DeleteApiKey` operationId).

func (*Client) DeleteFCMEventContractDailyCap

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

DeleteFCMEventContractDailyCap Delete FCM Subtrader Event Contract Daily Cap

Removes the event-contract daily premium cap for an FCM member's subtrader. Removal closes the subtrader to new orders on cap-reservation sessions — every subtrader-bound API key — until a cap is set again. It does not stop orders your own unbound sessions submit on the subtrader's behalf; to stop the account entirely, block subtrader trading.

Corresponds with DELETE /fcm/subtraders/event_contract_daily_cap (the `DeleteFCMEventContractDailyCap` operationId).

func (*Client) DeleteOrderGroup

func (c *Client) DeleteOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteOrderGroup Delete Order Group

Deletes an order group and cancels all orders within it. This permanently removes the group.

Corresponds with DELETE /portfolio/order_groups/{order_group_id} (the `DeleteOrderGroup` operationId).

func (*Client) DeleteQuote

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

DeleteQuote Delete Quote

DEPRECATED: Use DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for deleting a quote, which means it can no longer be accepted.

Corresponds with DELETE /communications/quotes/{quote_id} (the `DeleteQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) DeleteRFQ

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

DeleteRFQ Delete RFQ

Endpoint for deleting an RFQ by ID.

Corresponds with DELETE /communications/rfqs/{rfq_id} (the `DeleteRFQ` operationId).

func (*Client) DeleteRFQQuote

func (c *Client) DeleteRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteRFQQuote Delete RFQ Quote

Endpoint for deleting a quote scoped to its RFQ, which means it can no longer be accepted.

Corresponds with DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `DeleteRFQQuote` operationId).

func (*Client) GenerateApiKey

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

GenerateApiKey Generate API Key

Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.

Takes a body of the `application/json` content type.

Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).

func (*Client) GenerateApiKeyWithBody

func (c *Client) GenerateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

GenerateApiKeyWithBody Generate API Key

Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.

Takes any type of body and a specified content type.

Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).

func (*Client) GetAccountApiLimits

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

GetAccountApiLimits Get Account API Limits

Endpoint to retrieve the authenticated user's Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.

Corresponds with GET /account/limits (the `GetAccountApiLimits` operationId).

func (*Client) GetAccountApiUsageLevelVolumeProgress

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

GetAccountApiUsageLevelVolumeProgress Get Account API Usage Level Volume Progress

Returns the authenticated user's latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.

Corresponds with GET /account/api_usage_level/volume_progress (the `GetAccountApiUsageLevelVolumeProgress` operationId).

func (*Client) GetAccountEndpointCosts

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

GetAccountEndpointCosts List Non-Default Endpoint Costs

Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.

Corresponds with GET /account/endpoint_costs (the `GetAccountEndpointCosts` operationId).

func (*Client) GetApiKeys

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

GetApiKeys Get API Keys

Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.

Corresponds with GET /api_keys (the `GetApiKeys` operationId).

func (*Client) GetBalance

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

GetBalance Get Balance

Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.

**Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.

Corresponds with GET /portfolio/balance (the `GetBalance` operationId).

func (*Client) GetBlockTradeProposals

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

GetBlockTradeProposals Get Block Trade Proposals

Endpoint for getting block trade proposals visible to the authenticated user.

Corresponds with GET /communications/block-trade-proposals (the `GetBlockTradeProposals` operationId).

func (*Client) GetCommunicationsID

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

GetCommunicationsID Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

Corresponds with GET /communications/id (the `GetCommunicationsID` operationId).

func (*Client) GetDeposits

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

GetDeposits Get Deposits

Endpoint for getting the member's deposit history.

Corresponds with GET /portfolio/deposits (the `GetDeposits` operationId).

func (*Client) GetEvent

func (c *Client) GetEvent(ctx context.Context, eventTicker string, params *GetEventParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetEvent Get Event

Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.

Corresponds with GET /events/{event_ticker} (the `GetEvent` operationId).

func (*Client) GetEventFeeChanges

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

GetEventFeeChanges Get Event Fee Changes

Event fees are an override layered on top of the parent series' fee structure. If `fee_type_override` and `fee_multiplier_override` are null, that indicates the override is cleared.

Corresponds with GET /events/fee_changes (the `GetEventFeeChanges` operationId).

func (*Client) GetEventForecastPercentilesHistory

func (c *Client) GetEventForecastPercentilesHistory(ctx context.Context, seriesTicker string, ticker string, params *GetEventForecastPercentilesHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetEventForecastPercentilesHistory Get Event Forecast Percentile History

Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.

Corresponds with GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history (the `GetEventForecastPercentilesHistory` operationId).

func (*Client) GetEventLiveData

func (c *Client) GetEventLiveData(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetEventLiveData Get Event Live Data

Get live data for an event by its event ticker. Serves event-keyed live data such as crypto price charts, commodity price timeseries, and weather observations. The `type` field in the response names the schema of the `details` object.

Corresponds with GET /live_data/events/{event_ticker} (the `GetEventLiveData` operationId).

func (*Client) GetEventMetadata

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

GetEventMetadata Get Event Metadata

Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.

Corresponds with GET /events/{event_ticker}/metadata (the `GetEventMetadata` operationId).

func (*Client) GetEvents

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

GetEvents Get Events

Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.

Corresponds with GET /events (the `GetEvents` operationId).

func (*Client) GetExchangeSchedule

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

GetExchangeSchedule Get Exchange Schedule

Endpoint for getting the exchange schedule.

Corresponds with GET /exchange/schedule (the `GetExchangeSchedule` operationId).

func (*Client) GetExchangeStatus

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

GetExchangeStatus Get Exchange Status

Endpoint for getting the exchange status.

Corresponds with GET /exchange/status (the `GetExchangeStatus` operationId).

func (*Client) GetFCMEventContractDailyCap

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

GetFCMEventContractDailyCap Get FCM Subtrader Event Contract Daily Cap

Returns the event-contract daily premium cap configured for an FCM member's subtrader, together with its live utilization. Executed utilization is the net premium deployed by fills today (sells and settlements credit back); resting and pending utilization reserve open and in-flight orders at their full worst-case cost plus fees. Executed utilization resets at midnight New York time on the returned cap date; resting and pending reservations persist for as long as their orders remain open, including across the reset. Returns 404 when the subtrader has no cap configured — in that state every order placed through the subtrader's bound API keys is rejected. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Corresponds with GET /fcm/subtraders/event_contract_daily_cap (the `GetFCMEventContractDailyCap` operationId).

func (*Client) GetFCMFills

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

GetFCMFills Get FCM Fills

Returns fills across the authenticated FCM's subtraders. Requires FCM member access.

Corresponds with GET /fcm/fills (the `GetFCMFills` operationId).

func (*Client) GetFCMOrders

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

GetFCMOrders Get FCM Orders

Endpoint for FCM members to get orders for their subtraders. This endpoint requires FCM member access level. At least one of `subtrader_id` or `client_order_ids` is required; supplying both returns only the orders matching both filters. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Corresponds with GET /fcm/orders (the `GetFCMOrders` operationId).

func (*Client) GetFCMPositions

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

GetFCMPositions Get FCM Positions

Endpoint for FCM members to get market positions filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering positions by subtrader ID. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Corresponds with GET /fcm/positions (the `GetFCMPositions` operationId).

func (*Client) GetFCMSubtraderBlockedCategories

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

GetFCMSubtraderBlockedCategories Get FCM Subtrader Blocked Categories

Returns the event categories an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. A subtrader with no blocks returns an empty list.

Corresponds with GET /fcm/subtraders/blocked_categories (the `GetFCMSubtraderBlockedCategories` operationId).

func (*Client) GetFills

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

GetFills Get Fills

Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Corresponds with GET /portfolio/fills (the `GetFills` operationId).

func (*Client) GetFillsHistorical

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

GetFillsHistorical Get Historical Fills

Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched. API keys restricted to a subaccount return only that subaccount's fills. If supplied, `subaccount` must match the key's restriction. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.

Corresponds with GET /historical/fills (the `GetFillsHistorical` operationId).

func (*Client) GetFiltersForSports

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

GetFiltersForSports Get Filters for Sports

Retrieve available filters organized by sport.

This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.

Corresponds with GET /search/filters_by_sport (the `GetFiltersForSports` operationId).

func (*Client) GetGameStats

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

GetGameStats Get Game Stats

Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men's Basketball, College Women's Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.

Corresponds with GET /live_data/milestone/{milestone_id}/game_stats (the `GetGameStats` operationId).

func (*Client) GetHistoricalCutoff

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

GetHistoricalCutoff Get Historical Cutoff Timestamps

Returns the archive's cutoff timestamps. For positions, the cutoff is the backfill horizon; visibility in the historical API waits for a buffered, whole-event handoff.

## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`. - `market_positions_last_updated_ts` : Backfill horizon for settled positions, not a guaranteed archive-visibility boundary. An event moves to `GET /historical/positions` only after its buffered handoff completes. Until then, its settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. Unsettled positions remain available in `GET /portfolio/positions`.

Corresponds with GET /historical/cutoff (the `GetHistoricalCutoff` operationId).

func (*Client) GetHistoricalMarket

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

GetHistoricalMarket Get Historical Market

Endpoint for getting data about a specific market by its ticker from the historical database.

Corresponds with GET /historical/markets/{ticker} (the `GetHistoricalMarket` operationId).

func (*Client) GetHistoricalMarkets

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

GetHistoricalMarkets Get Historical Markets

Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.

Corresponds with GET /historical/markets (the `GetHistoricalMarkets` operationId).

func (*Client) GetHistoricalOrders

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

GetHistoricalOrders Get Historical Orders

Endpoint for getting orders that have been archived to the historical database. API keys restricted to a subaccount return only that subaccount's orders. If supplied, `subaccount` must match the key's restriction.

Corresponds with GET /historical/orders (the `GetHistoricalOrders` operationId).

func (*Client) GetHistoricalPositions

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

GetHistoricalPositions Get Historical Positions

Returns settled market positions after their event completes the live-to-historical handoff. Until then, settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. The `market_positions_last_updated_ts` value on `GET /historical/cutoff` is the backfill horizon, not a guarantee that every older position has moved. Unsettled positions are available via `GET /portfolio/positions`.

Corresponds with GET /historical/positions (the `GetHistoricalPositions` operationId).

func (*Client) GetIncentivePrograms

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

GetIncentivePrograms Get Incentives

List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.

Corresponds with GET /incentive_programs (the `GetIncentivePrograms` operationId).

func (*Client) GetIntraExchangeInstanceTransfer

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

GetIntraExchangeInstanceTransfer Get Intra Account Transfer

Endpoint for getting a single intra-account transfer by id.

Corresponds with GET /portfolio/intra_exchange_instance_transfers/{transfer_id} (the `GetIntraExchangeInstanceTransfer` operationId).

func (*Client) GetIntraExchangeInstanceTransfers

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

GetIntraExchangeInstanceTransfers Get Intra Account Transfers

Endpoint for fetching intra-exchange account transfer history.

Corresponds with GET /portfolio/intra_exchange_instance_transfers (the `GetIntraExchangeInstanceTransfers` operationId).

func (*Client) GetLiveData

func (c *Client) GetLiveData(ctx context.Context, pType string, milestoneId string, params *GetLiveDataParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLiveData Get Live Data (with type)

Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.

Corresponds with GET /live_data/{type}/milestone/{milestone_id} (the `GetLiveData` operationId).

func (*Client) GetLiveDataByMilestone

func (c *Client) GetLiveDataByMilestone(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLiveDataByMilestone Get Live Data

Get live data for a specific milestone.

Corresponds with GET /live_data/milestone/{milestone_id} (the `GetLiveDataByMilestone` operationId).

func (*Client) GetLiveDatas

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

GetLiveDatas Get Multiple Live Data

Get live data for multiple milestones.

Corresponds with GET /live_data/batch (the `GetLiveDatas` operationId).

func (*Client) GetMarket

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

GetMarket Get Market

Endpoint for getting data about a specific market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., "Will candidate X win?"). Markets have yes/no positions, current prices, volume, and settlement rules.

Corresponds with GET /markets/{ticker} (the `GetMarket` operationId).

func (*Client) GetMarketCandlesticks

func (c *Client) GetMarketCandlesticks(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMarketCandlesticks Get Market Candlesticks

Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Corresponds with GET /series/{series_ticker}/markets/{ticker}/candlesticks (the `GetMarketCandlesticks` operationId).

func (*Client) GetMarketCandlesticksByEvent

func (c *Client) GetMarketCandlesticksByEvent(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksByEventParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMarketCandlesticksByEvent Get Event Candlesticks

End-point for returning aggregated data across all markets corresponding to an event.

Corresponds with GET /series/{series_ticker}/events/{ticker}/candlesticks (the `GetMarketCandlesticksByEvent` operationId).

func (*Client) GetMarketCandlesticksHistorical

func (c *Client) GetMarketCandlesticksHistorical(ctx context.Context, ticker string, params *GetMarketCandlesticksHistoricalParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMarketCandlesticksHistorical Get Historical Market Candlesticks

Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).

Corresponds with GET /historical/markets/{ticker}/candlesticks (the `GetMarketCandlesticksHistorical` operationId).

func (*Client) GetMarketOrderbook

func (c *Client) GetMarketOrderbook(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMarketOrderbook Get Market Orderbook

Endpoint for getting the current order book for a specific market.  The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes.  Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.

Corresponds with GET /markets/{ticker}/orderbook (the `GetMarketOrderbook` operationId).

func (*Client) GetMarketOrderbooks

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

GetMarketOrderbooks Get Multiple Market Orderbooks

Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.

Corresponds with GET /markets/orderbooks (the `GetMarketOrderbooks` operationId).

func (*Client) GetMarkets

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

GetMarkets Get Markets

Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.

• Only one `status` filter may be supplied at a time.

• Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.

  | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts, max_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude`. May be combined with `series_ticker`, which requires `mve_filter=exclude` |

  Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Corresponds with GET /markets (the `GetMarkets` operationId).

func (*Client) GetMilestone

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

GetMilestone Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Corresponds with GET /milestones/{milestone_id} (the `GetMilestone` operationId).

func (*Client) GetMilestones

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

GetMilestones Get Milestones

Minimum start date to filter milestones. Format: RFC3339 timestamp

Corresponds with GET /milestones (the `GetMilestones` operationId).

func (*Client) GetMultivariateEventCollection

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

GetMultivariateEventCollection Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Corresponds with GET /multivariate_event_collections/{collection_ticker} (the `GetMultivariateEventCollection` operationId).

func (*Client) GetMultivariateEventCollections

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

GetMultivariateEventCollections Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

Corresponds with GET /multivariate_event_collections (the `GetMultivariateEventCollections` operationId).

func (*Client) GetMultivariateEvents

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

GetMultivariateEvents Get Multivariate Events

Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series ticker, collection ticker, or a comma-separated list of event tickers.

Corresponds with GET /events/multivariate (the `GetMultivariateEvents` operationId).

func (*Client) GetOrder

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

GetOrder Get Order

Endpoint for getting a single order.

Corresponds with GET /portfolio/orders/{order_id} (the `GetOrder` operationId).

func (*Client) GetOrderGroup

func (c *Client) GetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetOrderGroup Get Order Group

Retrieves details for a single order group including all order IDs and auto-cancel status.

Corresponds with GET /portfolio/order_groups/{order_group_id} (the `GetOrderGroup` operationId).

func (*Client) GetOrderGroups

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

GetOrderGroups Get Order Groups

Retrieves all order groups for the authenticated user.

Corresponds with GET /portfolio/order_groups (the `GetOrderGroups` operationId).

func (*Client) GetOrderQueuePosition

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

GetOrderQueuePosition Get Order Queue Position

Endpoint for getting an order's queue position in the order book. This represents the amount of orders that need to be matched before this order receives a partial or full match. Queue position is determined using a price-time priority.

Corresponds with GET /portfolio/orders/{order_id}/queue_position (the `GetOrderQueuePosition` operationId).

func (*Client) GetOrderQueuePositions

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

GetOrderQueuePositions Get Queue Positions for Orders

Endpoint for getting queue positions for all resting orders. Queue position represents the number of contracts that need to be matched before an order receives a partial or full match, determined using price-time priority.

Corresponds with GET /portfolio/orders/queue_positions (the `GetOrderQueuePositions` operationId).

func (*Client) GetOrders

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

GetOrders Get Orders

Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Corresponds with GET /portfolio/orders (the `GetOrders` operationId).

func (*Client) GetPortfolioRestingOrderTotalValue

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

GetPortfolioRestingOrderTotalValue Get Total Resting Order Value

Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you're uncertain about this endpoint, it likely does not apply to you.

Corresponds with GET /portfolio/summary/total_resting_order_value (the `GetPortfolioRestingOrderTotalValue` operationId).

func (*Client) GetPositions

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

GetPositions Get Positions

Returns unsettled positions by default. Set `settlement_status=settled` to page through settled positions that are still in the live data set, or `settlement_status=all` for both live states. Positions already archived are available via `GET /historical/positions`. Settled and all-state positions are paginated by event ticker to keep large histories bounded. Cursors are specific to the selected settlement status. `count_filter` restricts positions to those with a non-zero position or total traded count. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.

Corresponds with GET /portfolio/positions (the `GetPositions` operationId).

func (*Client) GetQuote

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

GetQuote Get Quote

DEPRECATED: Use GET /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for getting a particular quote.

Corresponds with GET /communications/quotes/{quote_id} (the `GetQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) GetQuotes

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

GetQuotes Get Quotes

List quotes. The rfq_id filter requires an RFQ UUID. Pass pagination cursors back unchanged; malformed RFQ IDs or cursors return HTTP 400.

Corresponds with GET /communications/quotes (the `GetQuotes` operationId).

func (*Client) GetRFQ

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

GetRFQ Get RFQ

Endpoint for getting a single RFQ by id.

Corresponds with GET /communications/rfqs/{rfq_id} (the `GetRFQ` operationId).

func (*Client) GetRFQQuote

func (c *Client) GetRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRFQQuote Get RFQ Quote

Endpoint for getting a particular quote scoped to its RFQ.

Corresponds with GET /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `GetRFQQuote` operationId).

func (*Client) GetRFQs

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

GetRFQs Get RFQs

List RFQs. Pass pagination cursors back unchanged. A malformed cursor or invalid creator_user_id UUID returns HTTP 400. Use user_filter=self to filter by the authenticated user.

Corresponds with GET /communications/rfqs (the `GetRFQs` operationId).

func (*Client) GetSeries

func (c *Client) GetSeries(ctx context.Context, seriesTicker string, params *GetSeriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSeries Get Series

Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.

Corresponds with GET /series/{series_ticker} (the `GetSeries` operationId).

func (*Client) GetSeriesFeeChanges

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

GetSeriesFeeChanges Get Series Fee Changes

Corresponds with GET /series/fee_changes (the `GetSeriesFeeChanges` operationId).

func (*Client) GetSeriesList

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

GetSeriesList Get Series List

Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). This endpoint allows you to browse and discover available series templates by category.

Corresponds with GET /series (the `GetSeriesList` operationId).

func (*Client) GetSettlements

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

GetSettlements Get Settlements

Returns settlement records still in the live data set. Archived positions are available via `GET /historical/positions`, which has different fields; this endpoint does not return archived settlement records.

Corresponds with GET /portfolio/settlements (the `GetSettlements` operationId).

func (*Client) GetStructuredTarget

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

GetStructuredTarget Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Corresponds with GET /structured_targets/{structured_target_id} (the `GetStructuredTarget` operationId).

func (*Client) GetStructuredTargets

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

GetStructuredTargets Get Structured Targets

Page size (min: 1, max: 2000)

Corresponds with GET /structured_targets (the `GetStructuredTargets` operationId).

func (*Client) GetSubaccountBalances

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

GetSubaccountBalances Get All Subaccount Balances

Gets balances for all subaccounts including the primary account.

Corresponds with GET /portfolio/subaccounts/balances (the `GetSubaccountBalances` operationId).

func (*Client) GetSubaccountNetting

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

GetSubaccountNetting Get Subaccount Netting

Gets the netting enabled settings for all subaccounts.

Corresponds with GET /portfolio/subaccounts/netting (the `GetSubaccountNetting` operationId).

func (*Client) GetSubaccountTransfers

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

GetSubaccountTransfers Get Subaccount Transfers

Gets a paginated list of all transfers between subaccounts for the authenticated user.

Corresponds with GET /portfolio/subaccounts/transfers (the `GetSubaccountTransfers` operationId).

func (*Client) GetTagsForSeriesCategories

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

GetTagsForSeriesCategories Get Tags for Series Categories

Retrieve tags organized by series categories.

This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.

Corresponds with GET /search/tags_by_categories (the `GetTagsForSeriesCategories` operationId).

func (*Client) GetTargetBalanceAllocation

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

GetTargetBalanceAllocation Get Target Balance Allocation

Retrieves the caller's target balance allocation across exchange indexes.

Corresponds with GET /portfolio/target_balance_allocation (the `GetTargetBalanceAllocation` operationId).

func (*Client) GetTrades

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

GetTrades Get Trades

Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. Block trades are included in the response by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. This endpoint returns a paginated response. Use the 'limit' parameter to control page size (1-1000, defaults to 100). The response includes a 'cursor' field - pass this value in the 'cursor' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.

Corresponds with GET /markets/trades (the `GetTrades` operationId).

func (*Client) GetTradesHistorical

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

GetTradesHistorical Get Historical Trades

Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. Block trades are included by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Corresponds with GET /historical/trades (the `GetTradesHistorical` operationId).

func (*Client) GetUserDataTimestamp

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

GetUserDataTimestamp Get User Data Timestamp

There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with WebSocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions

Corresponds with GET /exchange/user_data_timestamp (the `GetUserDataTimestamp` operationId).

func (*Client) GetWeatherIndex

func (c *Client) GetWeatherIndex(ctx context.Context, city string, params *GetWeatherIndexParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetWeatherIndex Get Weather Index

Get the Kalshi-computed city temperature index: the canonical minute-resolution series behind hourly temperature markets. City-keyed and independent of any event — the series exists whenever the city's index is configured. Values are Fahrenheit rounded to 0.01. Minutes where the index quorum failed carry no value and are never returned as points, so gaps in the series are real gaps. With `detailed=true` each point additionally carries every member station's reported reading and quality-control disposition — the pre-incorporation breakdown.

Corresponds with GET /live_data/weather/{city} (the `GetWeatherIndex` operationId).

func (*Client) GetWeatherIndexCalibrations

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

GetWeatherIndexCalibrations Get Weather Index Calibrations

Get a city's published weather-index configuration timeline: the launch configuration plus every weekly offset calibration and methodology update, ascending by effective time. Each record carries the station weights, station offsets (Celsius), and the city reference used to compute index values from the record's effective time until the next record — everything needed to reproduce published index values for minutes computed under that configuration version. Offsets are re-estimated weekly after each complete UTC week; weights never change through calibration. The timeline is append-only and complete: it is never trimmed.

Corresponds with GET /live_data/weather/{city}/calibrations (the `GetWeatherIndexCalibrations` operationId).

func (*Client) GetWithdrawals

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

GetWithdrawals Get Withdrawals

Endpoint for getting the member's withdrawal history.

Corresponds with GET /portfolio/withdrawals (the `GetWithdrawals` operationId).

func (*Client) IntraExchangeInstanceTransfer

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

IntraExchangeInstanceTransfer Intra Account Transfer

Transfers funds within the same account.

When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.

Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).

func (*Client) IntraExchangeInstanceTransferWithBody

func (c *Client) IntraExchangeInstanceTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

IntraExchangeInstanceTransferWithBody Intra Account Transfer

Transfers funds within the same account.

When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.

Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).

func (*Client) ListFCMSubtraders

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

ListFCMSubtraders List FCM Subtraders

Lists the authenticated FCM's event-contract subtraders, including accounts with no trades. Exchange metadata is asynchronous, so newly created accounts may not appear immediately. Trading block status includes firm-wide and Kalshi restrictions; fcm_trading_blocked identifies the FCM's own per-subtrader restriction.

Corresponds with GET /fcm/subtraders (the `ListFCMSubtraders` operationId).

func (*Client) ProposeBlockTrade

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

ProposeBlockTrade Propose Block Trade

Endpoint for creating a block trade proposal.

Takes a body of the `application/json` content type.

Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).

func (*Client) ProposeBlockTradeWithBody

func (c *Client) ProposeBlockTradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ProposeBlockTradeWithBody Propose Block Trade

Endpoint for creating a block trade proposal.

Takes any type of body and a specified content type.

Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).

func (*Client) ResetOrderGroup

func (c *Client) ResetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, body ResetOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ResetOrderGroup Reset Order Group

Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.

Takes a body of the `application/json` content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).

func (*Client) ResetOrderGroupWithBody

func (c *Client) ResetOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ResetOrderGroupWithBody Reset Order Group

Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.

Takes any type of body and a specified content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).

func (*Client) SetTargetBalanceAllocation

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

SetTargetBalanceAllocation Set Target Balance Allocation

Replaces the caller's target balance allocation across exchange indexes. Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.

Takes a body of the `application/json` content type.

Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).

func (*Client) SetTargetBalanceAllocationWithBody

func (c *Client) SetTargetBalanceAllocationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetTargetBalanceAllocationWithBody Set Target Balance Allocation

Replaces the caller's target balance allocation across exchange indexes. Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.

Takes any type of body and a specified content type.

Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).

func (*Client) TriggerOrderGroup

func (c *Client) TriggerOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, body TriggerOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

TriggerOrderGroup Trigger Order Group

Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.

Takes a body of the `application/json` content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).

func (*Client) TriggerOrderGroupWithBody

func (c *Client) TriggerOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

TriggerOrderGroupWithBody Trigger Order Group

Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.

Takes any type of body and a specified content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).

func (*Client) UpdateFCMEventContractDailyCap

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

UpdateFCMEventContractDailyCap Update FCM Subtrader Event Contract Daily Cap

Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds the subtrader's net premium at risk per trading day. It is enforced on cap-reservation sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader with no cap cannot trade through its bound keys. Cap changes take effect immediately; existing resting orders are never cancelled by a cap change.

Takes a body of the `application/json` content type.

Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).

func (*Client) UpdateFCMEventContractDailyCapWithBody

func (c *Client) UpdateFCMEventContractDailyCapWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateFCMEventContractDailyCapWithBody Update FCM Subtrader Event Contract Daily Cap

Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds the subtrader's net premium at risk per trading day. It is enforced on cap-reservation sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader with no cap cannot trade through its bound keys. Cap changes take effect immediately; existing resting orders are never cancelled by a cap change.

Takes any type of body and a specified content type.

Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).

func (*Client) UpdateFCMSubtraderBlockedCategories

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

UpdateFCMSubtraderBlockedCategories Update FCM Subtrader Blocked Categories

Adds one event category to, or removes one from, the set an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. Blocks apply prospectively: new orders the subtrader places through its bound API credentials are rejected in markets whose event belongs to a blocked category, while orders already resting are not cancelled. Returns the subtrader's full resulting blocked set.

Takes a body of the `application/json` content type.

Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).

func (*Client) UpdateFCMSubtraderBlockedCategoriesWithBody

func (c *Client) UpdateFCMSubtraderBlockedCategoriesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateFCMSubtraderBlockedCategoriesWithBody Update FCM Subtrader Blocked Categories

Adds one event category to, or removes one from, the set an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. Blocks apply prospectively: new orders the subtrader places through its bound API credentials are rejected in markets whose event belongs to a blocked category, while orders already resting are not cancelled. Returns the subtrader's full resulting blocked set.

Takes any type of body and a specified content type.

Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).

func (*Client) UpdateOrderGroupLimit

func (c *Client) UpdateOrderGroupLimit(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, body UpdateOrderGroupLimitJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateOrderGroupLimit Update Order Group Limit

Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.

Takes a body of the `application/json` content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).

func (*Client) UpdateOrderGroupLimitWithBody

func (c *Client) UpdateOrderGroupLimitWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateOrderGroupLimitWithBody Update Order Group Limit

Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.

Takes any type of body and a specified content type.

Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).

func (*Client) UpdateSubaccountNetting

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

UpdateSubaccountNetting Update Subaccount Netting

Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.

Takes a body of the `application/json` content type.

Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).

func (*Client) UpdateSubaccountNettingWithBody

func (c *Client) UpdateSubaccountNettingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateSubaccountNettingWithBody Update Subaccount Netting

Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.

Takes any type of body and a specified content type.

Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).

func (*Client) UpgradeAccountApiUsageLevel

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

UpgradeAccountApiUsageLevel Upgrade Account API Usage Level

Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user's last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.

Corresponds with POST /account/api_usage_level/upgrade (the `UpgradeAccountApiUsageLevel` operationId).

type ClientInterface

type ClientInterface interface {

	// UpgradeAccountApiUsageLevel Upgrade Account API Usage Level
	//
	// Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user's last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
	//
	// Corresponds with POST /account/api_usage_level/upgrade (the `UpgradeAccountApiUsageLevel` operationId).
	UpgradeAccountApiUsageLevel(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountApiUsageLevelVolumeProgress Get Account API Usage Level Volume Progress
	//
	// Returns the authenticated user's latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
	//
	// Corresponds with GET /account/api_usage_level/volume_progress (the `GetAccountApiUsageLevelVolumeProgress` operationId).
	GetAccountApiUsageLevelVolumeProgress(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountEndpointCosts List Non-Default Endpoint Costs
	//
	// Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
	//
	// Corresponds with GET /account/endpoint_costs (the `GetAccountEndpointCosts` operationId).
	GetAccountEndpointCosts(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountApiLimits Get Account API Limits
	//
	// Endpoint to retrieve the authenticated user's Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
	//
	// Corresponds with GET /account/limits (the `GetAccountApiLimits` operationId).
	GetAccountApiLimits(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKeys Get API Keys
	//
	//  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
	//
	// Corresponds with GET /api_keys (the `GetApiKeys` operationId).
	GetApiKeys(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateApiKeyWithBody Create API Key
	//
	//  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api_keys (the `CreateApiKey` operationId).
	CreateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateApiKey Create API Key
	//
	//  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api_keys (the `CreateApiKey` operationId).
	CreateApiKey(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateApiKeyWithBody Generate API Key
	//
	//  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).
	GenerateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateApiKey Generate API Key
	//
	//  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).
	GenerateApiKey(ctx context.Context, body GenerateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiKey Delete API Key
	//
	//  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
	//
	// Corresponds with DELETE /api_keys/{api_key} (the `DeleteApiKey` operationId).
	DeleteApiKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBlockTradeProposals Get Block Trade Proposals
	//
	//  Endpoint for getting block trade proposals visible to the authenticated user.
	//
	// Corresponds with GET /communications/block-trade-proposals (the `GetBlockTradeProposals` operationId).
	GetBlockTradeProposals(ctx context.Context, params *GetBlockTradeProposalsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProposeBlockTradeWithBody Propose Block Trade
	//
	//  Endpoint for creating a block trade proposal.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).
	ProposeBlockTradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProposeBlockTrade Propose Block Trade
	//
	//  Endpoint for creating a block trade proposal.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).
	ProposeBlockTrade(ctx context.Context, body ProposeBlockTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptBlockTradeProposalWithBody Accept Block Trade Proposal
	//
	//  Endpoint for accepting a block trade proposal.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).
	AcceptBlockTradeProposalWithBody(ctx context.Context, blockTradeProposalId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptBlockTradeProposal Accept Block Trade Proposal
	//
	//  Endpoint for accepting a block trade proposal.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).
	AcceptBlockTradeProposal(ctx context.Context, blockTradeProposalId string, body AcceptBlockTradeProposalJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCommunicationsID Get Communications ID
	//
	//  Endpoint for getting the communications ID of the logged-in user.
	//
	// Corresponds with GET /communications/id (the `GetCommunicationsID` operationId).
	GetCommunicationsID(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetQuotes Get Quotes
	//
	// List quotes. The rfq_id filter requires an RFQ UUID. Pass pagination cursors back unchanged; malformed RFQ IDs or cursors return HTTP 400.
	//
	// Corresponds with GET /communications/quotes (the `GetQuotes` operationId).
	GetQuotes(ctx context.Context, params *GetQuotesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateQuoteWithBody Create Quote
	//
	//  Endpoint for creating a quote in response to an RFQ.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /communications/quotes (the `CreateQuote` operationId).
	CreateQuoteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateQuote Create Quote
	//
	//  Endpoint for creating a quote in response to an RFQ.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /communications/quotes (the `CreateQuote` operationId).
	CreateQuote(ctx context.Context, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteQuote Delete Quote
	//
	// DEPRECATED: Use DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for deleting a quote, which means it can no longer be accepted.
	//
	// Corresponds with DELETE /communications/quotes/{quote_id} (the `DeleteQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	DeleteQuote(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetQuote Get Quote
	//
	// DEPRECATED: Use GET /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for getting a particular quote.
	//
	// Corresponds with GET /communications/quotes/{quote_id} (the `GetQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetQuote(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptQuoteWithBody Accept Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AcceptQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptQuote Accept Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AcceptQuote(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConfirmQuoteWithBody Confirm Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ConfirmQuoteWithBody(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConfirmQuote Confirm Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ConfirmQuote(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRFQs Get RFQs
	//
	// List RFQs. Pass pagination cursors back unchanged. A malformed cursor or invalid creator_user_id UUID returns HTTP 400. Use user_filter=self to filter by the authenticated user.
	//
	// Corresponds with GET /communications/rfqs (the `GetRFQs` operationId).
	GetRFQs(ctx context.Context, params *GetRFQsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRFQWithBody Create RFQ
	//
	//  Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).
	CreateRFQWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRFQ Create RFQ
	//
	//  Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).
	CreateRFQ(ctx context.Context, body CreateRFQJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRFQ Delete RFQ
	//
	//  Endpoint for deleting an RFQ by ID.
	//
	// Corresponds with DELETE /communications/rfqs/{rfq_id} (the `DeleteRFQ` operationId).
	DeleteRFQ(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRFQ Get RFQ
	//
	//  Endpoint for getting a single RFQ by id.
	//
	// Corresponds with GET /communications/rfqs/{rfq_id} (the `GetRFQ` operationId).
	GetRFQ(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRFQQuote Delete RFQ Quote
	//
	//  Endpoint for deleting a quote scoped to its RFQ, which means it can no longer be accepted.
	//
	// Corresponds with DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `DeleteRFQQuote` operationId).
	DeleteRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRFQQuote Get RFQ Quote
	//
	//  Endpoint for getting a particular quote scoped to its RFQ.
	//
	// Corresponds with GET /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `GetRFQQuote` operationId).
	GetRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptRFQQuoteWithBody Accept RFQ Quote
	//
	//  Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).
	AcceptRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptRFQQuote Accept RFQ Quote
	//
	//  Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).
	AcceptRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body AcceptRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConfirmRFQQuoteWithBody Confirm RFQ Quote
	//
	//  Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).
	ConfirmRFQQuoteWithBody(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ConfirmRFQQuote Confirm RFQ Quote
	//
	//  Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).
	ConfirmRFQQuote(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body ConfirmRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvents Get Events
	//
	// Get all events. This endpoint excludes multivariate events.
	// To retrieve multivariate events, use the GET /events/multivariate endpoint.
	// All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
	//
	// Corresponds with GET /events (the `GetEvents` operationId).
	GetEvents(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEventFeeChanges Get Event Fee Changes
	//
	// Event fees are an override layered on top of the parent series' fee structure. If `fee_type_override` and `fee_multiplier_override` are null, that indicates the override is cleared.
	//
	// Corresponds with GET /events/fee_changes (the `GetEventFeeChanges` operationId).
	GetEventFeeChanges(ctx context.Context, params *GetEventFeeChangesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMultivariateEvents Get Multivariate Events
	//
	// Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series ticker, collection ticker, or a comma-separated list of event tickers.
	//
	// Corresponds with GET /events/multivariate (the `GetMultivariateEvents` operationId).
	GetMultivariateEvents(ctx context.Context, params *GetMultivariateEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvent Get Event
	//
	// Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release.
	// Events contain one or more markets where users can place trades on different outcomes.
	// All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
	//
	// Corresponds with GET /events/{event_ticker} (the `GetEvent` operationId).
	GetEvent(ctx context.Context, eventTicker string, params *GetEventParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEventMetadata Get Event Metadata
	//
	//  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
	//
	// Corresponds with GET /events/{event_ticker}/metadata (the `GetEventMetadata` operationId).
	GetEventMetadata(ctx context.Context, eventTicker string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExchangeSchedule Get Exchange Schedule
	//
	//  Endpoint for getting the exchange schedule.
	//
	// Corresponds with GET /exchange/schedule (the `GetExchangeSchedule` operationId).
	GetExchangeSchedule(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExchangeStatus Get Exchange Status
	//
	//  Endpoint for getting the exchange status.
	//
	// Corresponds with GET /exchange/status (the `GetExchangeStatus` operationId).
	GetExchangeStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserDataTimestamp Get User Data Timestamp
	//
	//  There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with WebSocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
	//
	// Corresponds with GET /exchange/user_data_timestamp (the `GetUserDataTimestamp` operationId).
	GetUserDataTimestamp(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFCMFills Get FCM Fills
	//
	// Returns fills across the authenticated FCM's subtraders. Requires FCM member access.
	//
	// Corresponds with GET /fcm/fills (the `GetFCMFills` operationId).
	GetFCMFills(ctx context.Context, params *GetFCMFillsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFCMOrders Get FCM Orders
	//
	// Endpoint for FCM members to get orders for their subtraders.
	// This endpoint requires FCM member access level. At least one of `subtrader_id` or
	// `client_order_ids` is required; supplying both returns only the orders matching both filters.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Corresponds with GET /fcm/orders (the `GetFCMOrders` operationId).
	GetFCMOrders(ctx context.Context, params *GetFCMOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFCMPositions Get FCM Positions
	//
	// Endpoint for FCM members to get market positions filtered by subtrader ID.
	// This endpoint requires FCM member access level and allows filtering positions by subtrader ID.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Corresponds with GET /fcm/positions (the `GetFCMPositions` operationId).
	GetFCMPositions(ctx context.Context, params *GetFCMPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMPositionTransferWithBody Create FCM Position Transfer
	//
	// Endpoint for FCM members to move a position in one market from one of their subtraders into a
	// subtrader under their FCM's error account.
	//
	// **This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the
	// error account that receives transferred positions and gives you that account's user id, which
	// prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.
	//
	// - The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader
	//   under it, which is created on first use.
	// - Each request moves one market for one source subtrader. To move many positions, send one
	//   request per subtrader and market.
	// - The transfer is booked like a trade at `price_centicents`, which is always the YES price, even
	//   when moving NO. No fee is charged and no fill is created. For YES, the error account pays the
	//   price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same
	//   amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds
	//   the side being moved and the target subtrader holds no opposite position in that market;
	//   otherwise the positions net like a trade and the balance changes differ.
	// - The source's current position is not checked. A request for more than the source holds, or
	//   with the opposite sign, flips or grows the source's position.
	// - Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
	// - The market must be open, neither account may be blocked, and the error account must have
	//   enough available balance on the market's exchange index to pay for the transfer. Otherwise
	//   the request returns 409.
	//
	// **Example: moving YES.** A customer subtrader holds 10 YES contracts. Send
	// `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents):
	// - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES.
	// - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50.
	// - Sending `price_centicents` 0 instead moves the position with no cash.
	//
	// **Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount`
	// -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):
	// - The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
	// - The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
	// - Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the
	//   error account pay the full $1 per contract ($5.00).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).
	CreateFCMPositionTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMPositionTransfer Create FCM Position Transfer
	//
	// Endpoint for FCM members to move a position in one market from one of their subtraders into a
	// subtrader under their FCM's error account.
	//
	// **This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the
	// error account that receives transferred positions and gives you that account's user id, which
	// prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.
	//
	// - The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader
	//   under it, which is created on first use.
	// - Each request moves one market for one source subtrader. To move many positions, send one
	//   request per subtrader and market.
	// - The transfer is booked like a trade at `price_centicents`, which is always the YES price, even
	//   when moving NO. No fee is charged and no fill is created. For YES, the error account pays the
	//   price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same
	//   amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds
	//   the side being moved and the target subtrader holds no opposite position in that market;
	//   otherwise the positions net like a trade and the balance changes differ.
	// - The source's current position is not checked. A request for more than the source holds, or
	//   with the opposite sign, flips or grows the source's position.
	// - Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
	// - The market must be open, neither account may be blocked, and the error account must have
	//   enough available balance on the market's exchange index to pay for the transfer. Otherwise
	//   the request returns 409.
	//
	// **Example: moving YES.** A customer subtrader holds 10 YES contracts. Send
	// `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents):
	// - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES.
	// - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50.
	// - Sending `price_centicents` 0 instead moves the position with no cash.
	//
	// **Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount`
	// -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):
	// - The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
	// - The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
	// - Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the
	//   error account pay the full $1 per contract ($5.00).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).
	CreateFCMPositionTransfer(ctx context.Context, body CreateFCMPositionTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFCMSubtraders List FCM Subtraders
	//
	// Lists the authenticated FCM's event-contract subtraders, including accounts with
	// no trades. Exchange metadata is asynchronous, so newly created accounts may not
	// appear immediately. Trading block status includes firm-wide and Kalshi restrictions;
	// fcm_trading_blocked identifies the FCM's own per-subtrader restriction.
	//
	// Corresponds with GET /fcm/subtraders (the `ListFCMSubtraders` operationId).
	ListFCMSubtraders(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMSubtraderWithBody Create FCM Subtrader
	//
	// Endpoint for FCM members to create a subtrader on the event-contract exchange. The
	// subtrader is registered on every exchange shard that knows the FCM; a shard provisioned
	// later registers it lazily on the subtrader's first order there. Re-creating an existing
	// subtrader returns 409.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).
	CreateFCMSubtraderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMSubtrader Create FCM Subtrader
	//
	// Endpoint for FCM members to create a subtrader on the event-contract exchange. The
	// subtrader is registered on every exchange shard that knows the FCM; a shard provisioned
	// later registers it lazily on the subtrader's first order there. Re-creating an existing
	// subtrader returns 409.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).
	CreateFCMSubtrader(ctx context.Context, body CreateFCMSubtraderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFCMSubtraderBlockedCategories Get FCM Subtrader Blocked Categories
	//
	// Returns the event categories an FCM member has blocked for one of its
	// subtraders. The subtrader must belong to the requesting FCM. A subtrader
	// with no blocks returns an empty list.
	//
	// Corresponds with GET /fcm/subtraders/blocked_categories (the `GetFCMSubtraderBlockedCategories` operationId).
	GetFCMSubtraderBlockedCategories(ctx context.Context, params *GetFCMSubtraderBlockedCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFCMSubtraderBlockedCategoriesWithBody Update FCM Subtrader Blocked Categories
	//
	// Adds one event category to, or removes one from, the set an FCM member
	// has blocked for one of its subtraders. The subtrader must belong to the
	// requesting FCM. Blocks apply prospectively: new orders the subtrader
	// places through its bound API credentials are rejected in markets whose
	// event belongs to a blocked category, while orders already resting are
	// not cancelled. Returns the subtrader's full resulting blocked set.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).
	UpdateFCMSubtraderBlockedCategoriesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFCMSubtraderBlockedCategories Update FCM Subtrader Blocked Categories
	//
	// Adds one event category to, or removes one from, the set an FCM member
	// has blocked for one of its subtraders. The subtrader must belong to the
	// requesting FCM. Blocks apply prospectively: new orders the subtrader
	// places through its bound API credentials are rejected in markets whose
	// event belongs to a blocked category, while orders already resting are
	// not cancelled. Returns the subtrader's full resulting blocked set.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).
	UpdateFCMSubtraderBlockedCategories(ctx context.Context, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFCMEventContractDailyCap Delete FCM Subtrader Event Contract Daily Cap
	//
	// Removes the event-contract daily premium cap for an FCM member's subtrader. Removal
	// closes the subtrader to new orders on cap-reservation sessions — every subtrader-bound
	// API key — until a cap is set again. It does not stop orders your own unbound sessions
	// submit on the subtrader's behalf; to stop the account entirely, block subtrader trading.
	//
	// Corresponds with DELETE /fcm/subtraders/event_contract_daily_cap (the `DeleteFCMEventContractDailyCap` operationId).
	DeleteFCMEventContractDailyCap(ctx context.Context, params *DeleteFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFCMEventContractDailyCap Get FCM Subtrader Event Contract Daily Cap
	//
	// Returns the event-contract daily premium cap configured for an FCM member's subtrader,
	// together with its live utilization. Executed utilization is the net premium deployed by
	// fills today (sells and settlements credit back); resting and pending utilization reserve
	// open and in-flight orders at their full worst-case cost plus fees. Executed utilization
	// resets at midnight New York time on the returned cap date; resting and pending
	// reservations persist for as long as their orders remain open, including across the reset.
	// Returns 404 when the subtrader has no cap configured — in that state every order placed
	// through the subtrader's bound API keys is rejected.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Corresponds with GET /fcm/subtraders/event_contract_daily_cap (the `GetFCMEventContractDailyCap` operationId).
	GetFCMEventContractDailyCap(ctx context.Context, params *GetFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFCMEventContractDailyCapWithBody Update FCM Subtrader Event Contract Daily Cap
	//
	// Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds
	// the subtrader's net premium at risk per trading day. It is enforced on cap-reservation
	// sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader
	// with no cap cannot trade through its bound keys. Cap changes take effect immediately;
	// existing resting orders are never cancelled by a cap change.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).
	UpdateFCMEventContractDailyCapWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFCMEventContractDailyCap Update FCM Subtrader Event Contract Daily Cap
	//
	// Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds
	// the subtrader's net premium at risk per trading day. It is enforced on cap-reservation
	// sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader
	// with no cap cannot trade through its bound keys. Cap changes take effect immediately;
	// existing resting orders are never cancelled by a cap change.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).
	UpdateFCMEventContractDailyCap(ctx context.Context, body UpdateFCMEventContractDailyCapJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalCutoff Get Historical Cutoff Timestamps
	//
	// Returns the archive's cutoff timestamps. For positions, the cutoff is the backfill horizon; visibility in the historical API waits for a buffered, whole-event handoff.
	//
	// ## Cutoff fields
	// - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`.
	// - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`.
	// - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
	// - `market_positions_last_updated_ts` : Backfill horizon for settled positions, not a guaranteed archive-visibility boundary. An event moves to `GET /historical/positions` only after its buffered handoff completes. Until then, its settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. Unsettled positions remain available in `GET /portfolio/positions`.
	//
	// Corresponds with GET /historical/cutoff (the `GetHistoricalCutoff` operationId).
	GetHistoricalCutoff(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFillsHistorical Get Historical Fills
	//
	// Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
	// API keys restricted to a subaccount return only that subaccount's fills. If supplied, `subaccount` must match the key's restriction.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	//
	// Corresponds with GET /historical/fills (the `GetFillsHistorical` operationId).
	GetFillsHistorical(ctx context.Context, params *GetFillsHistoricalParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalMarkets Get Historical Markets
	//
	// Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
	//
	// Corresponds with GET /historical/markets (the `GetHistoricalMarkets` operationId).
	GetHistoricalMarkets(ctx context.Context, params *GetHistoricalMarketsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalMarket Get Historical Market
	//
	//  Endpoint for getting data about a specific market by its ticker from the historical database.
	//
	// Corresponds with GET /historical/markets/{ticker} (the `GetHistoricalMarket` operationId).
	GetHistoricalMarket(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarketCandlesticksHistorical Get Historical Market Candlesticks
	//
	//  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
	//
	// Corresponds with GET /historical/markets/{ticker}/candlesticks (the `GetMarketCandlesticksHistorical` operationId).
	GetMarketCandlesticksHistorical(ctx context.Context, ticker string, params *GetMarketCandlesticksHistoricalParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalOrders Get Historical Orders
	//
	// Endpoint for getting orders that have been archived to the historical database.
	// API keys restricted to a subaccount return only that subaccount's orders. If supplied, `subaccount` must match the key's restriction.
	//
	// Corresponds with GET /historical/orders (the `GetHistoricalOrders` operationId).
	GetHistoricalOrders(ctx context.Context, params *GetHistoricalOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalPositions Get Historical Positions
	//
	// Returns settled market positions after their event completes the live-to-historical handoff. Until then, settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. The `market_positions_last_updated_ts` value on `GET /historical/cutoff` is the backfill horizon, not a guarantee that every older position has moved. Unsettled positions are available via `GET /portfolio/positions`.
	//
	// Corresponds with GET /historical/positions (the `GetHistoricalPositions` operationId).
	GetHistoricalPositions(ctx context.Context, params *GetHistoricalPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTradesHistorical Get Historical Trades
	//
	//  Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. Block trades are included by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Corresponds with GET /historical/trades (the `GetTradesHistorical` operationId).
	GetTradesHistorical(ctx context.Context, params *GetTradesHistoricalParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIncentivePrograms Get Incentives
	//
	//  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
	//
	// Corresponds with GET /incentive_programs (the `GetIncentivePrograms` operationId).
	GetIncentivePrograms(ctx context.Context, params *GetIncentiveProgramsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLiveDatas Get Multiple Live Data
	//
	// Get live data for multiple milestones.
	//
	// Corresponds with GET /live_data/batch (the `GetLiveDatas` operationId).
	GetLiveDatas(ctx context.Context, params *GetLiveDatasParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEventLiveData Get Event Live Data
	//
	// Get live data for an event by its event ticker. Serves event-keyed live data such as crypto price charts, commodity price timeseries, and weather observations. The `type` field in the response names the schema of the `details` object.
	//
	// Corresponds with GET /live_data/events/{event_ticker} (the `GetEventLiveData` operationId).
	GetEventLiveData(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLiveDataByMilestone Get Live Data
	//
	// Get live data for a specific milestone.
	//
	// Corresponds with GET /live_data/milestone/{milestone_id} (the `GetLiveDataByMilestone` operationId).
	GetLiveDataByMilestone(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetGameStats Get Game Stats
	//
	// Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men's Basketball, College Women's Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
	//
	// Corresponds with GET /live_data/milestone/{milestone_id}/game_stats (the `GetGameStats` operationId).
	GetGameStats(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetWeatherIndex Get Weather Index
	//
	// Get the Kalshi-computed city temperature index: the canonical minute-resolution series behind hourly temperature markets. City-keyed and independent of any event — the series exists whenever the city's index is configured. Values are Fahrenheit rounded to 0.01. Minutes where the index quorum failed carry no value and are never returned as points, so gaps in the series are real gaps. With `detailed=true` each point additionally carries every member station's reported reading and quality-control disposition — the pre-incorporation breakdown.
	//
	// Corresponds with GET /live_data/weather/{city} (the `GetWeatherIndex` operationId).
	GetWeatherIndex(ctx context.Context, city string, params *GetWeatherIndexParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetWeatherIndexCalibrations Get Weather Index Calibrations
	//
	// Get a city's published weather-index configuration timeline: the launch configuration plus every weekly offset calibration and methodology update, ascending by effective time. Each record carries the station weights, station offsets (Celsius), and the city reference used to compute index values from the record's effective time until the next record — everything needed to reproduce published index values for minutes computed under that configuration version. Offsets are re-estimated weekly after each complete UTC week; weights never change through calibration. The timeline is append-only and complete: it is never trimmed.
	//
	// Corresponds with GET /live_data/weather/{city}/calibrations (the `GetWeatherIndexCalibrations` operationId).
	GetWeatherIndexCalibrations(ctx context.Context, city string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLiveData Get Live Data (with type)
	//
	// Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
	//
	// Corresponds with GET /live_data/{type}/milestone/{milestone_id} (the `GetLiveData` operationId).
	GetLiveData(ctx context.Context, pType string, milestoneId string, params *GetLiveDataParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarkets Get Markets
	//
	// Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.
	//  - Only one `status` filter may be supplied at a time.
	//  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.
	//
	//  | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |
	//  |------------------------------|--------------------------|-------------|
	//  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |
	//  | min_close_ts, max_close_ts | `closed`, *empty* | |
	//  | min_settled_ts, max_settled_ts | `settled`, *empty* | |
	//  | min_updated_ts, max_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude`. May be combined with `series_ticker`, which requires `mve_filter=exclude` |
	//
	//  Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Corresponds with GET /markets (the `GetMarkets` operationId).
	GetMarkets(ctx context.Context, params *GetMarketsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchGetMarketCandlesticks Batch Get Market Candlesticks
	//
	// Endpoint for retrieving candlestick data for multiple markets.
	//
	// - Accepts up to 100 market tickers per request
	// - Returns up to 10,000 candlesticks total across all markets
	// - Returns candlesticks grouped by market_id
	// - Optionally includes a synthetic initial candlestick for price continuity (see `include_latest_before_start` parameter)
	//
	// Corresponds with GET /markets/candlesticks (the `BatchGetMarketCandlesticks` operationId).
	BatchGetMarketCandlesticks(ctx context.Context, params *BatchGetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarketOrderbooks Get Multiple Market Orderbooks
	//
	// Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
	//
	// Corresponds with GET /markets/orderbooks (the `GetMarketOrderbooks` operationId).
	GetMarketOrderbooks(ctx context.Context, params *GetMarketOrderbooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTrades Get Trades
	//
	// Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. Block trades are included in the response by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. This endpoint returns a paginated response. Use the 'limit' parameter to control page size (1-1000, defaults to 100). The response includes a 'cursor' field - pass this value in the 'cursor' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
	//
	// Corresponds with GET /markets/trades (the `GetTrades` operationId).
	GetTrades(ctx context.Context, params *GetTradesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarket Get Market
	//
	//  Endpoint for getting data about a specific market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., "Will candidate X win?"). Markets have yes/no positions, current prices, volume, and settlement rules.
	//
	// Corresponds with GET /markets/{ticker} (the `GetMarket` operationId).
	GetMarket(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarketOrderbook Get Market Orderbook
	//
	//  Endpoint for getting the current order book for a specific market.  The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes.  Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.
	//
	// Corresponds with GET /markets/{ticker}/orderbook (the `GetMarketOrderbook` operationId).
	GetMarketOrderbook(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMilestones Get Milestones
	//
	// Minimum start date to filter milestones. Format: RFC3339 timestamp
	//
	// Corresponds with GET /milestones (the `GetMilestones` operationId).
	GetMilestones(ctx context.Context, params *GetMilestonesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMilestone Get Milestone
	//
	//  Endpoint for getting data about a specific milestone by its ID.
	//
	// Corresponds with GET /milestones/{milestone_id} (the `GetMilestone` operationId).
	GetMilestone(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMultivariateEventCollections Get Multivariate Event Collections
	//
	//  Endpoint for getting data about multivariate event collections.
	//
	// Corresponds with GET /multivariate_event_collections (the `GetMultivariateEventCollections` operationId).
	GetMultivariateEventCollections(ctx context.Context, params *GetMultivariateEventCollectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMultivariateEventCollection Get Multivariate Event Collection
	//
	//  Endpoint for getting data about a multivariate event collection by its ticker.
	//
	// Corresponds with GET /multivariate_event_collections/{collection_ticker} (the `GetMultivariateEventCollection` operationId).
	GetMultivariateEventCollection(ctx context.Context, collectionTicker string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateMarketInMultivariateEventCollectionWithBody Create Market In Multivariate Event Collection
	//
	// Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).
	CreateMarketInMultivariateEventCollectionWithBody(ctx context.Context, collectionTicker string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateMarketInMultivariateEventCollection Create Market In Multivariate Event Collection
	//
	// Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).
	CreateMarketInMultivariateEventCollection(ctx context.Context, collectionTicker string, body CreateMarketInMultivariateEventCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBalance Get Balance
	//
	// Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.
	//
	// **Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.
	//
	// Corresponds with GET /portfolio/balance (the `GetBalance` operationId).
	GetBalance(ctx context.Context, params *GetBalanceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDeposits Get Deposits
	//
	// Endpoint for getting the member's deposit history.
	//
	// Corresponds with GET /portfolio/deposits (the `GetDeposits` operationId).
	GetDeposits(ctx context.Context, params *GetDepositsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelAllOrders Cancel All Orders
	//
	// Cancels all resting event-market orders for the authenticated Direct member across every exchange shard. If `subaccount` is omitted, matching orders may come from any subaccount. If it is provided, only orders for that subaccount are eligible. Newly placed orders may also be cancelled during the minute after the request.
	//
	// Corresponds with DELETE /portfolio/events/orders (the `CancelAllOrders` operationId).
	CancelAllOrders(ctx context.Context, params *CancelAllOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderV2WithBody Create Order (V2)
	//
	// Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).
	CreateOrderV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderV2 Create Order (V2)
	//
	// Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).
	CreateOrderV2(ctx context.Context, body CreateOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchCancelOrdersV2WithBody Batch Cancel Orders (V2)
	//
	// Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).
	BatchCancelOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchCancelOrdersV2 Batch Cancel Orders (V2)
	//
	// Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).
	BatchCancelOrdersV2(ctx context.Context, body BatchCancelOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchCreateOrdersV2WithBody Batch Create Orders (V2)
	//
	// Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).
	BatchCreateOrdersV2WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchCreateOrdersV2 Batch Create Orders (V2)
	//
	// Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).
	BatchCreateOrdersV2(ctx context.Context, body BatchCreateOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelOrderV2 Cancel Order (V2)
	//
	// Endpoint for cancelling event-market orders using the V2 response shape. To auto-route the cancellation, provide `market_ticker` and omit `exchange_index` or set it to `-1`. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
	//
	// Corresponds with DELETE /portfolio/events/orders/{order_id} (the `CancelOrderV2` operationId).
	CancelOrderV2(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AmendOrderV2WithBody Amend Order (V2)
	//
	// Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).
	AmendOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AmendOrderV2 Amend Order (V2)
	//
	// Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).
	AmendOrderV2(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, body AmendOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DecreaseOrderV2WithBody Decrease Order (V2)
	//
	// Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).
	DecreaseOrderV2WithBody(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DecreaseOrderV2 Decrease Order (V2)
	//
	// Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).
	DecreaseOrderV2(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, body DecreaseOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFills Get Fills
	//
	// Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	// Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Corresponds with GET /portfolio/fills (the `GetFills` operationId).
	GetFills(ctx context.Context, params *GetFillsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IntraExchangeInstanceTransferWithBody Intra Account Transfer
	//
	// Transfers funds within the same account.
	//
	// When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.
	//
	// Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).
	IntraExchangeInstanceTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IntraExchangeInstanceTransfer Intra Account Transfer
	//
	// Transfers funds within the same account.
	//
	// When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.
	//
	// Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).
	IntraExchangeInstanceTransfer(ctx context.Context, body IntraExchangeInstanceTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIntraExchangeInstanceTransfers Get Intra Account Transfers
	//
	// Endpoint for fetching intra-exchange account transfer history.
	//
	// Corresponds with GET /portfolio/intra_exchange_instance_transfers (the `GetIntraExchangeInstanceTransfers` operationId).
	GetIntraExchangeInstanceTransfers(ctx context.Context, params *GetIntraExchangeInstanceTransfersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIntraExchangeInstanceTransfer Get Intra Account Transfer
	//
	// Endpoint for getting a single intra-account transfer by id.
	//
	// Corresponds with GET /portfolio/intra_exchange_instance_transfers/{transfer_id} (the `GetIntraExchangeInstanceTransfer` operationId).
	GetIntraExchangeInstanceTransfer(ctx context.Context, transferId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrderGroups Get Order Groups
	//
	//  Retrieves all order groups for the authenticated user.
	//
	// Corresponds with GET /portfolio/order_groups (the `GetOrderGroups` operationId).
	GetOrderGroups(ctx context.Context, params *GetOrderGroupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderGroupWithBody Create Order Group
	//
	//  Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).
	CreateOrderGroupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderGroup Create Order Group
	//
	//  Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).
	CreateOrderGroup(ctx context.Context, body CreateOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteOrderGroup Delete Order Group
	//
	//  Deletes an order group and cancels all orders within it. This permanently removes the group.
	//
	// Corresponds with DELETE /portfolio/order_groups/{order_group_id} (the `DeleteOrderGroup` operationId).
	DeleteOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrderGroup Get Order Group
	//
	//  Retrieves details for a single order group including all order IDs and auto-cancel status.
	//
	// Corresponds with GET /portfolio/order_groups/{order_group_id} (the `GetOrderGroup` operationId).
	GetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrderGroupLimitWithBody Update Order Group Limit
	//
	//  Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).
	UpdateOrderGroupLimitWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateOrderGroupLimit Update Order Group Limit
	//
	//  Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).
	UpdateOrderGroupLimit(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, body UpdateOrderGroupLimitJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResetOrderGroupWithBody Reset Order Group
	//
	//  Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).
	ResetOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResetOrderGroup Reset Order Group
	//
	//  Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).
	ResetOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, body ResetOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TriggerOrderGroupWithBody Trigger Order Group
	//
	//  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).
	TriggerOrderGroupWithBody(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TriggerOrderGroup Trigger Order Group
	//
	//  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).
	TriggerOrderGroup(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, body TriggerOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrders Get Orders
	//
	// Restricts the response to orders that have a certain status: resting, canceled, or executed.
	// Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Corresponds with GET /portfolio/orders (the `GetOrders` operationId).
	GetOrders(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrderQueuePositions Get Queue Positions for Orders
	//
	//  Endpoint for getting queue positions for all resting orders. Queue position represents the number of contracts that need to be matched before an order receives a partial or full match, determined using price-time priority.
	//
	// Corresponds with GET /portfolio/orders/queue_positions (the `GetOrderQueuePositions` operationId).
	GetOrderQueuePositions(ctx context.Context, params *GetOrderQueuePositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrder Get Order
	//
	//  Endpoint for getting a single order.
	//
	// Corresponds with GET /portfolio/orders/{order_id} (the `GetOrder` operationId).
	GetOrder(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrderQueuePosition Get Order Queue Position
	//
	//  Endpoint for getting an order's queue position in the order book. This represents the amount of orders that need to be matched before this order receives a partial or full match. Queue position is determined using a price-time priority.
	//
	// Corresponds with GET /portfolio/orders/{order_id}/queue_position (the `GetOrderQueuePosition` operationId).
	GetOrderQueuePosition(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPositions Get Positions
	//
	// Returns unsettled positions by default. Set `settlement_status=settled` to page through settled positions that are still in the live data set, or `settlement_status=all` for both live states. Positions already archived are available via `GET /historical/positions`.
	// Settled and all-state positions are paginated by event ticker to keep large histories bounded. Cursors are specific to the selected settlement status.
	// `count_filter` restricts positions to those with a non-zero position or total traded count.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	//
	// Corresponds with GET /portfolio/positions (the `GetPositions` operationId).
	GetPositions(ctx context.Context, params *GetPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSettlements Get Settlements
	//
	// Returns settlement records still in the live data set. Archived positions are available via `GET /historical/positions`, which has different fields; this endpoint does not return archived settlement records.
	//
	// Corresponds with GET /portfolio/settlements (the `GetSettlements` operationId).
	GetSettlements(ctx context.Context, params *GetSettlementsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSubaccountWithBody Create Subaccount
	//
	// Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).
	CreateSubaccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSubaccount Create Subaccount
	//
	// Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).
	CreateSubaccount(ctx context.Context, body CreateSubaccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSubaccountBalances Get All Subaccount Balances
	//
	// Gets balances for all subaccounts including the primary account.
	//
	// Corresponds with GET /portfolio/subaccounts/balances (the `GetSubaccountBalances` operationId).
	GetSubaccountBalances(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSubaccountNetting Get Subaccount Netting
	//
	// Gets the netting enabled settings for all subaccounts.
	//
	// Corresponds with GET /portfolio/subaccounts/netting (the `GetSubaccountNetting` operationId).
	GetSubaccountNetting(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSubaccountNettingWithBody Update Subaccount Netting
	//
	// Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).
	UpdateSubaccountNettingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSubaccountNetting Update Subaccount Netting
	//
	// Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).
	UpdateSubaccountNetting(ctx context.Context, body UpdateSubaccountNettingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ApplySubaccountTransferWithBody Transfer Between Subaccounts
	//
	// Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).
	ApplySubaccountTransferWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ApplySubaccountTransfer Transfer Between Subaccounts
	//
	// Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).
	ApplySubaccountTransfer(ctx context.Context, body ApplySubaccountTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSubaccountTransfers Get Subaccount Transfers
	//
	// Gets a paginated list of all transfers between subaccounts for the authenticated user.
	//
	// Corresponds with GET /portfolio/subaccounts/transfers (the `GetSubaccountTransfers` operationId).
	GetSubaccountTransfers(ctx context.Context, params *GetSubaccountTransfersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPortfolioRestingOrderTotalValue Get Total Resting Order Value
	//
	//  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you're uncertain about this endpoint, it likely does not apply to you.
	//
	// Corresponds with GET /portfolio/summary/total_resting_order_value (the `GetPortfolioRestingOrderTotalValue` operationId).
	GetPortfolioRestingOrderTotalValue(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTargetBalanceAllocation Get Target Balance Allocation
	//
	// Retrieves the caller's target balance allocation across exchange indexes.
	//
	// Corresponds with GET /portfolio/target_balance_allocation (the `GetTargetBalanceAllocation` operationId).
	GetTargetBalanceAllocation(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetTargetBalanceAllocationWithBody Set Target Balance Allocation
	//
	// Replaces the caller's target balance allocation across exchange indexes.
	// Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).
	SetTargetBalanceAllocationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetTargetBalanceAllocation Set Target Balance Allocation
	//
	// Replaces the caller's target balance allocation across exchange indexes.
	// Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).
	SetTargetBalanceAllocation(ctx context.Context, body SetTargetBalanceAllocationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetWithdrawals Get Withdrawals
	//
	// Endpoint for getting the member's withdrawal history.
	//
	// Corresponds with GET /portfolio/withdrawals (the `GetWithdrawals` operationId).
	GetWithdrawals(ctx context.Context, params *GetWithdrawalsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFiltersForSports Get Filters for Sports
	//
	// Retrieve available filters organized by sport.
	//
	// This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
	//
	// Corresponds with GET /search/filters_by_sport (the `GetFiltersForSports` operationId).
	GetFiltersForSports(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTagsForSeriesCategories Get Tags for Series Categories
	//
	// Retrieve tags organized by series categories.
	//
	// This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
	//
	// Corresponds with GET /search/tags_by_categories (the `GetTagsForSeriesCategories` operationId).
	GetTagsForSeriesCategories(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSeriesList Get Series List
	//
	//  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). This endpoint allows you to browse and discover available series templates by category.
	//
	// Corresponds with GET /series (the `GetSeriesList` operationId).
	GetSeriesList(ctx context.Context, params *GetSeriesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSeriesFeeChanges Get Series Fee Changes
	//
	// Corresponds with GET /series/fee_changes (the `GetSeriesFeeChanges` operationId).
	GetSeriesFeeChanges(ctx context.Context, params *GetSeriesFeeChangesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSeries Get Series
	//
	//  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
	//
	// Corresponds with GET /series/{series_ticker} (the `GetSeries` operationId).
	GetSeries(ctx context.Context, seriesTicker string, params *GetSeriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarketCandlesticksByEvent Get Event Candlesticks
	//
	//  End-point for returning aggregated data across all markets corresponding to an event.
	//
	// Corresponds with GET /series/{series_ticker}/events/{ticker}/candlesticks (the `GetMarketCandlesticksByEvent` operationId).
	GetMarketCandlesticksByEvent(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksByEventParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEventForecastPercentilesHistory Get Event Forecast Percentile History
	//
	// Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
	//
	// Corresponds with GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history (the `GetEventForecastPercentilesHistory` operationId).
	GetEventForecastPercentilesHistory(ctx context.Context, seriesTicker string, ticker string, params *GetEventForecastPercentilesHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMarketCandlesticks Get Market Candlesticks
	//
	// Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
	// Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Corresponds with GET /series/{series_ticker}/markets/{ticker}/candlesticks (the `GetMarketCandlesticks` operationId).
	GetMarketCandlesticks(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStructuredTargets Get Structured Targets
	//
	// Page size (min: 1, max: 2000)
	//
	// Corresponds with GET /structured_targets (the `GetStructuredTargets` operationId).
	GetStructuredTargets(ctx context.Context, params *GetStructuredTargetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStructuredTarget Get Structured Target
	//
	//  Endpoint for getting data about a specific structured target by its ID.
	//
	// Corresponds with GET /structured_targets/{structured_target_id} (the `GetStructuredTarget` operationId).
	GetStructuredTarget(ctx context.Context, structuredTargetId string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

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

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

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

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

func (*ClientWithResponses) AcceptBlockTradeProposalWithBodyWithResponse

func (c *ClientWithResponses) AcceptBlockTradeProposalWithBodyWithResponse(ctx context.Context, blockTradeProposalId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptBlockTradeProposalResponse, error)

AcceptBlockTradeProposalWithBodyWithResponse Accept Block Trade Proposal

Endpoint for accepting a block trade proposal.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).

func (*ClientWithResponses) AcceptBlockTradeProposalWithResponse

func (c *ClientWithResponses) AcceptBlockTradeProposalWithResponse(ctx context.Context, blockTradeProposalId string, body AcceptBlockTradeProposalJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptBlockTradeProposalResponse, error)

AcceptBlockTradeProposalWithResponse Accept Block Trade Proposal

Endpoint for accepting a block trade proposal.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).

func (*ClientWithResponses) AcceptQuoteWithBodyWithResponse

func (c *ClientWithResponses) AcceptQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptQuoteResponse, error)

AcceptQuoteWithBodyWithResponse Accept Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) AcceptQuoteWithResponse

func (c *ClientWithResponses) AcceptQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptQuoteResponse, error)

AcceptQuoteWithResponse Accept Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) AcceptRFQQuoteWithBodyWithResponse

func (c *ClientWithResponses) AcceptRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptRFQQuoteResponse, error)

AcceptRFQQuoteWithBodyWithResponse Accept RFQ Quote

Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).

func (*ClientWithResponses) AcceptRFQQuoteWithResponse

func (c *ClientWithResponses) AcceptRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body AcceptRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptRFQQuoteResponse, error)

AcceptRFQQuoteWithResponse Accept RFQ Quote

Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).

func (*ClientWithResponses) AmendOrderV2WithBodyWithResponse

func (c *ClientWithResponses) AmendOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AmendOrderV2Response2, error)

AmendOrderV2WithBodyWithResponse Amend Order (V2)

Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).

func (*ClientWithResponses) AmendOrderV2WithResponse

func (c *ClientWithResponses) AmendOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, body AmendOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*AmendOrderV2Response2, error)

AmendOrderV2WithResponse Amend Order (V2)

Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).

func (*ClientWithResponses) ApplySubaccountTransferWithBodyWithResponse

func (c *ClientWithResponses) ApplySubaccountTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ApplySubaccountTransferResponse2, error)

ApplySubaccountTransferWithBodyWithResponse Transfer Between Subaccounts

Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).

func (*ClientWithResponses) ApplySubaccountTransferWithResponse

func (c *ClientWithResponses) ApplySubaccountTransferWithResponse(ctx context.Context, body ApplySubaccountTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*ApplySubaccountTransferResponse2, error)

ApplySubaccountTransferWithResponse Transfer Between Subaccounts

Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).

func (*ClientWithResponses) BatchCancelOrdersV2WithBodyWithResponse

func (c *ClientWithResponses) BatchCancelOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCancelOrdersV2Response2, error)

BatchCancelOrdersV2WithBodyWithResponse Batch Cancel Orders (V2)

Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).

func (*ClientWithResponses) BatchCancelOrdersV2WithResponse

func (c *ClientWithResponses) BatchCancelOrdersV2WithResponse(ctx context.Context, body BatchCancelOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCancelOrdersV2Response2, error)

BatchCancelOrdersV2WithResponse Batch Cancel Orders (V2)

Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).

func (*ClientWithResponses) BatchCreateOrdersV2WithBodyWithResponse

func (c *ClientWithResponses) BatchCreateOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreateOrdersV2Response2, error)

BatchCreateOrdersV2WithBodyWithResponse Batch Create Orders (V2)

Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).

func (*ClientWithResponses) BatchCreateOrdersV2WithResponse

func (c *ClientWithResponses) BatchCreateOrdersV2WithResponse(ctx context.Context, body BatchCreateOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreateOrdersV2Response2, error)

BatchCreateOrdersV2WithResponse Batch Create Orders (V2)

Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).

func (*ClientWithResponses) BatchGetMarketCandlesticksWithResponse

func (c *ClientWithResponses) BatchGetMarketCandlesticksWithResponse(ctx context.Context, params *BatchGetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*BatchGetMarketCandlesticksResponse2, error)

BatchGetMarketCandlesticksWithResponse Batch Get Market Candlesticks

Endpoint for retrieving candlestick data for multiple markets.

- Accepts up to 100 market tickers per request - Returns up to 10,000 candlesticks total across all markets - Returns candlesticks grouped by market_id - Optionally includes a synthetic initial candlestick for price continuity (see `include_latest_before_start` parameter)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets/candlesticks (the `BatchGetMarketCandlesticks` operationId).

func (*ClientWithResponses) CancelAllOrdersWithResponse

func (c *ClientWithResponses) CancelAllOrdersWithResponse(ctx context.Context, params *CancelAllOrdersParams, reqEditors ...RequestEditorFn) (*CancelAllOrdersResponse, error)

CancelAllOrdersWithResponse Cancel All Orders

Cancels all resting event-market orders for the authenticated Direct member across every exchange shard. If `subaccount` is omitted, matching orders may come from any subaccount. If it is provided, only orders for that subaccount are eligible. Newly placed orders may also be cancelled during the minute after the request.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /portfolio/events/orders (the `CancelAllOrders` operationId).

func (*ClientWithResponses) CancelOrderV2WithResponse

func (c *ClientWithResponses) CancelOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, reqEditors ...RequestEditorFn) (*CancelOrderV2Response2, error)

CancelOrderV2WithResponse Cancel Order (V2)

Endpoint for cancelling event-market orders using the V2 response shape. To auto-route the cancellation, provide `market_ticker` and omit `exchange_index` or set it to `-1`. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /portfolio/events/orders/{order_id} (the `CancelOrderV2` operationId).

func (*ClientWithResponses) ConfirmQuoteWithBodyWithResponse

func (c *ClientWithResponses) ConfirmQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmQuoteResponse, error)

ConfirmQuoteWithBodyWithResponse Confirm Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) ConfirmQuoteWithResponse

func (c *ClientWithResponses) ConfirmQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmQuoteResponse, error)

ConfirmQuoteWithResponse Confirm Quote

DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId). Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) ConfirmRFQQuoteWithBodyWithResponse

func (c *ClientWithResponses) ConfirmRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmRFQQuoteResponse, error)

ConfirmRFQQuoteWithBodyWithResponse Confirm RFQ Quote

Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).

func (*ClientWithResponses) ConfirmRFQQuoteWithResponse

func (c *ClientWithResponses) ConfirmRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body ConfirmRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmRFQQuoteResponse, error)

ConfirmRFQQuoteWithResponse Confirm RFQ Quote

Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).

func (*ClientWithResponses) CreateApiKeyWithBodyWithResponse

func (c *ClientWithResponses) CreateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse2, error)

CreateApiKeyWithBodyWithResponse Create API Key

Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api_keys (the `CreateApiKey` operationId).

func (*ClientWithResponses) CreateApiKeyWithResponse

func (c *ClientWithResponses) CreateApiKeyWithResponse(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse2, error)

CreateApiKeyWithResponse Create API Key

Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api_keys (the `CreateApiKey` operationId).

func (*ClientWithResponses) CreateFCMPositionTransferWithBodyWithResponse

func (c *ClientWithResponses) CreateFCMPositionTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMPositionTransferResponse2, error)

CreateFCMPositionTransferWithBodyWithResponse Create FCM Position Transfer

Endpoint for FCM members to move a position in one market from one of their subtraders into a subtrader under their FCM's error account.

**This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the error account that receives transferred positions and gives you that account's user id, which prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.

• The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader under it, which is created on first use.
• Each request moves one market for one source subtrader. To move many positions, send one request per subtrader and market.
• The transfer is booked like a trade at `price_centicents`, which is always the YES price, even when moving NO. No fee is charged and no fill is created. For YES, the error account pays the price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds the side being moved and the target subtrader holds no opposite position in that market; otherwise the positions net like a trade and the balance changes differ.
• The source's current position is not checked. A request for more than the source holds, or with the opposite sign, flips or grows the source's position.
• Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
• The market must be open, neither account may be blocked, and the error account must have enough available balance on the market's exchange index to pay for the transfer. Otherwise the request returns 409.

**Example: moving YES.** A customer subtrader holds 10 YES contracts. Send `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents): - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES. - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50. - Sending `price_centicents` 0 instead moves the position with no cash.

**Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount` -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):

• The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
• The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
• Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the error account pay the full $1 per contract ($5.00).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).

func (*ClientWithResponses) CreateFCMPositionTransferWithResponse

func (c *ClientWithResponses) CreateFCMPositionTransferWithResponse(ctx context.Context, body CreateFCMPositionTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMPositionTransferResponse2, error)

CreateFCMPositionTransferWithResponse Create FCM Position Transfer

Endpoint for FCM members to move a position in one market from one of their subtraders into a subtrader under their FCM's error account.

**This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the error account that receives transferred positions and gives you that account's user id, which prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.

• The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader under it, which is created on first use.
• Each request moves one market for one source subtrader. To move many positions, send one request per subtrader and market.
• The transfer is booked like a trade at `price_centicents`, which is always the YES price, even when moving NO. No fee is charged and no fill is created. For YES, the error account pays the price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds the side being moved and the target subtrader holds no opposite position in that market; otherwise the positions net like a trade and the balance changes differ.
• The source's current position is not checked. A request for more than the source holds, or with the opposite sign, flips or grows the source's position.
• Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
• The market must be open, neither account may be blocked, and the error account must have enough available balance on the market's exchange index to pay for the transfer. Otherwise the request returns 409.

**Example: moving YES.** A customer subtrader holds 10 YES contracts. Send `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents): - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES. - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50. - Sending `price_centicents` 0 instead moves the position with no cash.

**Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount` -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):

• The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
• The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
• Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the error account pay the full $1 per contract ($5.00).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).

func (*ClientWithResponses) CreateFCMSubtraderWithBodyWithResponse

func (c *ClientWithResponses) CreateFCMSubtraderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMSubtraderResponse2, error)

CreateFCMSubtraderWithBodyWithResponse Create FCM Subtrader

Endpoint for FCM members to create a subtrader on the event-contract exchange. The subtrader is registered on every exchange shard that knows the FCM; a shard provisioned later registers it lazily on the subtrader's first order there. Re-creating an existing subtrader returns 409.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).

func (*ClientWithResponses) CreateFCMSubtraderWithResponse

func (c *ClientWithResponses) CreateFCMSubtraderWithResponse(ctx context.Context, body CreateFCMSubtraderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMSubtraderResponse2, error)

CreateFCMSubtraderWithResponse Create FCM Subtrader

Endpoint for FCM members to create a subtrader on the event-contract exchange. The subtrader is registered on every exchange shard that knows the FCM; a shard provisioned later registers it lazily on the subtrader's first order there. Re-creating an existing subtrader returns 409.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).

func (*ClientWithResponses) CreateMarketInMultivariateEventCollectionWithBodyWithResponse

func (c *ClientWithResponses) CreateMarketInMultivariateEventCollectionWithBodyWithResponse(ctx context.Context, collectionTicker string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateMarketInMultivariateEventCollectionResponse2, error)

CreateMarketInMultivariateEventCollectionWithBodyWithResponse Create Market In Multivariate Event Collection

Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).

func (*ClientWithResponses) CreateMarketInMultivariateEventCollectionWithResponse

func (c *ClientWithResponses) CreateMarketInMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, body CreateMarketInMultivariateEventCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateMarketInMultivariateEventCollectionResponse2, error)

CreateMarketInMultivariateEventCollectionWithResponse Create Market In Multivariate Event Collection

Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).

func (*ClientWithResponses) CreateOrderGroupWithBodyWithResponse

func (c *ClientWithResponses) CreateOrderGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderGroupResponse2, error)

CreateOrderGroupWithBodyWithResponse Create Order Group

Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).

func (*ClientWithResponses) CreateOrderGroupWithResponse

func (c *ClientWithResponses) CreateOrderGroupWithResponse(ctx context.Context, body CreateOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderGroupResponse2, error)

CreateOrderGroupWithResponse Create Order Group

Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).

func (*ClientWithResponses) CreateOrderV2WithBodyWithResponse

func (c *ClientWithResponses) CreateOrderV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderV2Response2, error)

CreateOrderV2WithBodyWithResponse Create Order (V2)

Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).

func (*ClientWithResponses) CreateOrderV2WithResponse

func (c *ClientWithResponses) CreateOrderV2WithResponse(ctx context.Context, body CreateOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderV2Response2, error)

CreateOrderV2WithResponse Create Order (V2)

Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).

func (*ClientWithResponses) CreateQuoteWithBodyWithResponse

func (c *ClientWithResponses) CreateQuoteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateQuoteResponse2, error)

CreateQuoteWithBodyWithResponse Create Quote

Endpoint for creating a quote in response to an RFQ.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/quotes (the `CreateQuote` operationId).

func (*ClientWithResponses) CreateQuoteWithResponse

func (c *ClientWithResponses) CreateQuoteWithResponse(ctx context.Context, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateQuoteResponse2, error)

CreateQuoteWithResponse Create Quote

Endpoint for creating a quote in response to an RFQ.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/quotes (the `CreateQuote` operationId).

func (*ClientWithResponses) CreateRFQWithBodyWithResponse

func (c *ClientWithResponses) CreateRFQWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRFQResponse2, error)

CreateRFQWithBodyWithResponse Create RFQ

Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).

func (*ClientWithResponses) CreateRFQWithResponse

func (c *ClientWithResponses) CreateRFQWithResponse(ctx context.Context, body CreateRFQJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRFQResponse2, error)

CreateRFQWithResponse Create RFQ

Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).

func (*ClientWithResponses) CreateSubaccountWithBodyWithResponse

func (c *ClientWithResponses) CreateSubaccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSubaccountResponse2, error)

CreateSubaccountWithBodyWithResponse Create Subaccount

Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).

func (*ClientWithResponses) CreateSubaccountWithResponse

func (c *ClientWithResponses) CreateSubaccountWithResponse(ctx context.Context, body CreateSubaccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSubaccountResponse2, error)

CreateSubaccountWithResponse Create Subaccount

Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).

func (*ClientWithResponses) DecreaseOrderV2WithBodyWithResponse

func (c *ClientWithResponses) DecreaseOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DecreaseOrderV2Response2, error)

DecreaseOrderV2WithBodyWithResponse Decrease Order (V2)

Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).

func (*ClientWithResponses) DecreaseOrderV2WithResponse

func (c *ClientWithResponses) DecreaseOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, body DecreaseOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*DecreaseOrderV2Response2, error)

DecreaseOrderV2WithResponse Decrease Order (V2)

Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).

func (*ClientWithResponses) DeleteApiKeyWithResponse

func (c *ClientWithResponses) DeleteApiKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteApiKeyResponse, error)

DeleteApiKeyWithResponse Delete API Key

Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api_keys/{api_key} (the `DeleteApiKey` operationId).

func (*ClientWithResponses) DeleteFCMEventContractDailyCapWithResponse

func (c *ClientWithResponses) DeleteFCMEventContractDailyCapWithResponse(ctx context.Context, params *DeleteFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*DeleteFCMEventContractDailyCapResponse, error)

DeleteFCMEventContractDailyCapWithResponse Delete FCM Subtrader Event Contract Daily Cap

Removes the event-contract daily premium cap for an FCM member's subtrader. Removal closes the subtrader to new orders on cap-reservation sessions — every subtrader-bound API key — until a cap is set again. It does not stop orders your own unbound sessions submit on the subtrader's behalf; to stop the account entirely, block subtrader trading.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /fcm/subtraders/event_contract_daily_cap (the `DeleteFCMEventContractDailyCap` operationId).

func (*ClientWithResponses) DeleteOrderGroupWithResponse

func (c *ClientWithResponses) DeleteOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams, reqEditors ...RequestEditorFn) (*DeleteOrderGroupResponse, error)

DeleteOrderGroupWithResponse Delete Order Group

Deletes an order group and cancels all orders within it. This permanently removes the group.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /portfolio/order_groups/{order_group_id} (the `DeleteOrderGroup` operationId).

func (*ClientWithResponses) DeleteQuoteWithResponse

func (c *ClientWithResponses) DeleteQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*DeleteQuoteResponse, error)

DeleteQuoteWithResponse Delete Quote

DEPRECATED: Use DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for deleting a quote, which means it can no longer be accepted.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /communications/quotes/{quote_id} (the `DeleteQuote` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) DeleteRFQQuoteWithResponse

func (c *ClientWithResponses) DeleteRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*DeleteRFQQuoteResponse, error)

DeleteRFQQuoteWithResponse Delete RFQ Quote

Endpoint for deleting a quote scoped to its RFQ, which means it can no longer be accepted.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `DeleteRFQQuote` operationId).

func (*ClientWithResponses) DeleteRFQWithResponse

func (c *ClientWithResponses) DeleteRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*DeleteRFQResponse, error)

DeleteRFQWithResponse Delete RFQ

Endpoint for deleting an RFQ by ID.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /communications/rfqs/{rfq_id} (the `DeleteRFQ` operationId).

func (*ClientWithResponses) GenerateApiKeyWithBodyWithResponse

func (c *ClientWithResponses) GenerateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateApiKeyResponse2, error)

GenerateApiKeyWithBodyWithResponse Generate API Key

Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).

func (*ClientWithResponses) GenerateApiKeyWithResponse

func (c *ClientWithResponses) GenerateApiKeyWithResponse(ctx context.Context, body GenerateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*GenerateApiKeyResponse2, error)

GenerateApiKeyWithResponse Generate API Key

Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).

func (*ClientWithResponses) GetAccountApiLimitsWithResponse

func (c *ClientWithResponses) GetAccountApiLimitsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiLimitsResponse2, error)

GetAccountApiLimitsWithResponse Get Account API Limits

Endpoint to retrieve the authenticated user's Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /account/limits (the `GetAccountApiLimits` operationId).

func (*ClientWithResponses) GetAccountApiUsageLevelVolumeProgressWithResponse

func (c *ClientWithResponses) GetAccountApiUsageLevelVolumeProgressWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiUsageLevelVolumeProgressResponse2, error)

GetAccountApiUsageLevelVolumeProgressWithResponse Get Account API Usage Level Volume Progress

Returns the authenticated user's latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /account/api_usage_level/volume_progress (the `GetAccountApiUsageLevelVolumeProgress` operationId).

func (*ClientWithResponses) GetAccountEndpointCostsWithResponse

func (c *ClientWithResponses) GetAccountEndpointCostsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountEndpointCostsResponse2, error)

GetAccountEndpointCostsWithResponse List Non-Default Endpoint Costs

Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /account/endpoint_costs (the `GetAccountEndpointCosts` operationId).

func (*ClientWithResponses) GetApiKeysWithResponse

func (c *ClientWithResponses) GetApiKeysWithResponse(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*GetApiKeysResponse2, error)

GetApiKeysWithResponse Get API Keys

Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api_keys (the `GetApiKeys` operationId).

func (*ClientWithResponses) GetBalanceWithResponse

func (c *ClientWithResponses) GetBalanceWithResponse(ctx context.Context, params *GetBalanceParams, reqEditors ...RequestEditorFn) (*GetBalanceResponse2, error)

GetBalanceWithResponse Get Balance

Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.

**Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/balance (the `GetBalance` operationId).

func (*ClientWithResponses) GetBlockTradeProposalsWithResponse

func (c *ClientWithResponses) GetBlockTradeProposalsWithResponse(ctx context.Context, params *GetBlockTradeProposalsParams, reqEditors ...RequestEditorFn) (*GetBlockTradeProposalsResponse2, error)

GetBlockTradeProposalsWithResponse Get Block Trade Proposals

Endpoint for getting block trade proposals visible to the authenticated user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/block-trade-proposals (the `GetBlockTradeProposals` operationId).

func (*ClientWithResponses) GetCommunicationsIDWithResponse

func (c *ClientWithResponses) GetCommunicationsIDWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCommunicationsIDResponse2, error)

GetCommunicationsIDWithResponse Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/id (the `GetCommunicationsID` operationId).

func (*ClientWithResponses) GetDepositsWithResponse

func (c *ClientWithResponses) GetDepositsWithResponse(ctx context.Context, params *GetDepositsParams, reqEditors ...RequestEditorFn) (*GetDepositsResponse2, error)

GetDepositsWithResponse Get Deposits

Endpoint for getting the member's deposit history.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/deposits (the `GetDeposits` operationId).

func (*ClientWithResponses) GetEventFeeChangesWithResponse

func (c *ClientWithResponses) GetEventFeeChangesWithResponse(ctx context.Context, params *GetEventFeeChangesParams, reqEditors ...RequestEditorFn) (*GetEventFeeChangesResponse2, error)

GetEventFeeChangesWithResponse Get Event Fee Changes

Event fees are an override layered on top of the parent series' fee structure. If `fee_type_override` and `fee_multiplier_override` are null, that indicates the override is cleared.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /events/fee_changes (the `GetEventFeeChanges` operationId).

func (*ClientWithResponses) GetEventForecastPercentilesHistoryWithResponse

func (c *ClientWithResponses) GetEventForecastPercentilesHistoryWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetEventForecastPercentilesHistoryParams, reqEditors ...RequestEditorFn) (*GetEventForecastPercentilesHistoryResponse2, error)

GetEventForecastPercentilesHistoryWithResponse Get Event Forecast Percentile History

Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history (the `GetEventForecastPercentilesHistory` operationId).

func (*ClientWithResponses) GetEventLiveDataWithResponse

func (c *ClientWithResponses) GetEventLiveDataWithResponse(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, reqEditors ...RequestEditorFn) (*GetEventLiveDataResponse2, error)

GetEventLiveDataWithResponse Get Event Live Data

Get live data for an event by its event ticker. Serves event-keyed live data such as crypto price charts, commodity price timeseries, and weather observations. The `type` field in the response names the schema of the `details` object.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/events/{event_ticker} (the `GetEventLiveData` operationId).

func (*ClientWithResponses) GetEventMetadataWithResponse

func (c *ClientWithResponses) GetEventMetadataWithResponse(ctx context.Context, eventTicker string, reqEditors ...RequestEditorFn) (*GetEventMetadataResponse2, error)

GetEventMetadataWithResponse Get Event Metadata

Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /events/{event_ticker}/metadata (the `GetEventMetadata` operationId).

func (*ClientWithResponses) GetEventWithResponse

func (c *ClientWithResponses) GetEventWithResponse(ctx context.Context, eventTicker string, params *GetEventParams, reqEditors ...RequestEditorFn) (*GetEventResponse2, error)

GetEventWithResponse Get Event

Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /events/{event_ticker} (the `GetEvent` operationId).

func (*ClientWithResponses) GetEventsWithResponse

func (c *ClientWithResponses) GetEventsWithResponse(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsResponse2, error)

GetEventsWithResponse Get Events

Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /events (the `GetEvents` operationId).

func (*ClientWithResponses) GetExchangeScheduleWithResponse

func (c *ClientWithResponses) GetExchangeScheduleWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeScheduleResponse2, error)

GetExchangeScheduleWithResponse Get Exchange Schedule

Endpoint for getting the exchange schedule.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /exchange/schedule (the `GetExchangeSchedule` operationId).

func (*ClientWithResponses) GetExchangeStatusWithResponse

func (c *ClientWithResponses) GetExchangeStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeStatusResponse, error)

GetExchangeStatusWithResponse Get Exchange Status

Endpoint for getting the exchange status.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /exchange/status (the `GetExchangeStatus` operationId).

func (*ClientWithResponses) GetFCMEventContractDailyCapWithResponse

func (c *ClientWithResponses) GetFCMEventContractDailyCapWithResponse(ctx context.Context, params *GetFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*GetFCMEventContractDailyCapResponse2, error)

GetFCMEventContractDailyCapWithResponse Get FCM Subtrader Event Contract Daily Cap

Returns the event-contract daily premium cap configured for an FCM member's subtrader, together with its live utilization. Executed utilization is the net premium deployed by fills today (sells and settlements credit back); resting and pending utilization reserve open and in-flight orders at their full worst-case cost plus fees. Executed utilization resets at midnight New York time on the returned cap date; resting and pending reservations persist for as long as their orders remain open, including across the reset. Returns 404 when the subtrader has no cap configured — in that state every order placed through the subtrader's bound API keys is rejected. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/subtraders/event_contract_daily_cap (the `GetFCMEventContractDailyCap` operationId).

func (*ClientWithResponses) GetFCMFillsWithResponse

func (c *ClientWithResponses) GetFCMFillsWithResponse(ctx context.Context, params *GetFCMFillsParams, reqEditors ...RequestEditorFn) (*GetFCMFillsResponse, error)

GetFCMFillsWithResponse Get FCM Fills

Returns fills across the authenticated FCM's subtraders. Requires FCM member access.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/fills (the `GetFCMFills` operationId).

func (*ClientWithResponses) GetFCMOrdersWithResponse

func (c *ClientWithResponses) GetFCMOrdersWithResponse(ctx context.Context, params *GetFCMOrdersParams, reqEditors ...RequestEditorFn) (*GetFCMOrdersResponse, error)

GetFCMOrdersWithResponse Get FCM Orders

Endpoint for FCM members to get orders for their subtraders. This endpoint requires FCM member access level. At least one of `subtrader_id` or `client_order_ids` is required; supplying both returns only the orders matching both filters. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/orders (the `GetFCMOrders` operationId).

func (*ClientWithResponses) GetFCMPositionsWithResponse

func (c *ClientWithResponses) GetFCMPositionsWithResponse(ctx context.Context, params *GetFCMPositionsParams, reqEditors ...RequestEditorFn) (*GetFCMPositionsResponse, error)

GetFCMPositionsWithResponse Get FCM Positions

Endpoint for FCM members to get market positions filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering positions by subtrader ID. API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound subtrader or the request is rejected.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/positions (the `GetFCMPositions` operationId).

func (*ClientWithResponses) GetFCMSubtraderBlockedCategoriesWithResponse

func (c *ClientWithResponses) GetFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, params *GetFCMSubtraderBlockedCategoriesParams, reqEditors ...RequestEditorFn) (*GetFCMSubtraderBlockedCategoriesResponse2, error)

GetFCMSubtraderBlockedCategoriesWithResponse Get FCM Subtrader Blocked Categories

Returns the event categories an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. A subtrader with no blocks returns an empty list.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/subtraders/blocked_categories (the `GetFCMSubtraderBlockedCategories` operationId).

func (*ClientWithResponses) GetFillsHistoricalWithResponse

func (c *ClientWithResponses) GetFillsHistoricalWithResponse(ctx context.Context, params *GetFillsHistoricalParams, reqEditors ...RequestEditorFn) (*GetFillsHistoricalResponse, error)

GetFillsHistoricalWithResponse Get Historical Fills

Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched. API keys restricted to a subaccount return only that subaccount's fills. If supplied, `subaccount` must match the key's restriction. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/fills (the `GetFillsHistorical` operationId).

func (*ClientWithResponses) GetFillsWithResponse

func (c *ClientWithResponses) GetFillsWithResponse(ctx context.Context, params *GetFillsParams, reqEditors ...RequestEditorFn) (*GetFillsResponse2, error)

GetFillsWithResponse Get Fills

Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/fills (the `GetFills` operationId).

func (*ClientWithResponses) GetFiltersForSportsWithResponse

func (c *ClientWithResponses) GetFiltersForSportsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFiltersForSportsResponse, error)

GetFiltersForSportsWithResponse Get Filters for Sports

Retrieve available filters organized by sport.

This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /search/filters_by_sport (the `GetFiltersForSports` operationId).

func (*ClientWithResponses) GetGameStatsWithResponse

func (c *ClientWithResponses) GetGameStatsWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetGameStatsResponse2, error)

GetGameStatsWithResponse Get Game Stats

Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men's Basketball, College Women's Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/milestone/{milestone_id}/game_stats (the `GetGameStats` operationId).

func (*ClientWithResponses) GetHistoricalCutoffWithResponse

func (c *ClientWithResponses) GetHistoricalCutoffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHistoricalCutoffResponse2, error)

GetHistoricalCutoffWithResponse Get Historical Cutoff Timestamps

Returns the archive's cutoff timestamps. For positions, the cutoff is the backfill horizon; visibility in the historical API waits for a buffered, whole-event handoff.

## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`. - `market_positions_last_updated_ts` : Backfill horizon for settled positions, not a guaranteed archive-visibility boundary. An event moves to `GET /historical/positions` only after its buffered handoff completes. Until then, its settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. Unsettled positions remain available in `GET /portfolio/positions`.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/cutoff (the `GetHistoricalCutoff` operationId).

func (*ClientWithResponses) GetHistoricalMarketWithResponse

func (c *ClientWithResponses) GetHistoricalMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetHistoricalMarketResponse, error)

GetHistoricalMarketWithResponse Get Historical Market

Endpoint for getting data about a specific market by its ticker from the historical database.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/markets/{ticker} (the `GetHistoricalMarket` operationId).

func (*ClientWithResponses) GetHistoricalMarketsWithResponse

func (c *ClientWithResponses) GetHistoricalMarketsWithResponse(ctx context.Context, params *GetHistoricalMarketsParams, reqEditors ...RequestEditorFn) (*GetHistoricalMarketsResponse, error)

GetHistoricalMarketsWithResponse Get Historical Markets

Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/markets (the `GetHistoricalMarkets` operationId).

func (*ClientWithResponses) GetHistoricalOrdersWithResponse

func (c *ClientWithResponses) GetHistoricalOrdersWithResponse(ctx context.Context, params *GetHistoricalOrdersParams, reqEditors ...RequestEditorFn) (*GetHistoricalOrdersResponse, error)

GetHistoricalOrdersWithResponse Get Historical Orders

Endpoint for getting orders that have been archived to the historical database. API keys restricted to a subaccount return only that subaccount's orders. If supplied, `subaccount` must match the key's restriction.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/orders (the `GetHistoricalOrders` operationId).

func (*ClientWithResponses) GetHistoricalPositionsWithResponse

func (c *ClientWithResponses) GetHistoricalPositionsWithResponse(ctx context.Context, params *GetHistoricalPositionsParams, reqEditors ...RequestEditorFn) (*GetHistoricalPositionsResponse, error)

GetHistoricalPositionsWithResponse Get Historical Positions

Returns settled market positions after their event completes the live-to-historical handoff. Until then, settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. The `market_positions_last_updated_ts` value on `GET /historical/cutoff` is the backfill horizon, not a guarantee that every older position has moved. Unsettled positions are available via `GET /portfolio/positions`.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/positions (the `GetHistoricalPositions` operationId).

func (*ClientWithResponses) GetIncentiveProgramsWithResponse

func (c *ClientWithResponses) GetIncentiveProgramsWithResponse(ctx context.Context, params *GetIncentiveProgramsParams, reqEditors ...RequestEditorFn) (*GetIncentiveProgramsResponse2, error)

GetIncentiveProgramsWithResponse Get Incentives

List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /incentive_programs (the `GetIncentivePrograms` operationId).

func (*ClientWithResponses) GetIntraExchangeInstanceTransferWithResponse

func (c *ClientWithResponses) GetIntraExchangeInstanceTransferWithResponse(ctx context.Context, transferId string, reqEditors ...RequestEditorFn) (*GetIntraExchangeInstanceTransferResponse2, error)

GetIntraExchangeInstanceTransferWithResponse Get Intra Account Transfer

Endpoint for getting a single intra-account transfer by id.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/intra_exchange_instance_transfers/{transfer_id} (the `GetIntraExchangeInstanceTransfer` operationId).

func (*ClientWithResponses) GetIntraExchangeInstanceTransfersWithResponse

func (c *ClientWithResponses) GetIntraExchangeInstanceTransfersWithResponse(ctx context.Context, params *GetIntraExchangeInstanceTransfersParams, reqEditors ...RequestEditorFn) (*GetIntraExchangeInstanceTransfersResponse2, error)

GetIntraExchangeInstanceTransfersWithResponse Get Intra Account Transfers

Endpoint for fetching intra-exchange account transfer history.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/intra_exchange_instance_transfers (the `GetIntraExchangeInstanceTransfers` operationId).

func (*ClientWithResponses) GetLiveDataByMilestoneWithResponse

func (c *ClientWithResponses) GetLiveDataByMilestoneWithResponse(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, reqEditors ...RequestEditorFn) (*GetLiveDataByMilestoneResponse, error)

GetLiveDataByMilestoneWithResponse Get Live Data

Get live data for a specific milestone.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/milestone/{milestone_id} (the `GetLiveDataByMilestone` operationId).

func (*ClientWithResponses) GetLiveDataWithResponse

func (c *ClientWithResponses) GetLiveDataWithResponse(ctx context.Context, pType string, milestoneId string, params *GetLiveDataParams, reqEditors ...RequestEditorFn) (*GetLiveDataResponse2, error)

GetLiveDataWithResponse Get Live Data (with type)

Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/{type}/milestone/{milestone_id} (the `GetLiveData` operationId).

func (*ClientWithResponses) GetLiveDatasWithResponse

func (c *ClientWithResponses) GetLiveDatasWithResponse(ctx context.Context, params *GetLiveDatasParams, reqEditors ...RequestEditorFn) (*GetLiveDatasResponse2, error)

GetLiveDatasWithResponse Get Multiple Live Data

Get live data for multiple milestones.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/batch (the `GetLiveDatas` operationId).

func (*ClientWithResponses) GetMarketCandlesticksByEventWithResponse

func (c *ClientWithResponses) GetMarketCandlesticksByEventWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksByEventParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksByEventResponse, error)

GetMarketCandlesticksByEventWithResponse Get Event Candlesticks

End-point for returning aggregated data across all markets corresponding to an event.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series/{series_ticker}/events/{ticker}/candlesticks (the `GetMarketCandlesticksByEvent` operationId).

func (*ClientWithResponses) GetMarketCandlesticksHistoricalWithResponse

func (c *ClientWithResponses) GetMarketCandlesticksHistoricalWithResponse(ctx context.Context, ticker string, params *GetMarketCandlesticksHistoricalParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksHistoricalResponse2, error)

GetMarketCandlesticksHistoricalWithResponse Get Historical Market Candlesticks

Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/markets/{ticker}/candlesticks (the `GetMarketCandlesticksHistorical` operationId).

func (*ClientWithResponses) GetMarketCandlesticksWithResponse

func (c *ClientWithResponses) GetMarketCandlesticksWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksResponse2, error)

GetMarketCandlesticksWithResponse Get Market Candlesticks

Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series/{series_ticker}/markets/{ticker}/candlesticks (the `GetMarketCandlesticks` operationId).

func (*ClientWithResponses) GetMarketOrderbookWithResponse

func (c *ClientWithResponses) GetMarketOrderbookWithResponse(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, reqEditors ...RequestEditorFn) (*GetMarketOrderbookResponse2, error)

GetMarketOrderbookWithResponse Get Market Orderbook

Endpoint for getting the current order book for a specific market.  The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes.  Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets/{ticker}/orderbook (the `GetMarketOrderbook` operationId).

func (*ClientWithResponses) GetMarketOrderbooksWithResponse

func (c *ClientWithResponses) GetMarketOrderbooksWithResponse(ctx context.Context, params *GetMarketOrderbooksParams, reqEditors ...RequestEditorFn) (*GetMarketOrderbooksResponse2, error)

GetMarketOrderbooksWithResponse Get Multiple Market Orderbooks

Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets/orderbooks (the `GetMarketOrderbooks` operationId).

func (*ClientWithResponses) GetMarketWithResponse

func (c *ClientWithResponses) GetMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetMarketResponse2, error)

GetMarketWithResponse Get Market

Endpoint for getting data about a specific market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., "Will candidate X win?"). Markets have yes/no positions, current prices, volume, and settlement rules.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets/{ticker} (the `GetMarket` operationId).

func (*ClientWithResponses) GetMarketsWithResponse

func (c *ClientWithResponses) GetMarketsWithResponse(ctx context.Context, params *GetMarketsParams, reqEditors ...RequestEditorFn) (*GetMarketsResponse2, error)

GetMarketsWithResponse Get Markets

Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.

• Only one `status` filter may be supplied at a time.

• Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.

  | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts, max_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude`. May be combined with `series_ticker`, which requires `mve_filter=exclude` |

  Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets (the `GetMarkets` operationId).

func (*ClientWithResponses) GetMilestoneWithResponse

func (c *ClientWithResponses) GetMilestoneWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetMilestoneResponse2, error)

GetMilestoneWithResponse Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /milestones/{milestone_id} (the `GetMilestone` operationId).

func (*ClientWithResponses) GetMilestonesWithResponse

func (c *ClientWithResponses) GetMilestonesWithResponse(ctx context.Context, params *GetMilestonesParams, reqEditors ...RequestEditorFn) (*GetMilestonesResponse2, error)

GetMilestonesWithResponse Get Milestones

Minimum start date to filter milestones. Format: RFC3339 timestamp

Returns a wrapper object for the known response body format(s).

Corresponds with GET /milestones (the `GetMilestones` operationId).

func (*ClientWithResponses) GetMultivariateEventCollectionWithResponse

func (c *ClientWithResponses) GetMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, reqEditors ...RequestEditorFn) (*GetMultivariateEventCollectionResponse2, error)

GetMultivariateEventCollectionWithResponse Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /multivariate_event_collections/{collection_ticker} (the `GetMultivariateEventCollection` operationId).

func (*ClientWithResponses) GetMultivariateEventCollectionsWithResponse

func (c *ClientWithResponses) GetMultivariateEventCollectionsWithResponse(ctx context.Context, params *GetMultivariateEventCollectionsParams, reqEditors ...RequestEditorFn) (*GetMultivariateEventCollectionsResponse2, error)

GetMultivariateEventCollectionsWithResponse Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /multivariate_event_collections (the `GetMultivariateEventCollections` operationId).

func (*ClientWithResponses) GetMultivariateEventsWithResponse

func (c *ClientWithResponses) GetMultivariateEventsWithResponse(ctx context.Context, params *GetMultivariateEventsParams, reqEditors ...RequestEditorFn) (*GetMultivariateEventsResponse2, error)

GetMultivariateEventsWithResponse Get Multivariate Events

Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series ticker, collection ticker, or a comma-separated list of event tickers.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /events/multivariate (the `GetMultivariateEvents` operationId).

func (*ClientWithResponses) GetOrderGroupWithResponse

func (c *ClientWithResponses) GetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams, reqEditors ...RequestEditorFn) (*GetOrderGroupResponse2, error)

GetOrderGroupWithResponse Get Order Group

Retrieves details for a single order group including all order IDs and auto-cancel status.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/order_groups/{order_group_id} (the `GetOrderGroup` operationId).

func (*ClientWithResponses) GetOrderGroupsWithResponse

func (c *ClientWithResponses) GetOrderGroupsWithResponse(ctx context.Context, params *GetOrderGroupsParams, reqEditors ...RequestEditorFn) (*GetOrderGroupsResponse2, error)

GetOrderGroupsWithResponse Get Order Groups

Retrieves all order groups for the authenticated user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/order_groups (the `GetOrderGroups` operationId).

func (*ClientWithResponses) GetOrderQueuePositionWithResponse

func (c *ClientWithResponses) GetOrderQueuePositionWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderQueuePositionResponse2, error)

GetOrderQueuePositionWithResponse Get Order Queue Position

Endpoint for getting an order's queue position in the order book. This represents the amount of orders that need to be matched before this order receives a partial or full match. Queue position is determined using a price-time priority.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/orders/{order_id}/queue_position (the `GetOrderQueuePosition` operationId).

func (*ClientWithResponses) GetOrderQueuePositionsWithResponse

func (c *ClientWithResponses) GetOrderQueuePositionsWithResponse(ctx context.Context, params *GetOrderQueuePositionsParams, reqEditors ...RequestEditorFn) (*GetOrderQueuePositionsResponse2, error)

GetOrderQueuePositionsWithResponse Get Queue Positions for Orders

Endpoint for getting queue positions for all resting orders. Queue position represents the number of contracts that need to be matched before an order receives a partial or full match, determined using price-time priority.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/orders/queue_positions (the `GetOrderQueuePositions` operationId).

func (*ClientWithResponses) GetOrderWithResponse

func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderResponse2, error)

GetOrderWithResponse Get Order

Endpoint for getting a single order.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/orders/{order_id} (the `GetOrder` operationId).

func (*ClientWithResponses) GetOrdersWithResponse

func (c *ClientWithResponses) GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*GetOrdersResponse2, error)

GetOrdersWithResponse Get Orders

Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/orders (the `GetOrders` operationId).

func (*ClientWithResponses) GetPortfolioRestingOrderTotalValueWithResponse

func (c *ClientWithResponses) GetPortfolioRestingOrderTotalValueWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPortfolioRestingOrderTotalValueResponse2, error)

GetPortfolioRestingOrderTotalValueWithResponse Get Total Resting Order Value

Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you're uncertain about this endpoint, it likely does not apply to you.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/summary/total_resting_order_value (the `GetPortfolioRestingOrderTotalValue` operationId).

func (*ClientWithResponses) GetPositionsWithResponse

func (c *ClientWithResponses) GetPositionsWithResponse(ctx context.Context, params *GetPositionsParams, reqEditors ...RequestEditorFn) (*GetPositionsResponse2, error)

GetPositionsWithResponse Get Positions

Returns unsettled positions by default. Set `settlement_status=settled` to page through settled positions that are still in the live data set, or `settlement_status=all` for both live states. Positions already archived are available via `GET /historical/positions`. Settled and all-state positions are paginated by event ticker to keep large histories bounded. Cursors are specific to the selected settlement status. `count_filter` restricts positions to those with a non-zero position or total traded count. Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/positions (the `GetPositions` operationId).

func (*ClientWithResponses) GetQuoteWithResponse

func (c *ClientWithResponses) GetQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*GetQuoteResponse2, error)

GetQuoteWithResponse Get Quote

DEPRECATED: Use GET /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for getting a particular quote.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/quotes/{quote_id} (the `GetQuote` operationId).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) GetQuotesWithResponse

func (c *ClientWithResponses) GetQuotesWithResponse(ctx context.Context, params *GetQuotesParams, reqEditors ...RequestEditorFn) (*GetQuotesResponse2, error)

GetQuotesWithResponse Get Quotes

List quotes. The rfq_id filter requires an RFQ UUID. Pass pagination cursors back unchanged; malformed RFQ IDs or cursors return HTTP 400.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/quotes (the `GetQuotes` operationId).

func (*ClientWithResponses) GetRFQQuoteWithResponse

func (c *ClientWithResponses) GetRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*GetRFQQuoteResponse, error)

GetRFQQuoteWithResponse Get RFQ Quote

Endpoint for getting a particular quote scoped to its RFQ.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `GetRFQQuote` operationId).

func (*ClientWithResponses) GetRFQWithResponse

func (c *ClientWithResponses) GetRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*GetRFQResponse2, error)

GetRFQWithResponse Get RFQ

Endpoint for getting a single RFQ by id.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/rfqs/{rfq_id} (the `GetRFQ` operationId).

func (*ClientWithResponses) GetRFQsWithResponse

func (c *ClientWithResponses) GetRFQsWithResponse(ctx context.Context, params *GetRFQsParams, reqEditors ...RequestEditorFn) (*GetRFQsResponse2, error)

GetRFQsWithResponse Get RFQs

List RFQs. Pass pagination cursors back unchanged. A malformed cursor or invalid creator_user_id UUID returns HTTP 400. Use user_filter=self to filter by the authenticated user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /communications/rfqs (the `GetRFQs` operationId).

func (*ClientWithResponses) GetSeriesFeeChangesWithResponse

func (c *ClientWithResponses) GetSeriesFeeChangesWithResponse(ctx context.Context, params *GetSeriesFeeChangesParams, reqEditors ...RequestEditorFn) (*GetSeriesFeeChangesResponse2, error)

GetSeriesFeeChangesWithResponse Get Series Fee Changes

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series/fee_changes (the `GetSeriesFeeChanges` operationId).

func (*ClientWithResponses) GetSeriesListWithResponse

func (c *ClientWithResponses) GetSeriesListWithResponse(ctx context.Context, params *GetSeriesListParams, reqEditors ...RequestEditorFn) (*GetSeriesListResponse2, error)

GetSeriesListWithResponse Get Series List

Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). This endpoint allows you to browse and discover available series templates by category.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series (the `GetSeriesList` operationId).

func (*ClientWithResponses) GetSeriesWithResponse

func (c *ClientWithResponses) GetSeriesWithResponse(ctx context.Context, seriesTicker string, params *GetSeriesParams, reqEditors ...RequestEditorFn) (*GetSeriesResponse2, error)

GetSeriesWithResponse Get Series

Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /series/{series_ticker} (the `GetSeries` operationId).

func (*ClientWithResponses) GetSettlementsWithResponse

func (c *ClientWithResponses) GetSettlementsWithResponse(ctx context.Context, params *GetSettlementsParams, reqEditors ...RequestEditorFn) (*GetSettlementsResponse2, error)

GetSettlementsWithResponse Get Settlements

Returns settlement records still in the live data set. Archived positions are available via `GET /historical/positions`, which has different fields; this endpoint does not return archived settlement records.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/settlements (the `GetSettlements` operationId).

func (*ClientWithResponses) GetStructuredTargetWithResponse

func (c *ClientWithResponses) GetStructuredTargetWithResponse(ctx context.Context, structuredTargetId string, reqEditors ...RequestEditorFn) (*GetStructuredTargetResponse2, error)

GetStructuredTargetWithResponse Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /structured_targets/{structured_target_id} (the `GetStructuredTarget` operationId).

func (*ClientWithResponses) GetStructuredTargetsWithResponse

func (c *ClientWithResponses) GetStructuredTargetsWithResponse(ctx context.Context, params *GetStructuredTargetsParams, reqEditors ...RequestEditorFn) (*GetStructuredTargetsResponse2, error)

GetStructuredTargetsWithResponse Get Structured Targets

Page size (min: 1, max: 2000)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /structured_targets (the `GetStructuredTargets` operationId).

func (*ClientWithResponses) GetSubaccountBalancesWithResponse

func (c *ClientWithResponses) GetSubaccountBalancesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountBalancesResponse2, error)

GetSubaccountBalancesWithResponse Get All Subaccount Balances

Gets balances for all subaccounts including the primary account.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/subaccounts/balances (the `GetSubaccountBalances` operationId).

func (*ClientWithResponses) GetSubaccountNettingWithResponse

func (c *ClientWithResponses) GetSubaccountNettingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountNettingResponse2, error)

GetSubaccountNettingWithResponse Get Subaccount Netting

Gets the netting enabled settings for all subaccounts.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/subaccounts/netting (the `GetSubaccountNetting` operationId).

func (*ClientWithResponses) GetSubaccountTransfersWithResponse

func (c *ClientWithResponses) GetSubaccountTransfersWithResponse(ctx context.Context, params *GetSubaccountTransfersParams, reqEditors ...RequestEditorFn) (*GetSubaccountTransfersResponse2, error)

GetSubaccountTransfersWithResponse Get Subaccount Transfers

Gets a paginated list of all transfers between subaccounts for the authenticated user.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/subaccounts/transfers (the `GetSubaccountTransfers` operationId).

func (*ClientWithResponses) GetTagsForSeriesCategoriesWithResponse

func (c *ClientWithResponses) GetTagsForSeriesCategoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTagsForSeriesCategoriesResponse2, error)

GetTagsForSeriesCategoriesWithResponse Get Tags for Series Categories

Retrieve tags organized by series categories.

This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /search/tags_by_categories (the `GetTagsForSeriesCategories` operationId).

func (*ClientWithResponses) GetTargetBalanceAllocationWithResponse

func (c *ClientWithResponses) GetTargetBalanceAllocationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTargetBalanceAllocationResponse2, error)

GetTargetBalanceAllocationWithResponse Get Target Balance Allocation

Retrieves the caller's target balance allocation across exchange indexes.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/target_balance_allocation (the `GetTargetBalanceAllocation` operationId).

func (*ClientWithResponses) GetTradesHistoricalWithResponse

func (c *ClientWithResponses) GetTradesHistoricalWithResponse(ctx context.Context, params *GetTradesHistoricalParams, reqEditors ...RequestEditorFn) (*GetTradesHistoricalResponse, error)

GetTradesHistoricalWithResponse Get Historical Trades

Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. Block trades are included by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical/trades (the `GetTradesHistorical` operationId).

func (*ClientWithResponses) GetTradesWithResponse

func (c *ClientWithResponses) GetTradesWithResponse(ctx context.Context, params *GetTradesParams, reqEditors ...RequestEditorFn) (*GetTradesResponse2, error)

GetTradesWithResponse Get Trades

Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. Block trades are included in the response by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. This endpoint returns a paginated response. Use the 'limit' parameter to control page size (1-1000, defaults to 100). The response includes a 'cursor' field - pass this value in the 'cursor' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /markets/trades (the `GetTrades` operationId).

func (*ClientWithResponses) GetUserDataTimestampWithResponse

func (c *ClientWithResponses) GetUserDataTimestampWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetUserDataTimestampResponse2, error)

GetUserDataTimestampWithResponse Get User Data Timestamp

There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with WebSocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions

Returns a wrapper object for the known response body format(s).

Corresponds with GET /exchange/user_data_timestamp (the `GetUserDataTimestamp` operationId).

func (*ClientWithResponses) GetWeatherIndexCalibrationsWithResponse

func (c *ClientWithResponses) GetWeatherIndexCalibrationsWithResponse(ctx context.Context, city string, reqEditors ...RequestEditorFn) (*GetWeatherIndexCalibrationsResponse2, error)

GetWeatherIndexCalibrationsWithResponse Get Weather Index Calibrations

Get a city's published weather-index configuration timeline: the launch configuration plus every weekly offset calibration and methodology update, ascending by effective time. Each record carries the station weights, station offsets (Celsius), and the city reference used to compute index values from the record's effective time until the next record — everything needed to reproduce published index values for minutes computed under that configuration version. Offsets are re-estimated weekly after each complete UTC week; weights never change through calibration. The timeline is append-only and complete: it is never trimmed.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/weather/{city}/calibrations (the `GetWeatherIndexCalibrations` operationId).

func (*ClientWithResponses) GetWeatherIndexWithResponse

func (c *ClientWithResponses) GetWeatherIndexWithResponse(ctx context.Context, city string, params *GetWeatherIndexParams, reqEditors ...RequestEditorFn) (*GetWeatherIndexResponse2, error)

GetWeatherIndexWithResponse Get Weather Index

Get the Kalshi-computed city temperature index: the canonical minute-resolution series behind hourly temperature markets. City-keyed and independent of any event — the series exists whenever the city's index is configured. Values are Fahrenheit rounded to 0.01. Minutes where the index quorum failed carry no value and are never returned as points, so gaps in the series are real gaps. With `detailed=true` each point additionally carries every member station's reported reading and quality-control disposition — the pre-incorporation breakdown.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /live_data/weather/{city} (the `GetWeatherIndex` operationId).

func (*ClientWithResponses) GetWithdrawalsWithResponse

func (c *ClientWithResponses) GetWithdrawalsWithResponse(ctx context.Context, params *GetWithdrawalsParams, reqEditors ...RequestEditorFn) (*GetWithdrawalsResponse2, error)

GetWithdrawalsWithResponse Get Withdrawals

Endpoint for getting the member's withdrawal history.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /portfolio/withdrawals (the `GetWithdrawals` operationId).

func (*ClientWithResponses) IntraExchangeInstanceTransferWithBodyWithResponse

func (c *ClientWithResponses) IntraExchangeInstanceTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IntraExchangeInstanceTransferResponse2, error)

IntraExchangeInstanceTransferWithBodyWithResponse Intra Account Transfer

Transfers funds within the same account.

When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.

Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).

func (*ClientWithResponses) IntraExchangeInstanceTransferWithResponse

func (c *ClientWithResponses) IntraExchangeInstanceTransferWithResponse(ctx context.Context, body IntraExchangeInstanceTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*IntraExchangeInstanceTransferResponse2, error)

IntraExchangeInstanceTransferWithResponse Intra Account Transfer

Transfers funds within the same account.

When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.

Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).

func (*ClientWithResponses) ListFCMSubtradersWithResponse

func (c *ClientWithResponses) ListFCMSubtradersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListFCMSubtradersResponse2, error)

ListFCMSubtradersWithResponse List FCM Subtraders

Lists the authenticated FCM's event-contract subtraders, including accounts with no trades. Exchange metadata is asynchronous, so newly created accounts may not appear immediately. Trading block status includes firm-wide and Kalshi restrictions; fcm_trading_blocked identifies the FCM's own per-subtrader restriction.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /fcm/subtraders (the `ListFCMSubtraders` operationId).

func (*ClientWithResponses) ProposeBlockTradeWithBodyWithResponse

func (c *ClientWithResponses) ProposeBlockTradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProposeBlockTradeResponse2, error)

ProposeBlockTradeWithBodyWithResponse Propose Block Trade

Endpoint for creating a block trade proposal.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).

func (*ClientWithResponses) ProposeBlockTradeWithResponse

func (c *ClientWithResponses) ProposeBlockTradeWithResponse(ctx context.Context, body ProposeBlockTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ProposeBlockTradeResponse2, error)

ProposeBlockTradeWithResponse Propose Block Trade

Endpoint for creating a block trade proposal.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).

func (*ClientWithResponses) ResetOrderGroupWithBodyWithResponse

func (c *ClientWithResponses) ResetOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResetOrderGroupResponse, error)

ResetOrderGroupWithBodyWithResponse Reset Order Group

Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).

func (*ClientWithResponses) ResetOrderGroupWithResponse

func (c *ClientWithResponses) ResetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, body ResetOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*ResetOrderGroupResponse, error)

ResetOrderGroupWithResponse Reset Order Group

Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).

func (*ClientWithResponses) SetTargetBalanceAllocationWithBodyWithResponse

func (c *ClientWithResponses) SetTargetBalanceAllocationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetTargetBalanceAllocationResponse, error)

SetTargetBalanceAllocationWithBodyWithResponse Set Target Balance Allocation

Replaces the caller's target balance allocation across exchange indexes. Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).

func (*ClientWithResponses) SetTargetBalanceAllocationWithResponse

func (c *ClientWithResponses) SetTargetBalanceAllocationWithResponse(ctx context.Context, body SetTargetBalanceAllocationJSONRequestBody, reqEditors ...RequestEditorFn) (*SetTargetBalanceAllocationResponse, error)

SetTargetBalanceAllocationWithResponse Set Target Balance Allocation

Replaces the caller's target balance allocation across exchange indexes. Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).

func (*ClientWithResponses) TriggerOrderGroupWithBodyWithResponse

func (c *ClientWithResponses) TriggerOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerOrderGroupResponse, error)

TriggerOrderGroupWithBodyWithResponse Trigger Order Group

Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).

func (*ClientWithResponses) TriggerOrderGroupWithResponse

func (c *ClientWithResponses) TriggerOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, body TriggerOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerOrderGroupResponse, error)

TriggerOrderGroupWithResponse Trigger Order Group

Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).

func (*ClientWithResponses) UpdateFCMEventContractDailyCapWithBodyWithResponse

func (c *ClientWithResponses) UpdateFCMEventContractDailyCapWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFCMEventContractDailyCapResponse, error)

UpdateFCMEventContractDailyCapWithBodyWithResponse Update FCM Subtrader Event Contract Daily Cap

Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds the subtrader's net premium at risk per trading day. It is enforced on cap-reservation sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader with no cap cannot trade through its bound keys. Cap changes take effect immediately; existing resting orders are never cancelled by a cap change.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).

func (*ClientWithResponses) UpdateFCMEventContractDailyCapWithResponse

func (c *ClientWithResponses) UpdateFCMEventContractDailyCapWithResponse(ctx context.Context, body UpdateFCMEventContractDailyCapJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFCMEventContractDailyCapResponse, error)

UpdateFCMEventContractDailyCapWithResponse Update FCM Subtrader Event Contract Daily Cap

Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds the subtrader's net premium at risk per trading day. It is enforced on cap-reservation sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader with no cap cannot trade through its bound keys. Cap changes take effect immediately; existing resting orders are never cancelled by a cap change.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).

func (*ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse

func (c *ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)

UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse Update FCM Subtrader Blocked Categories

Adds one event category to, or removes one from, the set an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. Blocks apply prospectively: new orders the subtrader places through its bound API credentials are rejected in markets whose event belongs to a blocked category, while orders already resting are not cancelled. Returns the subtrader's full resulting blocked set.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).

func (*ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithResponse

func (c *ClientWithResponses) UpdateFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)

UpdateFCMSubtraderBlockedCategoriesWithResponse Update FCM Subtrader Blocked Categories

Adds one event category to, or removes one from, the set an FCM member has blocked for one of its subtraders. The subtrader must belong to the requesting FCM. Blocks apply prospectively: new orders the subtrader places through its bound API credentials are rejected in markets whose event belongs to a blocked category, while orders already resting are not cancelled. Returns the subtrader's full resulting blocked set.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).

func (*ClientWithResponses) UpdateOrderGroupLimitWithBodyWithResponse

func (c *ClientWithResponses) UpdateOrderGroupLimitWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrderGroupLimitResponse, error)

UpdateOrderGroupLimitWithBodyWithResponse Update Order Group Limit

Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).

func (*ClientWithResponses) UpdateOrderGroupLimitWithResponse

func (c *ClientWithResponses) UpdateOrderGroupLimitWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, body UpdateOrderGroupLimitJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrderGroupLimitResponse, error)

UpdateOrderGroupLimitWithResponse Update Order Group Limit

Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).

func (*ClientWithResponses) UpdateSubaccountNettingWithBodyWithResponse

func (c *ClientWithResponses) UpdateSubaccountNettingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSubaccountNettingResponse, error)

UpdateSubaccountNettingWithBodyWithResponse Update Subaccount Netting

Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).

func (*ClientWithResponses) UpdateSubaccountNettingWithResponse

func (c *ClientWithResponses) UpdateSubaccountNettingWithResponse(ctx context.Context, body UpdateSubaccountNettingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSubaccountNettingResponse, error)

UpdateSubaccountNettingWithResponse Update Subaccount Netting

Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).

func (*ClientWithResponses) UpgradeAccountApiUsageLevelWithResponse

func (c *ClientWithResponses) UpgradeAccountApiUsageLevelWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UpgradeAccountApiUsageLevelResponse, error)

UpgradeAccountApiUsageLevelWithResponse Upgrade Account API Usage Level

Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user's last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /account/api_usage_level/upgrade (the `UpgradeAccountApiUsageLevel` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// UpgradeAccountApiUsageLevelWithResponse Upgrade Account API Usage Level
	//
	// Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user's last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /account/api_usage_level/upgrade (the `UpgradeAccountApiUsageLevel` operationId).
	UpgradeAccountApiUsageLevelWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UpgradeAccountApiUsageLevelResponse, error)

	// GetAccountApiUsageLevelVolumeProgressWithResponse Get Account API Usage Level Volume Progress
	//
	// Returns the authenticated user's latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /account/api_usage_level/volume_progress (the `GetAccountApiUsageLevelVolumeProgress` operationId).
	GetAccountApiUsageLevelVolumeProgressWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiUsageLevelVolumeProgressResponse2, error)

	// GetAccountEndpointCostsWithResponse List Non-Default Endpoint Costs
	//
	// Lists API v2 endpoints whose configured token cost differs from the default cost. Endpoints that use the default cost are omitted.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /account/endpoint_costs (the `GetAccountEndpointCosts` operationId).
	GetAccountEndpointCostsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountEndpointCostsResponse2, error)

	// GetAccountApiLimitsWithResponse Get Account API Limits
	//
	// Endpoint to retrieve the authenticated user's Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /account/limits (the `GetAccountApiLimits` operationId).
	GetAccountApiLimitsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountApiLimitsResponse2, error)

	// GetApiKeysWithResponse Get API Keys
	//
	//  Endpoint for retrieving all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api_keys (the `GetApiKeys` operationId).
	GetApiKeysWithResponse(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*GetApiKeysResponse2, error)

	// CreateApiKeyWithBodyWithResponse Create API Key
	//
	//  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api_keys (the `CreateApiKey` operationId).
	CreateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse2, error)

	// CreateApiKeyWithResponse Create API Key
	//
	//  Endpoint for creating a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA or Ed25519 public key in PEM format. The platform will use this public key to verify signatures on API requests: RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api_keys (the `CreateApiKey` operationId).
	CreateApiKeyWithResponse(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse2, error)

	// GenerateApiKeyWithBodyWithResponse Generate API Key
	//
	//  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).
	GenerateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateApiKeyResponse2, error)

	// GenerateApiKeyWithResponse Generate API Key
	//
	//  Endpoint for generating a new API key with an automatically created key pair.  This endpoint generates a key pair of the requested key_type (RSA when omitted). The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api_keys/generate (the `GenerateApiKey` operationId).
	GenerateApiKeyWithResponse(ctx context.Context, body GenerateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*GenerateApiKeyResponse2, error)

	// DeleteApiKeyWithResponse Delete API Key
	//
	//  Endpoint for deleting an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api_keys/{api_key} (the `DeleteApiKey` operationId).
	DeleteApiKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteApiKeyResponse, error)

	// GetBlockTradeProposalsWithResponse Get Block Trade Proposals
	//
	//  Endpoint for getting block trade proposals visible to the authenticated user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/block-trade-proposals (the `GetBlockTradeProposals` operationId).
	GetBlockTradeProposalsWithResponse(ctx context.Context, params *GetBlockTradeProposalsParams, reqEditors ...RequestEditorFn) (*GetBlockTradeProposalsResponse2, error)

	// ProposeBlockTradeWithBodyWithResponse Propose Block Trade
	//
	//  Endpoint for creating a block trade proposal.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).
	ProposeBlockTradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProposeBlockTradeResponse2, error)

	// ProposeBlockTradeWithResponse Propose Block Trade
	//
	//  Endpoint for creating a block trade proposal.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/block-trade-proposals (the `ProposeBlockTrade` operationId).
	ProposeBlockTradeWithResponse(ctx context.Context, body ProposeBlockTradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ProposeBlockTradeResponse2, error)

	// AcceptBlockTradeProposalWithBodyWithResponse Accept Block Trade Proposal
	//
	//  Endpoint for accepting a block trade proposal.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).
	AcceptBlockTradeProposalWithBodyWithResponse(ctx context.Context, blockTradeProposalId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptBlockTradeProposalResponse, error)

	// AcceptBlockTradeProposalWithResponse Accept Block Trade Proposal
	//
	//  Endpoint for accepting a block trade proposal.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept (the `AcceptBlockTradeProposal` operationId).
	AcceptBlockTradeProposalWithResponse(ctx context.Context, blockTradeProposalId string, body AcceptBlockTradeProposalJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptBlockTradeProposalResponse, error)

	// GetCommunicationsIDWithResponse Get Communications ID
	//
	//  Endpoint for getting the communications ID of the logged-in user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/id (the `GetCommunicationsID` operationId).
	GetCommunicationsIDWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCommunicationsIDResponse2, error)

	// GetQuotesWithResponse Get Quotes
	//
	// List quotes. The rfq_id filter requires an RFQ UUID. Pass pagination cursors back unchanged; malformed RFQ IDs or cursors return HTTP 400.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/quotes (the `GetQuotes` operationId).
	GetQuotesWithResponse(ctx context.Context, params *GetQuotesParams, reqEditors ...RequestEditorFn) (*GetQuotesResponse2, error)

	// CreateQuoteWithBodyWithResponse Create Quote
	//
	//  Endpoint for creating a quote in response to an RFQ.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/quotes (the `CreateQuote` operationId).
	CreateQuoteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateQuoteResponse2, error)

	// CreateQuoteWithResponse Create Quote
	//
	//  Endpoint for creating a quote in response to an RFQ.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/quotes (the `CreateQuote` operationId).
	CreateQuoteWithResponse(ctx context.Context, body CreateQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateQuoteResponse2, error)

	// DeleteQuoteWithResponse Delete Quote
	//
	// DEPRECATED: Use DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for deleting a quote, which means it can no longer be accepted.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /communications/quotes/{quote_id} (the `DeleteQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	DeleteQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*DeleteQuoteResponse, error)

	// GetQuoteWithResponse Get Quote
	//
	// DEPRECATED: Use GET /communications/rfqs/{rfq_id}/quotes/{quote_id} instead. Endpoint for getting a particular quote.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/quotes/{quote_id} (the `GetQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	GetQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*GetQuoteResponse2, error)

	// AcceptQuoteWithBodyWithResponse Accept Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AcceptQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptQuoteResponse, error)

	// AcceptQuoteWithResponse Accept Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept instead. Endpoint for accepting a quote. This will require the quoter to confirm.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/accept (the `AcceptQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	AcceptQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body AcceptQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptQuoteResponse, error)

	// ConfirmQuoteWithBodyWithResponse Confirm Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ConfirmQuoteWithBodyWithResponse(ctx context.Context, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmQuoteResponse, error)

	// ConfirmQuoteWithResponse Confirm Quote
	//
	// DEPRECATED: Use PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm instead. Endpoint for confirming a quote. This will start a timer for order execution.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/quotes/{quote_id}/confirm (the `ConfirmQuote` operationId).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ConfirmQuoteWithResponse(ctx context.Context, quoteId QuoteIdPath, body ConfirmQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmQuoteResponse, error)

	// GetRFQsWithResponse Get RFQs
	//
	// List RFQs. Pass pagination cursors back unchanged. A malformed cursor or invalid creator_user_id UUID returns HTTP 400. Use user_filter=self to filter by the authenticated user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/rfqs (the `GetRFQs` operationId).
	GetRFQsWithResponse(ctx context.Context, params *GetRFQsParams, reqEditors ...RequestEditorFn) (*GetRFQsResponse2, error)

	// CreateRFQWithBodyWithResponse Create RFQ
	//
	//  Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).
	CreateRFQWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRFQResponse2, error)

	// CreateRFQWithResponse Create RFQ
	//
	//  Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /communications/rfqs (the `CreateRFQ` operationId).
	CreateRFQWithResponse(ctx context.Context, body CreateRFQJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRFQResponse2, error)

	// DeleteRFQWithResponse Delete RFQ
	//
	//  Endpoint for deleting an RFQ by ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /communications/rfqs/{rfq_id} (the `DeleteRFQ` operationId).
	DeleteRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*DeleteRFQResponse, error)

	// GetRFQWithResponse Get RFQ
	//
	//  Endpoint for getting a single RFQ by id.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/rfqs/{rfq_id} (the `GetRFQ` operationId).
	GetRFQWithResponse(ctx context.Context, rfqId RfqIdPath, reqEditors ...RequestEditorFn) (*GetRFQResponse2, error)

	// DeleteRFQQuoteWithResponse Delete RFQ Quote
	//
	//  Endpoint for deleting a quote scoped to its RFQ, which means it can no longer be accepted.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `DeleteRFQQuote` operationId).
	DeleteRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*DeleteRFQQuoteResponse, error)

	// GetRFQQuoteWithResponse Get RFQ Quote
	//
	//  Endpoint for getting a particular quote scoped to its RFQ.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /communications/rfqs/{rfq_id}/quotes/{quote_id} (the `GetRFQQuote` operationId).
	GetRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, reqEditors ...RequestEditorFn) (*GetRFQQuoteResponse, error)

	// AcceptRFQQuoteWithBodyWithResponse Accept RFQ Quote
	//
	//  Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).
	AcceptRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptRFQQuoteResponse, error)

	// AcceptRFQQuoteWithResponse Accept RFQ Quote
	//
	//  Endpoint for accepting a quote scoped to its RFQ. This will require the quoter to confirm.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept (the `AcceptRFQQuote` operationId).
	AcceptRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body AcceptRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptRFQQuoteResponse, error)

	// ConfirmRFQQuoteWithBodyWithResponse Confirm RFQ Quote
	//
	//  Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).
	ConfirmRFQQuoteWithBodyWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfirmRFQQuoteResponse, error)

	// ConfirmRFQQuoteWithResponse Confirm RFQ Quote
	//
	//  Endpoint for confirming a quote scoped to its RFQ. This will start a timer for order execution.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm (the `ConfirmRFQQuote` operationId).
	ConfirmRFQQuoteWithResponse(ctx context.Context, rfqId RfqIdPath, quoteId QuoteIdPath, body ConfirmRFQQuoteJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfirmRFQQuoteResponse, error)

	// GetEventsWithResponse Get Events
	//
	// Get all events. This endpoint excludes multivariate events.
	// To retrieve multivariate events, use the GET /events/multivariate endpoint.
	// All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /events (the `GetEvents` operationId).
	GetEventsWithResponse(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsResponse2, error)

	// GetEventFeeChangesWithResponse Get Event Fee Changes
	//
	// Event fees are an override layered on top of the parent series' fee structure. If `fee_type_override` and `fee_multiplier_override` are null, that indicates the override is cleared.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /events/fee_changes (the `GetEventFeeChanges` operationId).
	GetEventFeeChangesWithResponse(ctx context.Context, params *GetEventFeeChangesParams, reqEditors ...RequestEditorFn) (*GetEventFeeChangesResponse2, error)

	// GetMultivariateEventsWithResponse Get Multivariate Events
	//
	// Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series ticker, collection ticker, or a comma-separated list of event tickers.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /events/multivariate (the `GetMultivariateEvents` operationId).
	GetMultivariateEventsWithResponse(ctx context.Context, params *GetMultivariateEventsParams, reqEditors ...RequestEditorFn) (*GetMultivariateEventsResponse2, error)

	// GetEventWithResponse Get Event
	//
	// Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release.
	// Events contain one or more markets where users can place trades on different outcomes.
	// All events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /events/{event_ticker} (the `GetEvent` operationId).
	GetEventWithResponse(ctx context.Context, eventTicker string, params *GetEventParams, reqEditors ...RequestEditorFn) (*GetEventResponse2, error)

	// GetEventMetadataWithResponse Get Event Metadata
	//
	//  Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /events/{event_ticker}/metadata (the `GetEventMetadata` operationId).
	GetEventMetadataWithResponse(ctx context.Context, eventTicker string, reqEditors ...RequestEditorFn) (*GetEventMetadataResponse2, error)

	// GetExchangeScheduleWithResponse Get Exchange Schedule
	//
	//  Endpoint for getting the exchange schedule.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /exchange/schedule (the `GetExchangeSchedule` operationId).
	GetExchangeScheduleWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeScheduleResponse2, error)

	// GetExchangeStatusWithResponse Get Exchange Status
	//
	//  Endpoint for getting the exchange status.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /exchange/status (the `GetExchangeStatus` operationId).
	GetExchangeStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExchangeStatusResponse, error)

	// GetUserDataTimestampWithResponse Get User Data Timestamp
	//
	//  There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with WebSocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /exchange/user_data_timestamp (the `GetUserDataTimestamp` operationId).
	GetUserDataTimestampWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetUserDataTimestampResponse2, error)

	// GetFCMFillsWithResponse Get FCM Fills
	//
	// Returns fills across the authenticated FCM's subtraders. Requires FCM member access.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/fills (the `GetFCMFills` operationId).
	GetFCMFillsWithResponse(ctx context.Context, params *GetFCMFillsParams, reqEditors ...RequestEditorFn) (*GetFCMFillsResponse, error)

	// GetFCMOrdersWithResponse Get FCM Orders
	//
	// Endpoint for FCM members to get orders for their subtraders.
	// This endpoint requires FCM member access level. At least one of `subtrader_id` or
	// `client_order_ids` is required; supplying both returns only the orders matching both filters.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/orders (the `GetFCMOrders` operationId).
	GetFCMOrdersWithResponse(ctx context.Context, params *GetFCMOrdersParams, reqEditors ...RequestEditorFn) (*GetFCMOrdersResponse, error)

	// GetFCMPositionsWithResponse Get FCM Positions
	//
	// Endpoint for FCM members to get market positions filtered by subtrader ID.
	// This endpoint requires FCM member access level and allows filtering positions by subtrader ID.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/positions (the `GetFCMPositions` operationId).
	GetFCMPositionsWithResponse(ctx context.Context, params *GetFCMPositionsParams, reqEditors ...RequestEditorFn) (*GetFCMPositionsResponse, error)

	// CreateFCMPositionTransferWithBodyWithResponse Create FCM Position Transfer
	//
	// Endpoint for FCM members to move a position in one market from one of their subtraders into a
	// subtrader under their FCM's error account.
	//
	// **This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the
	// error account that receives transferred positions and gives you that account's user id, which
	// prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.
	//
	// - The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader
	//   under it, which is created on first use.
	// - Each request moves one market for one source subtrader. To move many positions, send one
	//   request per subtrader and market.
	// - The transfer is booked like a trade at `price_centicents`, which is always the YES price, even
	//   when moving NO. No fee is charged and no fill is created. For YES, the error account pays the
	//   price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same
	//   amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds
	//   the side being moved and the target subtrader holds no opposite position in that market;
	//   otherwise the positions net like a trade and the balance changes differ.
	// - The source's current position is not checked. A request for more than the source holds, or
	//   with the opposite sign, flips or grows the source's position.
	// - Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
	// - The market must be open, neither account may be blocked, and the error account must have
	//   enough available balance on the market's exchange index to pay for the transfer. Otherwise
	//   the request returns 409.
	//
	// **Example: moving YES.** A customer subtrader holds 10 YES contracts. Send
	// `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents):
	// - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES.
	// - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50.
	// - Sending `price_centicents` 0 instead moves the position with no cash.
	//
	// **Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount`
	// -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):
	// - The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
	// - The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
	// - Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the
	//   error account pay the full $1 per contract ($5.00).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).
	CreateFCMPositionTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMPositionTransferResponse2, error)

	// CreateFCMPositionTransferWithResponse Create FCM Position Transfer
	//
	// Endpoint for FCM members to move a position in one market from one of their subtraders into a
	// subtrader under their FCM's error account.
	//
	// **This endpoint must be enabled for your FCM by Kalshi.** Kalshi enables it by configuring the
	// error account that receives transferred positions and gives you that account's user id, which
	// prefixes `target_subtrader_id`. Contact Kalshi to enable it; until then, requests return 400.
	//
	// - The destination is always your FCM's error account. `target_subtrader_id` picks the subtrader
	//   under it, which is created on first use.
	// - Each request moves one market for one source subtrader. To move many positions, send one
	//   request per subtrader and market.
	// - The transfer is booked like a trade at `price_centicents`, which is always the YES price, even
	//   when moving NO. No fee is charged and no fill is created. For YES, the error account pays the
	//   price per contract; for NO, it pays $1 minus the price per contract. The FCM receives the same
	//   amount. Use 0 for YES or 10000 for NO to move no cash. These amounts assume the source holds
	//   the side being moved and the target subtrader holds no opposite position in that market;
	//   otherwise the positions net like a trade and the balance changes differ.
	// - The source's current position is not checked. A request for more than the source holds, or
	//   with the opposite sign, flips or grows the source's position.
	// - Requests are not idempotent. After a timeout or 5xx, check the position before retrying.
	// - The market must be open, neither account may be blocked, and the error account must have
	//   enough available balance on the market's exchange index to pay for the transfer. Otherwise
	//   the request returns 409.
	//
	// **Example: moving YES.** A customer subtrader holds 10 YES contracts. Send
	// `position_centicount` 1000 and `price_centicents` 4500 (YES at 45 cents):
	// - The customer subtrader goes from 10 YES to 0, and the error account subtrader from 0 to 10 YES.
	// - The error account pays 10 x $0.45 = $4.50 and the FCM receives $4.50.
	// - Sending `price_centicents` 0 instead moves the position with no cash.
	//
	// **Example: moving NO.** A customer subtrader holds 5 NO contracts. Send `position_centicount`
	// -500 and `price_centicents` 7000 (YES at 70 cents, so NO at 30 cents):
	// - The customer subtrader goes from 5 NO to 0, and the error account subtrader from 0 to 5 NO.
	// - The error account pays 5 x $0.30 = $1.50 and the FCM receives $1.50.
	// - Sending `price_centicents` 10000 instead moves the position with no cash. Sending 0 makes the
	//   error account pay the full $1 per contract ($5.00).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /fcm/positions/transfers (the `CreateFCMPositionTransfer` operationId).
	CreateFCMPositionTransferWithResponse(ctx context.Context, body CreateFCMPositionTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMPositionTransferResponse2, error)

	// ListFCMSubtradersWithResponse List FCM Subtraders
	//
	// Lists the authenticated FCM's event-contract subtraders, including accounts with
	// no trades. Exchange metadata is asynchronous, so newly created accounts may not
	// appear immediately. Trading block status includes firm-wide and Kalshi restrictions;
	// fcm_trading_blocked identifies the FCM's own per-subtrader restriction.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/subtraders (the `ListFCMSubtraders` operationId).
	ListFCMSubtradersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListFCMSubtradersResponse2, error)

	// CreateFCMSubtraderWithBodyWithResponse Create FCM Subtrader
	//
	// Endpoint for FCM members to create a subtrader on the event-contract exchange. The
	// subtrader is registered on every exchange shard that knows the FCM; a shard provisioned
	// later registers it lazily on the subtrader's first order there. Re-creating an existing
	// subtrader returns 409.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).
	CreateFCMSubtraderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMSubtraderResponse2, error)

	// CreateFCMSubtraderWithResponse Create FCM Subtrader
	//
	// Endpoint for FCM members to create a subtrader on the event-contract exchange. The
	// subtrader is registered on every exchange shard that knows the FCM; a shard provisioned
	// later registers it lazily on the subtrader's first order there. Re-creating an existing
	// subtrader returns 409.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /fcm/subtraders (the `CreateFCMSubtrader` operationId).
	CreateFCMSubtraderWithResponse(ctx context.Context, body CreateFCMSubtraderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMSubtraderResponse2, error)

	// GetFCMSubtraderBlockedCategoriesWithResponse Get FCM Subtrader Blocked Categories
	//
	// Returns the event categories an FCM member has blocked for one of its
	// subtraders. The subtrader must belong to the requesting FCM. A subtrader
	// with no blocks returns an empty list.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/subtraders/blocked_categories (the `GetFCMSubtraderBlockedCategories` operationId).
	GetFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, params *GetFCMSubtraderBlockedCategoriesParams, reqEditors ...RequestEditorFn) (*GetFCMSubtraderBlockedCategoriesResponse2, error)

	// UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse Update FCM Subtrader Blocked Categories
	//
	// Adds one event category to, or removes one from, the set an FCM member
	// has blocked for one of its subtraders. The subtrader must belong to the
	// requesting FCM. Blocks apply prospectively: new orders the subtrader
	// places through its bound API credentials are rejected in markets whose
	// event belongs to a blocked category, while orders already resting are
	// not cancelled. Returns the subtrader's full resulting blocked set.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).
	UpdateFCMSubtraderBlockedCategoriesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)

	// UpdateFCMSubtraderBlockedCategoriesWithResponse Update FCM Subtrader Blocked Categories
	//
	// Adds one event category to, or removes one from, the set an FCM member
	// has blocked for one of its subtraders. The subtrader must belong to the
	// requesting FCM. Blocks apply prospectively: new orders the subtrader
	// places through its bound API credentials are rejected in markets whose
	// event belongs to a blocked category, while orders already resting are
	// not cancelled. Returns the subtrader's full resulting blocked set.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /fcm/subtraders/blocked_categories (the `UpdateFCMSubtraderBlockedCategories` operationId).
	UpdateFCMSubtraderBlockedCategoriesWithResponse(ctx context.Context, body UpdateFCMSubtraderBlockedCategoriesJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)

	// DeleteFCMEventContractDailyCapWithResponse Delete FCM Subtrader Event Contract Daily Cap
	//
	// Removes the event-contract daily premium cap for an FCM member's subtrader. Removal
	// closes the subtrader to new orders on cap-reservation sessions — every subtrader-bound
	// API key — until a cap is set again. It does not stop orders your own unbound sessions
	// submit on the subtrader's behalf; to stop the account entirely, block subtrader trading.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /fcm/subtraders/event_contract_daily_cap (the `DeleteFCMEventContractDailyCap` operationId).
	DeleteFCMEventContractDailyCapWithResponse(ctx context.Context, params *DeleteFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*DeleteFCMEventContractDailyCapResponse, error)

	// GetFCMEventContractDailyCapWithResponse Get FCM Subtrader Event Contract Daily Cap
	//
	// Returns the event-contract daily premium cap configured for an FCM member's subtrader,
	// together with its live utilization. Executed utilization is the net premium deployed by
	// fills today (sells and settlements credit back); resting and pending utilization reserve
	// open and in-flight orders at their full worst-case cost plus fees. Executed utilization
	// resets at midnight New York time on the returned cap date; resting and pending
	// reservations persist for as long as their orders remain open, including across the reset.
	// Returns 404 when the subtrader has no cap configured — in that state every order placed
	// through the subtrader's bound API keys is rejected.
	// API keys bound to a single FCM subtrader may also call this endpoint: `subtrader_id` may be
	// omitted and defaults to the key's bound subtrader, and if supplied it must equal the bound
	// subtrader or the request is rejected.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /fcm/subtraders/event_contract_daily_cap (the `GetFCMEventContractDailyCap` operationId).
	GetFCMEventContractDailyCapWithResponse(ctx context.Context, params *GetFCMEventContractDailyCapParams, reqEditors ...RequestEditorFn) (*GetFCMEventContractDailyCapResponse2, error)

	// UpdateFCMEventContractDailyCapWithBodyWithResponse Update FCM Subtrader Event Contract Daily Cap
	//
	// Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds
	// the subtrader's net premium at risk per trading day. It is enforced on cap-reservation
	// sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader
	// with no cap cannot trade through its bound keys. Cap changes take effect immediately;
	// existing resting orders are never cancelled by a cap change.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).
	UpdateFCMEventContractDailyCapWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFCMEventContractDailyCapResponse, error)

	// UpdateFCMEventContractDailyCapWithResponse Update FCM Subtrader Event Contract Daily Cap
	//
	// Sets the event-contract daily premium cap for an FCM member's subtrader. The cap bounds
	// the subtrader's net premium at risk per trading day. It is enforced on cap-reservation
	// sessions — which every subtrader-bound API key uses — and is mandatory there: a subtrader
	// with no cap cannot trade through its bound keys. Cap changes take effect immediately;
	// existing resting orders are never cancelled by a cap change.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /fcm/subtraders/event_contract_daily_cap (the `UpdateFCMEventContractDailyCap` operationId).
	UpdateFCMEventContractDailyCapWithResponse(ctx context.Context, body UpdateFCMEventContractDailyCapJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFCMEventContractDailyCapResponse, error)

	// GetHistoricalCutoffWithResponse Get Historical Cutoff Timestamps
	//
	// Returns the archive's cutoff timestamps. For positions, the cutoff is the backfill horizon; visibility in the historical API waits for a buffered, whole-event handoff.
	//
	// ## Cutoff fields
	// - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`.
	// - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`.
	// - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
	// - `market_positions_last_updated_ts` : Backfill horizon for settled positions, not a guaranteed archive-visibility boundary. An event moves to `GET /historical/positions` only after its buffered handoff completes. Until then, its settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. Unsettled positions remain available in `GET /portfolio/positions`.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/cutoff (the `GetHistoricalCutoff` operationId).
	GetHistoricalCutoffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHistoricalCutoffResponse2, error)

	// GetFillsHistoricalWithResponse Get Historical Fills
	//
	// Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
	// API keys restricted to a subaccount return only that subaccount's fills. If supplied, `subaccount` must match the key's restriction.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/fills (the `GetFillsHistorical` operationId).
	GetFillsHistoricalWithResponse(ctx context.Context, params *GetFillsHistoricalParams, reqEditors ...RequestEditorFn) (*GetFillsHistoricalResponse, error)

	// GetHistoricalMarketsWithResponse Get Historical Markets
	//
	// Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/markets (the `GetHistoricalMarkets` operationId).
	GetHistoricalMarketsWithResponse(ctx context.Context, params *GetHistoricalMarketsParams, reqEditors ...RequestEditorFn) (*GetHistoricalMarketsResponse, error)

	// GetHistoricalMarketWithResponse Get Historical Market
	//
	//  Endpoint for getting data about a specific market by its ticker from the historical database.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/markets/{ticker} (the `GetHistoricalMarket` operationId).
	GetHistoricalMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetHistoricalMarketResponse, error)

	// GetMarketCandlesticksHistoricalWithResponse Get Historical Market Candlesticks
	//
	//  Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/markets/{ticker}/candlesticks (the `GetMarketCandlesticksHistorical` operationId).
	GetMarketCandlesticksHistoricalWithResponse(ctx context.Context, ticker string, params *GetMarketCandlesticksHistoricalParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksHistoricalResponse2, error)

	// GetHistoricalOrdersWithResponse Get Historical Orders
	//
	// Endpoint for getting orders that have been archived to the historical database.
	// API keys restricted to a subaccount return only that subaccount's orders. If supplied, `subaccount` must match the key's restriction.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/orders (the `GetHistoricalOrders` operationId).
	GetHistoricalOrdersWithResponse(ctx context.Context, params *GetHistoricalOrdersParams, reqEditors ...RequestEditorFn) (*GetHistoricalOrdersResponse, error)

	// GetHistoricalPositionsWithResponse Get Historical Positions
	//
	// Returns settled market positions after their event completes the live-to-historical handoff. Until then, settled positions remain available via `GET /portfolio/positions?settlement_status=settled`. The `market_positions_last_updated_ts` value on `GET /historical/cutoff` is the backfill horizon, not a guarantee that every older position has moved. Unsettled positions are available via `GET /portfolio/positions`.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/positions (the `GetHistoricalPositions` operationId).
	GetHistoricalPositionsWithResponse(ctx context.Context, params *GetHistoricalPositionsParams, reqEditors ...RequestEditorFn) (*GetHistoricalPositionsResponse, error)

	// GetTradesHistoricalWithResponse Get Historical Trades
	//
	//  Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. Block trades are included by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical/trades (the `GetTradesHistorical` operationId).
	GetTradesHistoricalWithResponse(ctx context.Context, params *GetTradesHistoricalParams, reqEditors ...RequestEditorFn) (*GetTradesHistoricalResponse, error)

	// GetIncentiveProgramsWithResponse Get Incentives
	//
	//  List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /incentive_programs (the `GetIncentivePrograms` operationId).
	GetIncentiveProgramsWithResponse(ctx context.Context, params *GetIncentiveProgramsParams, reqEditors ...RequestEditorFn) (*GetIncentiveProgramsResponse2, error)

	// GetLiveDatasWithResponse Get Multiple Live Data
	//
	// Get live data for multiple milestones.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/batch (the `GetLiveDatas` operationId).
	GetLiveDatasWithResponse(ctx context.Context, params *GetLiveDatasParams, reqEditors ...RequestEditorFn) (*GetLiveDatasResponse2, error)

	// GetEventLiveDataWithResponse Get Event Live Data
	//
	// Get live data for an event by its event ticker. Serves event-keyed live data such as crypto price charts, commodity price timeseries, and weather observations. The `type` field in the response names the schema of the `details` object.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/events/{event_ticker} (the `GetEventLiveData` operationId).
	GetEventLiveDataWithResponse(ctx context.Context, eventTicker string, params *GetEventLiveDataParams, reqEditors ...RequestEditorFn) (*GetEventLiveDataResponse2, error)

	// GetLiveDataByMilestoneWithResponse Get Live Data
	//
	// Get live data for a specific milestone.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/milestone/{milestone_id} (the `GetLiveDataByMilestone` operationId).
	GetLiveDataByMilestoneWithResponse(ctx context.Context, milestoneId string, params *GetLiveDataByMilestoneParams, reqEditors ...RequestEditorFn) (*GetLiveDataByMilestoneResponse, error)

	// GetGameStatsWithResponse Get Game Stats
	//
	// Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men's Basketball, College Women's Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/milestone/{milestone_id}/game_stats (the `GetGameStats` operationId).
	GetGameStatsWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetGameStatsResponse2, error)

	// GetWeatherIndexWithResponse Get Weather Index
	//
	// Get the Kalshi-computed city temperature index: the canonical minute-resolution series behind hourly temperature markets. City-keyed and independent of any event — the series exists whenever the city's index is configured. Values are Fahrenheit rounded to 0.01. Minutes where the index quorum failed carry no value and are never returned as points, so gaps in the series are real gaps. With `detailed=true` each point additionally carries every member station's reported reading and quality-control disposition — the pre-incorporation breakdown.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/weather/{city} (the `GetWeatherIndex` operationId).
	GetWeatherIndexWithResponse(ctx context.Context, city string, params *GetWeatherIndexParams, reqEditors ...RequestEditorFn) (*GetWeatherIndexResponse2, error)

	// GetWeatherIndexCalibrationsWithResponse Get Weather Index Calibrations
	//
	// Get a city's published weather-index configuration timeline: the launch configuration plus every weekly offset calibration and methodology update, ascending by effective time. Each record carries the station weights, station offsets (Celsius), and the city reference used to compute index values from the record's effective time until the next record — everything needed to reproduce published index values for minutes computed under that configuration version. Offsets are re-estimated weekly after each complete UTC week; weights never change through calibration. The timeline is append-only and complete: it is never trimmed.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/weather/{city}/calibrations (the `GetWeatherIndexCalibrations` operationId).
	GetWeatherIndexCalibrationsWithResponse(ctx context.Context, city string, reqEditors ...RequestEditorFn) (*GetWeatherIndexCalibrationsResponse2, error)

	// GetLiveDataWithResponse Get Live Data (with type)
	//
	// Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /live_data/{type}/milestone/{milestone_id} (the `GetLiveData` operationId).
	GetLiveDataWithResponse(ctx context.Context, pType string, milestoneId string, params *GetLiveDataParams, reqEditors ...RequestEditorFn) (*GetLiveDataResponse2, error)

	// GetMarketsWithResponse Get Markets
	//
	// Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status.
	//  - Only one `status` filter may be supplied at a time.
	//  - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters.
	//
	//  | Compatible Timestamp Filters | Additional Status Filters| Extra Notes |
	//  |------------------------------|--------------------------|-------------|
	//  | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | |
	//  | min_close_ts, max_close_ts | `closed`, *empty* | |
	//  | min_settled_ts, max_settled_ts | `settled`, *empty* | |
	//  | min_updated_ts, max_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude`. May be combined with `series_ticker`, which requires `mve_filter=exclude` |
	//
	//  Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets (the `GetMarkets` operationId).
	GetMarketsWithResponse(ctx context.Context, params *GetMarketsParams, reqEditors ...RequestEditorFn) (*GetMarketsResponse2, error)

	// BatchGetMarketCandlesticksWithResponse Batch Get Market Candlesticks
	//
	// Endpoint for retrieving candlestick data for multiple markets.
	//
	// - Accepts up to 100 market tickers per request
	// - Returns up to 10,000 candlesticks total across all markets
	// - Returns candlesticks grouped by market_id
	// - Optionally includes a synthetic initial candlestick for price continuity (see `include_latest_before_start` parameter)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets/candlesticks (the `BatchGetMarketCandlesticks` operationId).
	BatchGetMarketCandlesticksWithResponse(ctx context.Context, params *BatchGetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*BatchGetMarketCandlesticksResponse2, error)

	// GetMarketOrderbooksWithResponse Get Multiple Market Orderbooks
	//
	// Endpoint for getting the current order books for multiple markets in a single request. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices. Returns one orderbook per requested market ticker.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets/orderbooks (the `GetMarketOrderbooks` operationId).
	GetMarketOrderbooksWithResponse(ctx context.Context, params *GetMarketOrderbooksParams, reqEditors ...RequestEditorFn) (*GetMarketOrderbooksResponse2, error)

	// GetTradesWithResponse Get Trades
	//
	// Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. Block trades are included in the response by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. This endpoint returns a paginated response. Use the 'limit' parameter to control page size (1-1000, defaults to 100). The response includes a 'cursor' field - pass this value in the 'cursor' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets/trades (the `GetTrades` operationId).
	GetTradesWithResponse(ctx context.Context, params *GetTradesParams, reqEditors ...RequestEditorFn) (*GetTradesResponse2, error)

	// GetMarketWithResponse Get Market
	//
	//  Endpoint for getting data about a specific market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., "Will candidate X win?"). Markets have yes/no positions, current prices, volume, and settlement rules.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets/{ticker} (the `GetMarket` operationId).
	GetMarketWithResponse(ctx context.Context, ticker TickerPath, reqEditors ...RequestEditorFn) (*GetMarketResponse2, error)

	// GetMarketOrderbookWithResponse Get Market Orderbook
	//
	//  Endpoint for getting the current order book for a specific market.  The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes.  Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /markets/{ticker}/orderbook (the `GetMarketOrderbook` operationId).
	GetMarketOrderbookWithResponse(ctx context.Context, ticker TickerPath, params *GetMarketOrderbookParams, reqEditors ...RequestEditorFn) (*GetMarketOrderbookResponse2, error)

	// GetMilestonesWithResponse Get Milestones
	//
	// Minimum start date to filter milestones. Format: RFC3339 timestamp
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /milestones (the `GetMilestones` operationId).
	GetMilestonesWithResponse(ctx context.Context, params *GetMilestonesParams, reqEditors ...RequestEditorFn) (*GetMilestonesResponse2, error)

	// GetMilestoneWithResponse Get Milestone
	//
	//  Endpoint for getting data about a specific milestone by its ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /milestones/{milestone_id} (the `GetMilestone` operationId).
	GetMilestoneWithResponse(ctx context.Context, milestoneId string, reqEditors ...RequestEditorFn) (*GetMilestoneResponse2, error)

	// GetMultivariateEventCollectionsWithResponse Get Multivariate Event Collections
	//
	//  Endpoint for getting data about multivariate event collections.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /multivariate_event_collections (the `GetMultivariateEventCollections` operationId).
	GetMultivariateEventCollectionsWithResponse(ctx context.Context, params *GetMultivariateEventCollectionsParams, reqEditors ...RequestEditorFn) (*GetMultivariateEventCollectionsResponse2, error)

	// GetMultivariateEventCollectionWithResponse Get Multivariate Event Collection
	//
	//  Endpoint for getting data about a multivariate event collection by its ticker.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /multivariate_event_collections/{collection_ticker} (the `GetMultivariateEventCollection` operationId).
	GetMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, reqEditors ...RequestEditorFn) (*GetMultivariateEventCollectionResponse2, error)

	// CreateMarketInMultivariateEventCollectionWithBodyWithResponse Create Market In Multivariate Event Collection
	//
	// Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).
	CreateMarketInMultivariateEventCollectionWithBodyWithResponse(ctx context.Context, collectionTicker string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateMarketInMultivariateEventCollectionResponse2, error)

	// CreateMarketInMultivariateEventCollectionWithResponse Create Market In Multivariate Event Collection
	//
	// Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /multivariate_event_collections/{collection_ticker} (the `CreateMarketInMultivariateEventCollection` operationId).
	CreateMarketInMultivariateEventCollectionWithResponse(ctx context.Context, collectionTicker string, body CreateMarketInMultivariateEventCollectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateMarketInMultivariateEventCollectionResponse2, error)

	// GetBalanceWithResponse Get Balance
	//
	// Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.
	//
	// **Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/balance (the `GetBalance` operationId).
	GetBalanceWithResponse(ctx context.Context, params *GetBalanceParams, reqEditors ...RequestEditorFn) (*GetBalanceResponse2, error)

	// GetDepositsWithResponse Get Deposits
	//
	// Endpoint for getting the member's deposit history.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/deposits (the `GetDeposits` operationId).
	GetDepositsWithResponse(ctx context.Context, params *GetDepositsParams, reqEditors ...RequestEditorFn) (*GetDepositsResponse2, error)

	// CancelAllOrdersWithResponse Cancel All Orders
	//
	// Cancels all resting event-market orders for the authenticated Direct member across every exchange shard. If `subaccount` is omitted, matching orders may come from any subaccount. If it is provided, only orders for that subaccount are eligible. Newly placed orders may also be cancelled during the minute after the request.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /portfolio/events/orders (the `CancelAllOrders` operationId).
	CancelAllOrdersWithResponse(ctx context.Context, params *CancelAllOrdersParams, reqEditors ...RequestEditorFn) (*CancelAllOrdersResponse, error)

	// CreateOrderV2WithBodyWithResponse Create Order (V2)
	//
	// Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).
	CreateOrderV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderV2Response2, error)

	// CreateOrderV2WithResponse Create Order (V2)
	//
	// Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders (the `CreateOrderV2` operationId).
	CreateOrderV2WithResponse(ctx context.Context, body CreateOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderV2Response2, error)

	// BatchCancelOrdersV2WithBodyWithResponse Batch Cancel Orders (V2)
	//
	// Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).
	BatchCancelOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCancelOrdersV2Response2, error)

	// BatchCancelOrdersV2WithResponse Batch Cancel Orders (V2)
	//
	// Endpoint for cancelling a batch of event-market orders using the V2 response shape. To auto-route a cancellation, provide its `market_ticker` and omit `exchange_index` or set it to `-1`. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /portfolio/events/orders/batched (the `BatchCancelOrdersV2` operationId).
	BatchCancelOrdersV2WithResponse(ctx context.Context, body BatchCancelOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCancelOrdersV2Response2, error)

	// BatchCreateOrdersV2WithBodyWithResponse Batch Create Orders (V2)
	//
	// Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).
	BatchCreateOrdersV2WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreateOrdersV2Response2, error)

	// BatchCreateOrdersV2WithResponse Batch Create Orders (V2)
	//
	// Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier's write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/batched (the `BatchCreateOrdersV2` operationId).
	BatchCreateOrdersV2WithResponse(ctx context.Context, body BatchCreateOrdersV2JSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreateOrdersV2Response2, error)

	// CancelOrderV2WithResponse Cancel Order (V2)
	//
	// Endpoint for cancelling event-market orders using the V2 response shape. To auto-route the cancellation, provide `market_ticker` and omit `exchange_index` or set it to `-1`. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /portfolio/events/orders/{order_id} (the `CancelOrderV2` operationId).
	CancelOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *CancelOrderV2Params, reqEditors ...RequestEditorFn) (*CancelOrderV2Response2, error)

	// AmendOrderV2WithBodyWithResponse Amend Order (V2)
	//
	// Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).
	AmendOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AmendOrderV2Response2, error)

	// AmendOrderV2WithResponse Amend Order (V2)
	//
	// Endpoint for amending the price, max fillable count, and/or expiration time of an existing event-market order. The request `count` is the updated total/max fillable count, equal to already filled count plus desired resting remaining count. This behavior matches the v1 amend endpoints; only the request/response shape differs.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/amend (the `AmendOrderV2` operationId).
	AmendOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *AmendOrderV2Params, body AmendOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*AmendOrderV2Response2, error)

	// DecreaseOrderV2WithBodyWithResponse Decrease Order (V2)
	//
	// Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).
	DecreaseOrderV2WithBodyWithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DecreaseOrderV2Response2, error)

	// DecreaseOrderV2WithResponse Decrease Order (V2)
	//
	// Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of `reduce_by` or `reduce_to` must be provided.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/events/orders/{order_id}/decrease (the `DecreaseOrderV2` operationId).
	DecreaseOrderV2WithResponse(ctx context.Context, orderId OrderIdPath, params *DecreaseOrderV2Params, body DecreaseOrderV2JSONRequestBody, reqEditors ...RequestEditorFn) (*DecreaseOrderV2Response2, error)

	// GetFillsWithResponse Get Fills
	//
	// Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	// Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/fills (the `GetFills` operationId).
	GetFillsWithResponse(ctx context.Context, params *GetFillsParams, reqEditors ...RequestEditorFn) (*GetFillsResponse2, error)

	// IntraExchangeInstanceTransferWithBodyWithResponse Intra Account Transfer
	//
	// Transfers funds within the same account.
	//
	// When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.
	//
	// Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).
	IntraExchangeInstanceTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IntraExchangeInstanceTransferResponse2, error)

	// IntraExchangeInstanceTransferWithResponse Intra Account Transfer
	//
	// Transfers funds within the same account.
	//
	// When `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.
	//
	// Cross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/intra_exchange_instance_transfer (the `IntraExchangeInstanceTransfer` operationId).
	IntraExchangeInstanceTransferWithResponse(ctx context.Context, body IntraExchangeInstanceTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*IntraExchangeInstanceTransferResponse2, error)

	// GetIntraExchangeInstanceTransfersWithResponse Get Intra Account Transfers
	//
	// Endpoint for fetching intra-exchange account transfer history.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/intra_exchange_instance_transfers (the `GetIntraExchangeInstanceTransfers` operationId).
	GetIntraExchangeInstanceTransfersWithResponse(ctx context.Context, params *GetIntraExchangeInstanceTransfersParams, reqEditors ...RequestEditorFn) (*GetIntraExchangeInstanceTransfersResponse2, error)

	// GetIntraExchangeInstanceTransferWithResponse Get Intra Account Transfer
	//
	// Endpoint for getting a single intra-account transfer by id.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/intra_exchange_instance_transfers/{transfer_id} (the `GetIntraExchangeInstanceTransfer` operationId).
	GetIntraExchangeInstanceTransferWithResponse(ctx context.Context, transferId string, reqEditors ...RequestEditorFn) (*GetIntraExchangeInstanceTransferResponse2, error)

	// GetOrderGroupsWithResponse Get Order Groups
	//
	//  Retrieves all order groups for the authenticated user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/order_groups (the `GetOrderGroups` operationId).
	GetOrderGroupsWithResponse(ctx context.Context, params *GetOrderGroupsParams, reqEditors ...RequestEditorFn) (*GetOrderGroupsResponse2, error)

	// CreateOrderGroupWithBodyWithResponse Create Order Group
	//
	//  Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).
	CreateOrderGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderGroupResponse2, error)

	// CreateOrderGroupWithResponse Create Order Group
	//
	//  Creates a new order group with a contracts limit measured over a rolling 15-second window. Users can have up to 100,000 order groups at a time. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/order_groups/create (the `CreateOrderGroup` operationId).
	CreateOrderGroupWithResponse(ctx context.Context, body CreateOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderGroupResponse2, error)

	// DeleteOrderGroupWithResponse Delete Order Group
	//
	//  Deletes an order group and cancels all orders within it. This permanently removes the group.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /portfolio/order_groups/{order_group_id} (the `DeleteOrderGroup` operationId).
	DeleteOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *DeleteOrderGroupParams, reqEditors ...RequestEditorFn) (*DeleteOrderGroupResponse, error)

	// GetOrderGroupWithResponse Get Order Group
	//
	//  Retrieves details for a single order group including all order IDs and auto-cancel status.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/order_groups/{order_group_id} (the `GetOrderGroup` operationId).
	GetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *GetOrderGroupParams, reqEditors ...RequestEditorFn) (*GetOrderGroupResponse2, error)

	// UpdateOrderGroupLimitWithBodyWithResponse Update Order Group Limit
	//
	//  Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).
	UpdateOrderGroupLimitWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrderGroupLimitResponse, error)

	// UpdateOrderGroupLimitWithResponse Update Order Group Limit
	//
	//  Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/limit (the `UpdateOrderGroupLimit` operationId).
	UpdateOrderGroupLimitWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *UpdateOrderGroupLimitParams, body UpdateOrderGroupLimitJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrderGroupLimitResponse, error)

	// ResetOrderGroupWithBodyWithResponse Reset Order Group
	//
	//  Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).
	ResetOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResetOrderGroupResponse, error)

	// ResetOrderGroupWithResponse Reset Order Group
	//
	//  Resets the order group's matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/reset (the `ResetOrderGroup` operationId).
	ResetOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *ResetOrderGroupParams, body ResetOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*ResetOrderGroupResponse, error)

	// TriggerOrderGroupWithBodyWithResponse Trigger Order Group
	//
	//  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).
	TriggerOrderGroupWithBodyWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerOrderGroupResponse, error)

	// TriggerOrderGroupWithResponse Trigger Order Group
	//
	//  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/order_groups/{order_group_id}/trigger (the `TriggerOrderGroup` operationId).
	TriggerOrderGroupWithResponse(ctx context.Context, orderGroupId OrderGroupIdPath, params *TriggerOrderGroupParams, body TriggerOrderGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerOrderGroupResponse, error)

	// GetOrdersWithResponse Get Orders
	//
	// Restricts the response to orders that have a certain status: resting, canceled, or executed.
	// Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/orders (the `GetOrders` operationId).
	GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*GetOrdersResponse2, error)

	// GetOrderQueuePositionsWithResponse Get Queue Positions for Orders
	//
	//  Endpoint for getting queue positions for all resting orders. Queue position represents the number of contracts that need to be matched before an order receives a partial or full match, determined using price-time priority.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/orders/queue_positions (the `GetOrderQueuePositions` operationId).
	GetOrderQueuePositionsWithResponse(ctx context.Context, params *GetOrderQueuePositionsParams, reqEditors ...RequestEditorFn) (*GetOrderQueuePositionsResponse2, error)

	// GetOrderWithResponse Get Order
	//
	//  Endpoint for getting a single order.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/orders/{order_id} (the `GetOrder` operationId).
	GetOrderWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderResponse2, error)

	// GetOrderQueuePositionWithResponse Get Order Queue Position
	//
	//  Endpoint for getting an order's queue position in the order book. This represents the amount of orders that need to be matched before this order receives a partial or full match. Queue position is determined using a price-time priority.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/orders/{order_id}/queue_position (the `GetOrderQueuePosition` operationId).
	GetOrderQueuePositionWithResponse(ctx context.Context, orderId OrderIdPath, reqEditors ...RequestEditorFn) (*GetOrderQueuePositionResponse2, error)

	// GetPositionsWithResponse Get Positions
	//
	// Returns unsettled positions by default. Set `settlement_status=settled` to page through settled positions that are still in the live data set, or `settlement_status=all` for both live states. Positions already archived are available via `GET /historical/positions`.
	// Settled and all-state positions are paginated by event ticker to keep large histories bounded. Cursors are specific to the selected settlement status.
	// `count_filter` restricts positions to those with a non-zero position or total traded count.
	// Registered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/positions (the `GetPositions` operationId).
	GetPositionsWithResponse(ctx context.Context, params *GetPositionsParams, reqEditors ...RequestEditorFn) (*GetPositionsResponse2, error)

	// GetSettlementsWithResponse Get Settlements
	//
	// Returns settlement records still in the live data set. Archived positions are available via `GET /historical/positions`, which has different fields; this endpoint does not return archived settlement records.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/settlements (the `GetSettlements` operationId).
	GetSettlementsWithResponse(ctx context.Context, params *GetSettlementsParams, reqEditors ...RequestEditorFn) (*GetSettlementsResponse2, error)

	// CreateSubaccountWithBodyWithResponse Create Subaccount
	//
	// Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).
	CreateSubaccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSubaccountResponse2, error)

	// CreateSubaccountWithResponse Create Subaccount
	//
	// Creates a new subaccount for the authenticated user. This endpoint is available to all users on the Advanced API tier and above. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/subaccounts (the `CreateSubaccount` operationId).
	CreateSubaccountWithResponse(ctx context.Context, body CreateSubaccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSubaccountResponse2, error)

	// GetSubaccountBalancesWithResponse Get All Subaccount Balances
	//
	// Gets balances for all subaccounts including the primary account.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/subaccounts/balances (the `GetSubaccountBalances` operationId).
	GetSubaccountBalancesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountBalancesResponse2, error)

	// GetSubaccountNettingWithResponse Get Subaccount Netting
	//
	// Gets the netting enabled settings for all subaccounts.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/subaccounts/netting (the `GetSubaccountNetting` operationId).
	GetSubaccountNettingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSubaccountNettingResponse2, error)

	// UpdateSubaccountNettingWithBodyWithResponse Update Subaccount Netting
	//
	// Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).
	UpdateSubaccountNettingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSubaccountNettingResponse, error)

	// UpdateSubaccountNettingWithResponse Update Subaccount Netting
	//
	// Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /portfolio/subaccounts/netting (the `UpdateSubaccountNetting` operationId).
	UpdateSubaccountNettingWithResponse(ctx context.Context, body UpdateSubaccountNettingJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSubaccountNettingResponse, error)

	// ApplySubaccountTransferWithBodyWithResponse Transfer Between Subaccounts
	//
	// Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).
	ApplySubaccountTransferWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ApplySubaccountTransferResponse2, error)

	// ApplySubaccountTransferWithResponse Transfer Between Subaccounts
	//
	// Transfers funds between the authenticated user's subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts. Set exchange_index to apply the transfer on a specific exchange shard (defaults to 0).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/subaccounts/transfer (the `ApplySubaccountTransfer` operationId).
	ApplySubaccountTransferWithResponse(ctx context.Context, body ApplySubaccountTransferJSONRequestBody, reqEditors ...RequestEditorFn) (*ApplySubaccountTransferResponse2, error)

	// GetSubaccountTransfersWithResponse Get Subaccount Transfers
	//
	// Gets a paginated list of all transfers between subaccounts for the authenticated user.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/subaccounts/transfers (the `GetSubaccountTransfers` operationId).
	GetSubaccountTransfersWithResponse(ctx context.Context, params *GetSubaccountTransfersParams, reqEditors ...RequestEditorFn) (*GetSubaccountTransfersResponse2, error)

	// GetPortfolioRestingOrderTotalValueWithResponse Get Total Resting Order Value
	//
	//  Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you're uncertain about this endpoint, it likely does not apply to you.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/summary/total_resting_order_value (the `GetPortfolioRestingOrderTotalValue` operationId).
	GetPortfolioRestingOrderTotalValueWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPortfolioRestingOrderTotalValueResponse2, error)

	// GetTargetBalanceAllocationWithResponse Get Target Balance Allocation
	//
	// Retrieves the caller's target balance allocation across exchange indexes.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/target_balance_allocation (the `GetTargetBalanceAllocation` operationId).
	GetTargetBalanceAllocationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTargetBalanceAllocationResponse2, error)

	// SetTargetBalanceAllocationWithBodyWithResponse Set Target Balance Allocation
	//
	// Replaces the caller's target balance allocation across exchange indexes.
	// Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).
	SetTargetBalanceAllocationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetTargetBalanceAllocationResponse, error)

	// SetTargetBalanceAllocationWithResponse Set Target Balance Allocation
	//
	// Replaces the caller's target balance allocation across exchange indexes.
	// Percentages must total 100. Passing an empty allocations array disables automatic rebalancing.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /portfolio/target_balance_allocation (the `SetTargetBalanceAllocation` operationId).
	SetTargetBalanceAllocationWithResponse(ctx context.Context, body SetTargetBalanceAllocationJSONRequestBody, reqEditors ...RequestEditorFn) (*SetTargetBalanceAllocationResponse, error)

	// GetWithdrawalsWithResponse Get Withdrawals
	//
	// Endpoint for getting the member's withdrawal history.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portfolio/withdrawals (the `GetWithdrawals` operationId).
	GetWithdrawalsWithResponse(ctx context.Context, params *GetWithdrawalsParams, reqEditors ...RequestEditorFn) (*GetWithdrawalsResponse2, error)

	// GetFiltersForSportsWithResponse Get Filters for Sports
	//
	// Retrieve available filters organized by sport.
	//
	// This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/filters_by_sport (the `GetFiltersForSports` operationId).
	GetFiltersForSportsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFiltersForSportsResponse, error)

	// GetTagsForSeriesCategoriesWithResponse Get Tags for Series Categories
	//
	// Retrieve tags organized by series categories.
	//
	// This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/tags_by_categories (the `GetTagsForSeriesCategories` operationId).
	GetTagsForSeriesCategoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTagsForSeriesCategoriesResponse2, error)

	// GetSeriesListWithResponse Get Series List
	//
	//  Endpoint for getting data about multiple series with specified filters.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). This endpoint allows you to browse and discover available series templates by category.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series (the `GetSeriesList` operationId).
	GetSeriesListWithResponse(ctx context.Context, params *GetSeriesListParams, reqEditors ...RequestEditorFn) (*GetSeriesListResponse2, error)

	// GetSeriesFeeChangesWithResponse Get Series Fee Changes
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series/fee_changes (the `GetSeriesFeeChanges` operationId).
	GetSeriesFeeChangesWithResponse(ctx context.Context, params *GetSeriesFeeChangesParams, reqEditors ...RequestEditorFn) (*GetSeriesFeeChangesResponse2, error)

	// GetSeriesWithResponse Get Series
	//
	//  Endpoint for getting data about a specific series by its ticker.  A series represents a template for recurring events that follow the same format and rules (e.g., "Monthly Jobs Report", "Weekly Initial Jobless Claims", "Daily Weather in NYC"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series/{series_ticker} (the `GetSeries` operationId).
	GetSeriesWithResponse(ctx context.Context, seriesTicker string, params *GetSeriesParams, reqEditors ...RequestEditorFn) (*GetSeriesResponse2, error)

	// GetMarketCandlesticksByEventWithResponse Get Event Candlesticks
	//
	//  End-point for returning aggregated data across all markets corresponding to an event.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series/{series_ticker}/events/{ticker}/candlesticks (the `GetMarketCandlesticksByEvent` operationId).
	GetMarketCandlesticksByEventWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksByEventParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksByEventResponse, error)

	// GetEventForecastPercentilesHistoryWithResponse Get Event Forecast Percentile History
	//
	// Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history (the `GetEventForecastPercentilesHistory` operationId).
	GetEventForecastPercentilesHistoryWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetEventForecastPercentilesHistoryParams, reqEditors ...RequestEditorFn) (*GetEventForecastPercentilesHistoryResponse2, error)

	// GetMarketCandlesticksWithResponse Get Market Candlesticks
	//
	// Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
	// Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /series/{series_ticker}/markets/{ticker}/candlesticks (the `GetMarketCandlesticks` operationId).
	GetMarketCandlesticksWithResponse(ctx context.Context, seriesTicker string, ticker string, params *GetMarketCandlesticksParams, reqEditors ...RequestEditorFn) (*GetMarketCandlesticksResponse2, error)

	// GetStructuredTargetsWithResponse Get Structured Targets
	//
	// Page size (min: 1, max: 2000)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /structured_targets (the `GetStructuredTargets` operationId).
	GetStructuredTargetsWithResponse(ctx context.Context, params *GetStructuredTargetsParams, reqEditors ...RequestEditorFn) (*GetStructuredTargetsResponse2, error)

	// GetStructuredTargetWithResponse Get Structured Target
	//
	//  Endpoint for getting data about a specific structured target by its ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /structured_targets/{structured_target_id} (the `GetStructuredTarget` operationId).
	GetStructuredTargetWithResponse(ctx context.Context, structuredTargetId string, reqEditors ...RequestEditorFn) (*GetStructuredTargetResponse2, error)
}

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

type ConfirmQuoteJSONRequestBody

type ConfirmQuoteJSONRequestBody = EmptyResponse

ConfirmQuoteJSONRequestBody defines body for ConfirmQuote for application/json ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type ConfirmQuoteResponse

type ConfirmQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseConfirmQuoteResponse

func ParseConfirmQuoteResponse(rsp *http.Response) (*ConfirmQuoteResponse, error)

ParseConfirmQuoteResponse parses an HTTP response from a ConfirmQuoteWithResponse call

func (ConfirmQuoteResponse) ContentType

func (r ConfirmQuoteResponse) ContentType() string

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

func (ConfirmQuoteResponse) GetBody

func (r ConfirmQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ConfirmQuoteResponse) GetJSON400

func (r ConfirmQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ConfirmQuoteResponse) GetJSON401

func (r ConfirmQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ConfirmQuoteResponse) GetJSON404

func (r ConfirmQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ConfirmQuoteResponse) GetJSON500

func (r ConfirmQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ConfirmQuoteResponse) Status

func (r ConfirmQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (ConfirmQuoteResponse) StatusCode

func (r ConfirmQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConfirmRFQQuoteJSONRequestBody

type ConfirmRFQQuoteJSONRequestBody = EmptyResponse

ConfirmRFQQuoteJSONRequestBody defines body for ConfirmRFQQuote for application/json ContentType.

type ConfirmRFQQuoteResponse

type ConfirmRFQQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseConfirmRFQQuoteResponse

func ParseConfirmRFQQuoteResponse(rsp *http.Response) (*ConfirmRFQQuoteResponse, error)

ParseConfirmRFQQuoteResponse parses an HTTP response from a ConfirmRFQQuoteWithResponse call

func (ConfirmRFQQuoteResponse) ContentType

func (r ConfirmRFQQuoteResponse) ContentType() string

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

func (ConfirmRFQQuoteResponse) GetBody

func (r ConfirmRFQQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ConfirmRFQQuoteResponse) GetJSON400

func (r ConfirmRFQQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ConfirmRFQQuoteResponse) GetJSON401

func (r ConfirmRFQQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ConfirmRFQQuoteResponse) GetJSON404

func (r ConfirmRFQQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ConfirmRFQQuoteResponse) GetJSON500

func (r ConfirmRFQQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ConfirmRFQQuoteResponse) Status

func (r ConfirmRFQQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (ConfirmRFQQuoteResponse) StatusCode

func (r ConfirmRFQQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConflictError

type ConflictError = ErrorResponse

ConflictError defines model for ConflictError.

type CountFilterQuery

type CountFilterQuery = string

CountFilterQuery defines model for CountFilterQuery.

type CreateApiKeyJSONRequestBody

type CreateApiKeyJSONRequestBody = CreateApiKeyRequest

CreateApiKeyJSONRequestBody defines body for CreateApiKey for application/json ContentType.

type CreateApiKeyRequest

type CreateApiKeyRequest struct {
	// FcmSubtraderId FCM members only. If set, binds the API key to a single FCM subtrader that you own, spelled {your_user_id}_{suffix} with a suffix of 1-16 case-sensitive ASCII alphanumeric characters. The subtrader must already exist. A bound key is the institution's trading credential for that subtrader - FIX order-entry and market-data sessions, plus margin WebSocket sessions scoped to the subtrader's own data - and is denied on every REST endpoint, including key management. Mutually exclusive with subaccount.
	FcmSubtraderId *string `json:"fcm_subtrader_id,omitempty"`

	// Name Name for the API key. This helps identify the key's purpose
	Name string `json:"name"`

	// PublicKey RSA or Ed25519 public key in PEM format (`-----BEGIN PUBLIC KEY-----`). This will be used to verify signatures on API requests - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys
	PublicKey string `json:"public_key"`

	// Scopes List of scopes to grant to the API key. If the broad `write` parent scope is included, `read` must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (`read`, `write`) if not provided.
	Scopes *[]ApiKeyScope `json:"scopes,omitempty"`

	// Subaccount If set, restricts the API key to a single sub-account (0-63) that you own. A restricted key may only read and trade on that sub-account; it cannot act on other sub-accounts, transfer funds between sub-accounts, or create sub-accounts. Omit to leave the key unrestricted. Mutually exclusive with fcm_subtrader_id.
	Subaccount *int `json:"subaccount,omitempty"`
}

CreateApiKeyRequest defines model for CreateApiKeyRequest.

type CreateApiKeyResponse

type CreateApiKeyResponse struct {
	// ApiKeyId Unique identifier for the newly created API key
	ApiKeyId string `json:"api_key_id"`

	// Warning Present only when the minted key is bound to an FCM subtrader that is missing a per-subtrader risk control - the initial-margin cap (margin lane) or the event-contract daily cap. The mint still succeeds; the warning names each missing control - an event-contract subtrader without a daily cap has its event-contract orders rejected until one is set, while a margin subtrader without an initial-margin cap is bounded only by firm-level risk limits.
	Warning *string `json:"warning,omitempty"`
}

CreateApiKeyResponse defines model for CreateApiKeyResponse.

type CreateApiKeyResponse2

type CreateApiKeyResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateApiKeyResponse
}

func ParseCreateApiKeyResponse2

func ParseCreateApiKeyResponse2(rsp *http.Response) (*CreateApiKeyResponse2, error)

ParseCreateApiKeyResponse2 parses an HTTP response from a CreateApiKeyWithResponse call

func (CreateApiKeyResponse2) ContentType

func (r CreateApiKeyResponse2) ContentType() string

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

func (CreateApiKeyResponse2) GetBody

func (r CreateApiKeyResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateApiKeyResponse2) GetJSON201

func (r CreateApiKeyResponse2) GetJSON201() *CreateApiKeyResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateApiKeyResponse2) Status

func (r CreateApiKeyResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateApiKeyResponse2) StatusCode

func (r CreateApiKeyResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateFCMPositionTransferJSONRequestBody

type CreateFCMPositionTransferJSONRequestBody = CreateFCMPositionTransferRequest

CreateFCMPositionTransferJSONRequestBody defines body for CreateFCMPositionTransfer for application/json ContentType.

type CreateFCMPositionTransferRequest

type CreateFCMPositionTransferRequest struct {
	// MarketTicker Ticker of the market whose position is moved.
	MarketTicker string `json:"market_ticker" validate:"required"`

	// PositionCenticount Contracts to move, in centicounts (contracts x 100). Positive moves YES, negative moves NO. Must be a non-zero whole number of contracts, e.g. 1000 for 10 YES or -500 for 5 NO.
	PositionCenticount int64 `json:"position_centicount" validate:"required,ne=0"`

	// PriceCenticents YES price per contract in centicents (cents x 100), in whole cents, even when moving NO. For example, 4500 is 45 cents.
	PriceCenticents int64 `json:"price_centicents" validate:"gte=0,lte=10000"`

	// SourceSubtraderId Full id of the FCM subtrader giving up the position, as returned by `GET /fcm/subtraders`.
	SourceSubtraderId string `json:"source_subtrader_id" validate:"required"`

	// TargetSubtraderId Subtrader under your error account that receives the position, `{error_account_id}_{suffix}` with a 1-16 character alphanumeric suffix. Created if it does not exist.
	TargetSubtraderId string `json:"target_subtrader_id" validate:"required"`
}

CreateFCMPositionTransferRequest defines model for CreateFCMPositionTransferRequest.

type CreateFCMPositionTransferResponse

type CreateFCMPositionTransferResponse struct {
	// PositionTransferId Id of the executed transfer. Store it; no Trade API endpoint lists past transfers.
	PositionTransferId string `json:"position_transfer_id"`
}

CreateFCMPositionTransferResponse defines model for CreateFCMPositionTransferResponse.

type CreateFCMPositionTransferResponse2

type CreateFCMPositionTransferResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateFCMPositionTransferResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ConflictError
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateFCMPositionTransferResponse2

func ParseCreateFCMPositionTransferResponse2(rsp *http.Response) (*CreateFCMPositionTransferResponse2, error)

ParseCreateFCMPositionTransferResponse2 parses an HTTP response from a CreateFCMPositionTransferWithResponse call

func (CreateFCMPositionTransferResponse2) ContentType

func (r CreateFCMPositionTransferResponse2) ContentType() string

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

func (CreateFCMPositionTransferResponse2) GetBody

func (r CreateFCMPositionTransferResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateFCMPositionTransferResponse2) GetJSON201

func (r CreateFCMPositionTransferResponse2) GetJSON201() *CreateFCMPositionTransferResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON400

func (r CreateFCMPositionTransferResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON401

func (r CreateFCMPositionTransferResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON403

func (r CreateFCMPositionTransferResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON404

func (r CreateFCMPositionTransferResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON409

func (r CreateFCMPositionTransferResponse2) GetJSON409() *ConflictError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON429

func (r CreateFCMPositionTransferResponse2) GetJSON429() *RateLimitError

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (CreateFCMPositionTransferResponse2) GetJSON500

func (r CreateFCMPositionTransferResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateFCMPositionTransferResponse2) Status

func (r CreateFCMPositionTransferResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateFCMPositionTransferResponse2) StatusCode

func (r CreateFCMPositionTransferResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateFCMSubtraderJSONRequestBody

type CreateFCMSubtraderJSONRequestBody = CreateFCMSubtraderRequest

CreateFCMSubtraderJSONRequestBody defines body for CreateFCMSubtrader for application/json ContentType.

type CreateFCMSubtraderRequest

type CreateFCMSubtraderRequest struct {
	// SubtraderSuffix Suffix for the new subtrader, 1-16 case-sensitive ASCII alphanumeric characters ([A-Za-z0-9]). The full subtrader id becomes {your_account_id}_{suffix}.
	SubtraderSuffix string `json:"subtrader_suffix"`
}

CreateFCMSubtraderRequest defines model for CreateFCMSubtraderRequest.

type CreateFCMSubtraderResponse

type CreateFCMSubtraderResponse struct {
	// SubtraderId The full id of the created subtrader.
	SubtraderId string `json:"subtrader_id"`
}

CreateFCMSubtraderResponse defines model for CreateFCMSubtraderResponse.

type CreateFCMSubtraderResponse2

type CreateFCMSubtraderResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateFCMSubtraderResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ConflictError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateFCMSubtraderResponse2

func ParseCreateFCMSubtraderResponse2(rsp *http.Response) (*CreateFCMSubtraderResponse2, error)

ParseCreateFCMSubtraderResponse2 parses an HTTP response from a CreateFCMSubtraderWithResponse call

func (CreateFCMSubtraderResponse2) ContentType

func (r CreateFCMSubtraderResponse2) ContentType() string

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

func (CreateFCMSubtraderResponse2) GetBody

func (r CreateFCMSubtraderResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateFCMSubtraderResponse2) GetJSON201

func (r CreateFCMSubtraderResponse2) GetJSON201() *CreateFCMSubtraderResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateFCMSubtraderResponse2) GetJSON400

func (r CreateFCMSubtraderResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateFCMSubtraderResponse2) GetJSON401

func (r CreateFCMSubtraderResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateFCMSubtraderResponse2) GetJSON403

func (r CreateFCMSubtraderResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateFCMSubtraderResponse2) GetJSON409

func (r CreateFCMSubtraderResponse2) GetJSON409() *ConflictError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateFCMSubtraderResponse2) GetJSON500

func (r CreateFCMSubtraderResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateFCMSubtraderResponse2) Status

func (r CreateFCMSubtraderResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateFCMSubtraderResponse2) StatusCode

func (r CreateFCMSubtraderResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateMarketInMultivariateEventCollectionJSONRequestBody

type CreateMarketInMultivariateEventCollectionJSONRequestBody = CreateMarketInMultivariateEventCollectionRequest

CreateMarketInMultivariateEventCollectionJSONRequestBody defines body for CreateMarketInMultivariateEventCollection for application/json ContentType.

type CreateMarketInMultivariateEventCollectionRequest

type CreateMarketInMultivariateEventCollectionRequest struct {
	// SelectedMarkets List of selected markets that act as parameters to determine which market is created.
	SelectedMarkets []TickerPair `json:"selected_markets" validate:"required,dive"`

	// WithMarketPayload Whether to include the market payload in the response.
	WithMarketPayload *bool `json:"with_market_payload,omitempty"`
}

CreateMarketInMultivariateEventCollectionRequest defines model for CreateMarketInMultivariateEventCollectionRequest.

type CreateMarketInMultivariateEventCollectionResponse

type CreateMarketInMultivariateEventCollectionResponse struct {
	// EventTicker Event ticker for the created market.
	EventTicker string  `json:"event_ticker"`
	Market      *Market `json:"market,omitempty"`

	// MarketTicker Market ticker for the created market.
	MarketTicker string `json:"market_ticker"`
}

CreateMarketInMultivariateEventCollectionResponse defines model for CreateMarketInMultivariateEventCollectionResponse.

type CreateMarketInMultivariateEventCollectionResponse2

type CreateMarketInMultivariateEventCollectionResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CreateMarketInMultivariateEventCollectionResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateMarketInMultivariateEventCollectionResponse2

func ParseCreateMarketInMultivariateEventCollectionResponse2(rsp *http.Response) (*CreateMarketInMultivariateEventCollectionResponse2, error)

ParseCreateMarketInMultivariateEventCollectionResponse2 parses an HTTP response from a CreateMarketInMultivariateEventCollectionWithResponse call

func (CreateMarketInMultivariateEventCollectionResponse2) ContentType

func (r CreateMarketInMultivariateEventCollectionResponse2) ContentType() string

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

func (CreateMarketInMultivariateEventCollectionResponse2) GetBody

func (r CreateMarketInMultivariateEventCollectionResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateMarketInMultivariateEventCollectionResponse2) GetJSON200

func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON200() *CreateMarketInMultivariateEventCollectionResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CreateMarketInMultivariateEventCollectionResponse2) GetJSON400

func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateMarketInMultivariateEventCollectionResponse2) GetJSON401

func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateMarketInMultivariateEventCollectionResponse2) GetJSON429

func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON429() *RateLimitError

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (CreateMarketInMultivariateEventCollectionResponse2) GetJSON500

func (r CreateMarketInMultivariateEventCollectionResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateMarketInMultivariateEventCollectionResponse2) Status

func (r CreateMarketInMultivariateEventCollectionResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateMarketInMultivariateEventCollectionResponse2) StatusCode

func (r CreateMarketInMultivariateEventCollectionResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrderGroupJSONRequestBody

type CreateOrderGroupJSONRequestBody = CreateOrderGroupRequest

CreateOrderGroupJSONRequestBody defines body for CreateOrderGroup for application/json ContentType.

type CreateOrderGroupRequest

type CreateOrderGroupRequest struct {
	// ContractsLimit Specifies the maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match.
	ContractsLimit int64 `json:"contracts_limit,omitempty" validate:"omitempty,gte=1"`

	// ContractsLimitFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsLimitFp *FixedPointCount `json:"contracts_limit_fp,omitempty"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0.
	ExchangeIndex ExchangeIndex `json:"exchange_index,omitempty"`

	// Subaccount Optional subaccount number to use for this order group (0 for primary, 1-63 for subaccounts). Subaccount-restricted API keys must omit this field or pass their locked subaccount.
	Subaccount *int `json:"subaccount,omitempty"`
}

CreateOrderGroupRequest defines model for CreateOrderGroupRequest.

type CreateOrderGroupResponse

type CreateOrderGroupResponse struct {
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// OrderGroupId The unique identifier for the created order group
	OrderGroupId string `json:"order_group_id"`

	// Subaccount Subaccount number that owns the created order group (0 for primary, 1-63 for subaccounts).
	Subaccount int `json:"subaccount"`
}

CreateOrderGroupResponse defines model for CreateOrderGroupResponse.

type CreateOrderGroupResponse2

type CreateOrderGroupResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateOrderGroupResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateOrderGroupResponse2

func ParseCreateOrderGroupResponse2(rsp *http.Response) (*CreateOrderGroupResponse2, error)

ParseCreateOrderGroupResponse2 parses an HTTP response from a CreateOrderGroupWithResponse call

func (CreateOrderGroupResponse2) ContentType

func (r CreateOrderGroupResponse2) ContentType() string

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

func (CreateOrderGroupResponse2) GetBody

func (r CreateOrderGroupResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateOrderGroupResponse2) GetJSON201

func (r CreateOrderGroupResponse2) GetJSON201() *CreateOrderGroupResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateOrderGroupResponse2) GetJSON400

func (r CreateOrderGroupResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateOrderGroupResponse2) GetJSON401

func (r CreateOrderGroupResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateOrderGroupResponse2) GetJSON500

func (r CreateOrderGroupResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateOrderGroupResponse2) Status

func (r CreateOrderGroupResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateOrderGroupResponse2) StatusCode

func (r CreateOrderGroupResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrderV2JSONRequestBody

type CreateOrderV2JSONRequestBody = CreateOrderV2Request

CreateOrderV2JSONRequestBody defines body for CreateOrderV2 for application/json ContentType.

type CreateOrderV2Request

type CreateOrderV2Request struct {
	// CancelOrderOnPause If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason.
	CancelOrderOnPause *bool  `json:"cancel_order_on_pause,omitempty"`
	ClientOrderId      string `json:"client_order_id,omitempty"`

	// Count Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	Count FixedPointCount `json:"count"`

	// ExchangeIndex Exchange shard index. If omitted, auto-routes when ticker is provided; otherwise defaults to 0. Use -1 to require auto-routing by ticker.
	ExchangeIndex *ExchangeIndex `json:"exchange_index,omitempty"`

	// ExpirationTime Optional Unix timestamp in seconds for when the order expires. To place
	// an expiring order, set `time_in_force` to `good_till_canceled` and
	// provide this `expiration_time`. `GTT` is an internal execution type and
	// is not a valid API value for `time_in_force`. The
	// `immediate_or_cancel` time-in-force value cannot be combined with
	// `expiration_time`.
	ExpirationTime *int64 `json:"expiration_time,omitempty"`

	// OrderGroupId The order group this order is part of
	OrderGroupId string `json:"order_group_id,omitempty"`
	PostOnly     *bool  `json:"post_only,omitempty"`

	// Price Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Price FixedPointDollars `json:"price"`

	// ReduceOnly Specifies whether the order place count should be capped by the member's current position. Orders with reduce_only set to true will be rejected unless time_in_force is immediate_or_cancel.
	ReduceOnly              *bool                   `json:"reduce_only,omitempty"`
	SelfTradePreventionType SelfTradePreventionType `json:"self_trade_prevention_type" validate:"required,oneof=taker_at_cross maker"`

	// Side Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)
	Side BookSide `json:"side" validate:"required,oneof=bid ask"`

	// Subaccount The subaccount number to use for this order. 0 is the primary subaccount. Subaccount-restricted API keys must omit this field or pass their locked subaccount.
	Subaccount *int   `json:"subaccount,omitempty"`
	Ticker     string `json:"ticker" validate:"required,min=1"`

	// TimeInForce Specifies how long the order remains active. Use `good_till_canceled`
	// with `expiration_time` for an order that should rest until a specific
	// expiration time; without `expiration_time`, `good_till_canceled` is a
	// true good-till-canceled order. `GTT` is not a valid API value.
	TimeInForce CreateOrderV2RequestTimeInForce `json:"time_in_force" validate:"required,oneof=fill_or_kill good_till_canceled immediate_or_cancel"`
}

CreateOrderV2Request Example: {"cancel_order_on_pause":false,"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","count":"10.00","exchange_index":0,"post_only":false,"price":"0.5600","reduce_only":false,"self_trade_prevention_type":"taker_at_cross","side":"bid","subaccount":0,"ticker":"HIGHNY-24JAN01-T60","time_in_force":"good_till_canceled"}

type CreateOrderV2RequestTimeInForce

type CreateOrderV2RequestTimeInForce string

CreateOrderV2RequestTimeInForce Specifies how long the order remains active. Use `good_till_canceled` with `expiration_time` for an order that should rest until a specific expiration time; without `expiration_time`, `good_till_canceled` is a true good-till-canceled order. `GTT` is not a valid API value.

const (
	CreateOrderV2RequestTimeInForceFillOrKill        CreateOrderV2RequestTimeInForce = "fill_or_kill"
	CreateOrderV2RequestTimeInForceGoodTillCanceled  CreateOrderV2RequestTimeInForce = "good_till_canceled"
	CreateOrderV2RequestTimeInForceImmediateOrCancel CreateOrderV2RequestTimeInForce = "immediate_or_cancel"
)

Defines values for CreateOrderV2RequestTimeInForce.

func (CreateOrderV2RequestTimeInForce) Valid

func (e CreateOrderV2RequestTimeInForce) Valid() bool

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

type CreateOrderV2Response

type CreateOrderV2Response struct {
	// AverageFeePaid Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	AverageFeePaid *FixedPointDollars `json:"average_fee_paid,omitempty"`

	// AverageFillPrice Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	AverageFillPrice *FixedPointDollars `json:"average_fill_price,omitempty"`
	ClientOrderId    *string            `json:"client_order_id,omitempty"`

	// FillCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	FillCount FixedPointCount `json:"fill_count"`
	OrderId   string          `json:"order_id"`

	// RemainingCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	RemainingCount FixedPointCount `json:"remaining_count"`

	// TsMs Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.
	TsMs int64 `json:"ts_ms"`
}

CreateOrderV2Response Example: {"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","fill_count":"0.00","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","remaining_count":"10.00","ts_ms":1715793600123}

type CreateOrderV2Response2

type CreateOrderV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateOrderV2Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ConflictError
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ServiceUnavailableError
}

func ParseCreateOrderV2Response2

func ParseCreateOrderV2Response2(rsp *http.Response) (*CreateOrderV2Response2, error)

ParseCreateOrderV2Response2 parses an HTTP response from a CreateOrderV2WithResponse call

func (CreateOrderV2Response2) ContentType

func (r CreateOrderV2Response2) ContentType() string

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

func (CreateOrderV2Response2) GetBody

func (r CreateOrderV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateOrderV2Response2) GetJSON201

func (r CreateOrderV2Response2) GetJSON201() *CreateOrderV2Response

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateOrderV2Response2) GetJSON400

func (r CreateOrderV2Response2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateOrderV2Response2) GetJSON401

func (r CreateOrderV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateOrderV2Response2) GetJSON403

func (r CreateOrderV2Response2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateOrderV2Response2) GetJSON409

func (r CreateOrderV2Response2) GetJSON409() *ConflictError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateOrderV2Response2) GetJSON429

func (r CreateOrderV2Response2) GetJSON429() *RateLimitError

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (CreateOrderV2Response2) GetJSON500

func (r CreateOrderV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateOrderV2Response2) GetJSON503

func (r CreateOrderV2Response2) GetJSON503() *ServiceUnavailableError

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreateOrderV2Response2) Status

func (r CreateOrderV2Response2) Status() string

Status returns HTTPResponse.Status

func (CreateOrderV2Response2) StatusCode

func (r CreateOrderV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateQuoteJSONRequestBody

type CreateQuoteJSONRequestBody = CreateQuoteRequest

CreateQuoteJSONRequestBody defines body for CreateQuote for application/json ContentType.

type CreateQuoteRequest

type CreateQuoteRequest struct {
	// NoBid Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoBid FixedPointDollars `json:"no_bid"`

	// PostOnly If true, the quote creator's resting order will be cancelled rather than crossed if it would take liquidity. Defaults to false.
	PostOnly *bool `json:"post_only,omitempty"`

	// RestRemainder Whether to rest the remainder of the quote after execution
	RestRemainder bool `json:"rest_remainder"`

	// RfqId The UUID of the RFQ to quote on. Pass the RFQ ID unchanged; malformed IDs return HTTP 400.
	RfqId string `json:"rfq_id"`

	// Subaccount Optional subaccount number to place the quote under (0 for primary, 1-63 for subaccounts)
	Subaccount *int `json:"subaccount,omitempty"`

	// YesBid Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesBid FixedPointDollars `json:"yes_bid"`
}

CreateQuoteRequest defines model for CreateQuoteRequest.

type CreateQuoteResponse

type CreateQuoteResponse struct {
	// Id UUID of the newly created quote. Pass it unchanged in subsequent requests.
	Id string `json:"id"`
}

CreateQuoteResponse defines model for CreateQuoteResponse.

type CreateQuoteResponse2

type CreateQuoteResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateQuoteResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateQuoteResponse2

func ParseCreateQuoteResponse2(rsp *http.Response) (*CreateQuoteResponse2, error)

ParseCreateQuoteResponse2 parses an HTTP response from a CreateQuoteWithResponse call

func (CreateQuoteResponse2) ContentType

func (r CreateQuoteResponse2) ContentType() string

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

func (CreateQuoteResponse2) GetBody

func (r CreateQuoteResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateQuoteResponse2) GetJSON201

func (r CreateQuoteResponse2) GetJSON201() *CreateQuoteResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateQuoteResponse2) GetJSON400

func (r CreateQuoteResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateQuoteResponse2) GetJSON401

func (r CreateQuoteResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateQuoteResponse2) GetJSON500

func (r CreateQuoteResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateQuoteResponse2) Status

func (r CreateQuoteResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateQuoteResponse2) StatusCode

func (r CreateQuoteResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRFQJSONRequestBody

type CreateRFQJSONRequestBody = CreateRFQRequest

CreateRFQJSONRequestBody defines body for CreateRFQ for application/json ContentType.

type CreateRFQRequest

type CreateRFQRequest struct {
	// Contracts Whole-contract count for the RFQ. Use contracts_fp for partial contract values; if both are provided, they must match.
	Contracts int `json:"contracts,omitempty"`

	// ContractsFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsFp *FixedPointCount `json:"contracts_fp,omitempty"`

	// MarketTicker The ticker of the market for which to create an RFQ
	MarketTicker string `json:"market_ticker"`

	// ObscureCreatorId Replace the RFQ creator's public communications ID with a shared empty-input SHA-256 hash for other users. Applies to RFQ responses and broadcasts, and to quotes before successful execution. Successful execution reveals the normal ID in subsequent RFQ responses and in the executed quote. Accepting or confirming a quote does not reveal the ID. The creator always sees their normal ID. See the RFQ guide for the placeholder and visibility rules.
	ObscureCreatorId bool `json:"obscure_creator_id,omitempty"`

	// ReplaceExisting Whether to delete existing RFQs as part of this RFQ's creation
	ReplaceExisting bool `json:"replace_existing,omitempty"`

	// RestRemainder Whether to rest the remainder of the RFQ after execution
	RestRemainder bool `json:"rest_remainder"`

	// Subaccount The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-63 for subaccounts)
	Subaccount *int `json:"subaccount,omitempty"`

	// SubtraderId The subtrader to create the RFQ for (FCM members only)
	SubtraderId string `json:"subtrader_id,omitempty"`

	// TargetCostCentiCents DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	TargetCostCentiCents int64 `json:"target_cost_centi_cents,omitempty"`

	// TargetCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TargetCostDollars FixedPointDollars `json:"target_cost_dollars,omitempty"`

	// TargetCostExcludesFees Sizes quotes against the target cost as principal only (contracts = target cost / price), with your taker fees charged on top of the target cost. By default (false) the target cost caps principal plus Kalshi fees, and quote sizes are reduced to make room for the fees. Only valid together with a target cost.
	TargetCostExcludesFees bool `json:"target_cost_excludes_fees,omitempty"`
}

CreateRFQRequest defines model for CreateRFQRequest.

type CreateRFQResponse

type CreateRFQResponse struct {
	// Id UUID of the newly created RFQ. Pass it unchanged in subsequent requests.
	Id string `json:"id"`
}

CreateRFQResponse defines model for CreateRFQResponse.

type CreateRFQResponse2

type CreateRFQResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateRFQResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ConflictError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateRFQResponse2

func ParseCreateRFQResponse2(rsp *http.Response) (*CreateRFQResponse2, error)

ParseCreateRFQResponse2 parses an HTTP response from a CreateRFQWithResponse call

func (CreateRFQResponse2) ContentType

func (r CreateRFQResponse2) ContentType() string

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

func (CreateRFQResponse2) GetBody

func (r CreateRFQResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRFQResponse2) GetJSON201

func (r CreateRFQResponse2) GetJSON201() *CreateRFQResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateRFQResponse2) GetJSON400

func (r CreateRFQResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateRFQResponse2) GetJSON401

func (r CreateRFQResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateRFQResponse2) GetJSON409

func (r CreateRFQResponse2) GetJSON409() *ConflictError

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateRFQResponse2) GetJSON500

func (r CreateRFQResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateRFQResponse2) Status

func (r CreateRFQResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateRFQResponse2) StatusCode

func (r CreateRFQResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSubaccountJSONRequestBody

type CreateSubaccountJSONRequestBody = CreateSubaccountRequest

CreateSubaccountJSONRequestBody defines body for CreateSubaccount for application/json ContentType.

type CreateSubaccountRequest

type CreateSubaccountRequest struct {
	// ExchangeIndex Identifier for an exchange shard. Defaults to 0 if unspecified.
	ExchangeIndex ExchangeIndex `json:"exchange_index,omitempty" validate:"gte=0"`
}

CreateSubaccountRequest defines model for CreateSubaccountRequest.

type CreateSubaccountResponse

type CreateSubaccountResponse struct {
	// SubaccountNumber The sequential number assigned to this subaccount (1-63).
	SubaccountNumber int `json:"subaccount_number"`
}

CreateSubaccountResponse defines model for CreateSubaccountResponse.

type CreateSubaccountResponse2

type CreateSubaccountResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreateSubaccountResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseCreateSubaccountResponse2

func ParseCreateSubaccountResponse2(rsp *http.Response) (*CreateSubaccountResponse2, error)

ParseCreateSubaccountResponse2 parses an HTTP response from a CreateSubaccountWithResponse call

func (CreateSubaccountResponse2) ContentType

func (r CreateSubaccountResponse2) ContentType() string

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

func (CreateSubaccountResponse2) GetBody

func (r CreateSubaccountResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateSubaccountResponse2) GetJSON201

func (r CreateSubaccountResponse2) GetJSON201() *CreateSubaccountResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateSubaccountResponse2) GetJSON400

func (r CreateSubaccountResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateSubaccountResponse2) GetJSON401

func (r CreateSubaccountResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateSubaccountResponse2) GetJSON500

func (r CreateSubaccountResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateSubaccountResponse2) Status

func (r CreateSubaccountResponse2) Status() string

Status returns HTTPResponse.Status

func (CreateSubaccountResponse2) StatusCode

func (r CreateSubaccountResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CursorQuery

type CursorQuery = string

CursorQuery defines model for CursorQuery.

type DailySchedule

type DailySchedule struct {
	// CloseTime Closing time in ET (Eastern Time) format HH:MM.
	CloseTime string `json:"close_time"`

	// OpenTime Opening time in ET (Eastern Time) format HH:MM.
	OpenTime string `json:"open_time"`
}

DailySchedule defines model for DailySchedule.

type DecreaseOrderV2JSONRequestBody

type DecreaseOrderV2JSONRequestBody = DecreaseOrderV2Request

DecreaseOrderV2JSONRequestBody defines body for DecreaseOrderV2 for application/json ContentType.

type DecreaseOrderV2Params

type DecreaseOrderV2Params struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

DecreaseOrderV2Params defines parameters for DecreaseOrderV2.

type DecreaseOrderV2Request

type DecreaseOrderV2Request struct {
	// ExchangeIndex Exchange shard index. If omitted, auto-routes when market_ticker is provided; otherwise defaults to 0. Use -1 to require auto-routing by market ticker.
	ExchangeIndex *ExchangeIndex `json:"exchange_index,omitempty"`

	// MarketTicker Market ticker used for auto-routing when exchange_index is omitted or -1.
	MarketTicker string `json:"market_ticker,omitempty"`

	// ReduceBy Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ReduceBy *FixedPointCount `json:"reduce_by,omitempty"`

	// ReduceTo Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ReduceTo *FixedPointCount `json:"reduce_to,omitempty"`
}

DecreaseOrderV2Request Example: {"exchange_index":0,"reduce_by":"2.00"}

type DecreaseOrderV2Response

type DecreaseOrderV2Response struct {
	ClientOrderId *string `json:"client_order_id,omitempty"`
	OrderId       string  `json:"order_id"`

	// RemainingCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	RemainingCount FixedPointCount `json:"remaining_count"`

	// TsMs Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds.
	TsMs int64 `json:"ts_ms"`
}

DecreaseOrderV2Response Example: {"client_order_id":"8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1","order_id":"3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d","remaining_count":"8.00","ts_ms":1715793680789}

type DecreaseOrderV2Response2

type DecreaseOrderV2Response2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DecreaseOrderV2Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDecreaseOrderV2Response2

func ParseDecreaseOrderV2Response2(rsp *http.Response) (*DecreaseOrderV2Response2, error)

ParseDecreaseOrderV2Response2 parses an HTTP response from a DecreaseOrderV2WithResponse call

func (DecreaseOrderV2Response2) ContentType

func (r DecreaseOrderV2Response2) ContentType() string

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

func (DecreaseOrderV2Response2) GetBody

func (r DecreaseOrderV2Response2) GetBody() []byte

GetBody returns the raw response body bytes

func (DecreaseOrderV2Response2) GetJSON200

func (r DecreaseOrderV2Response2) GetJSON200() *DecreaseOrderV2Response

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DecreaseOrderV2Response2) GetJSON400

func (r DecreaseOrderV2Response2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DecreaseOrderV2Response2) GetJSON401

func (r DecreaseOrderV2Response2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DecreaseOrderV2Response2) GetJSON404

func (r DecreaseOrderV2Response2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DecreaseOrderV2Response2) GetJSON500

func (r DecreaseOrderV2Response2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DecreaseOrderV2Response2) Status

func (r DecreaseOrderV2Response2) Status() string

Status returns HTTPResponse.Status

func (DecreaseOrderV2Response2) StatusCode

func (r DecreaseOrderV2Response2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiKeyResponse

type DeleteApiKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteApiKeyResponse

func ParseDeleteApiKeyResponse(rsp *http.Response) (*DeleteApiKeyResponse, error)

ParseDeleteApiKeyResponse parses an HTTP response from a DeleteApiKeyWithResponse call

func (DeleteApiKeyResponse) ContentType

func (r DeleteApiKeyResponse) ContentType() string

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

func (DeleteApiKeyResponse) GetBody

func (r DeleteApiKeyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteApiKeyResponse) Status

func (r DeleteApiKeyResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteApiKeyResponse) StatusCode

func (r DeleteApiKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteFCMEventContractDailyCapParams

type DeleteFCMEventContractDailyCapParams struct {
	// SubtraderId The subtrader whose daily cap should be removed. Must belong to the requesting FCM.
	SubtraderId string `form:"subtrader_id" json:"subtrader_id"`
}

DeleteFCMEventContractDailyCapParams defines parameters for DeleteFCMEventContractDailyCap.

type DeleteFCMEventContractDailyCapResponse

type DeleteFCMEventContractDailyCapResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDeleteFCMEventContractDailyCapResponse

func ParseDeleteFCMEventContractDailyCapResponse(rsp *http.Response) (*DeleteFCMEventContractDailyCapResponse, error)

ParseDeleteFCMEventContractDailyCapResponse parses an HTTP response from a DeleteFCMEventContractDailyCapWithResponse call

func (DeleteFCMEventContractDailyCapResponse) ContentType

func (r DeleteFCMEventContractDailyCapResponse) ContentType() string

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

func (DeleteFCMEventContractDailyCapResponse) GetBody

func (r DeleteFCMEventContractDailyCapResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteFCMEventContractDailyCapResponse) GetJSON200

func (r DeleteFCMEventContractDailyCapResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) GetJSON400

func (r DeleteFCMEventContractDailyCapResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) GetJSON401

func (r DeleteFCMEventContractDailyCapResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) GetJSON403

func (r DeleteFCMEventContractDailyCapResponse) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) GetJSON404

func (r DeleteFCMEventContractDailyCapResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) GetJSON500

func (r DeleteFCMEventContractDailyCapResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteFCMEventContractDailyCapResponse) Status

func (r DeleteFCMEventContractDailyCapResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteFCMEventContractDailyCapResponse) StatusCode

func (r DeleteFCMEventContractDailyCapResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteOrderGroupParams

type DeleteOrderGroupParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0.
	ExchangeIndex ExchangeIndexQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`
}

DeleteOrderGroupParams defines parameters for DeleteOrderGroup.

type DeleteOrderGroupResponse

type DeleteOrderGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDeleteOrderGroupResponse

func ParseDeleteOrderGroupResponse(rsp *http.Response) (*DeleteOrderGroupResponse, error)

ParseDeleteOrderGroupResponse parses an HTTP response from a DeleteOrderGroupWithResponse call

func (DeleteOrderGroupResponse) ContentType

func (r DeleteOrderGroupResponse) ContentType() string

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

func (DeleteOrderGroupResponse) GetBody

func (r DeleteOrderGroupResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteOrderGroupResponse) GetJSON200

func (r DeleteOrderGroupResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DeleteOrderGroupResponse) GetJSON401

func (r DeleteOrderGroupResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteOrderGroupResponse) GetJSON404

func (r DeleteOrderGroupResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteOrderGroupResponse) GetJSON500

func (r DeleteOrderGroupResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteOrderGroupResponse) Status

func (r DeleteOrderGroupResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteOrderGroupResponse) StatusCode

func (r DeleteOrderGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteQuoteResponse

type DeleteQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDeleteQuoteResponse

func ParseDeleteQuoteResponse(rsp *http.Response) (*DeleteQuoteResponse, error)

ParseDeleteQuoteResponse parses an HTTP response from a DeleteQuoteWithResponse call

func (DeleteQuoteResponse) ContentType

func (r DeleteQuoteResponse) ContentType() string

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

func (DeleteQuoteResponse) GetBody

func (r DeleteQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteQuoteResponse) GetJSON400

func (r DeleteQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteQuoteResponse) GetJSON401

func (r DeleteQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteQuoteResponse) GetJSON404

func (r DeleteQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteQuoteResponse) GetJSON500

func (r DeleteQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteQuoteResponse) Status

func (r DeleteQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteQuoteResponse) StatusCode

func (r DeleteQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRFQQuoteResponse

type DeleteRFQQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDeleteRFQQuoteResponse

func ParseDeleteRFQQuoteResponse(rsp *http.Response) (*DeleteRFQQuoteResponse, error)

ParseDeleteRFQQuoteResponse parses an HTTP response from a DeleteRFQQuoteWithResponse call

func (DeleteRFQQuoteResponse) ContentType

func (r DeleteRFQQuoteResponse) ContentType() string

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

func (DeleteRFQQuoteResponse) GetBody

func (r DeleteRFQQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteRFQQuoteResponse) GetJSON400

func (r DeleteRFQQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteRFQQuoteResponse) GetJSON401

func (r DeleteRFQQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteRFQQuoteResponse) GetJSON404

func (r DeleteRFQQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteRFQQuoteResponse) GetJSON500

func (r DeleteRFQQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteRFQQuoteResponse) Status

func (r DeleteRFQQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRFQQuoteResponse) StatusCode

func (r DeleteRFQQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRFQResponse

type DeleteRFQResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseDeleteRFQResponse

func ParseDeleteRFQResponse(rsp *http.Response) (*DeleteRFQResponse, error)

ParseDeleteRFQResponse parses an HTTP response from a DeleteRFQWithResponse call

func (DeleteRFQResponse) ContentType

func (r DeleteRFQResponse) ContentType() string

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

func (DeleteRFQResponse) GetBody

func (r DeleteRFQResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteRFQResponse) GetJSON400

func (r DeleteRFQResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteRFQResponse) GetJSON401

func (r DeleteRFQResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteRFQResponse) GetJSON404

func (r DeleteRFQResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteRFQResponse) GetJSON500

func (r DeleteRFQResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteRFQResponse) Status

func (r DeleteRFQResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRFQResponse) StatusCode

func (r DeleteRFQResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Deposit

type Deposit struct {
	// AmountCents Deposit amount in cents.
	AmountCents int64 `json:"amount_cents"`

	// CreatedTs Unix timestamp of when the deposit was created.
	CreatedTs int64 `json:"created_ts"`

	// FeeCents Fee charged for the deposit in cents.
	FeeCents int64 `json:"fee_cents"`

	// FinalizedTs Unix timestamp of when the deposit was finalized (applied, failed, or returned).
	FinalizedTs *int64 `json:"finalized_ts,omitempty"`

	// Id Unique identifier for the deposit.
	Id string `json:"id"`

	// Status Current status of the deposit. 'applied' means funds are reflected in balance.
	Status DepositStatus `json:"status"`

	// Type Payment method used for the deposit.
	Type DepositType `json:"type"`
}

Deposit defines model for Deposit.

type DepositStatus

type DepositStatus string

DepositStatus Current status of the deposit. 'applied' means funds are reflected in balance.

const (
	DepositStatusDepositStatusApplied  DepositStatus = "applied"
	DepositStatusDepositStatusFailed   DepositStatus = "failed"
	DepositStatusDepositStatusPending  DepositStatus = "pending"
	DepositStatusDepositStatusReturned DepositStatus = "returned"
)

Defines values for DepositStatus.

func (DepositStatus) Valid

func (e DepositStatus) Valid() bool

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

type DepositType

type DepositType string

DepositType Payment method used for the deposit.

const (
	DepositTypeAch    DepositType = "ach"
	DepositTypeApm    DepositType = "apm"
	DepositTypeCrypto DepositType = "crypto"
	DepositTypeDebit  DepositType = "debit"
	DepositTypeWire   DepositType = "wire"
)

Defines values for DepositType.

func (DepositType) Valid

func (e DepositType) Valid() bool

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

type EmptyResponse

type EmptyResponse = map[string]interface{}

EmptyResponse An empty response body

type EndpointTokenCost

type EndpointTokenCost struct {
	// Cost Configured token cost for an endpoint whose cost differs from the default cost.
	Cost int `json:"cost"`

	// Method HTTP method for the endpoint.
	Method string `json:"method"`

	// Path API route path for the endpoint.
	Path string `json:"path"`
}

EndpointTokenCost defines model for EndpointTokenCost.

type ErrorResponse

type ErrorResponse struct {
	// Code Error code
	Code *string `json:"code,omitempty"`

	// Details Additional details about the error, if available
	Details *string `json:"details,omitempty"`

	// Message Human-readable error message
	Message *string `json:"message,omitempty"`
}

ErrorResponse defines model for ErrorResponse.

type EventData

type EventData struct {
	// Category Event category (deprecated, use series-level category instead).
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Category string `json:"category,omitempty"`

	// CollateralReturnType Collateral-return netting type for this event: `MECNET` for mutually exclusive markets, `DIRECNET` for directional netting, or an empty string for no collateral-return netting.
	// Netting applies within this event, not across all events in its series, and also requires netting to be enabled for the trading account or subtrader.
	// Use `with_nested_markets=true` to retrieve the markets associated with each event.
	CollateralReturnType string `json:"collateral_return_type"`

	// EventTicker Unique identifier for this event.
	EventTicker   string        `json:"event_ticker"`
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FeeMultiplierOverride Fee multiplier override for this event. Paired with fee_type_override.
	FeeMultiplierOverride *float64 `json:"fee_multiplier_override,omitempty"`

	// FeeTypeOverride Fee type override for this event. When present, takes precedence over the series-level fee for this event's markets.
	FeeTypeOverride *string `json:"fee_type_override,omitempty"`

	// LastUpdatedTs Timestamp of when this event's metadata was last updated.
	LastUpdatedTs *time.Time `json:"last_updated_ts,omitempty"`

	// Markets Array of markets associated with this event. Only populated when 'with_nested_markets=true' is specified in the request.
	Markets []Market `json:"markets,omitempty"`

	// MutuallyExclusive True when `collateral_return_type` is `MECNET`: at most one market in this event can resolve to 'yes'.
	// False for both `DIRECNET` and an empty collateral-return type. A false value does not mean collateral-return netting is unavailable. Use `collateral_return_type` to distinguish these cases.
	MutuallyExclusive bool `json:"mutually_exclusive"`

	// ProductMetadata Additional metadata for the event.
	ProductMetadata map[string]interface{} `json:"product_metadata,omitempty"`

	// SeriesTicker Unique identifier for the series this event belongs to.
	SeriesTicker string `json:"series_ticker"`

	// SettlementSources The official sources used for the determination of markets within this event. Methodology is defined in the rulebook.
	SettlementSources *[]SettlementSource `json:"settlement_sources"`

	// StrikeDate The specific date this event is based on. Only filled when the event uses a date strike (mutually exclusive with strike_period).
	StrikeDate *time.Time `json:"strike_date,omitempty"`

	// StrikePeriod The time period this event covers (e.g., 'week', 'month'). Only filled when the event uses a period strike (mutually exclusive with strike_date).
	StrikePeriod *string `json:"strike_period,omitempty"`

	// SubTitle Shortened descriptive title for the event.
	SubTitle string `json:"sub_title"`

	// Title Full title of the event.
	Title string `json:"title"`
}

EventData defines model for EventData.

type EventFeeChange

type EventFeeChange struct {
	// EventTicker Event ticker this fee change applies to
	EventTicker string `json:"event_ticker"`

	// FeeMultiplierOverride New fee multiplier override for the event. When null, the event clears any prior override and falls back to the parent series' fee multiplier.
	FeeMultiplierOverride *float64 `json:"fee_multiplier_override"`

	// FeeTypeOverride New fee type override for the event. When null, the event clears any prior override and falls back to the parent series' fee structure.
	//
	// Example: quadratic
	FeeTypeOverride *FeeType `json:"fee_type_override"`

	// Id Unique identifier for this fee change
	Id string `json:"id"`

	// ScheduledTs Timestamp when this fee change is scheduled to take effect
	ScheduledTs time.Time `json:"scheduled_ts"`

	// SeriesTicker Series ticker for the event
	SeriesTicker string `json:"series_ticker"`
}

EventFeeChange defines model for EventFeeChange.

type EventLiveData

type EventLiveData struct {
	// DefaultRange Chart range the client should default to (e.g. `15min`, `1h`). Omitted when unset.
	DefaultRange *string `json:"default_range,omitempty"`

	// Details Live data details as a flexible object whose shape depends on the type.
	Details map[string]interface{} `json:"details"`

	// IsHistorical Present for crypto live data. True when the event has matured and the payload is a frozen historical snapshot.
	IsHistorical *bool `json:"is_historical,omitempty"`

	// RangeOptions Chart range menu options. Omitted when unset.
	RangeOptions *[]string `json:"range_options,omitempty"`

	// Type Type of live data. Names the schema of the details object.
	Type string `json:"type"`
}

EventLiveData defines model for EventLiveData.

type EventPosition

type EventPosition struct {
	// EventExposureDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	EventExposureDollars FixedPointDollars `json:"event_exposure_dollars"`

	// EventTicker Unique identifier for events
	EventTicker string `json:"event_ticker"`

	// FeesPaidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	FeesPaidDollars FixedPointDollars `json:"fees_paid_dollars"`

	// RealizedPnlDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	RealizedPnlDollars FixedPointDollars `json:"realized_pnl_dollars"`

	// TotalCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TotalCostDollars FixedPointDollars `json:"total_cost_dollars"`

	// TotalCostSharesFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	TotalCostSharesFp FixedPointCount `json:"total_cost_shares_fp"`
}

EventPosition defines model for EventPosition.

type EventTickersQuery

type EventTickersQuery = string

EventTickersQuery defines model for EventTickersQuery.

type ExchangeIndex

type ExchangeIndex = int

ExchangeIndex Identifier for an exchange shard.

Example: 0

type ExchangeIndexFilterQuery

type ExchangeIndexFilterQuery = int32

ExchangeIndexFilterQuery defines model for ExchangeIndexFilterQuery.

type ExchangeIndexQuery

type ExchangeIndexQuery = ExchangeIndex

ExchangeIndexQuery Identifier for an exchange shard.

Example: 0

type ExchangeIndexStatus

type ExchangeIndexStatus struct {
	// Description Description of this exchange shard.
	Description string `json:"description"`

	// ExchangeActive False if this exchange index is no longer taking any state changes at all. True unless under maintenance.
	ExchangeActive bool `json:"exchange_active"`

	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// IntraExchangeTransfersActive True if intra-exchange transfers are currently permitted on this exchange index. False when transfers are temporarily blocked.
	IntraExchangeTransfersActive bool `json:"intra_exchange_transfers_active"`

	// TradingActive True if trading is currently permitted on this exchange index. False outside exchange hours or during pauses.
	TradingActive bool `json:"trading_active"`
}

ExchangeIndexStatus defines model for ExchangeIndexStatus.

type ExchangeInstance

type ExchangeInstance string

ExchangeInstance The exchange instance type

const (
	ExchangeInstanceEventContract ExchangeInstance = "event_contract"
	ExchangeInstanceMargined      ExchangeInstance = "margined"
)

Defines values for ExchangeInstance.

func (ExchangeInstance) Valid

func (e ExchangeInstance) Valid() bool

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

type ExchangeStatus

type ExchangeStatus struct {
	// ExchangeActive False if the core Kalshi exchange is no longer taking any state changes at all. This includes but is not limited to trading, new users, and transfers. True unless we are under maintenance.
	ExchangeActive bool `json:"exchange_active"`

	// ExchangeEstimatedResumeTime Estimated downtime for the current exchange maintenance window. However, this is not guaranteed and can be extended.
	ExchangeEstimatedResumeTime *time.Time `json:"exchange_estimated_resume_time,omitempty"`

	// ExchangeIndexStatuses Status of each exchange index. The top-level fields above reflect the default exchange index (0). Absent when the per-index breakdown is unavailable.
	ExchangeIndexStatuses *[]ExchangeIndexStatus `json:"exchange_index_statuses,omitempty"`

	// IntraExchangeTransfersActive True if intra-exchange transfers are currently permitted. False when transfers are temporarily blocked.
	IntraExchangeTransfersActive *bool `json:"intra_exchange_transfers_active,omitempty"`

	// TradingActive True if we are currently permitting trading on the exchange. This is true during trading hours and false outside exchange hours. Kalshi reserves the right to pause at any time in case issues are detected.
	TradingActive bool `json:"trading_active"`
}

ExchangeStatus defines model for ExchangeStatus.

type FCMSubtrader

type FCMSubtrader struct {
	// ExchangeIndices Exchange indices where this subtrader has been observed.
	ExchangeIndices []int32 `json:"exchange_indices"`

	// FcmTradingBlocked Whether an FCM-owned per-subtrader trading block is configured.
	FcmTradingBlocked bool `json:"fcm_trading_blocked"`

	// PropagationPending Whether a configured per-subtrader block is awaiting engine application.
	PropagationPending bool `json:"propagation_pending"`

	// SubtraderId Full subtrader identifier owned by the authenticated FCM.
	SubtraderId string `json:"subtrader_id"`

	// TradingBlocked Effective trading block, including firm-wide and Kalshi restrictions.
	TradingBlocked bool `json:"trading_blocked"`
}

FCMSubtrader defines model for FCMSubtrader.

type FcmFill

type FcmFill struct {
	// CountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	CountFp FixedPointCount `json:"count_fp"`

	// CreatedTime Fill execution time.
	CreatedTime *time.Time `json:"created_time,omitempty"`

	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FillId Fill ID.
	FillId string `json:"fill_id"`

	// MakerFeeCost Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MakerFeeCost *FixedPointDollars `json:"maker_fee_cost,omitempty"`

	// MakerOrderId Maker order ID when owned by the FCM.
	MakerOrderId *string `json:"maker_order_id,omitempty"`

	// MakerSubtraderId Maker subtrader ID when owned by the FCM.
	MakerSubtraderId *string `json:"maker_subtrader_id,omitempty"`

	// TakerFeeCost Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TakerFeeCost *FixedPointDollars `json:"taker_fee_cost,omitempty"`

	// TakerOrderId Taker order ID when owned by the FCM.
	TakerOrderId *string `json:"taker_order_id,omitempty"`

	// TakerOutcomeSide Outcome side.
	TakerOutcomeSide OutcomeSide `json:"taker_outcome_side"`

	// TakerSubtraderId Taker subtrader ID when owned by the FCM.
	TakerSubtraderId *string `json:"taker_subtrader_id,omitempty"`

	// Ticker Market ticker.
	Ticker string `json:"ticker"`

	// YesPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesPriceDollars FixedPointDollars `json:"yes_price_dollars"`
}

FcmFill defines model for FcmFill.

type FeeType

type FeeType string

FeeType Fee type for a series or scheduled fee override.

const (
	FeeTypeFeeTypeFlat                        FeeType = "flat"
	FeeTypeFeeTypeQuadratic                   FeeType = "quadratic"
	FeeTypeFeeTypeQuadraticWithComboMakerFees FeeType = "quadratic_with_combo_maker_fees"
	FeeTypeFeeTypeQuadraticWithMakerFees      FeeType = "quadratic_with_maker_fees"
)

Defines values for FeeType.

func (FeeType) Valid

func (e FeeType) Valid() bool

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

type Fill

type Fill struct {
	// Action Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Action FillAction `json:"action,omitempty"`

	// BookSide Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)
	BookSide BookSide `json:"book_side"`

	// CountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	CountFp FixedPointCount `json:"count_fp"`

	// CreatedTime Timestamp when this fill was executed
	CreatedTime *time.Time `json:"created_time,omitempty"`

	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FeeCost Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	FeeCost FixedPointDollars `json:"fee_cost"`

	// FillId Unique identifier for this fill
	FillId string `json:"fill_id"`

	// IsTaker If true, this fill was a taker (removed liquidity from the order book)
	IsTaker bool `json:"is_taker"`

	// MarketTicker Unique identifier for the market (legacy field name, same as ticker)
	MarketTicker string `json:"market_ticker"`

	// NoPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoPriceDollars FixedPointDollars `json:"no_price_dollars"`

	// OrderId Unique identifier for the order that resulted in this fill
	OrderId string `json:"order_id"`

	// OutcomeSide Outcome side.
	OutcomeSide OutcomeSide `json:"outcome_side"`

	// Side Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Side FillSide `json:"side,omitempty"`

	// SubaccountNumber Subaccount number (0 for primary, 1-63 for subaccounts). Present for direct users.
	SubaccountNumber *int `json:"subaccount_number,omitempty"`

	// Ticker Unique identifier for the market
	Ticker string `json:"ticker"`

	// TradeId Unique identifier for this fill (legacy field name, same as fill_id)
	TradeId string `json:"trade_id"`

	// Ts Unix timestamp when this fill was executed (legacy field name)
	Ts *int64 `json:"ts,omitempty"`

	// YesPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesPriceDollars FixedPointDollars `json:"yes_price_dollars"`
}

Fill defines model for Fill.

type FillAction

type FillAction string

FillAction Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

const (
	FillActionBuy  FillAction = "buy"
	FillActionSell FillAction = "sell"
)

Defines values for FillAction.

func (FillAction) Valid

func (e FillAction) Valid() bool

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

type FillSide

type FillSide string

FillSide Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

const (
	FillSideNo  FillSide = "no"
	FillSideYes FillSide = "yes"
)

Defines values for FillSide.

func (FillSide) Valid

func (e FillSide) Valid() bool

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

type FixedPointCount

type FixedPointCount = string

FixedPointCount Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

Example: 10.00

type FixedPointDollars

type FixedPointDollars = string

FixedPointDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.

Example: 0.5600

type ForbiddenError

type ForbiddenError = ErrorResponse

ForbiddenError defines model for ForbiddenError.

type ForecastPercentilesPoint

type ForecastPercentilesPoint struct {
	// EndPeriodTs Unix timestamp for the inclusive end of the forecast period.
	EndPeriodTs int64 `json:"end_period_ts"`

	// EventTicker The event ticker this forecast is for.
	EventTicker string `json:"event_ticker"`

	// PercentilePoints Array of forecast values at different percentiles.
	PercentilePoints []PercentilePoint `json:"percentile_points"`

	// PeriodInterval Length of the forecast period in minutes.
	PeriodInterval int32 `json:"period_interval"`
}

ForecastPercentilesPoint defines model for ForecastPercentilesPoint.

type GenerateApiKeyJSONRequestBody

type GenerateApiKeyJSONRequestBody = GenerateApiKeyRequest

GenerateApiKeyJSONRequestBody defines body for GenerateApiKey for application/json ContentType.

type GenerateApiKeyRequest

type GenerateApiKeyRequest struct {
	// FcmSubtraderId FCM members only. If set, binds the API key to a single FCM subtrader that you own, spelled {your_user_id}_{suffix} with a suffix of 1-16 case-sensitive ASCII alphanumeric characters. The subtrader must already exist. A bound key is the institution's trading credential for that subtrader - FIX order-entry and market-data sessions, plus margin WebSocket sessions scoped to the subtrader's own data - and is denied on every REST endpoint, including key management. Mutually exclusive with subaccount.
	FcmSubtraderId *string `json:"fcm_subtrader_id,omitempty"`

	// KeyType Signature algorithm of an API key pair. `rsa` - 2048-bit RSA; requests are signed with RSA-PSS SHA-256. `ed25519` - Ed25519 (RFC 8032) signatures over the same pre-sign text, with lower client-side signing cost. Defaults to `rsa` when omitted from a generate request, for compatibility with existing clients.
	KeyType *ApiKeyType `json:"key_type,omitempty"`

	// Name Name for the API key. This helps identify the key's purpose
	Name string `json:"name"`

	// Scopes List of scopes to grant to the API key. If the broad `write` parent scope is included, `read` must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (`read`, `write`) if not provided.
	Scopes *[]ApiKeyScope `json:"scopes,omitempty"`

	// Subaccount If set, restricts the API key to a single sub-account (0-63) that you own. A restricted key may only read and trade on that sub-account; it cannot act on other sub-accounts, transfer funds between sub-accounts, or create sub-accounts. Omit to leave the key unrestricted. Mutually exclusive with fcm_subtrader_id.
	Subaccount *int `json:"subaccount,omitempty"`
}

GenerateApiKeyRequest defines model for GenerateApiKeyRequest.

type GenerateApiKeyResponse

type GenerateApiKeyResponse struct {
	// ApiKeyId Unique identifier for the newly generated API key
	ApiKeyId string `json:"api_key_id"`

	// KeyType Signature algorithm of an API key pair. `rsa` - 2048-bit RSA; requests are signed with RSA-PSS SHA-256. `ed25519` - Ed25519 (RFC 8032) signatures over the same pre-sign text, with lower client-side signing cost. Defaults to `rsa` when omitted from a generate request, for compatibility with existing clients.
	KeyType *ApiKeyType `json:"key_type,omitempty"`

	// PrivateKey Private key in PEM format - PKCS#1 (`-----BEGIN RSA PRIVATE KEY-----`) for `rsa`, PKCS#8 (`-----BEGIN PRIVATE KEY-----`) for `ed25519`. This must be stored securely and cannot be retrieved again after this response
	PrivateKey string `json:"private_key"`

	// Warning Present only when the minted key is bound to an FCM subtrader that is missing a per-subtrader risk control - the initial-margin cap (margin lane) or the event-contract daily cap. The mint still succeeds; the warning names each missing control - an event-contract subtrader without a daily cap has its event-contract orders rejected until one is set, while a margin subtrader without an initial-margin cap is bounded only by firm-level risk limits.
	Warning *string `json:"warning,omitempty"`
}

GenerateApiKeyResponse defines model for GenerateApiKeyResponse.

type GenerateApiKeyResponse2

type GenerateApiKeyResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *GenerateApiKeyResponse
}

func ParseGenerateApiKeyResponse2

func ParseGenerateApiKeyResponse2(rsp *http.Response) (*GenerateApiKeyResponse2, error)

ParseGenerateApiKeyResponse2 parses an HTTP response from a GenerateApiKeyWithResponse call

func (GenerateApiKeyResponse2) ContentType

func (r GenerateApiKeyResponse2) ContentType() string

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

func (GenerateApiKeyResponse2) GetBody

func (r GenerateApiKeyResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GenerateApiKeyResponse2) GetJSON201

func (r GenerateApiKeyResponse2) GetJSON201() *GenerateApiKeyResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (GenerateApiKeyResponse2) Status

func (r GenerateApiKeyResponse2) Status() string

Status returns HTTPResponse.Status

func (GenerateApiKeyResponse2) StatusCode

func (r GenerateApiKeyResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountApiLimitsResponse

type GetAccountApiLimitsResponse struct {
	// Grants The caller's active API usage level grants across exchange lanes, where each grant applies to its exchange_instance and usage_tier reflects the effective tier for the lane reported by this endpoint.
	Grants []ApiUsageLevelGrant `json:"grants"`

	// Read Token-bucket budget for one rate-limit bucket. Each request deducts
	// tokens equal to its endpoint cost; the bucket refills at refill_rate
	// tokens per second up to bucket_capacity. A request is allowed if the
	// bucket holds enough tokens to cover its cost; otherwise the request
	// is rejected with HTTP 429.
	Read BucketLimit `json:"read"`

	// UsageTier User's effective Predictions API usage tier for these limits (for example, basic, advanced, expert, premier, paragon, prime, or prestige).
	//
	// Example: expert
	UsageTier string `json:"usage_tier"`

	// Write Token-bucket budget for one rate-limit bucket. Each request deducts
	// tokens equal to its endpoint cost; the bucket refills at refill_rate
	// tokens per second up to bucket_capacity. A request is allowed if the
	// bucket holds enough tokens to cover its cost; otherwise the request
	// is rejected with HTTP 429.
	Write BucketLimit `json:"write"`
}

GetAccountApiLimitsResponse defines model for GetAccountApiLimitsResponse.

type GetAccountApiLimitsResponse2

type GetAccountApiLimitsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetAccountApiLimitsResponse
}

func ParseGetAccountApiLimitsResponse2

func ParseGetAccountApiLimitsResponse2(rsp *http.Response) (*GetAccountApiLimitsResponse2, error)

ParseGetAccountApiLimitsResponse2 parses an HTTP response from a GetAccountApiLimitsWithResponse call

func (GetAccountApiLimitsResponse2) ContentType

func (r GetAccountApiLimitsResponse2) ContentType() string

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

func (GetAccountApiLimitsResponse2) GetBody

func (r GetAccountApiLimitsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAccountApiLimitsResponse2) GetJSON200

func (r GetAccountApiLimitsResponse2) GetJSON200() *GetAccountApiLimitsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAccountApiLimitsResponse2) Status

func (r GetAccountApiLimitsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetAccountApiLimitsResponse2) StatusCode

func (r GetAccountApiLimitsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountApiUsageLevelVolumeProgressResponse

type GetAccountApiUsageLevelVolumeProgressResponse struct {
	// VolumeProgress Latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume-based public tiers are Expert, Premier, Paragon, Prime, and Prestige.
	VolumeProgress []AccountApiUsageLevelVolumeProgress `json:"volume_progress"`
}

GetAccountApiUsageLevelVolumeProgressResponse defines model for GetAccountApiUsageLevelVolumeProgressResponse.

type GetAccountApiUsageLevelVolumeProgressResponse2

type GetAccountApiUsageLevelVolumeProgressResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetAccountApiUsageLevelVolumeProgressResponse
}

func ParseGetAccountApiUsageLevelVolumeProgressResponse2

func ParseGetAccountApiUsageLevelVolumeProgressResponse2(rsp *http.Response) (*GetAccountApiUsageLevelVolumeProgressResponse2, error)

ParseGetAccountApiUsageLevelVolumeProgressResponse2 parses an HTTP response from a GetAccountApiUsageLevelVolumeProgressWithResponse call

func (GetAccountApiUsageLevelVolumeProgressResponse2) ContentType

func (r GetAccountApiUsageLevelVolumeProgressResponse2) ContentType() string

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

func (GetAccountApiUsageLevelVolumeProgressResponse2) GetBody

func (r GetAccountApiUsageLevelVolumeProgressResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAccountApiUsageLevelVolumeProgressResponse2) GetJSON200

func (r GetAccountApiUsageLevelVolumeProgressResponse2) GetJSON200() *GetAccountApiUsageLevelVolumeProgressResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAccountApiUsageLevelVolumeProgressResponse2) Status

func (r GetAccountApiUsageLevelVolumeProgressResponse2) Status() string

Status returns HTTPResponse.Status

func (GetAccountApiUsageLevelVolumeProgressResponse2) StatusCode

func (r GetAccountApiUsageLevelVolumeProgressResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountEndpointCostsResponse

type GetAccountEndpointCostsResponse struct {
	// DefaultCost Default token cost applied to endpoints that are not listed in `endpoint_costs`. This is currently 10.
	DefaultCost int `json:"default_cost"`

	// EndpointCosts API v2 endpoints whose configured token cost differs from `default_cost`. Endpoints that use the default cost are omitted.
	EndpointCosts []EndpointTokenCost `json:"endpoint_costs"`
}

GetAccountEndpointCostsResponse defines model for GetAccountEndpointCostsResponse.

type GetAccountEndpointCostsResponse2

type GetAccountEndpointCostsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetAccountEndpointCostsResponse
}

func ParseGetAccountEndpointCostsResponse2

func ParseGetAccountEndpointCostsResponse2(rsp *http.Response) (*GetAccountEndpointCostsResponse2, error)

ParseGetAccountEndpointCostsResponse2 parses an HTTP response from a GetAccountEndpointCostsWithResponse call

func (GetAccountEndpointCostsResponse2) ContentType

func (r GetAccountEndpointCostsResponse2) ContentType() string

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

func (GetAccountEndpointCostsResponse2) GetBody

func (r GetAccountEndpointCostsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAccountEndpointCostsResponse2) GetJSON200

func (r GetAccountEndpointCostsResponse2) GetJSON200() *GetAccountEndpointCostsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAccountEndpointCostsResponse2) Status

func (r GetAccountEndpointCostsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetAccountEndpointCostsResponse2) StatusCode

func (r GetAccountEndpointCostsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiKeysParams

type GetApiKeysParams struct {
	// FcmSubtraderId Return only API keys bound to this FCM subtrader. Spelled {your_user_id}_{suffix}; only FCM members hold bound keys. Omit to return every key.
	FcmSubtraderId *string `form:"fcm_subtrader_id,omitempty" json:"fcm_subtrader_id,omitempty"`
}

GetApiKeysParams defines parameters for GetApiKeys.

type GetApiKeysResponse

type GetApiKeysResponse struct {
	// ApiKeyRegionExpirationTs Unix timestamp (seconds) when the account's location attestation for API key requests expires; a past value means the attestation has lapsed. Absent when the account has never attested.
	ApiKeyRegionExpirationTs *int64 `json:"api_key_region_expiration_ts,omitempty"`

	// ApiKeys List of all API keys associated with the user
	ApiKeys []ApiKey `json:"api_keys"`
}

GetApiKeysResponse defines model for GetApiKeysResponse.

type GetApiKeysResponse2

type GetApiKeysResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetApiKeysResponse
}

func ParseGetApiKeysResponse2

func ParseGetApiKeysResponse2(rsp *http.Response) (*GetApiKeysResponse2, error)

ParseGetApiKeysResponse2 parses an HTTP response from a GetApiKeysWithResponse call

func (GetApiKeysResponse2) ContentType

func (r GetApiKeysResponse2) ContentType() string

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

func (GetApiKeysResponse2) GetBody

func (r GetApiKeysResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiKeysResponse2) GetJSON200

func (r GetApiKeysResponse2) GetJSON200() *GetApiKeysResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiKeysResponse2) Status

func (r GetApiKeysResponse2) Status() string

Status returns HTTPResponse.Status

func (GetApiKeysResponse2) StatusCode

func (r GetApiKeysResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBalanceParams

type GetBalanceParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Exchange index used to scope the balance and portfolio value. If omitted, both include all exchange indexes.
	ExchangeIndex *ExchangeIndex `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`
}

GetBalanceParams defines parameters for GetBalance.

type GetBalanceResponse

type GetBalanceResponse struct {
	// Balance Member's available balance in cents for the requested account and exchange index. It includes all exchange indexes when `exchange_index` is omitted.
	Balance int64 `json:"balance"`

	// BalanceBreakdown User balance breakdown per exchange instance, omitted only when using a subaccount-restricted API key.
	BalanceBreakdown *[]IndexedBalance `json:"balance_breakdown,omitempty"`

	// BalanceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	BalanceDollars FixedPointDollars `json:"balance_dollars"`

	// PortfolioValue Member's portfolio value in cents for the requested account and exchange index. It includes all exchange indexes when `exchange_index` is omitted.
	PortfolioValue int64 `json:"portfolio_value"`

	// UpdatedTs Unix timestamp of the last update to the balance.
	UpdatedTs int64 `json:"updated_ts"`
}

GetBalanceResponse defines model for GetBalanceResponse.

type GetBalanceResponse2

type GetBalanceResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetBalanceResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetBalanceResponse2

func ParseGetBalanceResponse2(rsp *http.Response) (*GetBalanceResponse2, error)

ParseGetBalanceResponse2 parses an HTTP response from a GetBalanceWithResponse call

func (GetBalanceResponse2) ContentType

func (r GetBalanceResponse2) ContentType() string

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

func (GetBalanceResponse2) GetBody

func (r GetBalanceResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetBalanceResponse2) GetJSON200

func (r GetBalanceResponse2) GetJSON200() *GetBalanceResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetBalanceResponse2) GetJSON401

func (r GetBalanceResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetBalanceResponse2) GetJSON500

func (r GetBalanceResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetBalanceResponse2) Status

func (r GetBalanceResponse2) Status() string

Status returns HTTPResponse.Status

func (GetBalanceResponse2) StatusCode

func (r GetBalanceResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBlockTradeProposalsParams

type GetBlockTradeProposalsParams struct {
	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// MarketTicker Filter by market ticker
	MarketTicker MarketTickerQuery `form:"market_ticker,omitempty" json:"market_ticker,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 100.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Status Filter block trade proposals by status
	Status *string `form:"status,omitempty" json:"status,omitempty"`
}

GetBlockTradeProposalsParams defines parameters for GetBlockTradeProposals.

type GetBlockTradeProposalsResponse

type GetBlockTradeProposalsResponse struct {
	// BlockTradeProposals List of block trade proposals
	BlockTradeProposals []BlockTradeProposal `json:"block_trade_proposals"`

	// Cursor Cursor for pagination to get the next page of results
	Cursor string `json:"cursor,omitempty"`
}

GetBlockTradeProposalsResponse defines model for GetBlockTradeProposalsResponse.

type GetBlockTradeProposalsResponse2

type GetBlockTradeProposalsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetBlockTradeProposalsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetBlockTradeProposalsResponse2

func ParseGetBlockTradeProposalsResponse2(rsp *http.Response) (*GetBlockTradeProposalsResponse2, error)

ParseGetBlockTradeProposalsResponse2 parses an HTTP response from a GetBlockTradeProposalsWithResponse call

func (GetBlockTradeProposalsResponse2) ContentType

func (r GetBlockTradeProposalsResponse2) ContentType() string

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

func (GetBlockTradeProposalsResponse2) GetBody

func (r GetBlockTradeProposalsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetBlockTradeProposalsResponse2) GetJSON200

func (r GetBlockTradeProposalsResponse2) GetJSON200() *GetBlockTradeProposalsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetBlockTradeProposalsResponse2) GetJSON400

func (r GetBlockTradeProposalsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetBlockTradeProposalsResponse2) GetJSON401

func (r GetBlockTradeProposalsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetBlockTradeProposalsResponse2) GetJSON500

func (r GetBlockTradeProposalsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetBlockTradeProposalsResponse2) Status

func (r GetBlockTradeProposalsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetBlockTradeProposalsResponse2) StatusCode

func (r GetBlockTradeProposalsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCommunicationsIDResponse

type GetCommunicationsIDResponse struct {
	// CommunicationsId A public communications ID which is used to identify the user
	CommunicationsId string `json:"communications_id"`
}

GetCommunicationsIDResponse defines model for GetCommunicationsIDResponse.

type GetCommunicationsIDResponse2

type GetCommunicationsIDResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetCommunicationsIDResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetCommunicationsIDResponse2

func ParseGetCommunicationsIDResponse2(rsp *http.Response) (*GetCommunicationsIDResponse2, error)

ParseGetCommunicationsIDResponse2 parses an HTTP response from a GetCommunicationsIDWithResponse call

func (GetCommunicationsIDResponse2) ContentType

func (r GetCommunicationsIDResponse2) ContentType() string

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

func (GetCommunicationsIDResponse2) GetBody

func (r GetCommunicationsIDResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetCommunicationsIDResponse2) GetJSON200

func (r GetCommunicationsIDResponse2) GetJSON200() *GetCommunicationsIDResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetCommunicationsIDResponse2) GetJSON401

func (r GetCommunicationsIDResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetCommunicationsIDResponse2) GetJSON500

func (r GetCommunicationsIDResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetCommunicationsIDResponse2) Status

func (r GetCommunicationsIDResponse2) Status() string

Status returns HTTPResponse.Status

func (GetCommunicationsIDResponse2) StatusCode

func (r GetCommunicationsIDResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDepositsParams

type GetDepositsParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 500.
	Limit *WithdrawalLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=500"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetDepositsParams defines parameters for GetDeposits.

type GetDepositsResponse

type GetDepositsResponse struct {
	Cursor   *string   `json:"cursor,omitempty"`
	Deposits []Deposit `json:"deposits"`
}

GetDepositsResponse defines model for GetDepositsResponse.

type GetDepositsResponse2

type GetDepositsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetDepositsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetDepositsResponse2

func ParseGetDepositsResponse2(rsp *http.Response) (*GetDepositsResponse2, error)

ParseGetDepositsResponse2 parses an HTTP response from a GetDepositsWithResponse call

func (GetDepositsResponse2) ContentType

func (r GetDepositsResponse2) ContentType() string

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

func (GetDepositsResponse2) GetBody

func (r GetDepositsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDepositsResponse2) GetJSON200

func (r GetDepositsResponse2) GetJSON200() *GetDepositsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDepositsResponse2) GetJSON400

func (r GetDepositsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetDepositsResponse2) GetJSON401

func (r GetDepositsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetDepositsResponse2) GetJSON500

func (r GetDepositsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetDepositsResponse2) Status

func (r GetDepositsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetDepositsResponse2) StatusCode

func (r GetDepositsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventCandlesticksResponse

type GetEventCandlesticksResponse struct {
	// AdjustedEndTs Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.
	AdjustedEndTs int64 `json:"adjusted_end_ts"`

	// MarketCandlesticks Array of market candlestick arrays, one for each market in the event.
	MarketCandlesticks [][]MarketCandlestick `json:"market_candlesticks"`

	// MarketTickers Array of market tickers in the event.
	MarketTickers []string `json:"market_tickers"`
}

GetEventCandlesticksResponse defines model for GetEventCandlesticksResponse.

type GetEventFeeChangesParams

type GetEventFeeChangesParams struct {
	EventTicker string `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetEventFeeChangesParams defines parameters for GetEventFeeChanges.

type GetEventFeeChangesResponse

type GetEventFeeChangesResponse struct {
	// Cursor Pagination cursor for the next page. Empty if there are no more results.
	Cursor          string           `json:"cursor"`
	EventFeeChanges []EventFeeChange `json:"event_fee_changes"`
}

GetEventFeeChangesResponse defines model for GetEventFeeChangesResponse.

type GetEventFeeChangesResponse2

type GetEventFeeChangesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventFeeChangesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetEventFeeChangesResponse2

func ParseGetEventFeeChangesResponse2(rsp *http.Response) (*GetEventFeeChangesResponse2, error)

ParseGetEventFeeChangesResponse2 parses an HTTP response from a GetEventFeeChangesWithResponse call

func (GetEventFeeChangesResponse2) ContentType

func (r GetEventFeeChangesResponse2) ContentType() string

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

func (GetEventFeeChangesResponse2) GetBody

func (r GetEventFeeChangesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventFeeChangesResponse2) GetJSON200

func (r GetEventFeeChangesResponse2) GetJSON200() *GetEventFeeChangesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventFeeChangesResponse2) GetJSON400

func (r GetEventFeeChangesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetEventFeeChangesResponse2) GetJSON500

func (r GetEventFeeChangesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetEventFeeChangesResponse2) Status

func (r GetEventFeeChangesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventFeeChangesResponse2) StatusCode

func (r GetEventFeeChangesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventForecastPercentilesHistoryParams

type GetEventForecastPercentilesHistoryParams struct {
	// Percentiles Array of percentile values to retrieve (0-9999, max 10 values)
	Percentiles []int32 `form:"percentiles" json:"percentiles"`

	// StartTs Start timestamp for the range
	StartTs int64 `form:"start_ts" json:"start_ts"`

	// EndTs End timestamp for the range
	EndTs int64 `form:"end_ts" json:"end_ts"`

	// PeriodInterval Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals.
	PeriodInterval GetEventForecastPercentilesHistoryParamsPeriodInterval `form:"period_interval" json:"period_interval"`
}

GetEventForecastPercentilesHistoryParams defines parameters for GetEventForecastPercentilesHistory.

type GetEventForecastPercentilesHistoryParamsPeriodInterval

type GetEventForecastPercentilesHistoryParamsPeriodInterval int32

GetEventForecastPercentilesHistoryParamsPeriodInterval defines parameters for GetEventForecastPercentilesHistory.

const (
	GetEventForecastPercentilesHistoryParamsPeriodIntervalN0    GetEventForecastPercentilesHistoryParamsPeriodInterval = 0
	GetEventForecastPercentilesHistoryParamsPeriodIntervalN1    GetEventForecastPercentilesHistoryParamsPeriodInterval = 1
	GetEventForecastPercentilesHistoryParamsPeriodIntervalN1440 GetEventForecastPercentilesHistoryParamsPeriodInterval = 1440
	GetEventForecastPercentilesHistoryParamsPeriodIntervalN60   GetEventForecastPercentilesHistoryParamsPeriodInterval = 60
)

Defines values for GetEventForecastPercentilesHistoryParamsPeriodInterval.

func (GetEventForecastPercentilesHistoryParamsPeriodInterval) Valid

func (e GetEventForecastPercentilesHistoryParamsPeriodInterval) Valid() bool

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

type GetEventForecastPercentilesHistoryResponse

type GetEventForecastPercentilesHistoryResponse struct {
	// ForecastHistory Array of forecast percentile data points over time.
	ForecastHistory []ForecastPercentilesPoint `json:"forecast_history"`
}

GetEventForecastPercentilesHistoryResponse defines model for GetEventForecastPercentilesHistoryResponse.

type GetEventForecastPercentilesHistoryResponse2

type GetEventForecastPercentilesHistoryResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventForecastPercentilesHistoryResponse
}

func ParseGetEventForecastPercentilesHistoryResponse2

func ParseGetEventForecastPercentilesHistoryResponse2(rsp *http.Response) (*GetEventForecastPercentilesHistoryResponse2, error)

ParseGetEventForecastPercentilesHistoryResponse2 parses an HTTP response from a GetEventForecastPercentilesHistoryWithResponse call

func (GetEventForecastPercentilesHistoryResponse2) ContentType

func (r GetEventForecastPercentilesHistoryResponse2) ContentType() string

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

func (GetEventForecastPercentilesHistoryResponse2) GetBody

func (r GetEventForecastPercentilesHistoryResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventForecastPercentilesHistoryResponse2) GetJSON200

func (r GetEventForecastPercentilesHistoryResponse2) GetJSON200() *GetEventForecastPercentilesHistoryResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventForecastPercentilesHistoryResponse2) Status

func (r GetEventForecastPercentilesHistoryResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventForecastPercentilesHistoryResponse2) StatusCode

func (r GetEventForecastPercentilesHistoryResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventLiveDataParams

type GetEventLiveDataParams struct {
	// Range Optional chart range hint (e.g. `15min`, `1h`, `1d`). When the underlying live data type supports it, restricts the returned timeseries to the requested window.
	Range *string `form:"range,omitempty" json:"range,omitempty"`
}

GetEventLiveDataParams defines parameters for GetEventLiveData.

type GetEventLiveDataResponse

type GetEventLiveDataResponse struct {
	LiveData EventLiveData `json:"live_data"`
}

GetEventLiveDataResponse defines model for GetEventLiveDataResponse.

type GetEventLiveDataResponse2

type GetEventLiveDataResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventLiveDataResponse
}

func ParseGetEventLiveDataResponse2

func ParseGetEventLiveDataResponse2(rsp *http.Response) (*GetEventLiveDataResponse2, error)

ParseGetEventLiveDataResponse2 parses an HTTP response from a GetEventLiveDataWithResponse call

func (GetEventLiveDataResponse2) ContentType

func (r GetEventLiveDataResponse2) ContentType() string

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

func (GetEventLiveDataResponse2) GetBody

func (r GetEventLiveDataResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventLiveDataResponse2) GetJSON200

func (r GetEventLiveDataResponse2) GetJSON200() *GetEventLiveDataResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventLiveDataResponse2) Status

func (r GetEventLiveDataResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventLiveDataResponse2) StatusCode

func (r GetEventLiveDataResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventMetadataResponse

type GetEventMetadataResponse struct {
	// Competition Event competition.
	Competition string `json:"competition,omitempty"`

	// CompetitionScope Event scope, based on the competition.
	CompetitionScope string `json:"competition_scope,omitempty"`

	// FeaturedImageUrl A path to an image that represents the image of the featured market.
	FeaturedImageUrl *string `json:"featured_image_url,omitempty"`

	// ImageUrl A path to an image that represents this event.
	ImageUrl string `json:"image_url"`

	// MarketDetails Metadata for the markets in this event.
	MarketDetails []MarketMetadata `json:"market_details"`

	// SettlementSources A list of settlement sources for this event.
	SettlementSources []SettlementSource `json:"settlement_sources"`
}

GetEventMetadataResponse defines model for GetEventMetadataResponse.

type GetEventMetadataResponse2

type GetEventMetadataResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventMetadataResponse
}

func ParseGetEventMetadataResponse2

func ParseGetEventMetadataResponse2(rsp *http.Response) (*GetEventMetadataResponse2, error)

ParseGetEventMetadataResponse2 parses an HTTP response from a GetEventMetadataWithResponse call

func (GetEventMetadataResponse2) ContentType

func (r GetEventMetadataResponse2) ContentType() string

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

func (GetEventMetadataResponse2) GetBody

func (r GetEventMetadataResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventMetadataResponse2) GetJSON200

func (r GetEventMetadataResponse2) GetJSON200() *GetEventMetadataResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventMetadataResponse2) Status

func (r GetEventMetadataResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventMetadataResponse2) StatusCode

func (r GetEventMetadataResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventParams

type GetEventParams struct {
	// ExcludeMarkets Return event metadata without loading child markets. Use GET /markets with event_ticker, limit and cursor for bounded market pages. Cannot be combined with with_nested_markets=true.
	ExcludeMarkets *bool `form:"exclude_markets,omitempty" json:"exclude_markets,omitempty"`

	// WithNestedMarkets If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included.
	WithNestedMarkets bool `form:"with_nested_markets,omitempty" json:"with_nested_markets,omitempty"`
}

GetEventParams defines parameters for GetEvent.

type GetEventResponse

type GetEventResponse struct {
	Event EventData `json:"event"`

	// Markets Data for the markets in this event. This field is deprecated in favour of the "markets" field inside the event. Which will be filled with the same value if you use the query parameter "with_nested_markets=true".
	Markets []Market `json:"markets"`
}

GetEventResponse defines model for GetEventResponse.

type GetEventResponse2

type GetEventResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventResponse
}

func ParseGetEventResponse2

func ParseGetEventResponse2(rsp *http.Response) (*GetEventResponse2, error)

ParseGetEventResponse2 parses an HTTP response from a GetEventWithResponse call

func (GetEventResponse2) ContentType

func (r GetEventResponse2) ContentType() string

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

func (GetEventResponse2) GetBody

func (r GetEventResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventResponse2) GetJSON200

func (r GetEventResponse2) GetJSON200() *GetEventResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventResponse2) Status

func (r GetEventResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventResponse2) StatusCode

func (r GetEventResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventsParams

type GetEventsParams struct {
	// Limit Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// WithNestedMarkets Parameter to specify if nested markets should be included in the response. When true, each event will include a 'markets' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included.
	WithNestedMarkets bool `form:"with_nested_markets,omitempty" json:"with_nested_markets,omitempty"`

	// WithMilestones If true, includes related milestones as a field alongside events.
	WithMilestones bool `form:"with_milestones,omitempty" json:"with_milestones,omitempty"`

	// Status Filter by event status. Possible values are 'unopened', 'open', 'closed', 'settled'. Leave empty to return events with any status.
	Status *GetEventsParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// SeriesTicker Filter by series ticker
	SeriesTicker SeriesTickerQuery `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`

	// Tickers Filter by specific event tickers. Comma-separated list of event tickers to retrieve.
	Tickers *EventTickersQuery `form:"tickers,omitempty" json:"tickers,omitempty"`

	// MinCloseTs Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
	MinCloseTs *int64 `form:"min_close_ts,omitempty" json:"min_close_ts,omitempty"`

	// MinUpdatedTs Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
	MinUpdatedTs *int64 `form:"min_updated_ts,omitempty" json:"min_updated_ts,omitempty"`
}

GetEventsParams defines parameters for GetEvents.

type GetEventsParamsStatus

type GetEventsParamsStatus string

GetEventsParamsStatus defines parameters for GetEvents.

const (
	GetEventsParamsStatusClosed   GetEventsParamsStatus = "closed"
	GetEventsParamsStatusOpen     GetEventsParamsStatus = "open"
	GetEventsParamsStatusSettled  GetEventsParamsStatus = "settled"
	GetEventsParamsStatusUnopened GetEventsParamsStatus = "unopened"
)

Defines values for GetEventsParamsStatus.

func (GetEventsParamsStatus) Valid

func (e GetEventsParamsStatus) Valid() bool

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

type GetEventsResponse

type GetEventsResponse struct {
	// Cursor Pagination cursor for the next page. Empty if there are no more results.
	Cursor string `json:"cursor"`

	// Events Array of events matching the query criteria.
	Events []EventData `json:"events"`

	// Milestones Array of milestones related to the events.
	Milestones *[]Milestone `json:"milestones,omitempty"`
}

GetEventsResponse defines model for GetEventsResponse.

type GetEventsResponse2

type GetEventsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventsResponse
}

func ParseGetEventsResponse2

func ParseGetEventsResponse2(rsp *http.Response) (*GetEventsResponse2, error)

ParseGetEventsResponse2 parses an HTTP response from a GetEventsWithResponse call

func (GetEventsResponse2) ContentType

func (r GetEventsResponse2) ContentType() string

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

func (GetEventsResponse2) GetBody

func (r GetEventsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventsResponse2) GetJSON200

func (r GetEventsResponse2) GetJSON200() *GetEventsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventsResponse2) Status

func (r GetEventsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetEventsResponse2) StatusCode

func (r GetEventsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExchangeScheduleResponse

type GetExchangeScheduleResponse struct {
	Schedule Schedule `json:"schedule"`
}

GetExchangeScheduleResponse defines model for GetExchangeScheduleResponse.

type GetExchangeScheduleResponse2

type GetExchangeScheduleResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetExchangeScheduleResponse
}

func ParseGetExchangeScheduleResponse2

func ParseGetExchangeScheduleResponse2(rsp *http.Response) (*GetExchangeScheduleResponse2, error)

ParseGetExchangeScheduleResponse2 parses an HTTP response from a GetExchangeScheduleWithResponse call

func (GetExchangeScheduleResponse2) ContentType

func (r GetExchangeScheduleResponse2) ContentType() string

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

func (GetExchangeScheduleResponse2) GetBody

func (r GetExchangeScheduleResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetExchangeScheduleResponse2) GetJSON200

func (r GetExchangeScheduleResponse2) GetJSON200() *GetExchangeScheduleResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetExchangeScheduleResponse2) Status

func (r GetExchangeScheduleResponse2) Status() string

Status returns HTTPResponse.Status

func (GetExchangeScheduleResponse2) StatusCode

func (r GetExchangeScheduleResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExchangeStatusResponse

type GetExchangeStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ExchangeStatus
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ExchangeStatus
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ExchangeStatus
	// JSON504 the response for an HTTP 504 `application/json` response
	JSON504 *ExchangeStatus
}

func ParseGetExchangeStatusResponse

func ParseGetExchangeStatusResponse(rsp *http.Response) (*GetExchangeStatusResponse, error)

ParseGetExchangeStatusResponse parses an HTTP response from a GetExchangeStatusWithResponse call

func (GetExchangeStatusResponse) ContentType

func (r GetExchangeStatusResponse) ContentType() string

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

func (GetExchangeStatusResponse) GetBody

func (r GetExchangeStatusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetExchangeStatusResponse) GetJSON200

func (r GetExchangeStatusResponse) GetJSON200() *ExchangeStatus

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetExchangeStatusResponse) GetJSON500

func (r GetExchangeStatusResponse) GetJSON500() *ExchangeStatus

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetExchangeStatusResponse) GetJSON503

func (r GetExchangeStatusResponse) GetJSON503() *ExchangeStatus

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetExchangeStatusResponse) GetJSON504

func (r GetExchangeStatusResponse) GetJSON504() *ExchangeStatus

GetJSON504 returns the response for an HTTP 504 `application/json` response

func (GetExchangeStatusResponse) Status

func (r GetExchangeStatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetExchangeStatusResponse) StatusCode

func (r GetExchangeStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFCMEventContractDailyCapParams

type GetFCMEventContractDailyCapParams struct {
	// SubtraderId The subtrader whose daily cap should be returned. Must belong to the requesting FCM. Required unless the API key is bound to a subtrader, in which case it defaults to the bound subtrader when omitted and must equal it when supplied.
	SubtraderId string `form:"subtrader_id,omitempty" json:"subtrader_id,omitempty"`
}

GetFCMEventContractDailyCapParams defines parameters for GetFCMEventContractDailyCap.

type GetFCMEventContractDailyCapResponse

type GetFCMEventContractDailyCapResponse struct {
	// CapDate The New York calendar date the executed utilization applies to. Executed utilization resets at midnight New York time; resting and pending reservations persist while their orders remain open.
	CapDate string `json:"cap_date"`

	// ExecutedUtilization Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	ExecutedUtilization FixedPointDollars `json:"executed_utilization"`

	// Limit Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Limit FixedPointDollars `json:"limit"`

	// PendingOrderUtilization Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	PendingOrderUtilization FixedPointDollars `json:"pending_order_utilization"`

	// RestingOrderUtilization Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	RestingOrderUtilization FixedPointDollars `json:"resting_order_utilization"`
	SubtraderId             string            `json:"subtrader_id"`
}

GetFCMEventContractDailyCapResponse defines model for GetFCMEventContractDailyCapResponse.

type GetFCMEventContractDailyCapResponse2

type GetFCMEventContractDailyCapResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFCMEventContractDailyCapResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetFCMEventContractDailyCapResponse2

func ParseGetFCMEventContractDailyCapResponse2(rsp *http.Response) (*GetFCMEventContractDailyCapResponse2, error)

ParseGetFCMEventContractDailyCapResponse2 parses an HTTP response from a GetFCMEventContractDailyCapWithResponse call

func (GetFCMEventContractDailyCapResponse2) ContentType

func (r GetFCMEventContractDailyCapResponse2) ContentType() string

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

func (GetFCMEventContractDailyCapResponse2) GetBody

func (r GetFCMEventContractDailyCapResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFCMEventContractDailyCapResponse2) GetJSON200

func (r GetFCMEventContractDailyCapResponse2) GetJSON200() *GetFCMEventContractDailyCapResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFCMEventContractDailyCapResponse2) GetJSON400

func (r GetFCMEventContractDailyCapResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetFCMEventContractDailyCapResponse2) GetJSON401

func (r GetFCMEventContractDailyCapResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFCMEventContractDailyCapResponse2) GetJSON403

func (r GetFCMEventContractDailyCapResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFCMEventContractDailyCapResponse2) GetJSON404

func (r GetFCMEventContractDailyCapResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFCMEventContractDailyCapResponse2) GetJSON500

func (r GetFCMEventContractDailyCapResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetFCMEventContractDailyCapResponse2) Status

func (r GetFCMEventContractDailyCapResponse2) Status() string

Status returns HTTPResponse.Status

func (GetFCMEventContractDailyCapResponse2) StatusCode

func (r GetFCMEventContractDailyCapResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFCMFillsParams

type GetFCMFillsParams struct {
	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetFCMFillsParams defines parameters for GetFCMFills.

type GetFCMFillsResponse

type GetFCMFillsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFcmFillsResponse
}

func ParseGetFCMFillsResponse

func ParseGetFCMFillsResponse(rsp *http.Response) (*GetFCMFillsResponse, error)

ParseGetFCMFillsResponse parses an HTTP response from a GetFCMFillsWithResponse call

func (GetFCMFillsResponse) ContentType

func (r GetFCMFillsResponse) ContentType() string

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

func (GetFCMFillsResponse) GetBody

func (r GetFCMFillsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFCMFillsResponse) GetJSON200

func (r GetFCMFillsResponse) GetJSON200() *GetFcmFillsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFCMFillsResponse) Status

func (r GetFCMFillsResponse) Status() string

Status returns HTTPResponse.Status

func (GetFCMFillsResponse) StatusCode

func (r GetFCMFillsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFCMOrdersParams

type GetFCMOrdersParams struct {
	// SubtraderId Restricts the response to orders for a specific subtrader (FCM members only). Required unless client_order_ids is supplied. For an API key bound to a subtrader, defaults to the bound subtrader when omitted and must equal it when supplied.
	SubtraderId string `form:"subtrader_id,omitempty" json:"subtrader_id,omitempty"`

	// ClientOrderIds Client order IDs to filter by, as a comma-separated list (maximum 100). Only orders created within the last 24 hours are searched, and a min_ts earlier than that is raised to 24 hours ago. Client order IDs are only unique within a subtrader among live and recent orders, so a single ID can match orders across subtraders or across time. Required unless subtrader_id is supplied.
	ClientOrderIds string `form:"client_order_ids,omitempty" json:"client_order_ids,omitempty"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// MinTs Restricts the response to orders after a timestamp, formatted as a Unix Timestamp
	MinTs *int64 `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Restricts the response to orders before a timestamp, formatted as a Unix Timestamp
	MaxTs *int64 `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Status Restricts the response to orders that have a certain status
	Status *GetFCMOrdersParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

GetFCMOrdersParams defines parameters for GetFCMOrders.

type GetFCMOrdersParamsStatus

type GetFCMOrdersParamsStatus string

GetFCMOrdersParamsStatus defines parameters for GetFCMOrders.

const (
	GetFCMOrdersParamsStatusCanceled GetFCMOrdersParamsStatus = "canceled"
	GetFCMOrdersParamsStatusExecuted GetFCMOrdersParamsStatus = "executed"
	GetFCMOrdersParamsStatusResting  GetFCMOrdersParamsStatus = "resting"
)

Defines values for GetFCMOrdersParamsStatus.

func (GetFCMOrdersParamsStatus) Valid

func (e GetFCMOrdersParamsStatus) Valid() bool

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

type GetFCMOrdersResponse

type GetFCMOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrdersResponse
}

func ParseGetFCMOrdersResponse

func ParseGetFCMOrdersResponse(rsp *http.Response) (*GetFCMOrdersResponse, error)

ParseGetFCMOrdersResponse parses an HTTP response from a GetFCMOrdersWithResponse call

func (GetFCMOrdersResponse) ContentType

func (r GetFCMOrdersResponse) ContentType() string

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

func (GetFCMOrdersResponse) GetBody

func (r GetFCMOrdersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFCMOrdersResponse) GetJSON200

func (r GetFCMOrdersResponse) GetJSON200() *GetOrdersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFCMOrdersResponse) Status

func (r GetFCMOrdersResponse) Status() string

Status returns HTTPResponse.Status

func (GetFCMOrdersResponse) StatusCode

func (r GetFCMOrdersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFCMPositionsParams

type GetFCMPositionsParams struct {
	// SubtraderId Restricts the response to positions for a specific subtrader (FCM members only). Required unless the API key is bound to a subtrader, in which case it defaults to the bound subtrader when omitted and must equal it when supplied.
	SubtraderId string `form:"subtrader_id,omitempty" json:"subtrader_id,omitempty"`

	// Ticker Ticker of desired positions
	Ticker string `form:"ticker,omitempty" json:"ticker,omitempty"`

	// EventTicker Event ticker of desired positions
	EventTicker string `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// CountFilter Restricts the positions to those with any of following fields with non-zero values, as a comma separated list
	CountFilter *string `form:"count_filter,omitempty" json:"count_filter,omitempty"`

	// SettlementStatus Settlement status of the markets to return. Defaults to unsettled
	SettlementStatus *GetFCMPositionsParamsSettlementStatus `form:"settlement_status,omitempty" json:"settlement_status,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor The Cursor represents a pointer to the next page of records in the pagination
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetFCMPositionsParams defines parameters for GetFCMPositions.

type GetFCMPositionsParamsSettlementStatus

type GetFCMPositionsParamsSettlementStatus string

GetFCMPositionsParamsSettlementStatus defines parameters for GetFCMPositions.

const (
	GetFCMPositionsParamsSettlementStatusAll       GetFCMPositionsParamsSettlementStatus = "all"
	GetFCMPositionsParamsSettlementStatusSettled   GetFCMPositionsParamsSettlementStatus = "settled"
	GetFCMPositionsParamsSettlementStatusUnsettled GetFCMPositionsParamsSettlementStatus = "unsettled"
)

Defines values for GetFCMPositionsParamsSettlementStatus.

func (GetFCMPositionsParamsSettlementStatus) Valid

func (e GetFCMPositionsParamsSettlementStatus) Valid() bool

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

type GetFCMPositionsResponse

type GetFCMPositionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetPositionsResponse
}

func ParseGetFCMPositionsResponse

func ParseGetFCMPositionsResponse(rsp *http.Response) (*GetFCMPositionsResponse, error)

ParseGetFCMPositionsResponse parses an HTTP response from a GetFCMPositionsWithResponse call

func (GetFCMPositionsResponse) ContentType

func (r GetFCMPositionsResponse) ContentType() string

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

func (GetFCMPositionsResponse) GetBody

func (r GetFCMPositionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFCMPositionsResponse) GetJSON200

func (r GetFCMPositionsResponse) GetJSON200() *GetPositionsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFCMPositionsResponse) Status

func (r GetFCMPositionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetFCMPositionsResponse) StatusCode

func (r GetFCMPositionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFCMSubtraderBlockedCategoriesParams

type GetFCMSubtraderBlockedCategoriesParams struct {
	// SubtraderId The subtrader whose blocked categories should be returned. Must belong to the requesting FCM.
	SubtraderId string `form:"subtrader_id" json:"subtrader_id"`
}

GetFCMSubtraderBlockedCategoriesParams defines parameters for GetFCMSubtraderBlockedCategories.

type GetFCMSubtraderBlockedCategoriesResponse

type GetFCMSubtraderBlockedCategoriesResponse struct {
	// Categories The event categories blocked for the subtrader, sorted ascending. Empty when no categories are blocked.
	Categories []string `json:"categories"`
}

GetFCMSubtraderBlockedCategoriesResponse defines model for GetFCMSubtraderBlockedCategoriesResponse.

type GetFCMSubtraderBlockedCategoriesResponse2

type GetFCMSubtraderBlockedCategoriesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFCMSubtraderBlockedCategoriesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetFCMSubtraderBlockedCategoriesResponse2

func ParseGetFCMSubtraderBlockedCategoriesResponse2(rsp *http.Response) (*GetFCMSubtraderBlockedCategoriesResponse2, error)

ParseGetFCMSubtraderBlockedCategoriesResponse2 parses an HTTP response from a GetFCMSubtraderBlockedCategoriesWithResponse call

func (GetFCMSubtraderBlockedCategoriesResponse2) ContentType

func (r GetFCMSubtraderBlockedCategoriesResponse2) ContentType() string

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

func (GetFCMSubtraderBlockedCategoriesResponse2) GetBody

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFCMSubtraderBlockedCategoriesResponse2) GetJSON200

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON200() *GetFCMSubtraderBlockedCategoriesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFCMSubtraderBlockedCategoriesResponse2) GetJSON400

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetFCMSubtraderBlockedCategoriesResponse2) GetJSON401

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetFCMSubtraderBlockedCategoriesResponse2) GetJSON403

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetFCMSubtraderBlockedCategoriesResponse2) GetJSON500

func (r GetFCMSubtraderBlockedCategoriesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetFCMSubtraderBlockedCategoriesResponse2) Status

func (r GetFCMSubtraderBlockedCategoriesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetFCMSubtraderBlockedCategoriesResponse2) StatusCode

func (r GetFCMSubtraderBlockedCategoriesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFcmFillsResponse

type GetFcmFillsResponse struct {
	Cursor string    `json:"cursor"`
	Fills  []FcmFill `json:"fills"`
}

GetFcmFillsResponse defines model for GetFcmFillsResponse.

type GetFillsHistoricalParams

type GetFillsHistoricalParams struct {
	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetFillsHistoricalParams defines parameters for GetFillsHistorical.

type GetFillsHistoricalResponse

type GetFillsHistoricalResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFillsResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
}

func ParseGetFillsHistoricalResponse

func ParseGetFillsHistoricalResponse(rsp *http.Response) (*GetFillsHistoricalResponse, error)

ParseGetFillsHistoricalResponse parses an HTTP response from a GetFillsHistoricalWithResponse call

func (GetFillsHistoricalResponse) ContentType

func (r GetFillsHistoricalResponse) ContentType() string

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

func (GetFillsHistoricalResponse) GetBody

func (r GetFillsHistoricalResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFillsHistoricalResponse) GetJSON200

func (r GetFillsHistoricalResponse) GetJSON200() *GetFillsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFillsHistoricalResponse) GetJSON404

func (r GetFillsHistoricalResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetFillsHistoricalResponse) Status

func (r GetFillsHistoricalResponse) Status() string

Status returns HTTPResponse.Status

func (GetFillsHistoricalResponse) StatusCode

func (r GetFillsHistoricalResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFillsParams

type GetFillsParams struct {
	// Ticker Filter by market ticker. Accepts a comma-separated list of up to 100 market tickers.
	Ticker string `form:"ticker,omitempty" json:"ticker,omitempty"`

	// OrderId Filter by order ID
	OrderId OrderIdQuery `form:"order_id,omitempty" json:"order_id,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Filter results by exchange shard. Omit to return results from all exchange shards.
	ExchangeIndex *ExchangeIndexFilterQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty" validate:"omitempty,gte=0"`
}

GetFillsParams defines parameters for GetFills.

type GetFillsResponse

type GetFillsResponse struct {
	Cursor string `json:"cursor"`
	Fills  []Fill `json:"fills"`
}

GetFillsResponse defines model for GetFillsResponse.

type GetFillsResponse2

type GetFillsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFillsResponse
}

func ParseGetFillsResponse2

func ParseGetFillsResponse2(rsp *http.Response) (*GetFillsResponse2, error)

ParseGetFillsResponse2 parses an HTTP response from a GetFillsWithResponse call

func (GetFillsResponse2) ContentType

func (r GetFillsResponse2) ContentType() string

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

func (GetFillsResponse2) GetBody

func (r GetFillsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFillsResponse2) GetJSON200

func (r GetFillsResponse2) GetJSON200() *GetFillsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFillsResponse2) Status

func (r GetFillsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetFillsResponse2) StatusCode

func (r GetFillsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFiltersBySportsResponse

type GetFiltersBySportsResponse struct {
	// FiltersBySports Mapping of sports to their filter details
	FiltersBySports map[string]SportFilterDetails `json:"filters_by_sports"`

	// SportOrdering Ordered list of sports for display
	SportOrdering []string `json:"sport_ordering"`
}

GetFiltersBySportsResponse defines model for GetFiltersBySportsResponse.

type GetFiltersForSportsResponse

type GetFiltersForSportsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetFiltersBySportsResponse
}

func ParseGetFiltersForSportsResponse

func ParseGetFiltersForSportsResponse(rsp *http.Response) (*GetFiltersForSportsResponse, error)

ParseGetFiltersForSportsResponse parses an HTTP response from a GetFiltersForSportsWithResponse call

func (GetFiltersForSportsResponse) ContentType

func (r GetFiltersForSportsResponse) ContentType() string

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

func (GetFiltersForSportsResponse) GetBody

func (r GetFiltersForSportsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetFiltersForSportsResponse) GetJSON200

func (r GetFiltersForSportsResponse) GetJSON200() *GetFiltersBySportsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetFiltersForSportsResponse) Status

func (r GetFiltersForSportsResponse) Status() string

Status returns HTTPResponse.Status

func (GetFiltersForSportsResponse) StatusCode

func (r GetFiltersForSportsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetGameStatsResponse

type GetGameStatsResponse struct {
	// Pbp Play-by-play data organized by period.
	Pbp *PlayByPlay `json:"pbp,omitempty"`
}

GetGameStatsResponse defines model for GetGameStatsResponse.

type GetGameStatsResponse2

type GetGameStatsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetGameStatsResponse
}

func ParseGetGameStatsResponse2

func ParseGetGameStatsResponse2(rsp *http.Response) (*GetGameStatsResponse2, error)

ParseGetGameStatsResponse2 parses an HTTP response from a GetGameStatsWithResponse call

func (GetGameStatsResponse2) ContentType

func (r GetGameStatsResponse2) ContentType() string

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

func (GetGameStatsResponse2) GetBody

func (r GetGameStatsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetGameStatsResponse2) GetJSON200

func (r GetGameStatsResponse2) GetJSON200() *GetGameStatsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetGameStatsResponse2) Status

func (r GetGameStatsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetGameStatsResponse2) StatusCode

func (r GetGameStatsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalCutoffResponse

type GetHistoricalCutoffResponse struct {
	// MarketPositionsLastUpdatedTs Cutoff based on **position last-update time**. Settled positions archived from the live data set before this timestamp are served through the historical section of position reads.
	MarketPositionsLastUpdatedTs *time.Time `json:"market_positions_last_updated_ts,omitempty"`

	// MarketSettledTs Cutoff based on **market settlement time**. Markets and their candlesticks that settled before this timestamp must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`.
	MarketSettledTs time.Time `json:"market_settled_ts"`

	// OrdersUpdatedTs Cutoff based on **order cancellation or execution time**. Orders canceled or fully executed before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
	OrdersUpdatedTs time.Time `json:"orders_updated_ts"`

	// TradesCreatedTs Cutoff based on **trade fill time**. Fills that occurred before this timestamp must be accessed via `GET /historical/fills`.
	TradesCreatedTs time.Time `json:"trades_created_ts"`
}

GetHistoricalCutoffResponse defines model for GetHistoricalCutoffResponse.

type GetHistoricalCutoffResponse2

type GetHistoricalCutoffResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetHistoricalCutoffResponse
}

func ParseGetHistoricalCutoffResponse2

func ParseGetHistoricalCutoffResponse2(rsp *http.Response) (*GetHistoricalCutoffResponse2, error)

ParseGetHistoricalCutoffResponse2 parses an HTTP response from a GetHistoricalCutoffWithResponse call

func (GetHistoricalCutoffResponse2) ContentType

func (r GetHistoricalCutoffResponse2) ContentType() string

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

func (GetHistoricalCutoffResponse2) GetBody

func (r GetHistoricalCutoffResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricalCutoffResponse2) GetJSON200

func (r GetHistoricalCutoffResponse2) GetJSON200() *GetHistoricalCutoffResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricalCutoffResponse2) Status

func (r GetHistoricalCutoffResponse2) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalCutoffResponse2) StatusCode

func (r GetHistoricalCutoffResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalMarketResponse

type GetHistoricalMarketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetHistoricalMarketResponse

func ParseGetHistoricalMarketResponse(rsp *http.Response) (*GetHistoricalMarketResponse, error)

ParseGetHistoricalMarketResponse parses an HTTP response from a GetHistoricalMarketWithResponse call

func (GetHistoricalMarketResponse) ContentType

func (r GetHistoricalMarketResponse) ContentType() string

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

func (GetHistoricalMarketResponse) GetBody

func (r GetHistoricalMarketResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricalMarketResponse) GetJSON200

func (r GetHistoricalMarketResponse) GetJSON200() *GetMarketResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricalMarketResponse) GetJSON404

func (r GetHistoricalMarketResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetHistoricalMarketResponse) GetJSON500

func (r GetHistoricalMarketResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHistoricalMarketResponse) Status

func (r GetHistoricalMarketResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalMarketResponse) StatusCode

func (r GetHistoricalMarketResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalMarketsParams

type GetHistoricalMarketsParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 1000.
	Limit *MarketLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,gte=0,lte=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Tickers Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
	Tickers *TickersQuery `form:"tickers,omitempty" json:"tickers,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// SeriesTicker Filter by series ticker
	SeriesTicker SeriesTickerQuery `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`

	// MveFilter Filter by multivariate events (combos). By default, MVE markets are included.
	MveFilter *GetHistoricalMarketsParamsMveFilter `form:"mve_filter,omitempty" json:"mve_filter,omitempty"`
}

GetHistoricalMarketsParams defines parameters for GetHistoricalMarkets.

type GetHistoricalMarketsParamsMveFilter

type GetHistoricalMarketsParamsMveFilter string

GetHistoricalMarketsParamsMveFilter defines parameters for GetHistoricalMarkets.

const (
	GetHistoricalMarketsParamsMveFilterExclude GetHistoricalMarketsParamsMveFilter = "exclude"
)

Defines values for GetHistoricalMarketsParamsMveFilter.

func (GetHistoricalMarketsParamsMveFilter) Valid

func (e GetHistoricalMarketsParamsMveFilter) Valid() bool

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

type GetHistoricalMarketsResponse

type GetHistoricalMarketsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetHistoricalMarketsResponse

func ParseGetHistoricalMarketsResponse(rsp *http.Response) (*GetHistoricalMarketsResponse, error)

ParseGetHistoricalMarketsResponse parses an HTTP response from a GetHistoricalMarketsWithResponse call

func (GetHistoricalMarketsResponse) ContentType

func (r GetHistoricalMarketsResponse) ContentType() string

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

func (GetHistoricalMarketsResponse) GetBody

func (r GetHistoricalMarketsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricalMarketsResponse) GetJSON200

func (r GetHistoricalMarketsResponse) GetJSON200() *GetMarketsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricalMarketsResponse) GetJSON400

func (r GetHistoricalMarketsResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetHistoricalMarketsResponse) GetJSON500

func (r GetHistoricalMarketsResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHistoricalMarketsResponse) Status

func (r GetHistoricalMarketsResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalMarketsResponse) StatusCode

func (r GetHistoricalMarketsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalOrdersParams

type GetHistoricalOrdersParams struct {
	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetHistoricalOrdersParams defines parameters for GetHistoricalOrders.

type GetHistoricalOrdersResponse

type GetHistoricalOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrdersResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetHistoricalOrdersResponse

func ParseGetHistoricalOrdersResponse(rsp *http.Response) (*GetHistoricalOrdersResponse, error)

ParseGetHistoricalOrdersResponse parses an HTTP response from a GetHistoricalOrdersWithResponse call

func (GetHistoricalOrdersResponse) ContentType

func (r GetHistoricalOrdersResponse) ContentType() string

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

func (GetHistoricalOrdersResponse) GetBody

func (r GetHistoricalOrdersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricalOrdersResponse) GetJSON200

func (r GetHistoricalOrdersResponse) GetJSON200() *GetOrdersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricalOrdersResponse) GetJSON400

func (r GetHistoricalOrdersResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetHistoricalOrdersResponse) GetJSON401

func (r GetHistoricalOrdersResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoricalOrdersResponse) GetJSON500

func (r GetHistoricalOrdersResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHistoricalOrdersResponse) Status

func (r GetHistoricalOrdersResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalOrdersResponse) StatusCode

func (r GetHistoricalOrdersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalPositionsParams

type GetHistoricalPositionsParams struct {
	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetHistoricalPositionsParams defines parameters for GetHistoricalPositions.

type GetHistoricalPositionsResponse

type GetHistoricalPositionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetPositionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetHistoricalPositionsResponse

func ParseGetHistoricalPositionsResponse(rsp *http.Response) (*GetHistoricalPositionsResponse, error)

ParseGetHistoricalPositionsResponse parses an HTTP response from a GetHistoricalPositionsWithResponse call

func (GetHistoricalPositionsResponse) ContentType

func (r GetHistoricalPositionsResponse) ContentType() string

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

func (GetHistoricalPositionsResponse) GetBody

func (r GetHistoricalPositionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricalPositionsResponse) GetJSON200

func (r GetHistoricalPositionsResponse) GetJSON200() *GetPositionsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricalPositionsResponse) GetJSON400

func (r GetHistoricalPositionsResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetHistoricalPositionsResponse) GetJSON401

func (r GetHistoricalPositionsResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoricalPositionsResponse) GetJSON500

func (r GetHistoricalPositionsResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHistoricalPositionsResponse) Status

func (r GetHistoricalPositionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalPositionsResponse) StatusCode

func (r GetHistoricalPositionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIncentiveProgramsParams

type GetIncentiveProgramsParams struct {
	// Status Status filter. Can be "all", "active", "upcoming", "closed", or "paid_out". Default is "all".
	Status *GetIncentiveProgramsParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Type Type filter. Can be "all", "liquidity", "volume", "margin_maker_volume", or "margin_taker_volume". Default is "all".
	Type *GetIncentiveProgramsParamsType `form:"type,omitempty" json:"type,omitempty"`

	// IncentiveDescription Filter by exact incentive description.
	IncentiveDescription *string `form:"incentive_description,omitempty" json:"incentive_description,omitempty"`

	// Limit Number of results per page. Defaults to 100. Maximum value is 10000.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Cursor for pagination
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetIncentiveProgramsParams defines parameters for GetIncentivePrograms.

type GetIncentiveProgramsParamsStatus

type GetIncentiveProgramsParamsStatus string

GetIncentiveProgramsParamsStatus defines parameters for GetIncentivePrograms.

const (
	GetIncentiveProgramsParamsStatusActive   GetIncentiveProgramsParamsStatus = "active"
	GetIncentiveProgramsParamsStatusAll      GetIncentiveProgramsParamsStatus = "all"
	GetIncentiveProgramsParamsStatusClosed   GetIncentiveProgramsParamsStatus = "closed"
	GetIncentiveProgramsParamsStatusPaidOut  GetIncentiveProgramsParamsStatus = "paid_out"
	GetIncentiveProgramsParamsStatusUpcoming GetIncentiveProgramsParamsStatus = "upcoming"
)

Defines values for GetIncentiveProgramsParamsStatus.

func (GetIncentiveProgramsParamsStatus) Valid

func (e GetIncentiveProgramsParamsStatus) Valid() bool

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

type GetIncentiveProgramsParamsType

type GetIncentiveProgramsParamsType string

GetIncentiveProgramsParamsType defines parameters for GetIncentivePrograms.

const (
	GetIncentiveProgramsParamsTypeAll               GetIncentiveProgramsParamsType = "all"
	GetIncentiveProgramsParamsTypeLiquidity         GetIncentiveProgramsParamsType = "liquidity"
	GetIncentiveProgramsParamsTypeMarginMakerVolume GetIncentiveProgramsParamsType = "margin_maker_volume"
	GetIncentiveProgramsParamsTypeMarginTakerVolume GetIncentiveProgramsParamsType = "margin_taker_volume"
	GetIncentiveProgramsParamsTypeVolume            GetIncentiveProgramsParamsType = "volume"
)

Defines values for GetIncentiveProgramsParamsType.

func (GetIncentiveProgramsParamsType) Valid

func (e GetIncentiveProgramsParamsType) Valid() bool

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

type GetIncentiveProgramsResponse

type GetIncentiveProgramsResponse struct {
	IncentivePrograms []IncentiveProgram `json:"incentive_programs"`

	// NextCursor Cursor for pagination to get the next page of results
	NextCursor *string `json:"next_cursor,omitempty"`
}

GetIncentiveProgramsResponse defines model for GetIncentiveProgramsResponse.

type GetIncentiveProgramsResponse2

type GetIncentiveProgramsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetIncentiveProgramsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseGetIncentiveProgramsResponse2

func ParseGetIncentiveProgramsResponse2(rsp *http.Response) (*GetIncentiveProgramsResponse2, error)

ParseGetIncentiveProgramsResponse2 parses an HTTP response from a GetIncentiveProgramsWithResponse call

func (GetIncentiveProgramsResponse2) ContentType

func (r GetIncentiveProgramsResponse2) ContentType() string

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

func (GetIncentiveProgramsResponse2) GetBody

func (r GetIncentiveProgramsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIncentiveProgramsResponse2) GetJSON200

func (r GetIncentiveProgramsResponse2) GetJSON200() *GetIncentiveProgramsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetIncentiveProgramsResponse2) GetJSON400

func (r GetIncentiveProgramsResponse2) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetIncentiveProgramsResponse2) GetJSON500

func (r GetIncentiveProgramsResponse2) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetIncentiveProgramsResponse2) Status

func (r GetIncentiveProgramsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetIncentiveProgramsResponse2) StatusCode

func (r GetIncentiveProgramsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntraExchangeInstanceTransferResponse

type GetIntraExchangeInstanceTransferResponse struct {
	Transfer IntraExchangeInstanceTransfer `json:"transfer"`
}

GetIntraExchangeInstanceTransferResponse defines model for GetIntraExchangeInstanceTransferResponse.

type GetIntraExchangeInstanceTransferResponse2

type GetIntraExchangeInstanceTransferResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetIntraExchangeInstanceTransferResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetIntraExchangeInstanceTransferResponse2

func ParseGetIntraExchangeInstanceTransferResponse2(rsp *http.Response) (*GetIntraExchangeInstanceTransferResponse2, error)

ParseGetIntraExchangeInstanceTransferResponse2 parses an HTTP response from a GetIntraExchangeInstanceTransferWithResponse call

func (GetIntraExchangeInstanceTransferResponse2) ContentType

func (r GetIntraExchangeInstanceTransferResponse2) ContentType() string

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

func (GetIntraExchangeInstanceTransferResponse2) GetBody

func (r GetIntraExchangeInstanceTransferResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIntraExchangeInstanceTransferResponse2) GetJSON200

func (r GetIntraExchangeInstanceTransferResponse2) GetJSON200() *GetIntraExchangeInstanceTransferResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetIntraExchangeInstanceTransferResponse2) GetJSON401

func (r GetIntraExchangeInstanceTransferResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetIntraExchangeInstanceTransferResponse2) GetJSON404

func (r GetIntraExchangeInstanceTransferResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetIntraExchangeInstanceTransferResponse2) GetJSON500

func (r GetIntraExchangeInstanceTransferResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetIntraExchangeInstanceTransferResponse2) Status

func (r GetIntraExchangeInstanceTransferResponse2) Status() string

Status returns HTTPResponse.Status

func (GetIntraExchangeInstanceTransferResponse2) StatusCode

func (r GetIntraExchangeInstanceTransferResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntraExchangeInstanceTransfersParams

type GetIntraExchangeInstanceTransfersParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 500.
	Limit TransfersLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=500"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetIntraExchangeInstanceTransfersParams defines parameters for GetIntraExchangeInstanceTransfers.

type GetIntraExchangeInstanceTransfersResponse

type GetIntraExchangeInstanceTransfersResponse struct {
	// Cursor Cursor for the next page of results. Omitted when there are no further pages.
	Cursor    *string                         `json:"cursor,omitempty"`
	Transfers []IntraExchangeInstanceTransfer `json:"transfers"`
}

GetIntraExchangeInstanceTransfersResponse defines model for GetIntraExchangeInstanceTransfersResponse.

type GetIntraExchangeInstanceTransfersResponse2

type GetIntraExchangeInstanceTransfersResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetIntraExchangeInstanceTransfersResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetIntraExchangeInstanceTransfersResponse2

func ParseGetIntraExchangeInstanceTransfersResponse2(rsp *http.Response) (*GetIntraExchangeInstanceTransfersResponse2, error)

ParseGetIntraExchangeInstanceTransfersResponse2 parses an HTTP response from a GetIntraExchangeInstanceTransfersWithResponse call

func (GetIntraExchangeInstanceTransfersResponse2) ContentType

func (r GetIntraExchangeInstanceTransfersResponse2) ContentType() string

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

func (GetIntraExchangeInstanceTransfersResponse2) GetBody

func (r GetIntraExchangeInstanceTransfersResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIntraExchangeInstanceTransfersResponse2) GetJSON200

func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON200() *GetIntraExchangeInstanceTransfersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetIntraExchangeInstanceTransfersResponse2) GetJSON400

func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetIntraExchangeInstanceTransfersResponse2) GetJSON401

func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetIntraExchangeInstanceTransfersResponse2) GetJSON500

func (r GetIntraExchangeInstanceTransfersResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetIntraExchangeInstanceTransfersResponse2) Status

func (r GetIntraExchangeInstanceTransfersResponse2) Status() string

Status returns HTTPResponse.Status

func (GetIntraExchangeInstanceTransfersResponse2) StatusCode

func (r GetIntraExchangeInstanceTransfersResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLiveDataByMilestoneParams

type GetLiveDataByMilestoneParams struct {
	// IncludePlayerStats When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men's Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
	IncludePlayerStats *bool `form:"include_player_stats,omitempty" json:"include_player_stats,omitempty"`
}

GetLiveDataByMilestoneParams defines parameters for GetLiveDataByMilestone.

type GetLiveDataByMilestoneResponse

type GetLiveDataByMilestoneResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetLiveDataResponse
}

func ParseGetLiveDataByMilestoneResponse

func ParseGetLiveDataByMilestoneResponse(rsp *http.Response) (*GetLiveDataByMilestoneResponse, error)

ParseGetLiveDataByMilestoneResponse parses an HTTP response from a GetLiveDataByMilestoneWithResponse call

func (GetLiveDataByMilestoneResponse) ContentType

func (r GetLiveDataByMilestoneResponse) ContentType() string

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

func (GetLiveDataByMilestoneResponse) GetBody

func (r GetLiveDataByMilestoneResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLiveDataByMilestoneResponse) GetJSON200

func (r GetLiveDataByMilestoneResponse) GetJSON200() *GetLiveDataResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLiveDataByMilestoneResponse) Status

func (r GetLiveDataByMilestoneResponse) Status() string

Status returns HTTPResponse.Status

func (GetLiveDataByMilestoneResponse) StatusCode

func (r GetLiveDataByMilestoneResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLiveDataParams

type GetLiveDataParams struct {
	// IncludePlayerStats When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men's Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
	IncludePlayerStats *bool `form:"include_player_stats,omitempty" json:"include_player_stats,omitempty"`
}

GetLiveDataParams defines parameters for GetLiveData.

type GetLiveDataResponse

type GetLiveDataResponse struct {
	LiveData LiveData `json:"live_data"`
}

GetLiveDataResponse defines model for GetLiveDataResponse.

type GetLiveDataResponse2

type GetLiveDataResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetLiveDataResponse
}

func ParseGetLiveDataResponse2

func ParseGetLiveDataResponse2(rsp *http.Response) (*GetLiveDataResponse2, error)

ParseGetLiveDataResponse2 parses an HTTP response from a GetLiveDataWithResponse call

func (GetLiveDataResponse2) ContentType

func (r GetLiveDataResponse2) ContentType() string

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

func (GetLiveDataResponse2) GetBody

func (r GetLiveDataResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLiveDataResponse2) GetJSON200

func (r GetLiveDataResponse2) GetJSON200() *GetLiveDataResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLiveDataResponse2) Status

func (r GetLiveDataResponse2) Status() string

Status returns HTTPResponse.Status

func (GetLiveDataResponse2) StatusCode

func (r GetLiveDataResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLiveDatasParams

type GetLiveDatasParams struct {
	// MilestoneIds Array of milestone IDs
	MilestoneIds []string `form:"milestone_ids" json:"milestone_ids"`

	// IncludePlayerStats When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men's Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
	IncludePlayerStats *bool `form:"include_player_stats,omitempty" json:"include_player_stats,omitempty"`
}

GetLiveDatasParams defines parameters for GetLiveDatas.

type GetLiveDatasResponse

type GetLiveDatasResponse struct {
	LiveDatas []LiveData `json:"live_datas"`
}

GetLiveDatasResponse defines model for GetLiveDatasResponse.

type GetLiveDatasResponse2

type GetLiveDatasResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetLiveDatasResponse
}

func ParseGetLiveDatasResponse2

func ParseGetLiveDatasResponse2(rsp *http.Response) (*GetLiveDatasResponse2, error)

ParseGetLiveDatasResponse2 parses an HTTP response from a GetLiveDatasWithResponse call

func (GetLiveDatasResponse2) ContentType

func (r GetLiveDatasResponse2) ContentType() string

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

func (GetLiveDatasResponse2) GetBody

func (r GetLiveDatasResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLiveDatasResponse2) GetJSON200

func (r GetLiveDatasResponse2) GetJSON200() *GetLiveDatasResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLiveDatasResponse2) Status

func (r GetLiveDatasResponse2) Status() string

Status returns HTTPResponse.Status

func (GetLiveDatasResponse2) StatusCode

func (r GetLiveDatasResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketCandlesticksByEventParams

type GetMarketCandlesticksByEventParams struct {
	// StartTs Start timestamp for the range
	StartTs int64 `form:"start_ts" json:"start_ts" validate:"required"`

	// EndTs End timestamp for the range
	EndTs int64 `form:"end_ts" json:"end_ts" validate:"required"`

	// PeriodInterval Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day.
	PeriodInterval GetMarketCandlesticksByEventParamsPeriodInterval `form:"period_interval" json:"period_interval" validate:"required,oneof=1 60 1440"`
}

GetMarketCandlesticksByEventParams defines parameters for GetMarketCandlesticksByEvent.

type GetMarketCandlesticksByEventParamsPeriodInterval

type GetMarketCandlesticksByEventParamsPeriodInterval int32

GetMarketCandlesticksByEventParamsPeriodInterval defines parameters for GetMarketCandlesticksByEvent.

const (
	GetMarketCandlesticksByEventParamsPeriodIntervalN1    GetMarketCandlesticksByEventParamsPeriodInterval = 1
	GetMarketCandlesticksByEventParamsPeriodIntervalN1440 GetMarketCandlesticksByEventParamsPeriodInterval = 1440
	GetMarketCandlesticksByEventParamsPeriodIntervalN60   GetMarketCandlesticksByEventParamsPeriodInterval = 60
)

Defines values for GetMarketCandlesticksByEventParamsPeriodInterval.

func (GetMarketCandlesticksByEventParamsPeriodInterval) Valid

func (e GetMarketCandlesticksByEventParamsPeriodInterval) Valid() bool

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

type GetMarketCandlesticksByEventResponse

type GetMarketCandlesticksByEventResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetEventCandlesticksResponse
}

func ParseGetMarketCandlesticksByEventResponse

func ParseGetMarketCandlesticksByEventResponse(rsp *http.Response) (*GetMarketCandlesticksByEventResponse, error)

ParseGetMarketCandlesticksByEventResponse parses an HTTP response from a GetMarketCandlesticksByEventWithResponse call

func (GetMarketCandlesticksByEventResponse) ContentType

func (r GetMarketCandlesticksByEventResponse) ContentType() string

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

func (GetMarketCandlesticksByEventResponse) GetBody

func (r GetMarketCandlesticksByEventResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketCandlesticksByEventResponse) GetJSON200

func (r GetMarketCandlesticksByEventResponse) GetJSON200() *GetEventCandlesticksResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketCandlesticksByEventResponse) Status

func (r GetMarketCandlesticksByEventResponse) Status() string

Status returns HTTPResponse.Status

func (GetMarketCandlesticksByEventResponse) StatusCode

func (r GetMarketCandlesticksByEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketCandlesticksHistoricalParams

type GetMarketCandlesticksHistoricalParams struct {
	// StartTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
	StartTs int64 `form:"start_ts" json:"start_ts"`

	// EndTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
	EndTs int64 `form:"end_ts" json:"end_ts"`

	// PeriodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
	PeriodInterval GetMarketCandlesticksHistoricalParamsPeriodInterval `form:"period_interval" json:"period_interval" validate:"required,oneof=1 60 1440"`
}

GetMarketCandlesticksHistoricalParams defines parameters for GetMarketCandlesticksHistorical.

type GetMarketCandlesticksHistoricalParamsPeriodInterval

type GetMarketCandlesticksHistoricalParamsPeriodInterval int

GetMarketCandlesticksHistoricalParamsPeriodInterval defines parameters for GetMarketCandlesticksHistorical.

const (
	GetMarketCandlesticksHistoricalParamsPeriodIntervalN1    GetMarketCandlesticksHistoricalParamsPeriodInterval = 1
	GetMarketCandlesticksHistoricalParamsPeriodIntervalN1440 GetMarketCandlesticksHistoricalParamsPeriodInterval = 1440
	GetMarketCandlesticksHistoricalParamsPeriodIntervalN60   GetMarketCandlesticksHistoricalParamsPeriodInterval = 60
)

Defines values for GetMarketCandlesticksHistoricalParamsPeriodInterval.

func (GetMarketCandlesticksHistoricalParamsPeriodInterval) Valid

func (e GetMarketCandlesticksHistoricalParamsPeriodInterval) Valid() bool

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

type GetMarketCandlesticksHistoricalResponse

type GetMarketCandlesticksHistoricalResponse struct {
	// Candlesticks Array of candlestick data points for the specified time range.
	Candlesticks []MarketCandlestickHistorical `json:"candlesticks"`

	// Ticker Unique identifier for the market.
	Ticker string `json:"ticker"`
}

GetMarketCandlesticksHistoricalResponse defines model for GetMarketCandlesticksHistoricalResponse.

type GetMarketCandlesticksHistoricalResponse2

type GetMarketCandlesticksHistoricalResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketCandlesticksHistoricalResponse
}

func ParseGetMarketCandlesticksHistoricalResponse2

func ParseGetMarketCandlesticksHistoricalResponse2(rsp *http.Response) (*GetMarketCandlesticksHistoricalResponse2, error)

ParseGetMarketCandlesticksHistoricalResponse2 parses an HTTP response from a GetMarketCandlesticksHistoricalWithResponse call

func (GetMarketCandlesticksHistoricalResponse2) ContentType

func (r GetMarketCandlesticksHistoricalResponse2) ContentType() string

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

func (GetMarketCandlesticksHistoricalResponse2) GetBody

func (r GetMarketCandlesticksHistoricalResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketCandlesticksHistoricalResponse2) GetJSON200

func (r GetMarketCandlesticksHistoricalResponse2) GetJSON200() *GetMarketCandlesticksHistoricalResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketCandlesticksHistoricalResponse2) Status

func (r GetMarketCandlesticksHistoricalResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketCandlesticksHistoricalResponse2) StatusCode

func (r GetMarketCandlesticksHistoricalResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketCandlesticksParams

type GetMarketCandlesticksParams struct {
	// StartTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
	StartTs int64 `form:"start_ts" json:"start_ts"`

	// EndTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
	EndTs int64 `form:"end_ts" json:"end_ts"`

	// PeriodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
	PeriodInterval GetMarketCandlesticksParamsPeriodInterval `form:"period_interval" json:"period_interval" validate:"required,oneof=1 60 1440"`

	// IncludeLatestBeforeStart If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by:
	// 1. Finding the most recent real candlestick before start_ts
	// 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts)
	// 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
	IncludeLatestBeforeStart *bool `form:"include_latest_before_start,omitempty" json:"include_latest_before_start,omitempty"`
}

GetMarketCandlesticksParams defines parameters for GetMarketCandlesticks.

type GetMarketCandlesticksParamsPeriodInterval

type GetMarketCandlesticksParamsPeriodInterval int

GetMarketCandlesticksParamsPeriodInterval defines parameters for GetMarketCandlesticks.

const (
	GetMarketCandlesticksParamsPeriodIntervalGetMarketCandlesticksParamsPeriodIntervalN1    GetMarketCandlesticksParamsPeriodInterval = 1
	GetMarketCandlesticksParamsPeriodIntervalGetMarketCandlesticksParamsPeriodIntervalN1440 GetMarketCandlesticksParamsPeriodInterval = 1440
	GetMarketCandlesticksParamsPeriodIntervalGetMarketCandlesticksParamsPeriodIntervalN60   GetMarketCandlesticksParamsPeriodInterval = 60
)

Defines values for GetMarketCandlesticksParamsPeriodInterval.

func (GetMarketCandlesticksParamsPeriodInterval) Valid

func (e GetMarketCandlesticksParamsPeriodInterval) Valid() bool

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

type GetMarketCandlesticksResponse

type GetMarketCandlesticksResponse struct {
	// Candlesticks Array of candlestick data points for the specified time range.
	Candlesticks []MarketCandlestick `json:"candlesticks"`

	// Ticker Unique identifier for the market.
	Ticker string `json:"ticker"`
}

GetMarketCandlesticksResponse defines model for GetMarketCandlesticksResponse.

type GetMarketCandlesticksResponse2

type GetMarketCandlesticksResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketCandlesticksResponse
}

func ParseGetMarketCandlesticksResponse2

func ParseGetMarketCandlesticksResponse2(rsp *http.Response) (*GetMarketCandlesticksResponse2, error)

ParseGetMarketCandlesticksResponse2 parses an HTTP response from a GetMarketCandlesticksWithResponse call

func (GetMarketCandlesticksResponse2) ContentType

func (r GetMarketCandlesticksResponse2) ContentType() string

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

func (GetMarketCandlesticksResponse2) GetBody

func (r GetMarketCandlesticksResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketCandlesticksResponse2) GetJSON200

func (r GetMarketCandlesticksResponse2) GetJSON200() *GetMarketCandlesticksResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketCandlesticksResponse2) Status

func (r GetMarketCandlesticksResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketCandlesticksResponse2) StatusCode

func (r GetMarketCandlesticksResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketOrderbookParams

type GetMarketOrderbookParams struct {
	// Depth Depth of the orderbook to retrieve (0 or negative means all levels, 1-100 for specific depth)
	Depth *int `form:"depth,omitempty" json:"depth,omitempty" validate:"omitempty,min=0,max=100"`
}

GetMarketOrderbookParams defines parameters for GetMarketOrderbook.

type GetMarketOrderbookResponse

type GetMarketOrderbookResponse struct {
	// OrderbookFp Orderbook with fixed-point contract counts (fp) in all dollar price levels.
	OrderbookFp OrderbookCountFp `json:"orderbook_fp"`
}

GetMarketOrderbookResponse defines model for GetMarketOrderbookResponse.

type GetMarketOrderbookResponse2

type GetMarketOrderbookResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketOrderbookResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetMarketOrderbookResponse2

func ParseGetMarketOrderbookResponse2(rsp *http.Response) (*GetMarketOrderbookResponse2, error)

ParseGetMarketOrderbookResponse2 parses an HTTP response from a GetMarketOrderbookWithResponse call

func (GetMarketOrderbookResponse2) ContentType

func (r GetMarketOrderbookResponse2) ContentType() string

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

func (GetMarketOrderbookResponse2) GetBody

func (r GetMarketOrderbookResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketOrderbookResponse2) GetJSON200

func (r GetMarketOrderbookResponse2) GetJSON200() *GetMarketOrderbookResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketOrderbookResponse2) GetJSON401

func (r GetMarketOrderbookResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMarketOrderbookResponse2) GetJSON404

func (r GetMarketOrderbookResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMarketOrderbookResponse2) GetJSON500

func (r GetMarketOrderbookResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMarketOrderbookResponse2) Status

func (r GetMarketOrderbookResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketOrderbookResponse2) StatusCode

func (r GetMarketOrderbookResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketOrderbooksParams

type GetMarketOrderbooksParams struct {
	// Tickers List of market tickers to fetch orderbooks for
	Tickers []string `form:"tickers" json:"tickers" validate:"required,min=1,max=100,dive,max=200"`
}

GetMarketOrderbooksParams defines parameters for GetMarketOrderbooks.

type GetMarketOrderbooksResponse

type GetMarketOrderbooksResponse struct {
	Orderbooks []MarketOrderbookFp `json:"orderbooks"`
}

GetMarketOrderbooksResponse defines model for GetMarketOrderbooksResponse.

type GetMarketOrderbooksResponse2

type GetMarketOrderbooksResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketOrderbooksResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetMarketOrderbooksResponse2

func ParseGetMarketOrderbooksResponse2(rsp *http.Response) (*GetMarketOrderbooksResponse2, error)

ParseGetMarketOrderbooksResponse2 parses an HTTP response from a GetMarketOrderbooksWithResponse call

func (GetMarketOrderbooksResponse2) ContentType

func (r GetMarketOrderbooksResponse2) ContentType() string

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

func (GetMarketOrderbooksResponse2) GetBody

func (r GetMarketOrderbooksResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketOrderbooksResponse2) GetJSON200

func (r GetMarketOrderbooksResponse2) GetJSON200() *GetMarketOrderbooksResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketOrderbooksResponse2) GetJSON400

func (r GetMarketOrderbooksResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMarketOrderbooksResponse2) GetJSON401

func (r GetMarketOrderbooksResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMarketOrderbooksResponse2) GetJSON500

func (r GetMarketOrderbooksResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMarketOrderbooksResponse2) Status

func (r GetMarketOrderbooksResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketOrderbooksResponse2) StatusCode

func (r GetMarketOrderbooksResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketResponse

type GetMarketResponse struct {
	Market Market `json:"market"`
}

GetMarketResponse defines model for GetMarketResponse.

type GetMarketResponse2

type GetMarketResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketResponse
}

func ParseGetMarketResponse2

func ParseGetMarketResponse2(rsp *http.Response) (*GetMarketResponse2, error)

ParseGetMarketResponse2 parses an HTTP response from a GetMarketWithResponse call

func (GetMarketResponse2) ContentType

func (r GetMarketResponse2) ContentType() string

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

func (GetMarketResponse2) GetBody

func (r GetMarketResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketResponse2) GetJSON200

func (r GetMarketResponse2) GetJSON200() *GetMarketResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketResponse2) Status

func (r GetMarketResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketResponse2) StatusCode

func (r GetMarketResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMarketsParams

type GetMarketsParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 1000.
	Limit *MarketLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,gte=0,lte=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// SeriesTicker Filter by series ticker
	SeriesTicker SeriesTickerQuery `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`

	// MinCreatedTs Filter items that created after this Unix timestamp
	MinCreatedTs *MinCreatedTsQuery `form:"min_created_ts,omitempty" json:"min_created_ts,omitempty"`

	// MaxCreatedTs Filter items that created before this Unix timestamp
	MaxCreatedTs *MaxCreatedTsQuery `form:"max_created_ts,omitempty" json:"max_created_ts,omitempty"`

	// MinUpdatedTs Return markets with metadata updated later than this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with max_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.
	MinUpdatedTs *MinUpdatedTsQuery `form:"min_updated_ts,omitempty" json:"min_updated_ts,omitempty"`

	// MaxUpdatedTs Return markets with metadata updated at or before this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with min_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.
	MaxUpdatedTs *MaxUpdatedTsQuery `form:"max_updated_ts,omitempty" json:"max_updated_ts,omitempty"`

	// MaxCloseTs Filter items that close before this Unix timestamp
	MaxCloseTs *MaxCloseTsQuery `form:"max_close_ts,omitempty" json:"max_close_ts,omitempty"`

	// MinCloseTs Filter items that close after this Unix timestamp
	MinCloseTs *MinCloseTsQuery `form:"min_close_ts,omitempty" json:"min_close_ts,omitempty"`

	// MinSettledTs Filter items that settled after this Unix timestamp
	MinSettledTs *MinSettledTsQuery `form:"min_settled_ts,omitempty" json:"min_settled_ts,omitempty"`

	// MaxSettledTs Filter items that settled before this Unix timestamp
	MaxSettledTs *MaxSettledTsQuery `form:"max_settled_ts,omitempty" json:"max_settled_ts,omitempty"`

	// Status Filter by market status. Leave empty to return markets with any status.
	Status *GetMarketsParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Tickers Filter by specific market tickers. Comma-separated list of market tickers to retrieve.
	Tickers *TickersQuery `form:"tickers,omitempty" json:"tickers,omitempty"`

	// MveFilter Filter by multivariate events (combos). 'only' returns only multivariate events, 'exclude' excludes multivariate events.
	MveFilter *GetMarketsParamsMveFilter `form:"mve_filter,omitempty" json:"mve_filter,omitempty"`
}

GetMarketsParams defines parameters for GetMarkets.

type GetMarketsParamsMveFilter

type GetMarketsParamsMveFilter string

GetMarketsParamsMveFilter defines parameters for GetMarkets.

const (
	GetMarketsParamsMveFilterExclude GetMarketsParamsMveFilter = "exclude"
	GetMarketsParamsMveFilterOnly    GetMarketsParamsMveFilter = "only"
)

Defines values for GetMarketsParamsMveFilter.

func (GetMarketsParamsMveFilter) Valid

func (e GetMarketsParamsMveFilter) Valid() bool

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

type GetMarketsParamsStatus

type GetMarketsParamsStatus string

GetMarketsParamsStatus defines parameters for GetMarkets.

const (
	GetMarketsParamsStatusClosed   GetMarketsParamsStatus = "closed"
	GetMarketsParamsStatusOpen     GetMarketsParamsStatus = "open"
	GetMarketsParamsStatusPaused   GetMarketsParamsStatus = "paused"
	GetMarketsParamsStatusSettled  GetMarketsParamsStatus = "settled"
	GetMarketsParamsStatusUnopened GetMarketsParamsStatus = "unopened"
)

Defines values for GetMarketsParamsStatus.

func (GetMarketsParamsStatus) Valid

func (e GetMarketsParamsStatus) Valid() bool

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

type GetMarketsResponse

type GetMarketsResponse struct {
	Cursor  string   `json:"cursor"`
	Markets []Market `json:"markets"`
}

GetMarketsResponse defines model for GetMarketsResponse.

type GetMarketsResponse2

type GetMarketsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMarketsResponse
}

func ParseGetMarketsResponse2

func ParseGetMarketsResponse2(rsp *http.Response) (*GetMarketsResponse2, error)

ParseGetMarketsResponse2 parses an HTTP response from a GetMarketsWithResponse call

func (GetMarketsResponse2) ContentType

func (r GetMarketsResponse2) ContentType() string

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

func (GetMarketsResponse2) GetBody

func (r GetMarketsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMarketsResponse2) GetJSON200

func (r GetMarketsResponse2) GetJSON200() *GetMarketsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMarketsResponse2) Status

func (r GetMarketsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMarketsResponse2) StatusCode

func (r GetMarketsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMilestoneResponse

type GetMilestoneResponse struct {
	Milestone Milestone `json:"milestone"`
}

GetMilestoneResponse defines model for GetMilestoneResponse.

type GetMilestoneResponse2

type GetMilestoneResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMilestoneResponse
}

func ParseGetMilestoneResponse2

func ParseGetMilestoneResponse2(rsp *http.Response) (*GetMilestoneResponse2, error)

ParseGetMilestoneResponse2 parses an HTTP response from a GetMilestoneWithResponse call

func (GetMilestoneResponse2) ContentType

func (r GetMilestoneResponse2) ContentType() string

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

func (GetMilestoneResponse2) GetBody

func (r GetMilestoneResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMilestoneResponse2) GetJSON200

func (r GetMilestoneResponse2) GetJSON200() *GetMilestoneResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMilestoneResponse2) Status

func (r GetMilestoneResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMilestoneResponse2) StatusCode

func (r GetMilestoneResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMilestonesParams

type GetMilestonesParams struct {
	// Limit Number of milestones to return per page
	Limit int `form:"limit" json:"limit"`

	// MinimumStartDate Minimum start date to filter milestones. Format RFC3339 timestamp
	MinimumStartDate *time.Time `form:"minimum_start_date,omitempty" json:"minimum_start_date,omitempty"`

	// Category Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.
	Category *string `form:"category,omitempty" json:"category,omitempty"`

	// Competition Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.
	Competition *string `form:"competition,omitempty" json:"competition,omitempty"`

	// SourceId Filter by source id
	SourceId *string `form:"source_id,omitempty" json:"source_id,omitempty"`

	// Type Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.
	Type *string `form:"type,omitempty" json:"type,omitempty"`

	// RelatedEventTicker Filter by related event ticker
	RelatedEventTicker *string `form:"related_event_ticker,omitempty" json:"related_event_ticker,omitempty"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// MinUpdatedTs Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
	MinUpdatedTs *int64 `form:"min_updated_ts,omitempty" json:"min_updated_ts,omitempty"`
}

GetMilestonesParams defines parameters for GetMilestones.

type GetMilestonesResponse

type GetMilestonesResponse struct {
	// Cursor Cursor for pagination.
	Cursor *string `json:"cursor,omitempty"`

	// Milestones List of milestones.
	Milestones []Milestone `json:"milestones"`
}

GetMilestonesResponse defines model for GetMilestonesResponse.

type GetMilestonesResponse2

type GetMilestonesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMilestonesResponse
}

func ParseGetMilestonesResponse2

func ParseGetMilestonesResponse2(rsp *http.Response) (*GetMilestonesResponse2, error)

ParseGetMilestonesResponse2 parses an HTTP response from a GetMilestonesWithResponse call

func (GetMilestonesResponse2) ContentType

func (r GetMilestonesResponse2) ContentType() string

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

func (GetMilestonesResponse2) GetBody

func (r GetMilestonesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMilestonesResponse2) GetJSON200

func (r GetMilestonesResponse2) GetJSON200() *GetMilestonesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMilestonesResponse2) Status

func (r GetMilestonesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMilestonesResponse2) StatusCode

func (r GetMilestonesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMultivariateEventCollectionResponse

type GetMultivariateEventCollectionResponse struct {
	MultivariateContract MultivariateEventCollection `json:"multivariate_contract"`
}

GetMultivariateEventCollectionResponse defines model for GetMultivariateEventCollectionResponse.

type GetMultivariateEventCollectionResponse2

type GetMultivariateEventCollectionResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMultivariateEventCollectionResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetMultivariateEventCollectionResponse2

func ParseGetMultivariateEventCollectionResponse2(rsp *http.Response) (*GetMultivariateEventCollectionResponse2, error)

ParseGetMultivariateEventCollectionResponse2 parses an HTTP response from a GetMultivariateEventCollectionWithResponse call

func (GetMultivariateEventCollectionResponse2) ContentType

func (r GetMultivariateEventCollectionResponse2) ContentType() string

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

func (GetMultivariateEventCollectionResponse2) GetBody

func (r GetMultivariateEventCollectionResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMultivariateEventCollectionResponse2) GetJSON200

func (r GetMultivariateEventCollectionResponse2) GetJSON200() *GetMultivariateEventCollectionResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMultivariateEventCollectionResponse2) GetJSON400

func (r GetMultivariateEventCollectionResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMultivariateEventCollectionResponse2) GetJSON404

func (r GetMultivariateEventCollectionResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMultivariateEventCollectionResponse2) GetJSON500

func (r GetMultivariateEventCollectionResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMultivariateEventCollectionResponse2) Status

func (r GetMultivariateEventCollectionResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMultivariateEventCollectionResponse2) StatusCode

func (r GetMultivariateEventCollectionResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMultivariateEventCollectionsParams

type GetMultivariateEventCollectionsParams struct {
	// Status Only return collections of a certain status. Can be unopened, open, or closed.
	Status *GetMultivariateEventCollectionsParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// AssociatedEventTicker Only return collections associated with a particular event ticker.
	AssociatedEventTicker *string `form:"associated_event_ticker,omitempty" json:"associated_event_ticker,omitempty"`

	// SeriesTicker Only return collections with a particular series ticker.
	SeriesTicker *string `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`

	// Limit Specify the maximum number of results.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetMultivariateEventCollectionsParams defines parameters for GetMultivariateEventCollections.

type GetMultivariateEventCollectionsParamsStatus

type GetMultivariateEventCollectionsParamsStatus string

GetMultivariateEventCollectionsParamsStatus defines parameters for GetMultivariateEventCollections.

const (
	GetMultivariateEventCollectionsParamsStatusClosed   GetMultivariateEventCollectionsParamsStatus = "closed"
	GetMultivariateEventCollectionsParamsStatusOpen     GetMultivariateEventCollectionsParamsStatus = "open"
	GetMultivariateEventCollectionsParamsStatusUnopened GetMultivariateEventCollectionsParamsStatus = "unopened"
)

Defines values for GetMultivariateEventCollectionsParamsStatus.

func (GetMultivariateEventCollectionsParamsStatus) Valid

func (e GetMultivariateEventCollectionsParamsStatus) Valid() bool

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

type GetMultivariateEventCollectionsResponse

type GetMultivariateEventCollectionsResponse struct {
	// Cursor The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page.
	Cursor string `json:"cursor,omitempty"`

	// MultivariateContracts List of multivariate event collections.
	MultivariateContracts []MultivariateEventCollection `json:"multivariate_contracts"`
}

GetMultivariateEventCollectionsResponse defines model for GetMultivariateEventCollectionsResponse.

type GetMultivariateEventCollectionsResponse2

type GetMultivariateEventCollectionsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMultivariateEventCollectionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetMultivariateEventCollectionsResponse2

func ParseGetMultivariateEventCollectionsResponse2(rsp *http.Response) (*GetMultivariateEventCollectionsResponse2, error)

ParseGetMultivariateEventCollectionsResponse2 parses an HTTP response from a GetMultivariateEventCollectionsWithResponse call

func (GetMultivariateEventCollectionsResponse2) ContentType

func (r GetMultivariateEventCollectionsResponse2) ContentType() string

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

func (GetMultivariateEventCollectionsResponse2) GetBody

func (r GetMultivariateEventCollectionsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMultivariateEventCollectionsResponse2) GetJSON200

func (r GetMultivariateEventCollectionsResponse2) GetJSON200() *GetMultivariateEventCollectionsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMultivariateEventCollectionsResponse2) GetJSON400

func (r GetMultivariateEventCollectionsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMultivariateEventCollectionsResponse2) GetJSON500

func (r GetMultivariateEventCollectionsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMultivariateEventCollectionsResponse2) Status

func (r GetMultivariateEventCollectionsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMultivariateEventCollectionsResponse2) StatusCode

func (r GetMultivariateEventCollectionsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMultivariateEventsParams

type GetMultivariateEventsParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 200.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// SeriesTicker Filter by series ticker
	SeriesTicker SeriesTickerQuery `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`

	// CollectionTicker Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker.
	CollectionTicker *string `form:"collection_ticker,omitempty" json:"collection_ticker,omitempty"`

	// Tickers Filter by specific event tickers. Comma-separated list of event tickers to retrieve.
	Tickers *EventTickersQuery `form:"tickers,omitempty" json:"tickers,omitempty"`

	// WithNestedMarkets Parameter to specify if nested markets should be included in the response. When true, each event will include a 'markets' field containing a list of Market objects associated with that event.
	WithNestedMarkets *bool `form:"with_nested_markets,omitempty" json:"with_nested_markets,omitempty"`
}

GetMultivariateEventsParams defines parameters for GetMultivariateEvents.

type GetMultivariateEventsResponse

type GetMultivariateEventsResponse struct {
	// Cursor Pagination cursor for the next page. Empty if there are no more results.
	Cursor string `json:"cursor"`

	// Events Array of multivariate events matching the query criteria.
	Events []EventData `json:"events"`
}

GetMultivariateEventsResponse defines model for GetMultivariateEventsResponse.

type GetMultivariateEventsResponse2

type GetMultivariateEventsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetMultivariateEventsResponse
}

func ParseGetMultivariateEventsResponse2

func ParseGetMultivariateEventsResponse2(rsp *http.Response) (*GetMultivariateEventsResponse2, error)

ParseGetMultivariateEventsResponse2 parses an HTTP response from a GetMultivariateEventsWithResponse call

func (GetMultivariateEventsResponse2) ContentType

func (r GetMultivariateEventsResponse2) ContentType() string

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

func (GetMultivariateEventsResponse2) GetBody

func (r GetMultivariateEventsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMultivariateEventsResponse2) GetJSON200

func (r GetMultivariateEventsResponse2) GetJSON200() *GetMultivariateEventsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMultivariateEventsResponse2) Status

func (r GetMultivariateEventsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetMultivariateEventsResponse2) StatusCode

func (r GetMultivariateEventsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderGroupParams

type GetOrderGroupParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetOrderGroupParams defines parameters for GetOrderGroup.

type GetOrderGroupResponse

type GetOrderGroupResponse struct {
	// ContractsLimitFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsLimitFp FixedPointCount `json:"contracts_limit_fp,omitempty"`
	ExchangeIndex    ExchangeIndex   `json:"exchange_index"`

	// IsAutoCancelEnabled Whether auto-cancel is enabled for this order group
	IsAutoCancelEnabled bool `json:"is_auto_cancel_enabled"`

	// Orders List of order IDs that belong to this order group
	Orders []string `json:"orders"`
}

GetOrderGroupResponse defines model for GetOrderGroupResponse.

type GetOrderGroupResponse2

type GetOrderGroupResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrderGroupResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrderGroupResponse2

func ParseGetOrderGroupResponse2(rsp *http.Response) (*GetOrderGroupResponse2, error)

ParseGetOrderGroupResponse2 parses an HTTP response from a GetOrderGroupWithResponse call

func (GetOrderGroupResponse2) ContentType

func (r GetOrderGroupResponse2) ContentType() string

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

func (GetOrderGroupResponse2) GetBody

func (r GetOrderGroupResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderGroupResponse2) GetJSON200

func (r GetOrderGroupResponse2) GetJSON200() *GetOrderGroupResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderGroupResponse2) GetJSON401

func (r GetOrderGroupResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderGroupResponse2) GetJSON404

func (r GetOrderGroupResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetOrderGroupResponse2) GetJSON500

func (r GetOrderGroupResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrderGroupResponse2) Status

func (r GetOrderGroupResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrderGroupResponse2) StatusCode

func (r GetOrderGroupResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderGroupsParams

type GetOrderGroupsParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetOrderGroupsParams defines parameters for GetOrderGroups.

type GetOrderGroupsResponse

type GetOrderGroupsResponse struct {
	OrderGroups []OrderGroup `json:"order_groups,omitempty"`
}

GetOrderGroupsResponse defines model for GetOrderGroupsResponse.

type GetOrderGroupsResponse2

type GetOrderGroupsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrderGroupsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrderGroupsResponse2

func ParseGetOrderGroupsResponse2(rsp *http.Response) (*GetOrderGroupsResponse2, error)

ParseGetOrderGroupsResponse2 parses an HTTP response from a GetOrderGroupsWithResponse call

func (GetOrderGroupsResponse2) ContentType

func (r GetOrderGroupsResponse2) ContentType() string

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

func (GetOrderGroupsResponse2) GetBody

func (r GetOrderGroupsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderGroupsResponse2) GetJSON200

func (r GetOrderGroupsResponse2) GetJSON200() *GetOrderGroupsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderGroupsResponse2) GetJSON400

func (r GetOrderGroupsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetOrderGroupsResponse2) GetJSON401

func (r GetOrderGroupsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderGroupsResponse2) GetJSON500

func (r GetOrderGroupsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrderGroupsResponse2) Status

func (r GetOrderGroupsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrderGroupsResponse2) StatusCode

func (r GetOrderGroupsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderQueuePositionResponse

type GetOrderQueuePositionResponse struct {
	// QueuePositionFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	QueuePositionFp FixedPointCount `json:"queue_position_fp"`
}

GetOrderQueuePositionResponse defines model for GetOrderQueuePositionResponse.

type GetOrderQueuePositionResponse2

type GetOrderQueuePositionResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrderQueuePositionResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrderQueuePositionResponse2

func ParseGetOrderQueuePositionResponse2(rsp *http.Response) (*GetOrderQueuePositionResponse2, error)

ParseGetOrderQueuePositionResponse2 parses an HTTP response from a GetOrderQueuePositionWithResponse call

func (GetOrderQueuePositionResponse2) ContentType

func (r GetOrderQueuePositionResponse2) ContentType() string

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

func (GetOrderQueuePositionResponse2) GetBody

func (r GetOrderQueuePositionResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderQueuePositionResponse2) GetJSON200

func (r GetOrderQueuePositionResponse2) GetJSON200() *GetOrderQueuePositionResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderQueuePositionResponse2) GetJSON401

func (r GetOrderQueuePositionResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderQueuePositionResponse2) GetJSON404

func (r GetOrderQueuePositionResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetOrderQueuePositionResponse2) GetJSON500

func (r GetOrderQueuePositionResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrderQueuePositionResponse2) Status

func (r GetOrderQueuePositionResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrderQueuePositionResponse2) StatusCode

func (r GetOrderQueuePositionResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderQueuePositionsParams

type GetOrderQueuePositionsParams struct {
	// MarketTickers Comma-separated list of market tickers to filter by
	MarketTickers *string `form:"market_tickers,omitempty" json:"market_tickers,omitempty"`

	// EventTicker Event ticker to filter by
	EventTicker *string `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetOrderQueuePositionsParams defines parameters for GetOrderQueuePositions.

type GetOrderQueuePositionsResponse

type GetOrderQueuePositionsResponse struct {
	// QueuePositions Queue positions for all matching orders
	QueuePositions []OrderQueuePosition `json:"queue_positions"`
}

GetOrderQueuePositionsResponse defines model for GetOrderQueuePositionsResponse.

type GetOrderQueuePositionsResponse2

type GetOrderQueuePositionsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrderQueuePositionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrderQueuePositionsResponse2

func ParseGetOrderQueuePositionsResponse2(rsp *http.Response) (*GetOrderQueuePositionsResponse2, error)

ParseGetOrderQueuePositionsResponse2 parses an HTTP response from a GetOrderQueuePositionsWithResponse call

func (GetOrderQueuePositionsResponse2) ContentType

func (r GetOrderQueuePositionsResponse2) ContentType() string

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

func (GetOrderQueuePositionsResponse2) GetBody

func (r GetOrderQueuePositionsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderQueuePositionsResponse2) GetJSON200

func (r GetOrderQueuePositionsResponse2) GetJSON200() *GetOrderQueuePositionsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderQueuePositionsResponse2) GetJSON400

func (r GetOrderQueuePositionsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetOrderQueuePositionsResponse2) GetJSON401

func (r GetOrderQueuePositionsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderQueuePositionsResponse2) GetJSON500

func (r GetOrderQueuePositionsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrderQueuePositionsResponse2) Status

func (r GetOrderQueuePositionsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrderQueuePositionsResponse2) StatusCode

func (r GetOrderQueuePositionsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderResponse

type GetOrderResponse struct {
	Order Order `json:"order"`
}

GetOrderResponse defines model for GetOrderResponse.

type GetOrderResponse2

type GetOrderResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrderResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrderResponse2

func ParseGetOrderResponse2(rsp *http.Response) (*GetOrderResponse2, error)

ParseGetOrderResponse2 parses an HTTP response from a GetOrderWithResponse call

func (GetOrderResponse2) ContentType

func (r GetOrderResponse2) ContentType() string

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

func (GetOrderResponse2) GetBody

func (r GetOrderResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrderResponse2) GetJSON200

func (r GetOrderResponse2) GetJSON200() *GetOrderResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrderResponse2) GetJSON401

func (r GetOrderResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrderResponse2) GetJSON404

func (r GetOrderResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetOrderResponse2) GetJSON500

func (r GetOrderResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrderResponse2) Status

func (r GetOrderResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrderResponse2) StatusCode

func (r GetOrderResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrdersParams

type GetOrdersParams struct {
	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// EventTicker Event tickers to filter by, as a comma-separated list (maximum 10).
	EventTicker MultipleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Status Filter by status. Possible values depend on the endpoint.
	Status *StatusQuery `form:"status,omitempty" json:"status,omitempty"`

	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Filter results by exchange shard. Omit to return results from all exchange shards.
	ExchangeIndex *ExchangeIndexFilterQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty" validate:"omitempty,gte=0"`
}

GetOrdersParams defines parameters for GetOrders.

type GetOrdersResponse

type GetOrdersResponse struct {
	Cursor string  `json:"cursor"`
	Orders []Order `json:"orders"`
}

GetOrdersResponse defines model for GetOrdersResponse.

type GetOrdersResponse2

type GetOrdersResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetOrdersResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetOrdersResponse2

func ParseGetOrdersResponse2(rsp *http.Response) (*GetOrdersResponse2, error)

ParseGetOrdersResponse2 parses an HTTP response from a GetOrdersWithResponse call

func (GetOrdersResponse2) ContentType

func (r GetOrdersResponse2) ContentType() string

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

func (GetOrdersResponse2) GetBody

func (r GetOrdersResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOrdersResponse2) GetJSON200

func (r GetOrdersResponse2) GetJSON200() *GetOrdersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetOrdersResponse2) GetJSON400

func (r GetOrdersResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetOrdersResponse2) GetJSON401

func (r GetOrdersResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetOrdersResponse2) GetJSON500

func (r GetOrdersResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOrdersResponse2) Status

func (r GetOrdersResponse2) Status() string

Status returns HTTPResponse.Status

func (GetOrdersResponse2) StatusCode

func (r GetOrdersResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPortfolioRestingOrderTotalValueResponse

type GetPortfolioRestingOrderTotalValueResponse struct {
	// RestingOrderValueBreakdown Total value of resting orders broken down by exchange index, with each balance expressed as a fixed-point dollar string.
	RestingOrderValueBreakdown []IndexedBalance `json:"resting_order_value_breakdown"`

	// TotalRestingOrderValue Total value of resting orders in cents
	TotalRestingOrderValue int `json:"total_resting_order_value"`
}

GetPortfolioRestingOrderTotalValueResponse defines model for GetPortfolioRestingOrderTotalValueResponse.

type GetPortfolioRestingOrderTotalValueResponse2

type GetPortfolioRestingOrderTotalValueResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetPortfolioRestingOrderTotalValueResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetPortfolioRestingOrderTotalValueResponse2

func ParseGetPortfolioRestingOrderTotalValueResponse2(rsp *http.Response) (*GetPortfolioRestingOrderTotalValueResponse2, error)

ParseGetPortfolioRestingOrderTotalValueResponse2 parses an HTTP response from a GetPortfolioRestingOrderTotalValueWithResponse call

func (GetPortfolioRestingOrderTotalValueResponse2) ContentType

func (r GetPortfolioRestingOrderTotalValueResponse2) ContentType() string

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

func (GetPortfolioRestingOrderTotalValueResponse2) GetBody

func (r GetPortfolioRestingOrderTotalValueResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPortfolioRestingOrderTotalValueResponse2) GetJSON200

func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON200() *GetPortfolioRestingOrderTotalValueResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetPortfolioRestingOrderTotalValueResponse2) GetJSON401

func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetPortfolioRestingOrderTotalValueResponse2) GetJSON500

func (r GetPortfolioRestingOrderTotalValueResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPortfolioRestingOrderTotalValueResponse2) Status

func (r GetPortfolioRestingOrderTotalValueResponse2) Status() string

Status returns HTTPResponse.Status

func (GetPortfolioRestingOrderTotalValueResponse2) StatusCode

func (r GetPortfolioRestingOrderTotalValueResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPositionsParams

type GetPositionsParams struct {
	// Cursor The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.
	Cursor *PositionsCursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 100.
	Limit *PositionsLimitQuery `form:"limit,omitempty" json:"limit,omitempty"`

	// CountFilter Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
	CountFilter *CountFilterQuery `form:"count_filter,omitempty" json:"count_filter,omitempty"`

	// SettlementStatus Return unsettled positions by default, settled positions that have not yet been archived, or all positions in the live data set.
	SettlementStatus *GetPositionsParamsSettlementStatus `form:"settlement_status,omitempty" json:"settlement_status,omitempty"`

	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Filter results by exchange shard. Omit to return results from all exchange shards.
	ExchangeIndex *ExchangeIndexFilterQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty" validate:"omitempty,gte=0"`
}

GetPositionsParams defines parameters for GetPositions.

type GetPositionsParamsSettlementStatus

type GetPositionsParamsSettlementStatus string

GetPositionsParamsSettlementStatus defines parameters for GetPositions.

const (
	GetPositionsParamsSettlementStatusAll       GetPositionsParamsSettlementStatus = "all"
	GetPositionsParamsSettlementStatusSettled   GetPositionsParamsSettlementStatus = "settled"
	GetPositionsParamsSettlementStatusUnsettled GetPositionsParamsSettlementStatus = "unsettled"
)

Defines values for GetPositionsParamsSettlementStatus.

func (GetPositionsParamsSettlementStatus) Valid

func (e GetPositionsParamsSettlementStatus) Valid() bool

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

type GetPositionsResponse

type GetPositionsResponse struct {
	// Cursor The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page.
	Cursor *string `json:"cursor,omitempty"`

	// EventPositions List of event positions
	EventPositions []EventPosition `json:"event_positions"`

	// MarketPositions List of market positions
	MarketPositions []MarketPosition `json:"market_positions"`
}

GetPositionsResponse defines model for GetPositionsResponse.

type GetPositionsResponse2

type GetPositionsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetPositionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetPositionsResponse2

func ParseGetPositionsResponse2(rsp *http.Response) (*GetPositionsResponse2, error)

ParseGetPositionsResponse2 parses an HTTP response from a GetPositionsWithResponse call

func (GetPositionsResponse2) ContentType

func (r GetPositionsResponse2) ContentType() string

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

func (GetPositionsResponse2) GetBody

func (r GetPositionsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPositionsResponse2) GetJSON200

func (r GetPositionsResponse2) GetJSON200() *GetPositionsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetPositionsResponse2) GetJSON400

func (r GetPositionsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPositionsResponse2) GetJSON401

func (r GetPositionsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetPositionsResponse2) GetJSON500

func (r GetPositionsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPositionsResponse2) Status

func (r GetPositionsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetPositionsResponse2) StatusCode

func (r GetPositionsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetQuoteResponse

type GetQuoteResponse struct {
	Quote Quote `json:"quote"`
}

GetQuoteResponse defines model for GetQuoteResponse.

type GetQuoteResponse2

type GetQuoteResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetQuoteResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetQuoteResponse2

func ParseGetQuoteResponse2(rsp *http.Response) (*GetQuoteResponse2, error)

ParseGetQuoteResponse2 parses an HTTP response from a GetQuoteWithResponse call

func (GetQuoteResponse2) ContentType

func (r GetQuoteResponse2) ContentType() string

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

func (GetQuoteResponse2) GetBody

func (r GetQuoteResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetQuoteResponse2) GetJSON200

func (r GetQuoteResponse2) GetJSON200() *GetQuoteResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetQuoteResponse2) GetJSON400

func (r GetQuoteResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetQuoteResponse2) GetJSON401

func (r GetQuoteResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetQuoteResponse2) GetJSON404

func (r GetQuoteResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetQuoteResponse2) GetJSON500

func (r GetQuoteResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetQuoteResponse2) Status

func (r GetQuoteResponse2) Status() string

Status returns HTTPResponse.Status

func (GetQuoteResponse2) StatusCode

func (r GetQuoteResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetQuotesParams

type GetQuotesParams struct {
	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// MinTs Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp
	MinTs *int64 `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp
	MaxTs *int64 `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 500.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Status Filter quotes by status
	Status string `form:"status,omitempty" json:"status,omitempty"`

	// QuoteCreatorUserId Filter quotes by quote creator user ID
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	QuoteCreatorUserId string `form:"quote_creator_user_id,omitempty" json:"quote_creator_user_id,omitempty"`

	// UserFilter Filter for quotes created by the authenticated user.
	UserFilter UserFilter `form:"user_filter,omitempty" json:"user_filter,omitempty" validate:"omitempty,oneof=self"`

	// RfqUserFilter Filter for quotes responding to RFQs created by the authenticated user.
	RfqUserFilter UserFilter `form:"rfq_user_filter,omitempty" json:"rfq_user_filter,omitempty" validate:"omitempty,oneof=self"`

	// RfqCreatorUserId Filter quotes by RFQ creator user ID
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	RfqCreatorUserId string `form:"rfq_creator_user_id,omitempty" json:"rfq_creator_user_id,omitempty"`

	// RfqCreatorSubtraderId Filter quotes by RFQ creator subtrader ID (FCM members only)
	RfqCreatorSubtraderId string `form:"rfq_creator_subtrader_id,omitempty" json:"rfq_creator_subtrader_id,omitempty"`

	// RfqId Filter quotes by RFQ UUID. Pass the RFQ ID unchanged; malformed IDs return HTTP 400.
	RfqId string `form:"rfq_id,omitempty" json:"rfq_id,omitempty"`
}

GetQuotesParams defines parameters for GetQuotes.

type GetQuotesResponse

type GetQuotesResponse struct {
	// Cursor Cursor for pagination to get the next page of results
	Cursor string `json:"cursor,omitempty"`

	// Quotes List of quotes matching the query criteria
	Quotes []Quote `json:"quotes"`
}

GetQuotesResponse defines model for GetQuotesResponse.

type GetQuotesResponse2

type GetQuotesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetQuotesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetQuotesResponse2

func ParseGetQuotesResponse2(rsp *http.Response) (*GetQuotesResponse2, error)

ParseGetQuotesResponse2 parses an HTTP response from a GetQuotesWithResponse call

func (GetQuotesResponse2) ContentType

func (r GetQuotesResponse2) ContentType() string

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

func (GetQuotesResponse2) GetBody

func (r GetQuotesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetQuotesResponse2) GetJSON200

func (r GetQuotesResponse2) GetJSON200() *GetQuotesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetQuotesResponse2) GetJSON400

func (r GetQuotesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetQuotesResponse2) GetJSON401

func (r GetQuotesResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetQuotesResponse2) GetJSON500

func (r GetQuotesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetQuotesResponse2) Status

func (r GetQuotesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetQuotesResponse2) StatusCode

func (r GetQuotesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRFQQuoteResponse

type GetRFQQuoteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetQuoteResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetRFQQuoteResponse

func ParseGetRFQQuoteResponse(rsp *http.Response) (*GetRFQQuoteResponse, error)

ParseGetRFQQuoteResponse parses an HTTP response from a GetRFQQuoteWithResponse call

func (GetRFQQuoteResponse) ContentType

func (r GetRFQQuoteResponse) ContentType() string

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

func (GetRFQQuoteResponse) GetBody

func (r GetRFQQuoteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRFQQuoteResponse) GetJSON200

func (r GetRFQQuoteResponse) GetJSON200() *GetQuoteResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRFQQuoteResponse) GetJSON400

func (r GetRFQQuoteResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRFQQuoteResponse) GetJSON401

func (r GetRFQQuoteResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRFQQuoteResponse) GetJSON404

func (r GetRFQQuoteResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRFQQuoteResponse) GetJSON500

func (r GetRFQQuoteResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetRFQQuoteResponse) Status

func (r GetRFQQuoteResponse) Status() string

Status returns HTTPResponse.Status

func (GetRFQQuoteResponse) StatusCode

func (r GetRFQQuoteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRFQResponse

type GetRFQResponse struct {
	Rfq RFQ `json:"rfq"`
}

GetRFQResponse defines model for GetRFQResponse.

type GetRFQResponse2

type GetRFQResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetRFQResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetRFQResponse2

func ParseGetRFQResponse2(rsp *http.Response) (*GetRFQResponse2, error)

ParseGetRFQResponse2 parses an HTTP response from a GetRFQWithResponse call

func (GetRFQResponse2) ContentType

func (r GetRFQResponse2) ContentType() string

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

func (GetRFQResponse2) GetBody

func (r GetRFQResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRFQResponse2) GetJSON200

func (r GetRFQResponse2) GetJSON200() *GetRFQResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRFQResponse2) GetJSON400

func (r GetRFQResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRFQResponse2) GetJSON401

func (r GetRFQResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRFQResponse2) GetJSON404

func (r GetRFQResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRFQResponse2) GetJSON500

func (r GetRFQResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetRFQResponse2) Status

func (r GetRFQResponse2) Status() string

Status returns HTTPResponse.Status

func (GetRFQResponse2) StatusCode

func (r GetRFQResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRFQsParams

type GetRFQsParams struct {
	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// MarketTicker Filter by market ticker
	MarketTicker MarketTickerQuery `form:"market_ticker,omitempty" json:"market_ticker,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// Limit Parameter to specify the number of results per page. Defaults to 100.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Status Filter RFQs by status
	Status *string `form:"status,omitempty" json:"status,omitempty"`

	// CreatorUserId Filter RFQs by creator user UUID. Use user_filter=self for the authenticated user.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	CreatorUserId *string    `form:"creator_user_id,omitempty" json:"creator_user_id,omitempty"`
	UserFilter    UserFilter `form:"user_filter,omitempty" json:"user_filter,omitempty" validate:"omitempty,oneof=self"`
}

GetRFQsParams defines parameters for GetRFQs.

type GetRFQsResponse

type GetRFQsResponse struct {
	// Cursor Cursor for pagination to get the next page of results
	Cursor string `json:"cursor,omitempty"`

	// Rfqs List of RFQs matching the query criteria
	Rfqs []RFQ `json:"rfqs"`
}

GetRFQsResponse defines model for GetRFQsResponse.

type GetRFQsResponse2

type GetRFQsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetRFQsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetRFQsResponse2

func ParseGetRFQsResponse2(rsp *http.Response) (*GetRFQsResponse2, error)

ParseGetRFQsResponse2 parses an HTTP response from a GetRFQsWithResponse call

func (GetRFQsResponse2) ContentType

func (r GetRFQsResponse2) ContentType() string

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

func (GetRFQsResponse2) GetBody

func (r GetRFQsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRFQsResponse2) GetJSON200

func (r GetRFQsResponse2) GetJSON200() *GetRFQsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRFQsResponse2) GetJSON400

func (r GetRFQsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRFQsResponse2) GetJSON401

func (r GetRFQsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRFQsResponse2) GetJSON500

func (r GetRFQsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetRFQsResponse2) Status

func (r GetRFQsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetRFQsResponse2) StatusCode

func (r GetRFQsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSeriesFeeChangesParams

type GetSeriesFeeChangesParams struct {
	SeriesTicker   string `form:"series_ticker,omitempty" json:"series_ticker,omitempty"`
	ShowHistorical bool   `form:"show_historical,omitempty" json:"show_historical,omitempty"`
}

GetSeriesFeeChangesParams defines parameters for GetSeriesFeeChanges.

type GetSeriesFeeChangesResponse

type GetSeriesFeeChangesResponse struct {
	SeriesFeeChangeArr []SeriesFeeChange `json:"series_fee_change_arr"`
}

GetSeriesFeeChangesResponse defines model for GetSeriesFeeChangesResponse.

type GetSeriesFeeChangesResponse2

type GetSeriesFeeChangesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSeriesFeeChangesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSeriesFeeChangesResponse2

func ParseGetSeriesFeeChangesResponse2(rsp *http.Response) (*GetSeriesFeeChangesResponse2, error)

ParseGetSeriesFeeChangesResponse2 parses an HTTP response from a GetSeriesFeeChangesWithResponse call

func (GetSeriesFeeChangesResponse2) ContentType

func (r GetSeriesFeeChangesResponse2) ContentType() string

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

func (GetSeriesFeeChangesResponse2) GetBody

func (r GetSeriesFeeChangesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSeriesFeeChangesResponse2) GetJSON200

func (r GetSeriesFeeChangesResponse2) GetJSON200() *GetSeriesFeeChangesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSeriesFeeChangesResponse2) GetJSON400

func (r GetSeriesFeeChangesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSeriesFeeChangesResponse2) GetJSON500

func (r GetSeriesFeeChangesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSeriesFeeChangesResponse2) Status

func (r GetSeriesFeeChangesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSeriesFeeChangesResponse2) StatusCode

func (r GetSeriesFeeChangesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSeriesListParams

type GetSeriesListParams struct {
	// Category Return series whose `categories` list contains this value. A series can have more than one discovery category, so the `category` field of a returned series (its primary category) may differ from the filter value. Matching is exact and case-sensitive.
	Category               string `form:"category,omitempty" json:"category,omitempty"`
	Tags                   string `form:"tags,omitempty" json:"tags,omitempty"`
	IncludeProductMetadata bool   `form:"include_product_metadata,omitempty" json:"include_product_metadata,omitempty"`

	// IncludeVolume If true, includes the total volume traded across all events in each series.
	IncludeVolume bool `form:"include_volume,omitempty" json:"include_volume,omitempty"`

	// MinUpdatedTs Filter series with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.
	MinUpdatedTs *int64 `form:"min_updated_ts,omitempty" json:"min_updated_ts,omitempty"`
}

GetSeriesListParams defines parameters for GetSeriesList.

type GetSeriesListResponse

type GetSeriesListResponse struct {
	Series []Series `json:"series"`
}

GetSeriesListResponse defines model for GetSeriesListResponse.

type GetSeriesListResponse2

type GetSeriesListResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSeriesListResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSeriesListResponse2

func ParseGetSeriesListResponse2(rsp *http.Response) (*GetSeriesListResponse2, error)

ParseGetSeriesListResponse2 parses an HTTP response from a GetSeriesListWithResponse call

func (GetSeriesListResponse2) ContentType

func (r GetSeriesListResponse2) ContentType() string

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

func (GetSeriesListResponse2) GetBody

func (r GetSeriesListResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSeriesListResponse2) GetJSON200

func (r GetSeriesListResponse2) GetJSON200() *GetSeriesListResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSeriesListResponse2) GetJSON400

func (r GetSeriesListResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSeriesListResponse2) GetJSON500

func (r GetSeriesListResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSeriesListResponse2) Status

func (r GetSeriesListResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSeriesListResponse2) StatusCode

func (r GetSeriesListResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSeriesParams

type GetSeriesParams struct {
	// IncludeVolume If true, includes the total volume traded across all events in this series.
	IncludeVolume bool `form:"include_volume,omitempty" json:"include_volume,omitempty"`
}

GetSeriesParams defines parameters for GetSeries.

type GetSeriesResponse

type GetSeriesResponse struct {
	Series Series `json:"series"`
}

GetSeriesResponse defines model for GetSeriesResponse.

type GetSeriesResponse2

type GetSeriesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSeriesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSeriesResponse2

func ParseGetSeriesResponse2(rsp *http.Response) (*GetSeriesResponse2, error)

ParseGetSeriesResponse2 parses an HTTP response from a GetSeriesWithResponse call

func (GetSeriesResponse2) ContentType

func (r GetSeriesResponse2) ContentType() string

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

func (GetSeriesResponse2) GetBody

func (r GetSeriesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSeriesResponse2) GetJSON200

func (r GetSeriesResponse2) GetJSON200() *GetSeriesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSeriesResponse2) GetJSON400

func (r GetSeriesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSeriesResponse2) GetJSON500

func (r GetSeriesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSeriesResponse2) Status

func (r GetSeriesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSeriesResponse2) StatusCode

func (r GetSeriesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSettlementsParams

type GetSettlementsParams struct {
	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// EventTicker Event ticker to filter by. Only a single event ticker is supported.
	EventTicker SingleEventTickerQuery `form:"event_ticker,omitempty" json:"event_ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.
	Subaccount *SubaccountQuery `form:"subaccount,omitempty" json:"subaccount,omitempty"`
}

GetSettlementsParams defines parameters for GetSettlements.

type GetSettlementsResponse

type GetSettlementsResponse struct {
	Cursor      *string      `json:"cursor,omitempty"`
	Settlements []Settlement `json:"settlements"`
}

GetSettlementsResponse defines model for GetSettlementsResponse.

type GetSettlementsResponse2

type GetSettlementsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSettlementsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSettlementsResponse2

func ParseGetSettlementsResponse2(rsp *http.Response) (*GetSettlementsResponse2, error)

ParseGetSettlementsResponse2 parses an HTTP response from a GetSettlementsWithResponse call

func (GetSettlementsResponse2) ContentType

func (r GetSettlementsResponse2) ContentType() string

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

func (GetSettlementsResponse2) GetBody

func (r GetSettlementsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSettlementsResponse2) GetJSON200

func (r GetSettlementsResponse2) GetJSON200() *GetSettlementsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSettlementsResponse2) GetJSON400

func (r GetSettlementsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSettlementsResponse2) GetJSON401

func (r GetSettlementsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSettlementsResponse2) GetJSON500

func (r GetSettlementsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSettlementsResponse2) Status

func (r GetSettlementsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSettlementsResponse2) StatusCode

func (r GetSettlementsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStructuredTargetResponse

type GetStructuredTargetResponse struct {
	StructuredTarget *StructuredTarget `json:"structured_target,omitempty"`
}

GetStructuredTargetResponse defines model for GetStructuredTargetResponse.

type GetStructuredTargetResponse2

type GetStructuredTargetResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetStructuredTargetResponse
}

func ParseGetStructuredTargetResponse2

func ParseGetStructuredTargetResponse2(rsp *http.Response) (*GetStructuredTargetResponse2, error)

ParseGetStructuredTargetResponse2 parses an HTTP response from a GetStructuredTargetWithResponse call

func (GetStructuredTargetResponse2) ContentType

func (r GetStructuredTargetResponse2) ContentType() string

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

func (GetStructuredTargetResponse2) GetBody

func (r GetStructuredTargetResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStructuredTargetResponse2) GetJSON200

func (r GetStructuredTargetResponse2) GetJSON200() *GetStructuredTargetResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStructuredTargetResponse2) Status

func (r GetStructuredTargetResponse2) Status() string

Status returns HTTPResponse.Status

func (GetStructuredTargetResponse2) StatusCode

func (r GetStructuredTargetResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStructuredTargetsParams

type GetStructuredTargetsParams struct {
	// Ids Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`).
	Ids *[]string `form:"ids,omitempty" json:"ids,omitempty"`

	// Type Filter by structured target type
	Type *string `form:"type,omitempty" json:"type,omitempty"`

	// Competition Filter by competition. Matches against the league, conference, division, or tour in the structured target details, or any entry in the details leagues array.
	Competition *string `form:"competition,omitempty" json:"competition,omitempty"`

	// PageSize Number of items per page (min 1, max 2000, default 100)
	PageSize *int32 `form:"page_size,omitempty" json:"page_size,omitempty"`

	// Cursor Pagination cursor
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetStructuredTargetsParams defines parameters for GetStructuredTargets.

type GetStructuredTargetsResponse

type GetStructuredTargetsResponse struct {
	// Cursor Pagination cursor for the next page. Empty if there are no more results.
	Cursor            *string             `json:"cursor,omitempty"`
	StructuredTargets *[]StructuredTarget `json:"structured_targets,omitempty"`
}

GetStructuredTargetsResponse defines model for GetStructuredTargetsResponse.

type GetStructuredTargetsResponse2

type GetStructuredTargetsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetStructuredTargetsResponse
}

func ParseGetStructuredTargetsResponse2

func ParseGetStructuredTargetsResponse2(rsp *http.Response) (*GetStructuredTargetsResponse2, error)

ParseGetStructuredTargetsResponse2 parses an HTTP response from a GetStructuredTargetsWithResponse call

func (GetStructuredTargetsResponse2) ContentType

func (r GetStructuredTargetsResponse2) ContentType() string

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

func (GetStructuredTargetsResponse2) GetBody

func (r GetStructuredTargetsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetStructuredTargetsResponse2) GetJSON200

func (r GetStructuredTargetsResponse2) GetJSON200() *GetStructuredTargetsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetStructuredTargetsResponse2) Status

func (r GetStructuredTargetsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetStructuredTargetsResponse2) StatusCode

func (r GetStructuredTargetsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSubaccountBalancesResponse

type GetSubaccountBalancesResponse struct {
	SubaccountBalances []SubaccountBalance `json:"subaccount_balances"`
}

GetSubaccountBalancesResponse defines model for GetSubaccountBalancesResponse.

type GetSubaccountBalancesResponse2

type GetSubaccountBalancesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSubaccountBalancesResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSubaccountBalancesResponse2

func ParseGetSubaccountBalancesResponse2(rsp *http.Response) (*GetSubaccountBalancesResponse2, error)

ParseGetSubaccountBalancesResponse2 parses an HTTP response from a GetSubaccountBalancesWithResponse call

func (GetSubaccountBalancesResponse2) ContentType

func (r GetSubaccountBalancesResponse2) ContentType() string

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

func (GetSubaccountBalancesResponse2) GetBody

func (r GetSubaccountBalancesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSubaccountBalancesResponse2) GetJSON200

func (r GetSubaccountBalancesResponse2) GetJSON200() *GetSubaccountBalancesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSubaccountBalancesResponse2) GetJSON401

func (r GetSubaccountBalancesResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSubaccountBalancesResponse2) GetJSON500

func (r GetSubaccountBalancesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSubaccountBalancesResponse2) Status

func (r GetSubaccountBalancesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSubaccountBalancesResponse2) StatusCode

func (r GetSubaccountBalancesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSubaccountNettingResponse

type GetSubaccountNettingResponse struct {
	NettingConfigs []SubaccountNettingConfig `json:"netting_configs"`
}

GetSubaccountNettingResponse defines model for GetSubaccountNettingResponse.

type GetSubaccountNettingResponse2

type GetSubaccountNettingResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSubaccountNettingResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSubaccountNettingResponse2

func ParseGetSubaccountNettingResponse2(rsp *http.Response) (*GetSubaccountNettingResponse2, error)

ParseGetSubaccountNettingResponse2 parses an HTTP response from a GetSubaccountNettingWithResponse call

func (GetSubaccountNettingResponse2) ContentType

func (r GetSubaccountNettingResponse2) ContentType() string

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

func (GetSubaccountNettingResponse2) GetBody

func (r GetSubaccountNettingResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSubaccountNettingResponse2) GetJSON200

func (r GetSubaccountNettingResponse2) GetJSON200() *GetSubaccountNettingResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSubaccountNettingResponse2) GetJSON401

func (r GetSubaccountNettingResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSubaccountNettingResponse2) GetJSON500

func (r GetSubaccountNettingResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSubaccountNettingResponse2) Status

func (r GetSubaccountNettingResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSubaccountNettingResponse2) StatusCode

func (r GetSubaccountNettingResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSubaccountTransfersParams

type GetSubaccountTransfersParams struct {
	// Limit Number of results per page. Defaults to 100.
	Limit *LimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetSubaccountTransfersParams defines parameters for GetSubaccountTransfers.

type GetSubaccountTransfersResponse

type GetSubaccountTransfersResponse struct {
	// Cursor Cursor for the next page of results.
	Cursor    *string              `json:"cursor,omitempty"`
	Transfers []SubaccountTransfer `json:"transfers"`
}

GetSubaccountTransfersResponse defines model for GetSubaccountTransfersResponse.

type GetSubaccountTransfersResponse2

type GetSubaccountTransfersResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetSubaccountTransfersResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetSubaccountTransfersResponse2

func ParseGetSubaccountTransfersResponse2(rsp *http.Response) (*GetSubaccountTransfersResponse2, error)

ParseGetSubaccountTransfersResponse2 parses an HTTP response from a GetSubaccountTransfersWithResponse call

func (GetSubaccountTransfersResponse2) ContentType

func (r GetSubaccountTransfersResponse2) ContentType() string

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

func (GetSubaccountTransfersResponse2) GetBody

func (r GetSubaccountTransfersResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSubaccountTransfersResponse2) GetJSON200

func (r GetSubaccountTransfersResponse2) GetJSON200() *GetSubaccountTransfersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSubaccountTransfersResponse2) GetJSON401

func (r GetSubaccountTransfersResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSubaccountTransfersResponse2) GetJSON500

func (r GetSubaccountTransfersResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSubaccountTransfersResponse2) Status

func (r GetSubaccountTransfersResponse2) Status() string

Status returns HTTPResponse.Status

func (GetSubaccountTransfersResponse2) StatusCode

func (r GetSubaccountTransfersResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTagsForSeriesCategoriesResponse

type GetTagsForSeriesCategoriesResponse struct {
	// TagsByCategories Mapping of series categories to their associated tags
	TagsByCategories map[string][]string `json:"tags_by_categories"`
}

GetTagsForSeriesCategoriesResponse defines model for GetTagsForSeriesCategoriesResponse.

type GetTagsForSeriesCategoriesResponse2

type GetTagsForSeriesCategoriesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetTagsForSeriesCategoriesResponse
}

func ParseGetTagsForSeriesCategoriesResponse2

func ParseGetTagsForSeriesCategoriesResponse2(rsp *http.Response) (*GetTagsForSeriesCategoriesResponse2, error)

ParseGetTagsForSeriesCategoriesResponse2 parses an HTTP response from a GetTagsForSeriesCategoriesWithResponse call

func (GetTagsForSeriesCategoriesResponse2) ContentType

func (r GetTagsForSeriesCategoriesResponse2) ContentType() string

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

func (GetTagsForSeriesCategoriesResponse2) GetBody

func (r GetTagsForSeriesCategoriesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTagsForSeriesCategoriesResponse2) GetJSON200

func (r GetTagsForSeriesCategoriesResponse2) GetJSON200() *GetTagsForSeriesCategoriesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTagsForSeriesCategoriesResponse2) Status

func (r GetTagsForSeriesCategoriesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetTagsForSeriesCategoriesResponse2) StatusCode

func (r GetTagsForSeriesCategoriesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTargetBalanceAllocationResponse

type GetTargetBalanceAllocationResponse struct {
	Allocations []TargetBalanceAllocation `json:"allocations"`

	// RestingMarginReservation Collateral an automatic rebalance leaves behind for resting orders. `none` reserves no
	// collateral for resting orders. `max` reserves the
	// largest single market-side commitment. `sum` reserves the summed margin of every resting order.
	RestingMarginReservation RestingMarginReservation `json:"resting_margin_reservation"`
}

GetTargetBalanceAllocationResponse defines model for GetTargetBalanceAllocationResponse.

type GetTargetBalanceAllocationResponse2

type GetTargetBalanceAllocationResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetTargetBalanceAllocationResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetTargetBalanceAllocationResponse2

func ParseGetTargetBalanceAllocationResponse2(rsp *http.Response) (*GetTargetBalanceAllocationResponse2, error)

ParseGetTargetBalanceAllocationResponse2 parses an HTTP response from a GetTargetBalanceAllocationWithResponse call

func (GetTargetBalanceAllocationResponse2) ContentType

func (r GetTargetBalanceAllocationResponse2) ContentType() string

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

func (GetTargetBalanceAllocationResponse2) GetBody

func (r GetTargetBalanceAllocationResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTargetBalanceAllocationResponse2) GetJSON200

func (r GetTargetBalanceAllocationResponse2) GetJSON200() *GetTargetBalanceAllocationResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTargetBalanceAllocationResponse2) GetJSON401

func (r GetTargetBalanceAllocationResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetTargetBalanceAllocationResponse2) GetJSON403

func (r GetTargetBalanceAllocationResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetTargetBalanceAllocationResponse2) GetJSON500

func (r GetTargetBalanceAllocationResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetTargetBalanceAllocationResponse2) Status

func (r GetTargetBalanceAllocationResponse2) Status() string

Status returns HTTPResponse.Status

func (GetTargetBalanceAllocationResponse2) StatusCode

func (r GetTargetBalanceAllocationResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTradesHistoricalParams

type GetTradesHistoricalParams struct {
	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// Limit Number of results per page. Defaults to 100. Maximum value is 1000.
	Limit *MarketLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,gte=0,lte=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// IsBlockTrade Filter trades by whether they are block trades. Omit to return all trades. Set to `true` to return only block trades. Set to `false` to return only non-block trades.
	IsBlockTrade *IsBlockTradeQuery `form:"is_block_trade,omitempty" json:"is_block_trade,omitempty"`
}

GetTradesHistoricalParams defines parameters for GetTradesHistorical.

type GetTradesHistoricalResponse

type GetTradesHistoricalResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetTradesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetTradesHistoricalResponse

func ParseGetTradesHistoricalResponse(rsp *http.Response) (*GetTradesHistoricalResponse, error)

ParseGetTradesHistoricalResponse parses an HTTP response from a GetTradesHistoricalWithResponse call

func (GetTradesHistoricalResponse) ContentType

func (r GetTradesHistoricalResponse) ContentType() string

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

func (GetTradesHistoricalResponse) GetBody

func (r GetTradesHistoricalResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTradesHistoricalResponse) GetJSON200

func (r GetTradesHistoricalResponse) GetJSON200() *GetTradesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTradesHistoricalResponse) GetJSON400

func (r GetTradesHistoricalResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetTradesHistoricalResponse) GetJSON404

func (r GetTradesHistoricalResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetTradesHistoricalResponse) GetJSON500

func (r GetTradesHistoricalResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetTradesHistoricalResponse) Status

func (r GetTradesHistoricalResponse) Status() string

Status returns HTTPResponse.Status

func (GetTradesHistoricalResponse) StatusCode

func (r GetTradesHistoricalResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTradesParams

type GetTradesParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 1000.
	Limit *MarketLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,gte=0,lte=1000"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Ticker Filter by market ticker
	Ticker TickerQuery `form:"ticker,omitempty" json:"ticker,omitempty"`

	// MinTs Filter items after this Unix timestamp
	MinTs *MinTsQuery `form:"min_ts,omitempty" json:"min_ts,omitempty"`

	// MaxTs Filter items before this Unix timestamp
	MaxTs *MaxTsQuery `form:"max_ts,omitempty" json:"max_ts,omitempty"`

	// IsBlockTrade Filter trades by whether they are block trades. Omit to return all trades. Set to `true` to return only block trades. Set to `false` to return only non-block trades.
	IsBlockTrade *IsBlockTradeQuery `form:"is_block_trade,omitempty" json:"is_block_trade,omitempty"`
}

GetTradesParams defines parameters for GetTrades.

type GetTradesResponse

type GetTradesResponse struct {
	Cursor string  `json:"cursor"`
	Trades []Trade `json:"trades"`
}

GetTradesResponse defines model for GetTradesResponse.

type GetTradesResponse2

type GetTradesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetTradesResponse
}

func ParseGetTradesResponse2

func ParseGetTradesResponse2(rsp *http.Response) (*GetTradesResponse2, error)

ParseGetTradesResponse2 parses an HTTP response from a GetTradesWithResponse call

func (GetTradesResponse2) ContentType

func (r GetTradesResponse2) ContentType() string

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

func (GetTradesResponse2) GetBody

func (r GetTradesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTradesResponse2) GetJSON200

func (r GetTradesResponse2) GetJSON200() *GetTradesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTradesResponse2) Status

func (r GetTradesResponse2) Status() string

Status returns HTTPResponse.Status

func (GetTradesResponse2) StatusCode

func (r GetTradesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserDataTimestampResponse

type GetUserDataTimestampResponse struct {
	// AsOfTime Timestamp when user data was last updated.
	AsOfTime time.Time `json:"as_of_time"`
}

GetUserDataTimestampResponse defines model for GetUserDataTimestampResponse.

type GetUserDataTimestampResponse2

type GetUserDataTimestampResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetUserDataTimestampResponse
}

func ParseGetUserDataTimestampResponse2

func ParseGetUserDataTimestampResponse2(rsp *http.Response) (*GetUserDataTimestampResponse2, error)

ParseGetUserDataTimestampResponse2 parses an HTTP response from a GetUserDataTimestampWithResponse call

func (GetUserDataTimestampResponse2) ContentType

func (r GetUserDataTimestampResponse2) ContentType() string

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

func (GetUserDataTimestampResponse2) GetBody

func (r GetUserDataTimestampResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetUserDataTimestampResponse2) GetJSON200

func (r GetUserDataTimestampResponse2) GetJSON200() *GetUserDataTimestampResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetUserDataTimestampResponse2) Status

func (r GetUserDataTimestampResponse2) Status() string

Status returns HTTPResponse.Status

func (GetUserDataTimestampResponse2) StatusCode

func (r GetUserDataTimestampResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWeatherIndexCalibrationsResponse

type GetWeatherIndexCalibrationsResponse struct {
	// Calibrations Configuration records, ascending by effective time.
	Calibrations []WeatherIndexCalibration `json:"calibrations"`

	// City Index city ID.
	City string `json:"city"`

	// Units Always `celsius` — offsets and the city reference are Celsius quantities from the index methodology (the published index value itself is Fahrenheit).
	Units string `json:"units"`
}

GetWeatherIndexCalibrationsResponse defines model for GetWeatherIndexCalibrationsResponse.

type GetWeatherIndexCalibrationsResponse2

type GetWeatherIndexCalibrationsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetWeatherIndexCalibrationsResponse
}

func ParseGetWeatherIndexCalibrationsResponse2

func ParseGetWeatherIndexCalibrationsResponse2(rsp *http.Response) (*GetWeatherIndexCalibrationsResponse2, error)

ParseGetWeatherIndexCalibrationsResponse2 parses an HTTP response from a GetWeatherIndexCalibrationsWithResponse call

func (GetWeatherIndexCalibrationsResponse2) ContentType

func (r GetWeatherIndexCalibrationsResponse2) ContentType() string

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

func (GetWeatherIndexCalibrationsResponse2) GetBody

func (r GetWeatherIndexCalibrationsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetWeatherIndexCalibrationsResponse2) GetJSON200

func (r GetWeatherIndexCalibrationsResponse2) GetJSON200() *GetWeatherIndexCalibrationsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetWeatherIndexCalibrationsResponse2) Status

func (r GetWeatherIndexCalibrationsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetWeatherIndexCalibrationsResponse2) StatusCode

func (r GetWeatherIndexCalibrationsResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWeatherIndexParams

type GetWeatherIndexParams struct {
	// From Window start, unix milliseconds (inclusive). Defaults to `to` minus 24 hours. Must be paired with `to` unless `last_sec` is used.
	From *int64 `form:"from,omitempty" json:"from,omitempty"`

	// To Window end, unix milliseconds (inclusive). Defaults to now.
	To *int64 `form:"to,omitempty" json:"to,omitempty"`

	// LastSec Trailing window in seconds; equivalent to `from=now-last_sec`, `to=now`. Mutually exclusive with `from`/`to`.
	LastSec *int64 `form:"last_sec,omitempty" json:"last_sec,omitempty"`

	// Detailed Include per-station audit readings on every point.
	Detailed *bool `form:"detailed,omitempty" json:"detailed,omitempty"`
}

GetWeatherIndexParams defines parameters for GetWeatherIndex.

type GetWeatherIndexResponse

type GetWeatherIndexResponse struct {
	// City Index city ID.
	City string `json:"city"`

	// ConfigVersion Index configuration version of the newest returned point (e.g. `miami-temperature-v1.0`). Empty when no points matched the window.
	ConfigVersion *string             `json:"config_version,omitempty"`
	Timeseries    []WeatherIndexPoint `json:"timeseries"`

	// Units Always `fahrenheit`.
	Units string `json:"units"`
}

GetWeatherIndexResponse defines model for GetWeatherIndexResponse.

type GetWeatherIndexResponse2

type GetWeatherIndexResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetWeatherIndexResponse
}

func ParseGetWeatherIndexResponse2

func ParseGetWeatherIndexResponse2(rsp *http.Response) (*GetWeatherIndexResponse2, error)

ParseGetWeatherIndexResponse2 parses an HTTP response from a GetWeatherIndexWithResponse call

func (GetWeatherIndexResponse2) ContentType

func (r GetWeatherIndexResponse2) ContentType() string

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

func (GetWeatherIndexResponse2) GetBody

func (r GetWeatherIndexResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetWeatherIndexResponse2) GetJSON200

func (r GetWeatherIndexResponse2) GetJSON200() *GetWeatherIndexResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetWeatherIndexResponse2) Status

func (r GetWeatherIndexResponse2) Status() string

Status returns HTTPResponse.Status

func (GetWeatherIndexResponse2) StatusCode

func (r GetWeatherIndexResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWithdrawalsParams

type GetWithdrawalsParams struct {
	// Limit Number of results per page. Defaults to 100. Maximum value is 500.
	Limit *WithdrawalLimitQuery `form:"limit,omitempty" json:"limit,omitempty" validate:"omitempty,min=1,max=500"`

	// Cursor Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
	Cursor CursorQuery `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetWithdrawalsParams defines parameters for GetWithdrawals.

type GetWithdrawalsResponse

type GetWithdrawalsResponse struct {
	Cursor      *string      `json:"cursor,omitempty"`
	Withdrawals []Withdrawal `json:"withdrawals"`
}

GetWithdrawalsResponse defines model for GetWithdrawalsResponse.

type GetWithdrawalsResponse2

type GetWithdrawalsResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GetWithdrawalsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseGetWithdrawalsResponse2

func ParseGetWithdrawalsResponse2(rsp *http.Response) (*GetWithdrawalsResponse2, error)

ParseGetWithdrawalsResponse2 parses an HTTP response from a GetWithdrawalsWithResponse call

func (GetWithdrawalsResponse2) ContentType

func (r GetWithdrawalsResponse2) ContentType() string

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

func (GetWithdrawalsResponse2) GetBody

func (r GetWithdrawalsResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (GetWithdrawalsResponse2) GetJSON200

func (r GetWithdrawalsResponse2) GetJSON200() *GetWithdrawalsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetWithdrawalsResponse2) GetJSON400

func (r GetWithdrawalsResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetWithdrawalsResponse2) GetJSON401

func (r GetWithdrawalsResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetWithdrawalsResponse2) GetJSON500

func (r GetWithdrawalsResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetWithdrawalsResponse2) Status

func (r GetWithdrawalsResponse2) Status() string

Status returns HTTPResponse.Status

func (GetWithdrawalsResponse2) StatusCode

func (r GetWithdrawalsResponse2) 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 IncentiveProgram

type IncentiveProgram struct {
	// DiscountFactorBps Discount factor in basis points (optional)
	DiscountFactorBps *int32 `json:"discount_factor_bps,omitempty"`

	// EndDate End date of the incentive program
	EndDate time.Time `json:"end_date"`

	// Id Unique identifier for the incentive program
	Id string `json:"id"`

	// IncentiveDescription Plain text description of the incentive program
	IncentiveDescription string `json:"incentive_description"`

	// IncentiveType Type of incentive program
	IncentiveType IncentiveProgramIncentiveType `json:"incentive_type"`

	// MarketId The unique identifier of the market associated with this incentive program
	MarketId string `json:"market_id"`

	// MarketTicker The ticker symbol of the market associated with this incentive program
	MarketTicker string `json:"market_ticker"`

	// MaxRewardPerAccount Maximum reward per account in centi-cents (optional)
	MaxRewardPerAccount *int64 `json:"max_reward_per_account,omitempty"`

	// PaidOut Whether the incentive has been paid out
	PaidOut bool `json:"paid_out"`

	// PeriodReward Total reward for the period in centi-cents
	PeriodReward int64 `json:"period_reward"`

	// StartDate Start date of the incentive program
	StartDate time.Time `json:"start_date"`

	// TargetSizeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	TargetSizeFp *FixedPointCount `json:"target_size_fp,omitempty"`
}

IncentiveProgram defines model for IncentiveProgram.

type IncentiveProgramIncentiveType

type IncentiveProgramIncentiveType string

IncentiveProgramIncentiveType Type of incentive program

const (
	IncentiveProgramIncentiveTypeLiquidity         IncentiveProgramIncentiveType = "liquidity"
	IncentiveProgramIncentiveTypeMarginMakerVolume IncentiveProgramIncentiveType = "margin_maker_volume"
	IncentiveProgramIncentiveTypeMarginTakerVolume IncentiveProgramIncentiveType = "margin_taker_volume"
	IncentiveProgramIncentiveTypeVolume            IncentiveProgramIncentiveType = "volume"
)

Defines values for IncentiveProgramIncentiveType.

func (IncentiveProgramIncentiveType) Valid

func (e IncentiveProgramIncentiveType) Valid() bool

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

type IndexedBalance

type IndexedBalance struct {
	// Balance Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Balance FixedPointDollars `json:"balance"`

	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`
}

IndexedBalance defines model for IndexedBalance.

type InternalServerError

type InternalServerError = ErrorResponse

InternalServerError defines model for InternalServerError.

type IntraExchangeInstanceTransfer

type IntraExchangeInstanceTransfer struct {
	// Amount Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Amount FixedPointDollars `json:"amount"`

	// CreatedTs Unix timestamp when the transfer was created
	CreatedTs int64 `json:"created_ts"`

	// Destination The exchange instance type
	Destination ExchangeInstance `json:"destination"`

	// DestinationExchangeShard Destination exchange shard index
	DestinationExchangeShard int `json:"destination_exchange_shard"`

	// Source The exchange instance type
	Source ExchangeInstance `json:"source"`

	// SourceExchangeShard Source exchange shard index
	SourceExchangeShard int `json:"source_exchange_shard"`

	// Status Transfer status.
	Status IntraExchangeInstanceTransferStatus `json:"status"`

	// TransferId Unique transfer id
	TransferId string `json:"transfer_id"`
}

IntraExchangeInstanceTransfer defines model for IntraExchangeInstanceTransfer.

type IntraExchangeInstanceTransferJSONRequestBody

type IntraExchangeInstanceTransferJSONRequestBody = IntraExchangeInstanceTransferRequest

IntraExchangeInstanceTransferJSONRequestBody defines body for IntraExchangeInstanceTransfer for application/json ContentType.

type IntraExchangeInstanceTransferRequest

type IntraExchangeInstanceTransferRequest struct {
	// Amount The amount to transfer in centicents
	Amount int64 `json:"amount"`

	// ClientTransferId Client ID for duplicate prevention. Reuse only for identical requests. Scoped to the user and both exchange instances and shards. Accepted transfers cannot be repeated with the same ID on the same route.
	// Only supported for primary accounts. Transfers involving numbered subaccounts reject this field. If omitted, each request creates a new transfer.
	ClientTransferId *openapi_types.UUID `json:"client_transfer_id,omitempty"`

	// Destination The exchange instance type
	Destination ExchangeInstance `json:"destination"`

	// DestinationExchangeShard Destination exchange shard index (default 0)
	DestinationExchangeShard int `json:"destination_exchange_shard,omitempty" validate:"gte=0,lte=100"`

	// DestinationSubaccount Destination subaccount number (default 0 for the primary account). Only supported for event contract to event contract transfers.
	DestinationSubaccount int `json:"destination_subaccount,omitempty" validate:"gte=0"`

	// Source The exchange instance type
	Source ExchangeInstance `json:"source"`

	// SourceExchangeShard Source exchange shard index (default 0)
	SourceExchangeShard int `json:"source_exchange_shard,omitempty" validate:"gte=0,lte=100"`

	// SourceSubaccount Source subaccount number (default 0 for the primary account). Only supported for event contract to event contract transfers.
	SourceSubaccount int `json:"source_subaccount,omitempty" validate:"gte=0"`
}

IntraExchangeInstanceTransferRequest defines model for IntraExchangeInstanceTransferRequest.

type IntraExchangeInstanceTransferResponse

type IntraExchangeInstanceTransferResponse struct {
	// TransferId The ID of the transfer that was created
	TransferId string `json:"transfer_id"`
}

IntraExchangeInstanceTransferResponse defines model for IntraExchangeInstanceTransferResponse.

type IntraExchangeInstanceTransferResponse2

type IntraExchangeInstanceTransferResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *IntraExchangeInstanceTransferResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseIntraExchangeInstanceTransferResponse2

func ParseIntraExchangeInstanceTransferResponse2(rsp *http.Response) (*IntraExchangeInstanceTransferResponse2, error)

ParseIntraExchangeInstanceTransferResponse2 parses an HTTP response from a IntraExchangeInstanceTransferWithResponse call

func (IntraExchangeInstanceTransferResponse2) ContentType

func (r IntraExchangeInstanceTransferResponse2) ContentType() string

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

func (IntraExchangeInstanceTransferResponse2) GetBody

func (r IntraExchangeInstanceTransferResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (IntraExchangeInstanceTransferResponse2) GetJSON200

func (r IntraExchangeInstanceTransferResponse2) GetJSON200() *IntraExchangeInstanceTransferResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IntraExchangeInstanceTransferResponse2) GetJSON400

func (r IntraExchangeInstanceTransferResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (IntraExchangeInstanceTransferResponse2) GetJSON401

func (r IntraExchangeInstanceTransferResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (IntraExchangeInstanceTransferResponse2) GetJSON403

func (r IntraExchangeInstanceTransferResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (IntraExchangeInstanceTransferResponse2) GetJSON500

func (r IntraExchangeInstanceTransferResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (IntraExchangeInstanceTransferResponse2) Status

func (r IntraExchangeInstanceTransferResponse2) Status() string

Status returns HTTPResponse.Status

func (IntraExchangeInstanceTransferResponse2) StatusCode

func (r IntraExchangeInstanceTransferResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IntraExchangeInstanceTransferStatus

type IntraExchangeInstanceTransferStatus string

IntraExchangeInstanceTransferStatus Transfer status.

const (
	IntraExchangeInstanceTransferStatusIntraExchangeInstanceTransferStatusComplete IntraExchangeInstanceTransferStatus = "complete"
	IntraExchangeInstanceTransferStatusIntraExchangeInstanceTransferStatusPending  IntraExchangeInstanceTransferStatus = "pending"
)

Defines values for IntraExchangeInstanceTransferStatus.

func (IntraExchangeInstanceTransferStatus) Valid

func (e IntraExchangeInstanceTransferStatus) Valid() bool

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

type IsBlockTradeQuery

type IsBlockTradeQuery = bool

IsBlockTradeQuery defines model for IsBlockTradeQuery.

type LimitQuery

type LimitQuery = int64

LimitQuery defines model for LimitQuery.

type ListFCMSubtradersResponse

type ListFCMSubtradersResponse struct {
	Subtraders []FCMSubtrader `json:"subtraders"`
}

ListFCMSubtradersResponse defines model for ListFCMSubtradersResponse.

type ListFCMSubtradersResponse2

type ListFCMSubtradersResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ListFCMSubtradersResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseListFCMSubtradersResponse2

func ParseListFCMSubtradersResponse2(rsp *http.Response) (*ListFCMSubtradersResponse2, error)

ParseListFCMSubtradersResponse2 parses an HTTP response from a ListFCMSubtradersWithResponse call

func (ListFCMSubtradersResponse2) ContentType

func (r ListFCMSubtradersResponse2) ContentType() string

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

func (ListFCMSubtradersResponse2) GetBody

func (r ListFCMSubtradersResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (ListFCMSubtradersResponse2) GetJSON200

func (r ListFCMSubtradersResponse2) GetJSON200() *ListFCMSubtradersResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListFCMSubtradersResponse2) GetJSON401

func (r ListFCMSubtradersResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListFCMSubtradersResponse2) GetJSON403

func (r ListFCMSubtradersResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListFCMSubtradersResponse2) GetJSON500

func (r ListFCMSubtradersResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListFCMSubtradersResponse2) Status

func (r ListFCMSubtradersResponse2) Status() string

Status returns HTTPResponse.Status

func (ListFCMSubtradersResponse2) StatusCode

func (r ListFCMSubtradersResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LiveData

type LiveData struct {
	// Details Live data details as a flexible object
	Details map[string]interface{} `json:"details"`

	// MilestoneId Milestone ID
	MilestoneId string `json:"milestone_id"`

	// Type Type of live data
	Type string `json:"type"`
}

LiveData defines model for LiveData.

type MaintenanceWindow

type MaintenanceWindow struct {
	// EndDatetime End date and time of the maintenance window.
	EndDatetime time.Time `json:"end_datetime"`

	// StartDatetime Start date and time of the maintenance window.
	StartDatetime time.Time `json:"start_datetime"`
}

MaintenanceWindow defines model for MaintenanceWindow.

type Market

type Market struct {
	CanCloseEarly bool `json:"can_close_early"`

	// CapStrike Maximum expiration value that leads to a YES settlement
	CapStrike   *float64  `json:"cap_strike,omitempty"`
	CloseTime   time.Time `json:"close_time"`
	CreatedTime time.Time `json:"created_time"`

	// CustomStrike Expiration value for each target that leads to a YES settlement
	CustomStrike *map[string]interface{} `json:"custom_strike,omitempty"`

	// EarlyCloseCondition The condition under which the market can close early
	EarlyCloseCondition string        `json:"early_close_condition,omitempty"`
	EventTicker         string        `json:"event_ticker"`
	ExchangeIndex       ExchangeIndex `json:"exchange_index"`

	// ExpectedExpirationTime Time when this market is expected to expire
	ExpectedExpirationTime *time.Time `json:"expected_expiration_time,omitempty"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	ExpirationTime time.Time `json:"expiration_time,omitzero"`

	// ExpirationValue The value that was considered for the settlement
	ExpirationValue string `json:"expiration_value"`

	// FeeWaiverExpirationTime Time when this market's fee waiver expires
	FeeWaiverExpirationTime *time.Time `json:"fee_waiver_expiration_time,omitempty"`

	// FloorStrike Minimum expiration value that leads to a YES settlement
	FloorStrike *float64 `json:"floor_strike,omitempty"`

	// FunctionalStrike Mapping from expiration values to settlement values
	FunctionalStrike *string `json:"functional_strike,omitempty"`

	// IsProvisional If true, the market may be removed after determination if there is no activity on it
	IsProvisional bool `json:"is_provisional,omitempty"`

	// LastPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	LastPriceDollars FixedPointDollars `json:"last_price_dollars"`

	// LatestExpirationTime Latest possible time for this market to expire
	LatestExpirationTime time.Time `json:"latest_expiration_time"`

	// MarketType Identifies the type of market
	MarketType MarketMarketType `json:"market_type"`

	// MveCollectionTicker The ticker of the multivariate event collection
	MveCollectionTicker string           `json:"mve_collection_ticker,omitempty"`
	MveSelectedLegs     []MveSelectedLeg `json:"mve_selected_legs,omitempty"`

	// NoAskDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoAskDollars FixedPointDollars `json:"no_ask_dollars"`

	// NoBidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoBidDollars FixedPointDollars `json:"no_bid_dollars"`

	// NoSubTitle Shortened title for the no side of this market
	NoSubTitle string `json:"no_sub_title"`

	// NotionalValueDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NotionalValueDollars FixedPointDollars `json:"notional_value_dollars"`

	// OccurrenceDatetime The recorded datetime when the underlying event occurred, if available
	OccurrenceDatetime *time.Time `json:"occurrence_datetime,omitempty"`

	// OpenInterestFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	OpenInterestFp FixedPointCount `json:"open_interest_fp"`
	OpenTime       time.Time       `json:"open_time"`

	// PreviousPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	PreviousPriceDollars FixedPointDollars `json:"previous_price_dollars"`

	// PreviousYesAskDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	PreviousYesAskDollars FixedPointDollars `json:"previous_yes_ask_dollars"`

	// PreviousYesBidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	PreviousYesBidDollars FixedPointDollars `json:"previous_yes_bid_dollars"`

	// PriceLevelStructure Price level structure for this market, defining price ranges and tick sizes
	PriceLevelStructure string `json:"price_level_structure"`

	// PriceRanges Valid price ranges for orders on this market
	PriceRanges           []PriceRange `json:"price_ranges"`
	PrimaryParticipantKey *string      `json:"primary_participant_key,omitempty"`
	Result                MarketResult `json:"result"`

	// RulesPrimary A plain language description of the most important market terms
	RulesPrimary string `json:"rules_primary"`

	// RulesSecondary A plain language description of secondary market terms
	RulesSecondary string `json:"rules_secondary"`

	// SettlementBoundsType Which settlement bounds apply to this market. default means the market has no settlement bounds
	SettlementBoundsType MarketSettlementBoundsType `json:"settlement_bounds_type"`

	// SettlementFloorDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	SettlementFloorDollars *FixedPointDollars `json:"settlement_floor_dollars,omitempty"`

	// SettlementTimerSeconds The amount of time after determination that the market settles
	SettlementTimerSeconds int `json:"settlement_timer_seconds"`

	// SettlementTs Timestamp when the market was settled. Only filled for settled markets
	SettlementTs *time.Time `json:"settlement_ts,omitempty"`

	// SettlementValueDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	SettlementValueDollars *FixedPointDollars `json:"settlement_value_dollars,omitempty"`

	// Status The current status of the market in its lifecycle.
	Status MarketStatus `json:"status"`

	// StrikeType Strike type defines how the market strike is defined and evaluated
	StrikeType MarketStrikeType `json:"strike_type,omitempty"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Subtitle string `json:"subtitle,omitempty"`
	Ticker   string `json:"ticker"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Title string `json:"title,omitempty"`

	// UpdatedTime Time of the last non-trading metadata update.
	UpdatedTime time.Time `json:"updated_time"`

	// Volume24hFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	Volume24hFp FixedPointCount `json:"volume_24h_fp"`

	// VolumeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	VolumeFp FixedPointCount `json:"volume_fp"`

	// YesAskDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesAskDollars FixedPointDollars `json:"yes_ask_dollars"`

	// YesAskSizeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	YesAskSizeFp FixedPointCount `json:"yes_ask_size_fp"`

	// YesBidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesBidDollars FixedPointDollars `json:"yes_bid_dollars"`

	// YesBidSizeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	YesBidSizeFp FixedPointCount `json:"yes_bid_size_fp"`

	// YesSubTitle Shortened title for the yes side of this market
	YesSubTitle string `json:"yes_sub_title"`
}

Market defines model for Market.

type MarketCandlestick

type MarketCandlestick struct {
	// EndPeriodTs Unix timestamp for the inclusive end of the candlestick period.
	EndPeriodTs int64 `json:"end_period_ts"`

	// OpenInterestFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	OpenInterestFp FixedPointCount   `json:"open_interest_fp"`
	Price          PriceDistribution `json:"price"`

	// VolumeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	VolumeFp FixedPointCount    `json:"volume_fp"`
	YesAsk   BidAskDistribution `json:"yes_ask"`
	YesBid   BidAskDistribution `json:"yes_bid"`
}

MarketCandlestick defines model for MarketCandlestick.

type MarketCandlestickHistorical

type MarketCandlestickHistorical struct {
	// EndPeriodTs Unix timestamp for the inclusive end of the candlestick period.
	EndPeriodTs int64 `json:"end_period_ts"`

	// OpenInterest Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	OpenInterest FixedPointCount             `json:"open_interest"`
	Price        PriceDistributionHistorical `json:"price"`

	// Volume Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	Volume FixedPointCount              `json:"volume"`
	YesAsk BidAskDistributionHistorical `json:"yes_ask"`
	YesBid BidAskDistributionHistorical `json:"yes_bid"`
}

MarketCandlestickHistorical defines model for MarketCandlestickHistorical.

type MarketCandlesticksResponse

type MarketCandlesticksResponse struct {
	// Candlesticks Array of candlestick data points for the market. Includes an initial data point at the start timestamp when available.
	Candlesticks []MarketCandlestick `json:"candlesticks"`

	// MarketTicker Market ticker string (e.g., 'INXD-24JAN01').
	MarketTicker string `json:"market_ticker"`
}

MarketCandlesticksResponse defines model for MarketCandlesticksResponse.

type MarketLimitQuery

type MarketLimitQuery = int64

MarketLimitQuery defines model for MarketLimitQuery.

type MarketMarketType

type MarketMarketType string

MarketMarketType Identifies the type of market

const (
	MarketMarketTypeBinary MarketMarketType = "binary"
	MarketMarketTypeScalar MarketMarketType = "scalar"
)

Defines values for MarketMarketType.

func (MarketMarketType) Valid

func (e MarketMarketType) Valid() bool

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

type MarketMetadata

type MarketMetadata struct {
	// ColorCode The color code for the market.
	ColorCode string `json:"color_code"`

	// ImageUrl A path to an image that represents this market.
	ImageUrl string `json:"image_url"`

	// MarketTicker The ticker of the market.
	MarketTicker string `json:"market_ticker"`
}

MarketMetadata defines model for MarketMetadata.

type MarketOrderbookFp

type MarketOrderbookFp struct {
	// OrderbookFp Orderbook with fixed-point contract counts (fp) in all dollar price levels.
	OrderbookFp OrderbookCountFp `json:"orderbook_fp"`
	Ticker      string           `json:"ticker"`
}

MarketOrderbookFp defines model for MarketOrderbookFp.

type MarketPosition

type MarketPosition struct {
	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FeesPaidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	FeesPaidDollars FixedPointDollars `json:"fees_paid_dollars"`

	// LastUpdatedTs Last time the position is updated
	LastUpdatedTs time.Time `json:"last_updated_ts"`

	// MarketExposureDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MarketExposureDollars FixedPointDollars `json:"market_exposure_dollars"`

	// PositionFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	PositionFp FixedPointCount `json:"position_fp"`

	// RealizedPnlDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	RealizedPnlDollars FixedPointDollars `json:"realized_pnl_dollars"`

	// Ticker Unique identifier for the market
	Ticker string `json:"ticker"`

	// TotalTradedDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TotalTradedDollars FixedPointDollars `json:"total_traded_dollars"`
}

MarketPosition defines model for MarketPosition.

type MarketResult

type MarketResult string

MarketResult defines model for Market.Result.

const (
	MarketResultEmpty  MarketResult = ""
	MarketResultNo     MarketResult = "no"
	MarketResultScalar MarketResult = "scalar"
	MarketResultYes    MarketResult = "yes"
)

Defines values for MarketResult.

func (MarketResult) Valid

func (e MarketResult) Valid() bool

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

type MarketSettlementBoundsType

type MarketSettlementBoundsType string

MarketSettlementBoundsType Which settlement bounds apply to this market. default means the market has no settlement bounds

const (
	MarketSettlementBoundsTypeDefault MarketSettlementBoundsType = "default"
	MarketSettlementBoundsTypeFloor   MarketSettlementBoundsType = "floor"
)

Defines values for MarketSettlementBoundsType.

func (MarketSettlementBoundsType) Valid

func (e MarketSettlementBoundsType) Valid() bool

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

type MarketStatus

type MarketStatus string

MarketStatus The current status of the market in its lifecycle.

const (
	MarketStatusActive      MarketStatus = "active"
	MarketStatusAmended     MarketStatus = "amended"
	MarketStatusClosed      MarketStatus = "closed"
	MarketStatusDetermined  MarketStatus = "determined"
	MarketStatusDisputed    MarketStatus = "disputed"
	MarketStatusFinalized   MarketStatus = "finalized"
	MarketStatusInactive    MarketStatus = "inactive"
	MarketStatusInitialized MarketStatus = "initialized"
)

Defines values for MarketStatus.

func (MarketStatus) Valid

func (e MarketStatus) Valid() bool

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

type MarketStatusQuery

type MarketStatusQuery string

MarketStatusQuery defines model for MarketStatusQuery.

const (
	MarketStatusQueryClosed   MarketStatusQuery = "closed"
	MarketStatusQueryOpen     MarketStatusQuery = "open"
	MarketStatusQueryPaused   MarketStatusQuery = "paused"
	MarketStatusQuerySettled  MarketStatusQuery = "settled"
	MarketStatusQueryUnopened MarketStatusQuery = "unopened"
)

Defines values for MarketStatusQuery.

func (MarketStatusQuery) Valid

func (e MarketStatusQuery) Valid() bool

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

type MarketStrikeType

type MarketStrikeType string

MarketStrikeType Strike type defines how the market strike is defined and evaluated

const (
	MarketStrikeTypeBetween        MarketStrikeType = "between"
	MarketStrikeTypeCustom         MarketStrikeType = "custom"
	MarketStrikeTypeFunctional     MarketStrikeType = "functional"
	MarketStrikeTypeGreater        MarketStrikeType = "greater"
	MarketStrikeTypeGreaterOrEqual MarketStrikeType = "greater_or_equal"
	MarketStrikeTypeLess           MarketStrikeType = "less"
	MarketStrikeTypeLessOrEqual    MarketStrikeType = "less_or_equal"
	MarketStrikeTypeStructured     MarketStrikeType = "structured"
)

Defines values for MarketStrikeType.

func (MarketStrikeType) Valid

func (e MarketStrikeType) Valid() bool

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

type MarketTickerQuery

type MarketTickerQuery = string

MarketTickerQuery defines model for MarketTickerQuery.

type MaxCloseTsQuery

type MaxCloseTsQuery = int64

MaxCloseTsQuery defines model for MaxCloseTsQuery.

type MaxCreatedTsQuery

type MaxCreatedTsQuery = int64

MaxCreatedTsQuery defines model for MaxCreatedTsQuery.

type MaxSettledTsQuery

type MaxSettledTsQuery = int64

MaxSettledTsQuery defines model for MaxSettledTsQuery.

type MaxTsQuery

type MaxTsQuery = int64

MaxTsQuery defines model for MaxTsQuery.

type MaxUpdatedTsQuery

type MaxUpdatedTsQuery = int64

MaxUpdatedTsQuery defines model for MaxUpdatedTsQuery.

type Milestone

type Milestone struct {
	// Category Category of the milestone. E.g. Sports, Elections, Esports, Crypto.
	//
	// Example: Sports
	Category string `json:"category"`

	// Details Additional details about the milestone.
	Details map[string]interface{} `json:"details"`

	// EndDate End date of the milestone, if any.
	EndDate *time.Time `json:"end_date,omitempty"`

	// Id Unique identifier for the milestone.
	Id string `json:"id"`

	// LastUpdatedTs Last time this structured target was updated.
	LastUpdatedTs time.Time `json:"last_updated_ts"`

	// NotificationMessage Notification message for the milestone.
	NotificationMessage string `json:"notification_message"`

	// PrimaryEventTickers List of event tickers directly related to the outcome of this milestone.
	PrimaryEventTickers []string `json:"primary_event_tickers"`

	// RelatedEventTickers List of event tickers related to this milestone.
	RelatedEventTickers []string `json:"related_event_tickers"`

	// SourceId Source id of milestone if available.
	SourceId *string `json:"source_id,omitempty"`

	// SourceIds Source ids of milestone if available.
	SourceIds *map[string]string `json:"source_ids,omitempty"`

	// StartDate Start date of the milestone.
	StartDate time.Time `json:"start_date"`

	// Title Title of the milestone.
	Title string `json:"title"`

	// Type Type of the milestone. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, golf_tournament, political_race.
	//
	// Example: football_game
	Type string `json:"type"`
}

Milestone defines model for Milestone.

type MinCloseTsQuery

type MinCloseTsQuery = int64

MinCloseTsQuery defines model for MinCloseTsQuery.

type MinCreatedTsQuery

type MinCreatedTsQuery = int64

MinCreatedTsQuery defines model for MinCreatedTsQuery.

type MinSettledTsQuery

type MinSettledTsQuery = int64

MinSettledTsQuery defines model for MinSettledTsQuery.

type MinTsQuery

type MinTsQuery = int64

MinTsQuery defines model for MinTsQuery.

type MinUpdatedTsQuery

type MinUpdatedTsQuery = int64

MinUpdatedTsQuery defines model for MinUpdatedTsQuery.

type MultipleEventTickerQuery

type MultipleEventTickerQuery = string

MultipleEventTickerQuery defines model for MultipleEventTickerQuery.

type MultivariateEventCollection

type MultivariateEventCollection struct {
	// AssociatedEventTickers [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints.
	AssociatedEventTickers []string `json:"associated_event_tickers"`

	// AssociatedEvents List of events with their individual configuration.
	AssociatedEvents []AssociatedEvent `json:"associated_events"`

	// CloseDate The close date of the collection. After this time, the collection cannot be interacted with.
	CloseDate time.Time `json:"close_date"`

	// CollectionTicker Unique identifier for the collection.
	CollectionTicker string `json:"collection_ticker"`

	// Description Short description of the collection.
	Description string `json:"description"`

	// ExchangeIndex Exchange index inherited from the collection's series.
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FunctionalDescription A functional description of the collection describing how inputs affect the output.
	FunctionalDescription string `json:"functional_description"`

	// IsAllYes [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of 'yes' may be used.
	IsAllYes bool `json:"is_all_yes"`

	// IsOrdered Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter.
	IsOrdered bool `json:"is_ordered"`

	// IsSingleMarketPerEvent [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.
	IsSingleMarketPerEvent bool `json:"is_single_market_per_event"`

	// OpenDate The open date of the collection. Before this time, the collection cannot be interacted with.
	OpenDate time.Time `json:"open_date"`

	// PriceLevelStructure Price level structure used for new markets created in this collection. Existing markets may differ; use the market's price_level_structure and price_ranges for its current pricing.
	PriceLevelStructure string `json:"price_level_structure"`

	// PriceRanges Price bands and tick sizes in fixed-point dollars for new markets created in this collection. Use these ranges to determine valid prices rather than hardcoding the structure name.
	PriceRanges []PriceRange `json:"price_ranges"`

	// SeriesTicker Series associated with the collection. Events produced in the collection will be associated with this series.
	SeriesTicker string `json:"series_ticker"`

	// SizeMax The maximum number of markets that must be passed into Lookup/Create (inclusive).
	SizeMax int32 `json:"size_max"`

	// SizeMin The minimum number of markets that must be passed into Lookup/Create (inclusive).
	SizeMin int32 `json:"size_min"`

	// Title Title of the collection.
	Title string `json:"title"`
}

MultivariateEventCollection defines model for MultivariateEventCollection.

type MveFilterQuery

type MveFilterQuery string

MveFilterQuery defines model for MveFilterQuery.

const (
	MveFilterQueryExclude MveFilterQuery = "exclude"
	MveFilterQueryOnly    MveFilterQuery = "only"
)

Defines values for MveFilterQuery.

func (MveFilterQuery) Valid

func (e MveFilterQuery) Valid() bool

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

type MveHistoricalFilterQuery

type MveHistoricalFilterQuery string

MveHistoricalFilterQuery defines model for MveHistoricalFilterQuery.

const (
	MveHistoricalFilterQueryExclude MveHistoricalFilterQuery = "exclude"
)

Defines values for MveHistoricalFilterQuery.

func (MveHistoricalFilterQuery) Valid

func (e MveHistoricalFilterQuery) Valid() bool

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

type MveSelectedLeg

type MveSelectedLeg struct {
	// EventTicker Unique identifier for the selected event
	EventTicker string `json:"event_ticker,omitempty"`

	// MarketTicker Unique identifier for the selected market
	MarketTicker string `json:"market_ticker,omitempty"`

	// Side The side of the selected market
	Side string `json:"side,omitempty"`

	// YesSettlementValueDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesSettlementValueDollars *FixedPointDollars `json:"yes_settlement_value_dollars,omitempty"`
}

MveSelectedLeg defines model for MveSelectedLeg.

type NotFoundError

type NotFoundError = ErrorResponse

NotFoundError defines model for NotFoundError.

type Order

type Order struct {
	// Action Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Action OrderAction `json:"action,omitempty"`

	// BookSide Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)
	BookSide BookSide `json:"book_side"`

	// CancelOrderOnPause If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason.
	CancelOrderOnPause *bool         `json:"cancel_order_on_pause,omitempty"`
	ClientOrderId      string        `json:"client_order_id"`
	CreatedTime        *time.Time    `json:"created_time"`
	ExchangeIndex      ExchangeIndex `json:"exchange_index"`
	ExpirationTime     *time.Time    `json:"expiration_time,omitempty"`

	// FillCountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	FillCountFp FixedPointCount `json:"fill_count_fp"`

	// InitialCountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	InitialCountFp FixedPointCount `json:"initial_count_fp"`

	// LastUpdateTime The last update to an order (modify, cancel, fill)
	LastUpdateTime *time.Time `json:"last_update_time,omitempty"`

	// MakerFeesDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MakerFeesDollars FixedPointDollars `json:"maker_fees_dollars"`

	// MakerFillCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MakerFillCostDollars FixedPointDollars `json:"maker_fill_cost_dollars"`

	// NoPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoPriceDollars FixedPointDollars `json:"no_price_dollars"`

	// OrderGroupId The order group this order is part of
	OrderGroupId *string `json:"order_group_id,omitempty"`
	OrderId      string  `json:"order_id"`

	// OutcomeSide The outcome side this order is positioned for. buy-yes and sell-no produce 'yes'; buy-no and sell-yes produce 'no'.
	//
	// `outcome_side` describes directional exposure only; it does not change the order's price. An order at price `p` with `outcome_side=no` is matched by an order at the same price `p` with `outcome_side=yes` — both parties trade at the same price, just on opposite directions.
	//
	// `outcome_side` and `book_side` will become the canonical way to determine order direction. The legacy `action`, `side`, and `is_yes` fields will be deprecated in a future release — please migrate to these new fields.
	OutcomeSide OrderOutcomeSide `json:"outcome_side"`

	// RemainingCountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	RemainingCountFp FixedPointCount `json:"remaining_count_fp"`

	// SelfTradePreventionType The self-trade prevention type for orders. `taker_at_cross` cancels the taker order when it would trade against another order from the same user; execution stops and any partial fills already matched are executed. `maker` cancels the resting maker order and continues matching.
	SelfTradePreventionType *SelfTradePreventionType `json:"self_trade_prevention_type"`

	// Side Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Side OrderSide `json:"side,omitempty"`

	// Status The status of an order
	Status OrderStatus `json:"status"`

	// SubaccountNumber Subaccount number (0 for primary, 1-63 for subaccounts).
	SubaccountNumber *int `json:"subaccount_number,omitempty"`

	// TakerFeesDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TakerFeesDollars FixedPointDollars `json:"taker_fees_dollars"`

	// TakerFillCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TakerFillCostDollars FixedPointDollars `json:"taker_fill_cost_dollars"`
	Ticker               string            `json:"ticker"`
	Type                 OrderType         `json:"type"`

	// UserId Unique identifier for users
	UserId string `json:"user_id"`

	// YesPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesPriceDollars FixedPointDollars `json:"yes_price_dollars"`
}

Order defines model for Order.

type OrderAction

type OrderAction string

OrderAction Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

const (
	OrderActionBuy  OrderAction = "buy"
	OrderActionSell OrderAction = "sell"
)

Defines values for OrderAction.

func (OrderAction) Valid

func (e OrderAction) Valid() bool

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

type OrderGroup

type OrderGroup struct {
	// ContractsLimitFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsLimitFp FixedPointCount `json:"contracts_limit_fp,omitempty"`
	ExchangeIndex    ExchangeIndex   `json:"exchange_index"`

	// Id Unique identifier for the order group
	Id string `json:"id"`

	// IsAutoCancelEnabled Whether auto-cancel is enabled for this order group
	IsAutoCancelEnabled bool `json:"is_auto_cancel_enabled"`
}

OrderGroup defines model for OrderGroup.

type OrderGroupIdPath

type OrderGroupIdPath = string

OrderGroupIdPath defines model for OrderGroupIdPath.

type OrderIdPath

type OrderIdPath = string

OrderIdPath defines model for OrderIdPath.

type OrderIdQuery

type OrderIdQuery = string

OrderIdQuery defines model for OrderIdQuery.

type OrderOutcomeSide

type OrderOutcomeSide string

OrderOutcomeSide The outcome side this order is positioned for. buy-yes and sell-no produce 'yes'; buy-no and sell-yes produce 'no'.

`outcome_side` describes directional exposure only; it does not change the order's price. An order at price `p` with `outcome_side=no` is matched by an order at the same price `p` with `outcome_side=yes` — both parties trade at the same price, just on opposite directions.

`outcome_side` and `book_side` will become the canonical way to determine order direction. The legacy `action`, `side`, and `is_yes` fields will be deprecated in a future release — please migrate to these new fields.

const (
	OrderOutcomeSideNo  OrderOutcomeSide = "no"
	OrderOutcomeSideYes OrderOutcomeSide = "yes"
)

Defines values for OrderOutcomeSide.

func (OrderOutcomeSide) Valid

func (e OrderOutcomeSide) Valid() bool

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

type OrderQueuePosition

type OrderQueuePosition struct {
	// MarketTicker The market ticker
	MarketTicker string `json:"market_ticker"`

	// OrderId The order ID
	OrderId string `json:"order_id"`

	// QueuePositionFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	QueuePositionFp FixedPointCount `json:"queue_position_fp"`
}

OrderQueuePosition defines model for OrderQueuePosition.

type OrderSide

type OrderSide string

OrderSide Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

const (
	OrderSideNo  OrderSide = "no"
	OrderSideYes OrderSide = "yes"
)

Defines values for OrderSide.

func (OrderSide) Valid

func (e OrderSide) Valid() bool

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

type OrderStatus

type OrderStatus string

OrderStatus The status of an order

const (
	OrderStatusCanceled OrderStatus = "canceled"
	OrderStatusExecuted OrderStatus = "executed"
	OrderStatusResting  OrderStatus = "resting"
)

Defines values for OrderStatus.

func (OrderStatus) Valid

func (e OrderStatus) Valid() bool

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

type OrderType

type OrderType string

OrderType defines model for Order.Type.

const (
	OrderTypeLimit  OrderType = "limit"
	OrderTypeMarket OrderType = "market"
)

Defines values for OrderType.

func (OrderType) Valid

func (e OrderType) Valid() bool

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

type OrderbookCountFp

type OrderbookCountFp struct {
	NoDollars  []PriceLevelDollarsCountFp `json:"no_dollars"`
	YesDollars []PriceLevelDollarsCountFp `json:"yes_dollars"`
}

OrderbookCountFp Orderbook with fixed-point contract counts (fp) in all dollar price levels.

type OutcomeSide

type OutcomeSide string

OutcomeSide Outcome side.

const (
	OutcomeSideOutcomeSideNo  OutcomeSide = "no"
	OutcomeSideOutcomeSideYes OutcomeSide = "yes"
)

Defines values for OutcomeSide.

func (OutcomeSide) Valid

func (e OutcomeSide) Valid() bool

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

type PercentilePoint

type PercentilePoint struct {
	// FormattedForecast The human-readable formatted forecast value.
	FormattedForecast string `json:"formatted_forecast"`

	// NumericalForecast The processed numerical forecast value.
	NumericalForecast float32 `json:"numerical_forecast"`

	// Percentile The percentile value (0-9999).
	Percentile int32 `json:"percentile"`

	// RawNumericalForecast The raw numerical forecast value.
	RawNumericalForecast float32 `json:"raw_numerical_forecast"`
}

PercentilePoint defines model for PercentilePoint.

type PlayByPlay

type PlayByPlay struct {
	Periods *[]struct {
		Events *[]map[string]interface{} `json:"events,omitempty"`
	} `json:"periods,omitempty"`
}

PlayByPlay Play-by-play data organized by period.

type PositionSettlementStatusQuery

type PositionSettlementStatusQuery string

PositionSettlementStatusQuery defines model for PositionSettlementStatusQuery.

const (
	PositionSettlementStatusQueryAll       PositionSettlementStatusQuery = "all"
	PositionSettlementStatusQuerySettled   PositionSettlementStatusQuery = "settled"
	PositionSettlementStatusQueryUnsettled PositionSettlementStatusQuery = "unsettled"
)

Defines values for PositionSettlementStatusQuery.

func (PositionSettlementStatusQuery) Valid

func (e PositionSettlementStatusQuery) Valid() bool

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

type PositionsCursorQuery

type PositionsCursorQuery = string

PositionsCursorQuery defines model for PositionsCursorQuery.

type PositionsLimitQuery

type PositionsLimitQuery = int32

PositionsLimitQuery defines model for PositionsLimitQuery.

type PriceDistribution

type PriceDistribution struct {
	// CloseDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	CloseDollars *FixedPointDollars `json:"close_dollars,omitempty"`

	// HighDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	HighDollars *FixedPointDollars `json:"high_dollars,omitempty"`

	// LowDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	LowDollars *FixedPointDollars `json:"low_dollars,omitempty"`

	// MaxDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MaxDollars *FixedPointDollars `json:"max_dollars,omitempty"`

	// MeanDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MeanDollars *FixedPointDollars `json:"mean_dollars,omitempty"`

	// MinDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	MinDollars *FixedPointDollars `json:"min_dollars,omitempty"`

	// OpenDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	OpenDollars *FixedPointDollars `json:"open_dollars,omitempty"`

	// PreviousDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	PreviousDollars *FixedPointDollars `json:"previous_dollars,omitempty"`
}

PriceDistribution defines model for PriceDistribution.

type PriceDistributionHistorical

type PriceDistributionHistorical struct {
	// Close Price of the last trade during the candlestick period (in dollars). Null if no trades occurred.
	Close *FixedPointDollars `json:"close"`

	// High Highest trade price during the candlestick period (in dollars). Null if no trades occurred.
	High *FixedPointDollars `json:"high"`

	// Low Lowest trade price during the candlestick period (in dollars). Null if no trades occurred.
	Low *FixedPointDollars `json:"low"`

	// Mean Volume-weighted average price during the candlestick period (in dollars). Null if no trades occurred.
	Mean *FixedPointDollars `json:"mean"`

	// Open Price of the first trade during the candlestick period (in dollars). Null if no trades occurred.
	Open *FixedPointDollars `json:"open"`

	// Previous Close price from the previous candlestick period (in dollars). Null if this is the first candlestick or no prior trade exists.
	Previous *FixedPointDollars `json:"previous"`
}

PriceDistributionHistorical defines model for PriceDistributionHistorical.

type PriceLevelDollarsCountFp

type PriceLevelDollarsCountFp = []string

PriceLevelDollarsCountFp Price level in dollars represented as [dollars_string, fp] where dollars_string is like "0.1500" and fp is a FixedPointCount string (fixed-point contract count). The second element is the contract quantity (not price).

Example: ["0.1500","100.00"]

type PriceRange

type PriceRange struct {
	// End Ending price for this range in dollars
	End string `json:"end"`

	// Start Starting price for this range in dollars
	Start string `json:"start"`

	// Step Price step/tick size for this range in dollars
	Step string `json:"step"`
}

PriceRange defines model for PriceRange.

type ProposeBlockTradeJSONRequestBody

type ProposeBlockTradeJSONRequestBody = ProposeBlockTradeRequest

ProposeBlockTradeJSONRequestBody defines body for ProposeBlockTrade for application/json ContentType.

type ProposeBlockTradeRequest

type ProposeBlockTradeRequest struct {
	// BuyerSubaccount User-managed subaccount number of the buyer (0 for primary, 1-63 for numbered subaccounts). Provide either this or buyer_subtrader_id, not both.
	BuyerSubaccount *int `json:"buyer_subaccount,omitempty"`

	// BuyerSubtraderId Subtrader ID of the buyer. Provide either this or buyer_subaccount, not both.
	BuyerSubtraderId string `json:"buyer_subtrader_id,omitempty"`

	// BuyerUserId User ID of the buyer
	BuyerUserId string `json:"buyer_user_id" validate:"required"`

	// Centicount Number of contracts in centicounts
	Centicount int64 `json:"centicount" validate:"required,gt=0"`

	// ExpirationTs Expiration time of the proposal
	ExpirationTs time.Time `json:"expiration_ts" validate:"required"`

	// MakerSide The maker side of the trade
	MakerSide ProposeBlockTradeRequestMakerSide `json:"maker_side" validate:"required,oneof=yes no"`

	// MarketTicker The ticker of the market for this block trade
	MarketTicker string `json:"market_ticker" validate:"required"`

	// PriceCentiCents Price in centi-cents
	PriceCentiCents int64 `json:"price_centi_cents" validate:"required,gt=0"`

	// SellerSubaccount User-managed subaccount number of the seller (0 for primary, 1-63 for numbered subaccounts). Provide either this or seller_subtrader_id, not both.
	SellerSubaccount *int `json:"seller_subaccount,omitempty"`

	// SellerSubtraderId Subtrader ID of the seller. Provide either this or seller_subaccount, not both.
	SellerSubtraderId string `json:"seller_subtrader_id,omitempty"`

	// SellerUserId User ID of the seller
	SellerUserId string `json:"seller_user_id" validate:"required"`
}

ProposeBlockTradeRequest defines model for ProposeBlockTradeRequest.

type ProposeBlockTradeRequestMakerSide

type ProposeBlockTradeRequestMakerSide string

ProposeBlockTradeRequestMakerSide The maker side of the trade

const (
	ProposeBlockTradeRequestMakerSideNo  ProposeBlockTradeRequestMakerSide = "no"
	ProposeBlockTradeRequestMakerSideYes ProposeBlockTradeRequestMakerSide = "yes"
)

Defines values for ProposeBlockTradeRequestMakerSide.

func (ProposeBlockTradeRequestMakerSide) Valid

func (e ProposeBlockTradeRequestMakerSide) Valid() bool

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

type ProposeBlockTradeResponse

type ProposeBlockTradeResponse struct {
	// BlockTradeProposalId The ID of the newly created block trade proposal
	BlockTradeProposalId string `json:"block_trade_proposal_id"`
}

ProposeBlockTradeResponse defines model for ProposeBlockTradeResponse.

type ProposeBlockTradeResponse2

type ProposeBlockTradeResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *ProposeBlockTradeResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseProposeBlockTradeResponse2

func ParseProposeBlockTradeResponse2(rsp *http.Response) (*ProposeBlockTradeResponse2, error)

ParseProposeBlockTradeResponse2 parses an HTTP response from a ProposeBlockTradeWithResponse call

func (ProposeBlockTradeResponse2) ContentType

func (r ProposeBlockTradeResponse2) ContentType() string

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

func (ProposeBlockTradeResponse2) GetBody

func (r ProposeBlockTradeResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (ProposeBlockTradeResponse2) GetJSON201

func (r ProposeBlockTradeResponse2) GetJSON201() *ProposeBlockTradeResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (ProposeBlockTradeResponse2) GetJSON400

func (r ProposeBlockTradeResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ProposeBlockTradeResponse2) GetJSON401

func (r ProposeBlockTradeResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ProposeBlockTradeResponse2) GetJSON403

func (r ProposeBlockTradeResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ProposeBlockTradeResponse2) GetJSON500

func (r ProposeBlockTradeResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ProposeBlockTradeResponse2) Status

func (r ProposeBlockTradeResponse2) Status() string

Status returns HTTPResponse.Status

func (ProposeBlockTradeResponse2) StatusCode

func (r ProposeBlockTradeResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Quote

type Quote struct {
	// AcceptedSide The side that was accepted (yes or no)
	AcceptedSide *QuoteAcceptedSide `json:"accepted_side,omitempty"`

	// AcceptedTs Timestamp when the quote was accepted
	AcceptedTs *time.Time `json:"accepted_ts,omitempty"`

	// CancellationReason Reason for quote cancellation if cancelled
	CancellationReason string `json:"cancellation_reason,omitempty"`

	// CancelledTs Timestamp when the quote was cancelled
	CancelledTs *time.Time `json:"cancelled_ts,omitempty"`

	// ConfirmedTs Timestamp when the quote was confirmed
	ConfirmedTs *time.Time `json:"confirmed_ts,omitempty"`

	// ContractsFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsFp FixedPointCount `json:"contracts_fp"`

	// CreatedTs Timestamp when the quote was created
	CreatedTs time.Time `json:"created_ts"`

	// CreatorId Public communications ID of the quote creator
	CreatorId string `json:"creator_id"`

	// CreatorOrderId Order ID for the quote creator (private field)
	CreatorOrderId string `json:"creator_order_id,omitempty"`

	// CreatorSubaccount Subaccount number of the quote creator (visible when the caller is the quote creator)
	CreatorSubaccount *int `json:"creator_subaccount,omitempty"`

	// CreatorUserId User ID of the quote creator (private field)
	CreatorUserId string `json:"creator_user_id,omitempty"`

	// ExecutedTs Timestamp when the quote was executed
	ExecutedTs *time.Time `json:"executed_ts,omitempty"`

	// Id UUID of the quote. Preserve the exact returned string.
	Id string `json:"id"`

	// MarketTicker The ticker of the market this quote is for
	MarketTicker string `json:"market_ticker"`

	// NoBidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoBidDollars FixedPointDollars `json:"no_bid_dollars"`

	// NoContractsFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	NoContractsFp *FixedPointCount `json:"no_contracts_fp,omitempty"`

	// PostOnly Whether the quote creator's order is post-only (visible when the caller is the quote creator)
	PostOnly *bool `json:"post_only,omitempty"`

	// RestRemainder Whether to rest the remainder of the quote after execution
	RestRemainder *bool `json:"rest_remainder,omitempty"`

	// RfqCreatorId Public communications ID of the RFQ creator (pseudonymous). When obscure_creator_id is enabled, other users receive the shared placeholder "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" (SHA-256 of empty input). The creator sees their normal ID. After this quote executes successfully, its counterparty sees the normal public communications ID.
	RfqCreatorId string `json:"rfq_creator_id"`

	// RfqCreatorOrderId Order ID for the RFQ creator (private field)
	RfqCreatorOrderId string `json:"rfq_creator_order_id,omitempty"`

	// RfqCreatorSubaccount Subaccount number of the RFQ creator (visible when the caller is the RFQ creator)
	RfqCreatorSubaccount *int `json:"rfq_creator_subaccount,omitempty"`

	// RfqCreatorUserId User ID of the RFQ creator (private field)
	RfqCreatorUserId string `json:"rfq_creator_user_id,omitempty"`

	// RfqId UUID of the RFQ this quote is responding to.
	RfqId string `json:"rfq_id"`

	// RfqTargetCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	RfqTargetCostDollars *FixedPointDollars `json:"rfq_target_cost_dollars,omitempty"`

	// Status Current status of the quote
	Status QuoteStatus `json:"status"`

	// TargetCostExcludesFees True when the RFQ's target cost is principal-only and the contracts-offered sizes were computed without reserving taker fees (fees are charged on top of the target cost).
	TargetCostExcludesFees bool `json:"target_cost_excludes_fees,omitempty"`

	// UpdatedTs Timestamp when the quote was last updated
	UpdatedTs time.Time `json:"updated_ts"`

	// YesBidDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesBidDollars FixedPointDollars `json:"yes_bid_dollars"`

	// YesContractsFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	YesContractsFp *FixedPointCount `json:"yes_contracts_fp,omitempty"`
}

Quote defines model for Quote.

type QuoteAcceptedSide

type QuoteAcceptedSide string

QuoteAcceptedSide The side that was accepted (yes or no)

const (
	QuoteAcceptedSideNo  QuoteAcceptedSide = "no"
	QuoteAcceptedSideYes QuoteAcceptedSide = "yes"
)

Defines values for QuoteAcceptedSide.

func (QuoteAcceptedSide) Valid

func (e QuoteAcceptedSide) Valid() bool

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

type QuoteIdPath

type QuoteIdPath = string

QuoteIdPath defines model for QuoteIdPath.

type QuoteStatus

type QuoteStatus string

QuoteStatus Current status of the quote

const (
	QuoteStatusAccepted  QuoteStatus = "accepted"
	QuoteStatusCancelled QuoteStatus = "cancelled"
	QuoteStatusConfirmed QuoteStatus = "confirmed"
	QuoteStatusExecuted  QuoteStatus = "executed"
	QuoteStatusOpen      QuoteStatus = "open"
)

Defines values for QuoteStatus.

func (QuoteStatus) Valid

func (e QuoteStatus) Valid() bool

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

type RFQ

type RFQ struct {
	// CancellationReason Reason for RFQ cancellation if cancelled
	CancellationReason string `json:"cancellation_reason,omitempty"`

	// CancelledTs Timestamp when the RFQ was cancelled
	CancelledTs *time.Time `json:"cancelled_ts,omitempty"`

	// ContractsFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsFp FixedPointCount `json:"contracts_fp"`

	// CreatedTs Timestamp when the RFQ was created
	CreatedTs time.Time `json:"created_ts"`

	// CreatorId Public communications ID of the RFQ creator (pseudonymous). When obscure_creator_id is enabled, other users receive the shared placeholder "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" (SHA-256 of empty input). The creator sees their normal ID. After successful quote execution, subsequent RFQ responses show the normal public communications ID to all viewers.
	CreatorId string `json:"creator_id"`

	// CreatorSubaccount Subaccount number of the RFQ creator (visible when the caller is the RFQ creator)
	CreatorSubaccount *int `json:"creator_subaccount,omitempty"`

	// CreatorUserId User ID of the RFQ creator (private field)
	CreatorUserId string `json:"creator_user_id,omitempty"`

	// Id UUID of the RFQ. Preserve the exact returned string.
	Id string `json:"id"`

	// MarketTicker The ticker of the market this RFQ is for
	MarketTicker string `json:"market_ticker"`

	// MveCollectionTicker Ticker of the MVE collection this market belongs to
	MveCollectionTicker string `json:"mve_collection_ticker,omitempty"`

	// MveSelectedLegs Selected legs for the MVE collection
	MveSelectedLegs []MveSelectedLeg `json:"mve_selected_legs,omitempty"`

	// RestRemainder Whether to rest the remainder of the RFQ after execution
	RestRemainder *bool `json:"rest_remainder,omitempty"`

	// Status Current status of the RFQ (open, closed)
	Status RFQStatus `json:"status"`

	// TargetCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	TargetCostDollars *FixedPointDollars `json:"target_cost_dollars,omitempty"`

	// TargetCostExcludesFees True when the target cost is principal-only and quote sizes are computed without reserving taker fees (fees are charged on top).
	TargetCostExcludesFees bool `json:"target_cost_excludes_fees,omitempty"`

	// UpdatedTs Timestamp when the RFQ was last updated
	UpdatedTs *time.Time `json:"updated_ts,omitempty"`
}

RFQ defines model for RFQ.

type RFQStatus

type RFQStatus string

RFQStatus Current status of the RFQ (open, closed)

const (
	RFQStatusClosed RFQStatus = "closed"
	RFQStatusOpen   RFQStatus = "open"
)

Defines values for RFQStatus.

func (RFQStatus) Valid

func (e RFQStatus) Valid() bool

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

type RateLimitError

type RateLimitError = ErrorResponse

RateLimitError defines model for RateLimitError.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResetOrderGroupJSONRequestBody

type ResetOrderGroupJSONRequestBody = EmptyResponse

ResetOrderGroupJSONRequestBody defines body for ResetOrderGroup for application/json ContentType.

type ResetOrderGroupParams

type ResetOrderGroupParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0.
	ExchangeIndex ExchangeIndexQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`
}

ResetOrderGroupParams defines parameters for ResetOrderGroup.

type ResetOrderGroupResponse

type ResetOrderGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseResetOrderGroupResponse

func ParseResetOrderGroupResponse(rsp *http.Response) (*ResetOrderGroupResponse, error)

ParseResetOrderGroupResponse parses an HTTP response from a ResetOrderGroupWithResponse call

func (ResetOrderGroupResponse) ContentType

func (r ResetOrderGroupResponse) ContentType() string

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

func (ResetOrderGroupResponse) GetBody

func (r ResetOrderGroupResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ResetOrderGroupResponse) GetJSON200

func (r ResetOrderGroupResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ResetOrderGroupResponse) GetJSON401

func (r ResetOrderGroupResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ResetOrderGroupResponse) GetJSON404

func (r ResetOrderGroupResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ResetOrderGroupResponse) GetJSON500

func (r ResetOrderGroupResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ResetOrderGroupResponse) Status

func (r ResetOrderGroupResponse) Status() string

Status returns HTTPResponse.Status

func (ResetOrderGroupResponse) StatusCode

func (r ResetOrderGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RestingMarginReservation

type RestingMarginReservation string

RestingMarginReservation Collateral an automatic rebalance leaves behind for resting orders. `none` reserves no collateral for resting orders. `max` reserves the largest single market-side commitment. `sum` reserves the summed margin of every resting order.

const (
	RestingMarginReservationRestingMarginReservationMax  RestingMarginReservation = "max"
	RestingMarginReservationRestingMarginReservationNone RestingMarginReservation = "none"
	RestingMarginReservationRestingMarginReservationSum  RestingMarginReservation = "sum"
)

Defines values for RestingMarginReservation.

func (RestingMarginReservation) Valid

func (e RestingMarginReservation) Valid() bool

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

type RfqIdPath

type RfqIdPath = string

RfqIdPath defines model for RfqIdPath.

type Schedule

type Schedule struct {
	// MaintenanceWindows Scheduled maintenance windows, during which the exchange may be unavailable.
	MaintenanceWindows []MaintenanceWindow `json:"maintenance_windows"`

	// StandardHours The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable.
	StandardHours []WeeklySchedule `json:"standard_hours"`
}

Schedule defines model for Schedule.

type ScopeList

type ScopeList struct {
	// Scopes List of scopes
	Scopes []string `json:"scopes"`
}

ScopeList defines model for ScopeList.

type SelfTradePreventionType

type SelfTradePreventionType string

SelfTradePreventionType The self-trade prevention type for orders. `taker_at_cross` cancels the taker order when it would trade against another order from the same user; execution stops and any partial fills already matched are executed. `maker` cancels the resting maker order and continues matching.

const (
	SelfTradePreventionTypeMaker        SelfTradePreventionType = "maker"
	SelfTradePreventionTypeTakerAtCross SelfTradePreventionType = "taker_at_cross"
)

Defines values for SelfTradePreventionType.

func (SelfTradePreventionType) Valid

func (e SelfTradePreventionType) Valid() bool

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

type Series

type Series struct {
	// AdditionalProhibitions AdditionalProhibitions is a list of additional trading prohibitions for this series.
	AdditionalProhibitions *[]string `json:"additional_prohibitions"`

	// Categories Categories is the list of discovery categories for this series. The `category` filter on Get Series List matches any entry in this list. May be empty.
	Categories []string `json:"categories"`

	// Category Category is the primary category of this series.
	Category string `json:"category"`

	// ContractTermsUrl ContractTermsUrl is the URL to the current terms of the contract underlying the series.
	ContractTermsUrl string `json:"contract_terms_url"`

	// ContractUrl ContractUrl provides a direct link to the original filing of the contract which underlies the series.
	ContractUrl   string        `json:"contract_url"`
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FeeMultiplier FeeMultiplier is a floating point multiplier applied to the fee calculations.
	FeeMultiplier float64 `json:"fee_multiplier"`

	// FeeType FeeType is a string representing the series' fee structure. Fee structures can be found at https://kalshi.com/docs/kalshi-fee-schedule.pdf. 'quadratic' is described by the General Trading Fees Table, 'quadratic_with_maker_fees' is described by the General Trading Fees Table with maker fees described in the Maker Fees section, 'quadratic_with_combo_maker_fees' is the same maker-fee structure with a 0.5 maker multiplier instead of 0.25, 'flat' is described by the Specific Trading Fees Table.
	FeeType FeeType `json:"fee_type"`

	// Frequency Description of the frequency of the series. There is no fixed value set here, but will be something human-readable like weekly, daily, one-off.
	Frequency string `json:"frequency"`

	// LastUpdatedTs Timestamp of when this series' metadata was last updated.
	LastUpdatedTs *time.Time `json:"last_updated_ts,omitempty"`

	// ProductMetadata Internal product metadata of the series.
	ProductMetadata *map[string]interface{} `json:"product_metadata,omitempty"`

	// SettlementSources SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook.
	SettlementSources *[]SettlementSource `json:"settlement_sources"`

	// Tags Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags.
	Tags *[]string `json:"tags"`

	// Ticker Ticker that identifies this series.
	Ticker string `json:"ticker"`

	// Title Title describing the series. For full context use you should use this field with the title field of the events belonging to this series.
	Title string `json:"title"`

	// VolumeFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	VolumeFp *FixedPointCount `json:"volume_fp,omitempty"`
}

Series defines model for Series.

type SeriesFeeChange

type SeriesFeeChange struct {
	// FeeMultiplier New fee multiplier for the series
	FeeMultiplier float64 `json:"fee_multiplier"`

	// FeeType New fee type for the series
	FeeType FeeType `json:"fee_type"`

	// Id Unique identifier for this fee change
	Id string `json:"id"`

	// ScheduledTs Timestamp when this fee change is scheduled to take effect
	ScheduledTs time.Time `json:"scheduled_ts"`

	// SeriesTicker Series ticker this fee change applies to
	SeriesTicker string `json:"series_ticker"`
}

SeriesFeeChange defines model for SeriesFeeChange.

type SeriesTickerQuery

type SeriesTickerQuery = string

SeriesTickerQuery defines model for SeriesTickerQuery.

type ServiceUnavailableError

type ServiceUnavailableError = ErrorResponse

ServiceUnavailableError defines model for ServiceUnavailableError.

type SetTargetBalanceAllocationJSONRequestBody

type SetTargetBalanceAllocationJSONRequestBody = SetTargetBalanceAllocationRequest

SetTargetBalanceAllocationJSONRequestBody defines body for SetTargetBalanceAllocation for application/json ContentType.

type SetTargetBalanceAllocationRequest

type SetTargetBalanceAllocationRequest struct {
	Allocations []TargetBalanceAllocationInput `json:"allocations" validate:"max=101,dive"`

	// RestingMarginReservation Defaults to `sum` when omitted.
	RestingMarginReservation RestingMarginReservation `json:"resting_margin_reservation,omitempty" validate:"omitempty,oneof=none max sum"`
}

SetTargetBalanceAllocationRequest defines model for SetTargetBalanceAllocationRequest.

type SetTargetBalanceAllocationResponse

type SetTargetBalanceAllocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseSetTargetBalanceAllocationResponse

func ParseSetTargetBalanceAllocationResponse(rsp *http.Response) (*SetTargetBalanceAllocationResponse, error)

ParseSetTargetBalanceAllocationResponse parses an HTTP response from a SetTargetBalanceAllocationWithResponse call

func (SetTargetBalanceAllocationResponse) ContentType

func (r SetTargetBalanceAllocationResponse) ContentType() string

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

func (SetTargetBalanceAllocationResponse) GetBody

func (r SetTargetBalanceAllocationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetTargetBalanceAllocationResponse) GetJSON200

func (r SetTargetBalanceAllocationResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetTargetBalanceAllocationResponse) GetJSON400

func (r SetTargetBalanceAllocationResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (SetTargetBalanceAllocationResponse) GetJSON401

func (r SetTargetBalanceAllocationResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SetTargetBalanceAllocationResponse) GetJSON403

func (r SetTargetBalanceAllocationResponse) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (SetTargetBalanceAllocationResponse) GetJSON500

func (r SetTargetBalanceAllocationResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (SetTargetBalanceAllocationResponse) Status

func (r SetTargetBalanceAllocationResponse) Status() string

Status returns HTTPResponse.Status

func (SetTargetBalanceAllocationResponse) StatusCode

func (r SetTargetBalanceAllocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Settlement

type Settlement struct {
	// EventTicker The event ticker symbol of the market that was settled.
	EventTicker string `json:"event_ticker"`

	// ExchangeIndex Identifier for an exchange shard.
	//
	// Example: 0
	ExchangeIndex ExchangeIndex `json:"exchange_index"`

	// FeeCost Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	FeeCost FixedPointDollars `json:"fee_cost"`

	// MarketResult The outcome of the market settlement. 'yes' = market resolved to YES, 'no' = market resolved to NO, 'scalar' = scalar market settled at a specific value.
	MarketResult SettlementMarketResult `json:"market_result"`

	// NoCountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	NoCountFp FixedPointCount `json:"no_count_fp"`

	// NoTotalCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoTotalCostDollars FixedPointDollars `json:"no_total_cost_dollars"`

	// Revenue Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each).
	Revenue int `json:"revenue"`

	// SettledTime Timestamp when the market was settled and payouts were processed.
	SettledTime time.Time `json:"settled_time"`

	// Ticker The ticker symbol of the market that was settled.
	Ticker string `json:"ticker"`

	// Value Payout of a single yes contract in cents.
	Value *int `json:"value,omitempty"`

	// YesCountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	YesCountFp FixedPointCount `json:"yes_count_fp"`

	// YesTotalCostDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesTotalCostDollars FixedPointDollars `json:"yes_total_cost_dollars"`
}

Settlement defines model for Settlement.

type SettlementMarketResult

type SettlementMarketResult string

SettlementMarketResult The outcome of the market settlement. 'yes' = market resolved to YES, 'no' = market resolved to NO, 'scalar' = scalar market settled at a specific value.

const (
	SettlementMarketResultNo     SettlementMarketResult = "no"
	SettlementMarketResultScalar SettlementMarketResult = "scalar"
	SettlementMarketResultYes    SettlementMarketResult = "yes"
)

Defines values for SettlementMarketResult.

func (SettlementMarketResult) Valid

func (e SettlementMarketResult) Valid() bool

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

type SettlementSource

type SettlementSource struct {
	// Name Name of the settlement source
	Name string `json:"name,omitempty"`

	// Url URL to the settlement source
	Url string `json:"url,omitempty"`
}

SettlementSource defines model for SettlementSource.

type SingleEventTickerQuery

type SingleEventTickerQuery = string

SingleEventTickerQuery defines model for SingleEventTickerQuery.

type SportFilterDetails

type SportFilterDetails struct {
	// Competitions Mapping of competitions to their scope lists
	Competitions map[string]ScopeList `json:"competitions"`

	// Scopes List of scopes available for this sport
	Scopes []string `json:"scopes"`
}

SportFilterDetails defines model for SportFilterDetails.

type StatusQuery

type StatusQuery = string

StatusQuery defines model for StatusQuery.

type StructuredTarget

type StructuredTarget struct {
	// Details Additional details about the structured target. Contains flexible JSON data specific to the target type.
	Details *map[string]interface{} `json:"details,omitempty"`

	// Id Unique identifier for the structured target.
	Id *string `json:"id,omitempty"`

	// LastUpdatedTs Timestamp when this structured target was last updated.
	LastUpdatedTs *time.Time `json:"last_updated_ts,omitempty"`

	// Name Name of the structured target.
	Name *string `json:"name,omitempty"`

	// SourceId External source identifier for the structured target, if available (e.g., third-party data provider ID).
	SourceId *string `json:"source_id,omitempty"`

	// SourceIds Source ids of structured target if available.
	SourceIds *map[string]string `json:"source_ids,omitempty"`

	// Type Type of the structured target.
	Type *string `json:"type,omitempty"`
}

StructuredTarget defines model for StructuredTarget.

type SubaccountBalance

type SubaccountBalance struct {
	// Balance Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Balance FixedPointDollars `json:"balance"`

	// ExchangeIndex Exchange index the balance is held on.
	ExchangeIndex int `json:"exchange_index"`

	// SubaccountNumber Subaccount number (0 for primary, 1-63 for subaccounts).
	SubaccountNumber int `json:"subaccount_number"`

	// UpdatedTs Unix timestamp of last balance update.
	UpdatedTs int64 `json:"updated_ts"`
}

SubaccountBalance defines model for SubaccountBalance.

type SubaccountNettingConfig

type SubaccountNettingConfig struct {
	// Enabled Whether netting is enabled for this subaccount.
	Enabled bool `json:"enabled"`

	// ExchangeIndex Exchange index of the subaccount.
	ExchangeIndex int `json:"exchange_index"`

	// SubaccountNumber Subaccount number (0 for primary, 1-63 for subaccounts).
	SubaccountNumber int `json:"subaccount_number"`
}

SubaccountNettingConfig defines model for SubaccountNettingConfig.

type SubaccountQuery

type SubaccountQuery = int

SubaccountQuery defines model for SubaccountQuery.

type SubaccountQueryDefaultPrimary

type SubaccountQueryDefaultPrimary = int

SubaccountQueryDefaultPrimary defines model for SubaccountQueryDefaultPrimary.

type SubaccountTransfer

type SubaccountTransfer struct {
	// AmountCents Cash transfer amount in cents.
	AmountCents int64 `json:"amount_cents"`

	// CreatedTs Unix timestamp when the transfer was created.
	CreatedTs int64 `json:"created_ts"`

	// ExchangeIndex Exchange index the transfer was applied on.
	ExchangeIndex int `json:"exchange_index"`

	// FromSubaccount Source subaccount number (0 for primary, 1-63 for subaccounts).
	FromSubaccount int `json:"from_subaccount"`

	// ToSubaccount Destination subaccount number (0 for primary, 1-63 for subaccounts).
	ToSubaccount int `json:"to_subaccount"`

	// TransferId Unique identifier for this transfer.
	TransferId string `json:"transfer_id"`
}

SubaccountTransfer defines model for SubaccountTransfer.

type TargetBalanceAllocation

type TargetBalanceAllocation struct {
	// ExchangeIndex Exchange index that receives this percentage of sweepable balance
	ExchangeIndex int `json:"exchange_index"`

	// Percent Target percentage of sweepable balance for the exchange index
	Percent int `json:"percent"`
}

TargetBalanceAllocation defines model for TargetBalanceAllocation.

type TargetBalanceAllocationInput

type TargetBalanceAllocationInput struct {
	// ExchangeIndex Exchange index that receives this percentage of sweepable balance
	ExchangeIndex *int `json:"exchange_index" validate:"required,gte=0"`

	// Percent Target percentage of sweepable balance for the exchange index
	Percent *int `json:"percent" validate:"required,gte=0,lte=100"`
}

TargetBalanceAllocationInput defines model for TargetBalanceAllocationInput.

type TickerPair

type TickerPair struct {
	// EventTicker Event ticker identifier.
	EventTicker string `json:"event_ticker"`

	// MarketTicker Market ticker identifier.
	MarketTicker string `json:"market_ticker"`

	// Side Side of the market (yes or no).
	Side TickerPairSide `json:"side" validate:"required,oneof=yes no"`
}

TickerPair defines model for TickerPair.

type TickerPairSide

type TickerPairSide string

TickerPairSide Side of the market (yes or no).

const (
	TickerPairSideNo  TickerPairSide = "no"
	TickerPairSideYes TickerPairSide = "yes"
)

Defines values for TickerPairSide.

func (TickerPairSide) Valid

func (e TickerPairSide) Valid() bool

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

type TickerPath

type TickerPath = string

TickerPath defines model for TickerPath.

type TickerQuery

type TickerQuery = string

TickerQuery defines model for TickerQuery.

type TickersQuery

type TickersQuery = string

TickersQuery defines model for TickersQuery.

type Trade

type Trade struct {
	// CountFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	CountFp FixedPointCount `json:"count_fp"`

	// CreatedTime Timestamp when this trade was executed
	CreatedTime time.Time `json:"created_time"`

	// IsBlockTrade True if this trade was matched off-book as a block trade (e.g. via RFQ / negotiated block proposal); false for trades that filled on the standard order book.
	IsBlockTrade bool `json:"is_block_trade"`

	// NoPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	NoPriceDollars FixedPointDollars `json:"no_price_dollars"`

	// TakerBookSide Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)
	TakerBookSide BookSide `json:"taker_book_side"`

	// TakerOutcomeSide The outcome side the taker is positioned for. buy-yes and sell-no produce 'yes'; buy-no and sell-yes produce 'no'.
	//
	// `taker_outcome_side` describes directional exposure only; it does not change the trade's price. A trade at price `p` with `taker_outcome_side=no` is matched against the maker at the same price `p` with the opposite direction — both parties trade at the same price.
	//
	// `taker_outcome_side` and `taker_book_side` will become the canonical way to determine trade direction. The legacy `taker_side` field will be deprecated in a future release — please migrate to these new fields.
	TakerOutcomeSide TradeTakerOutcomeSide `json:"taker_outcome_side"`

	// TakerSide Deprecated. Use `taker_outcome_side` (or `taker_book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	TakerSide TradeTakerSide `json:"taker_side,omitempty"`

	// Ticker Unique identifier for the market
	Ticker string `json:"ticker"`

	// TradeId Unique identifier for this trade
	TradeId string `json:"trade_id"`

	// YesPriceDollars Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	YesPriceDollars FixedPointDollars `json:"yes_price_dollars"`
}

Trade defines model for Trade.

type TradeTakerOutcomeSide

type TradeTakerOutcomeSide string

TradeTakerOutcomeSide The outcome side the taker is positioned for. buy-yes and sell-no produce 'yes'; buy-no and sell-yes produce 'no'.

`taker_outcome_side` describes directional exposure only; it does not change the trade's price. A trade at price `p` with `taker_outcome_side=no` is matched against the maker at the same price `p` with the opposite direction — both parties trade at the same price.

`taker_outcome_side` and `taker_book_side` will become the canonical way to determine trade direction. The legacy `taker_side` field will be deprecated in a future release — please migrate to these new fields.

const (
	TradeTakerOutcomeSideTradeTakerOutcomeSideNo  TradeTakerOutcomeSide = "no"
	TradeTakerOutcomeSideTradeTakerOutcomeSideYes TradeTakerOutcomeSide = "yes"
)

Defines values for TradeTakerOutcomeSide.

func (TradeTakerOutcomeSide) Valid

func (e TradeTakerOutcomeSide) Valid() bool

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

type TradeTakerSide

type TradeTakerSide string

TradeTakerSide Deprecated. Use `taker_outcome_side` (or `taker_book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

const (
	TradeTakerSideTradeTakerSideNo  TradeTakerSide = "no"
	TradeTakerSideTradeTakerSideYes TradeTakerSide = "yes"
)

Defines values for TradeTakerSide.

func (TradeTakerSide) Valid

func (e TradeTakerSide) Valid() bool

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

type TransfersLimitQuery

type TransfersLimitQuery = int64

TransfersLimitQuery defines model for TransfersLimitQuery.

type TriggerOrderGroupJSONRequestBody

type TriggerOrderGroupJSONRequestBody = EmptyResponse

TriggerOrderGroupJSONRequestBody defines body for TriggerOrderGroup for application/json ContentType.

type TriggerOrderGroupParams

type TriggerOrderGroupParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0.
	ExchangeIndex ExchangeIndexQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`
}

TriggerOrderGroupParams defines parameters for TriggerOrderGroup.

type TriggerOrderGroupResponse

type TriggerOrderGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseTriggerOrderGroupResponse

func ParseTriggerOrderGroupResponse(rsp *http.Response) (*TriggerOrderGroupResponse, error)

ParseTriggerOrderGroupResponse parses an HTTP response from a TriggerOrderGroupWithResponse call

func (TriggerOrderGroupResponse) ContentType

func (r TriggerOrderGroupResponse) ContentType() string

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

func (TriggerOrderGroupResponse) GetBody

func (r TriggerOrderGroupResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TriggerOrderGroupResponse) GetJSON200

func (r TriggerOrderGroupResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TriggerOrderGroupResponse) GetJSON401

func (r TriggerOrderGroupResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (TriggerOrderGroupResponse) GetJSON404

func (r TriggerOrderGroupResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (TriggerOrderGroupResponse) GetJSON500

func (r TriggerOrderGroupResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (TriggerOrderGroupResponse) Status

func (r TriggerOrderGroupResponse) Status() string

Status returns HTTPResponse.Status

func (TriggerOrderGroupResponse) StatusCode

func (r TriggerOrderGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UnauthorizedError

type UnauthorizedError = ErrorResponse

UnauthorizedError defines model for UnauthorizedError.

type UpdateFCMEventContractDailyCapJSONRequestBody

type UpdateFCMEventContractDailyCapJSONRequestBody = UpdateFCMEventContractDailyCapRequest

UpdateFCMEventContractDailyCapJSONRequestBody defines body for UpdateFCMEventContractDailyCap for application/json ContentType.

type UpdateFCMEventContractDailyCapRequest

type UpdateFCMEventContractDailyCapRequest struct {
	// Limit Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.
	//
	// Example: 0.5600
	Limit FixedPointDollars `json:"limit"`

	// SubtraderId The subtrader whose daily cap should be set. Must belong to the requesting FCM.
	SubtraderId string `json:"subtrader_id"`
}

UpdateFCMEventContractDailyCapRequest defines model for UpdateFCMEventContractDailyCapRequest.

type UpdateFCMEventContractDailyCapResponse

type UpdateFCMEventContractDailyCapResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseUpdateFCMEventContractDailyCapResponse

func ParseUpdateFCMEventContractDailyCapResponse(rsp *http.Response) (*UpdateFCMEventContractDailyCapResponse, error)

ParseUpdateFCMEventContractDailyCapResponse parses an HTTP response from a UpdateFCMEventContractDailyCapWithResponse call

func (UpdateFCMEventContractDailyCapResponse) ContentType

func (r UpdateFCMEventContractDailyCapResponse) ContentType() string

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

func (UpdateFCMEventContractDailyCapResponse) GetBody

func (r UpdateFCMEventContractDailyCapResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateFCMEventContractDailyCapResponse) GetJSON200

func (r UpdateFCMEventContractDailyCapResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) GetJSON400

func (r UpdateFCMEventContractDailyCapResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) GetJSON401

func (r UpdateFCMEventContractDailyCapResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) GetJSON403

func (r UpdateFCMEventContractDailyCapResponse) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) GetJSON404

func (r UpdateFCMEventContractDailyCapResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) GetJSON500

func (r UpdateFCMEventContractDailyCapResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (UpdateFCMEventContractDailyCapResponse) Status

func (r UpdateFCMEventContractDailyCapResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateFCMEventContractDailyCapResponse) StatusCode

func (r UpdateFCMEventContractDailyCapResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateFCMSubtraderBlockedCategoriesJSONRequestBody

type UpdateFCMSubtraderBlockedCategoriesJSONRequestBody = UpdateFCMSubtraderBlockedCategoriesRequest

UpdateFCMSubtraderBlockedCategoriesJSONRequestBody defines body for UpdateFCMSubtraderBlockedCategories for application/json ContentType.

type UpdateFCMSubtraderBlockedCategoriesRequest

type UpdateFCMSubtraderBlockedCategoriesRequest struct {
	// Blocked True adds the category to the blocked set; false removes it. Removing a category that is not blocked is a no-op.
	Blocked bool `json:"blocked"`

	// Category A single event category to add to or remove from the blocked set, 1-100 characters (e.g. "Politics").
	Category string `json:"category"`

	// SubtraderId The subtrader whose blocked categories should be updated. Must belong to the requesting FCM.
	SubtraderId string `json:"subtrader_id"`
}

UpdateFCMSubtraderBlockedCategoriesRequest defines model for UpdateFCMSubtraderBlockedCategoriesRequest.

type UpdateFCMSubtraderBlockedCategoriesResponse

type UpdateFCMSubtraderBlockedCategoriesResponse struct {
	// Categories The subtrader's full resulting blocked set, sorted ascending.
	Categories []string `json:"categories"`
}

UpdateFCMSubtraderBlockedCategoriesResponse defines model for UpdateFCMSubtraderBlockedCategoriesResponse.

type UpdateFCMSubtraderBlockedCategoriesResponse2

type UpdateFCMSubtraderBlockedCategoriesResponse2 struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UpdateFCMSubtraderBlockedCategoriesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseUpdateFCMSubtraderBlockedCategoriesResponse2

func ParseUpdateFCMSubtraderBlockedCategoriesResponse2(rsp *http.Response) (*UpdateFCMSubtraderBlockedCategoriesResponse2, error)

ParseUpdateFCMSubtraderBlockedCategoriesResponse2 parses an HTTP response from a UpdateFCMSubtraderBlockedCategoriesWithResponse call

func (UpdateFCMSubtraderBlockedCategoriesResponse2) ContentType

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) ContentType() string

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

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetBody

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON200

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON200() *UpdateFCMSubtraderBlockedCategoriesResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON400

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON401

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON403

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON403() *ForbiddenError

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON404

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON500

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (UpdateFCMSubtraderBlockedCategoriesResponse2) Status

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) Status() string

Status returns HTTPResponse.Status

func (UpdateFCMSubtraderBlockedCategoriesResponse2) StatusCode

func (r UpdateFCMSubtraderBlockedCategoriesResponse2) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateOrderGroupLimitJSONRequestBody

type UpdateOrderGroupLimitJSONRequestBody = UpdateOrderGroupLimitRequest

UpdateOrderGroupLimitJSONRequestBody defines body for UpdateOrderGroupLimit for application/json ContentType.

type UpdateOrderGroupLimitParams

type UpdateOrderGroupLimitParams struct {
	// Subaccount Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
	Subaccount *SubaccountQueryDefaultPrimary `form:"subaccount,omitempty" json:"subaccount,omitempty"`

	// ExchangeIndex Identifier for an exchange shard. Defaults to 0.
	ExchangeIndex ExchangeIndexQuery `form:"exchange_index,omitempty" json:"exchange_index,omitempty"`
}

UpdateOrderGroupLimitParams defines parameters for UpdateOrderGroupLimit.

type UpdateOrderGroupLimitRequest

type UpdateOrderGroupLimitRequest struct {
	// ContractsLimit New maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match.
	ContractsLimit int64 `json:"contracts_limit,omitempty" validate:"omitempty,gte=1"`

	// ContractsLimitFp Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.
	//
	// Example: 10.00
	ContractsLimitFp *FixedPointCount `json:"contracts_limit_fp,omitempty"`
}

UpdateOrderGroupLimitRequest defines model for UpdateOrderGroupLimitRequest.

type UpdateOrderGroupLimitResponse

type UpdateOrderGroupLimitResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EmptyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseUpdateOrderGroupLimitResponse

func ParseUpdateOrderGroupLimitResponse(rsp *http.Response) (*UpdateOrderGroupLimitResponse, error)

ParseUpdateOrderGroupLimitResponse parses an HTTP response from a UpdateOrderGroupLimitWithResponse call

func (UpdateOrderGroupLimitResponse) ContentType

func (r UpdateOrderGroupLimitResponse) ContentType() string

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

func (UpdateOrderGroupLimitResponse) GetBody

func (r UpdateOrderGroupLimitResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateOrderGroupLimitResponse) GetJSON200

func (r UpdateOrderGroupLimitResponse) GetJSON200() *EmptyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateOrderGroupLimitResponse) GetJSON400

func (r UpdateOrderGroupLimitResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateOrderGroupLimitResponse) GetJSON401

func (r UpdateOrderGroupLimitResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateOrderGroupLimitResponse) GetJSON404

func (r UpdateOrderGroupLimitResponse) GetJSON404() *NotFoundError

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateOrderGroupLimitResponse) GetJSON500

func (r UpdateOrderGroupLimitResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (UpdateOrderGroupLimitResponse) Status

func (r UpdateOrderGroupLimitResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateOrderGroupLimitResponse) StatusCode

func (r UpdateOrderGroupLimitResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateSubaccountNettingJSONRequestBody

type UpdateSubaccountNettingJSONRequestBody = UpdateSubaccountNettingRequest

UpdateSubaccountNettingJSONRequestBody defines body for UpdateSubaccountNetting for application/json ContentType.

type UpdateSubaccountNettingRequest

type UpdateSubaccountNettingRequest struct {
	// Enabled Whether netting is enabled for this subaccount.
	Enabled bool `json:"enabled"`

	// SubaccountNumber Subaccount number (0 for primary, 1-63 for subaccounts).
	SubaccountNumber int `json:"subaccount_number"`
}

UpdateSubaccountNettingRequest defines model for UpdateSubaccountNettingRequest.

type UpdateSubaccountNettingResponse

type UpdateSubaccountNettingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *UnauthorizedError
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerError
}

func ParseUpdateSubaccountNettingResponse

func ParseUpdateSubaccountNettingResponse(rsp *http.Response) (*UpdateSubaccountNettingResponse, error)

ParseUpdateSubaccountNettingResponse parses an HTTP response from a UpdateSubaccountNettingWithResponse call

func (UpdateSubaccountNettingResponse) ContentType

func (r UpdateSubaccountNettingResponse) ContentType() string

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

func (UpdateSubaccountNettingResponse) GetBody

func (r UpdateSubaccountNettingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateSubaccountNettingResponse) GetJSON400

func (r UpdateSubaccountNettingResponse) GetJSON400() *BadRequestError

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateSubaccountNettingResponse) GetJSON401

func (r UpdateSubaccountNettingResponse) GetJSON401() *UnauthorizedError

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateSubaccountNettingResponse) GetJSON500

func (r UpdateSubaccountNettingResponse) GetJSON500() *InternalServerError

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (UpdateSubaccountNettingResponse) Status

func (r UpdateSubaccountNettingResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSubaccountNettingResponse) StatusCode

func (r UpdateSubaccountNettingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpgradeAccountApiUsageLevelResponse

type UpgradeAccountApiUsageLevelResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseUpgradeAccountApiUsageLevelResponse

func ParseUpgradeAccountApiUsageLevelResponse(rsp *http.Response) (*UpgradeAccountApiUsageLevelResponse, error)

ParseUpgradeAccountApiUsageLevelResponse parses an HTTP response from a UpgradeAccountApiUsageLevelWithResponse call

func (UpgradeAccountApiUsageLevelResponse) ContentType

func (r UpgradeAccountApiUsageLevelResponse) ContentType() string

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

func (UpgradeAccountApiUsageLevelResponse) GetBody

func (r UpgradeAccountApiUsageLevelResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpgradeAccountApiUsageLevelResponse) Status

func (r UpgradeAccountApiUsageLevelResponse) Status() string

Status returns HTTPResponse.Status

func (UpgradeAccountApiUsageLevelResponse) StatusCode

func (r UpgradeAccountApiUsageLevelResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UserFilter

type UserFilter string

UserFilter Omit or leave empty to return all results. Use `self` to filter by the authenticated user.

const (
	UserFilterUserFilterSelf UserFilter = "self"
)

Defines values for UserFilter.

func (UserFilter) Valid

func (e UserFilter) Valid() bool

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

type WeatherIndexCalibration

type WeatherIndexCalibration struct {
	// CalibrationWindowEndMs End of the calibration window (exclusive).
	CalibrationWindowEndMs *int64 `json:"calibration_window_end_ms,omitempty"`

	// CalibrationWindowStartMs Start of the trailing observation window the offsets were estimated from. Absent on records not derived from a calibration window (the launch configuration).
	CalibrationWindowStartMs *int64 `json:"calibration_window_start_ms,omitempty"`

	// ChangeReason Why the configuration changed.
	ChangeReason *string `json:"change_reason,omitempty"`

	// CityReferenceC City reference B_c in Celsius: the weight-dot-offset sum over all configured member stations.
	CityReferenceC float64 `json:"city_reference_c"`

	// ConfigVersion Configuration version (e.g. `miami-temperature-v1.0-cal-20260831`). Index points report the version they were computed under in their `config_version` field.
	ConfigVersion string `json:"config_version"`

	// EffectiveAtMs The record governs event minutes at or after this time (unix milliseconds UTC), until superseded by the next record.
	EffectiveAtMs int64 `json:"effective_at_ms"`

	// PublishedAtMs When the record was published, unix milliseconds UTC.
	PublishedAtMs *int64 `json:"published_at_ms,omitempty"`

	// Stations Configured member stations, in configuration order.
	Stations []WeatherIndexCalibrationStation `json:"stations"`
}

WeatherIndexCalibration defines model for WeatherIndexCalibration.

type WeatherIndexCalibrationStation

type WeatherIndexCalibrationStation struct {
	// OffsetC Station offset in Celsius (positive = station normally runs warmer than its peers).
	OffsetC float64 `json:"offset_c"`

	// StationId Member station ID (e.g. `KMIA1M`).
	StationId string `json:"station_id"`

	// UpdateNote Weekly-calibration disposition, present only on weekly calibration records: `updated ...` with the residual count, target, and applied adjustment, or `insufficient ...` when the prior offset was retained.
	UpdateNote *string `json:"update_note,omitempty"`

	// Weight Base weight (weights sum to 1.0 across members).
	Weight float64 `json:"weight"`
}

WeatherIndexCalibrationStation defines model for WeatherIndexCalibrationStation.

type WeatherIndexPoint

type WeatherIndexPoint struct {
	// Contributors Number of accepted member stations backing the point. Absent on `incomplete` points.
	Contributors *int `json:"contributors,omitempty"`

	// ReceiptBasis Present only on points produced by the labelled historical backfill that seeds a city's series for the period before it went live. `synoptic_latency` means the receipt-deadline test used `observation_time + Synoptic ingest latency` in place of Kalshi's local receipt clock. Absent on canonical points, which are the only settlement-eligible ones.
	ReceiptBasis *string `json:"receipt_basis,omitempty"`

	// Stations Per-station audit readings (only with `detailed=true`), sorted by station ID — every configured member's reported value and QC disposition before incorporation into the index.
	Stations *[]WeatherIndexStationReading `json:"stations,omitempty"`

	// Status `normal` (every member contributed its exact-minute primary observation) or `degraded` (a member was absent, fallback-fed, or substituted by quality control; the value is equally settlement-eligible). With `detailed=true`, trailing minutes still inside their receipt deadline are additionally served as `incomplete`: no value, and stations carrying the raw readings recorded so far (code `pending`, not yet quality-controlled — more readings may still arrive, and the canonical value may differ).
	Status string `json:"status"`

	// T Event minute, unix milliseconds UTC.
	T int64 `json:"t"`

	// V Published index value, Fahrenheit rounded to 0.01. Absent on `incomplete` points, which have no canonical value yet.
	V *float64 `json:"v,omitempty"`
}

WeatherIndexPoint defines model for WeatherIndexPoint.

type WeatherIndexStationReading

type WeatherIndexStationReading struct {
	// Code Disposition: `ok` (accepted), `missing` (no eligible observation), `late` (received after the deadline; diagnostic only), a QC rejection (`range`, `rate_spatial`, `extreme`), or `pending` (raw reading on an `incomplete` minute, not yet quality-controlled).
	Code string `json:"code"`

	// ObsTimeMs Observation time for carried-forward fallbacks (differs from the event minute). Absent for exact-minute primaries.
	ObsTimeMs *int64 `json:"obs_time_ms,omitempty"`

	// PrimaryCode Why the primary observation was passed over when a fallback was selected instead.
	PrimaryCode *string `json:"primary_code,omitempty"`

	// ReceivedAtMs Local wire-receipt time backing the eligibility deadline.
	ReceivedAtMs *int64 `json:"received_at_ms,omitempty"`

	// Source `hf_asos` (exact-minute primary) or `metar` (carried-forward official observation). Absent when no reading was available.
	Source *string `json:"source,omitempty"`

	// StationId Member station (e.g. `KMIA1M`) or its official fallback ID.
	StationId string `json:"station_id"`

	// TempF Raw reported temperature in Fahrenheit (unrounded — only the published index value carries output rounding). Absent for `missing` members.
	TempF *float64 `json:"temp_f,omitempty"`
}

WeatherIndexStationReading defines model for WeatherIndexStationReading.

type WeeklySchedule

type WeeklySchedule struct {
	// EndTime End date and time for when this weekly schedule is no longer effective.
	EndTime time.Time `json:"end_time"`

	// Friday Trading hours for Friday. May contain multiple sessions.
	Friday []DailySchedule `json:"friday"`

	// Monday Trading hours for Monday. May contain multiple sessions.
	Monday []DailySchedule `json:"monday"`

	// Saturday Trading hours for Saturday. May contain multiple sessions.
	Saturday []DailySchedule `json:"saturday"`

	// StartTime Start date and time for when this weekly schedule is effective.
	StartTime time.Time `json:"start_time"`

	// Sunday Trading hours for Sunday. May contain multiple sessions.
	Sunday []DailySchedule `json:"sunday"`

	// Thursday Trading hours for Thursday. May contain multiple sessions.
	Thursday []DailySchedule `json:"thursday"`

	// Tuesday Trading hours for Tuesday. May contain multiple sessions.
	Tuesday []DailySchedule `json:"tuesday"`

	// Wednesday Trading hours for Wednesday. May contain multiple sessions.
	Wednesday []DailySchedule `json:"wednesday"`
}

WeeklySchedule defines model for WeeklySchedule.

type Withdrawal

type Withdrawal struct {
	// AmountCents Withdrawal amount in cents.
	AmountCents int64 `json:"amount_cents"`

	// CreatedTs Unix timestamp of when the withdrawal was created.
	CreatedTs int64 `json:"created_ts"`

	// FeeCents Fee charged for the withdrawal in cents.
	FeeCents int64 `json:"fee_cents"`

	// FinalizedTs Unix timestamp of when the withdrawal was finalized (applied, failed, or returned).
	FinalizedTs *int64 `json:"finalized_ts,omitempty"`

	// Id Unique identifier for the withdrawal.
	Id string `json:"id"`

	// Status Current status of the withdrawal. 'applied' means funds have been deducted from balance.
	Status WithdrawalStatus `json:"status"`

	// Type Payment type used for the withdrawal.
	Type WithdrawalType `json:"type"`
}

Withdrawal defines model for Withdrawal.

type WithdrawalLimitQuery

type WithdrawalLimitQuery = int64

WithdrawalLimitQuery defines model for WithdrawalLimitQuery.

type WithdrawalStatus

type WithdrawalStatus string

WithdrawalStatus Current status of the withdrawal. 'applied' means funds have been deducted from balance.

const (
	WithdrawalStatusWithdrawalStatusApplied  WithdrawalStatus = "applied"
	WithdrawalStatusWithdrawalStatusFailed   WithdrawalStatus = "failed"
	WithdrawalStatusWithdrawalStatusPending  WithdrawalStatus = "pending"
	WithdrawalStatusWithdrawalStatusReturned WithdrawalStatus = "returned"
)

Defines values for WithdrawalStatus.

func (WithdrawalStatus) Valid

func (e WithdrawalStatus) Valid() bool

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

type WithdrawalType

type WithdrawalType string

WithdrawalType Payment type used for the withdrawal.

const (
	WithdrawalTypeAch    WithdrawalType = "ach"
	WithdrawalTypeApm    WithdrawalType = "apm"
	WithdrawalTypeCrypto WithdrawalType = "crypto"
	WithdrawalTypeDebit  WithdrawalType = "debit"
	WithdrawalTypeWire   WithdrawalType = "wire"
)

Defines values for WithdrawalType.

func (WithdrawalType) Valid

func (e WithdrawalType) Valid() bool

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