scalar

Documentation

Index

• type BidAsk
  • func (ba *BidAsk) UnmarshalJSON(b []byte) error
• type CancelAfter
  • func (cancelAfter *CancelAfter) String() (str string)
• type ComplianceJob
  • func (complianceJob *ComplianceJob) String() (str string)
• type EntryType
• type Format
  • func (format *Format) String() (str string)
• type Granularity
  • func (granularity Granularity) Int() (i int)
  • func (granularity *Granularity) String() (str string)
• type OrderCancelTime
• type OrderSTP
  • func (orderSTP *OrderSTP) String() (str string)
• type OrderSide
  • func (orderSide *OrderSide) String() (str string)
• type OrderStop
  • func (orderStop *OrderStop) String() (str string)
• type OrderType
  • func (orderType *OrderType) String() (str string)
• type PaymentMethod
• type ReportType
  • func (reportType *ReportType) String() (str string)
• type Status
  • func (status *Status) String() (str string)
• type SystemStatus
• type TimeInForce
  • func (timeInForce *TimeInForce) String() (str string)
• type TransferMethod
  • func (transferMethod *TransferMethod) String() (str string)

Types

type BidAsk

type BidAsk []byte

BidAsk is a slice of bytes that represents the bids or asks for a given product.

func (*BidAsk) UnmarshalJSON

func (ba *BidAsk) UnmarshalJSON(b []byte) error

type CancelAfter

type CancelAfter string

CancelAfter is the timeframe in which to cancel an order if it hasn't been filled

const (
	CancelAfterMin  CancelAfter = "min"
	CancelAfterHour CancelAfter = "hour"
	CancelAfterDay  CancelAfter = "day"
)

func (*CancelAfter) String

func (cancelAfter *CancelAfter) String() (str string)

type ComplianceJob

type ComplianceJob string

const (
	ComplianceJobTweets ComplianceJob = "tweets"
	ComplianceJobUsers  ComplianceJob = "users"
)

func (*ComplianceJob) String

func (complianceJob *ComplianceJob) String() (str string)

String returns the string value of a ComplianceJob type.

type EntryType

type EntryType string

EntryType indicates the reason for the account change

const (
	// EntryTypeTransfer are funds moved to/from Coinbase to Coinbase Exchange
	EntryTypeTransfer EntryType = "transfer"

	// EntryTypeMatch are funds moved as a result of a trade
	EntryTypeMatch EntryType = "match"

	// EntryTypeFee is a fee as a result of a trade
	EntryTypeFee EntryType = "fee"

	// EntryTypeRebate is a fee rebate as per our fee schedule
	EntryTypeRebate EntryType = "rebate"

	// EntryTypeConversion are funds converted between fiat currency and a
	// stablecoin
	EntryTypeConversion EntryType = "conversion"
)

type Format

type Format string

const (
	FormatPDF Format = "pdf"
	FormatCSV Format = "csv"
)

func (*Format) String

func (format *Format) String() (str string)

String converts a pointer reference to Format to a string

type Granularity

type Granularity uint8

Granularity is the level of granularity needed for examining historical data.

const (
	Seconds60 Granularity = iota
	Seconds300
	Seconds900
	Seconds3600
	Seconds21600
	Seoncds86400
)

func (Granularity) Int

func (granularity Granularity) Int() (i int)

Int will convert the historic granularity into an integer

func (*Granularity) String

func (granularity *Granularity) String() (str string)

type OrderCancelTime

type OrderCancelTime string

OrderCancelTime represents when to cancel an order

const (
	OrderCancelTimeMin  OrderCancelTime = "min"
	OrderCancelTimeHour OrderCancelTime = "hour"
	OrderCancelTimeDay  OrderCancelTime = "day"
)

type OrderSTP

type OrderSTP string

OrderSTP is the order's Self trade preservation flag

const (
	// OrderSTP_DC = decrease and cancel, default
	OrderSTP_DC OrderSTP = "dc"

	// OrderSTP_CO = cancel oldest
	OrderSTP_CO OrderSTP = "co"

	// OrderSTP_CN = cancel newest
	OrderSTP_CN OrderSTP = "cn"

	// OrderSTP_CB = cancel boath
	OrderSTP_CB OrderSTP = "cb"
)

func (*OrderSTP) String

func (orderSTP *OrderSTP) String() (str string)

type OrderSide

type OrderSide string

OrderSide represents "Buy" or "Sell"

const (
	OrderSideBuy  OrderSide = "buy"
	OrderSideSell OrderSide = "sell"
)

func (*OrderSide) String

func (orderSide *OrderSide) String() (str string)

type OrderStop

type OrderStop string

OrderStop is either loss or entry

const (
	OrderStopLoss  OrderStop = "loss"
	OrderStopEntry OrderStop = "entry"
)

func (*OrderStop) String

func (orderStop *OrderStop) String() (str string)

type OrderType

type OrderType string

const (
	OrderTypeMarket OrderType = "market"
	OrderTypeLimit  OrderType = "limit"
)

func (*OrderType) String

func (orderType *OrderType) String() (str string)

String converts a pointer reference to OrderType to a string

type PaymentMethod

type PaymentMethod string

As fiat accounts can be used for buying and selling, they have an associated payment method. This type of a payment method will also have a fiat_account reference to the actual account.

const (
	// PaymentMethodACHBankAccount is the PM for a regular US bank account
	PaymentMethodACHBankAccount PaymentMethod = "ach_bank_account"

	// PaymentMethodBankWire is the PM for a bank wire (US only)
	PaymentMethodBankWire PaymentMethod = "bank_wire"

	// PaymentMethodCreditCard is the PM for a credit card (can’t be used for buying/selling)
	PaymentMethodCreditCard PaymentMethod = "credit_card"

	// PaymentMethodCreditCard is the PM for cryptocurrency transactions
	PaymentMethodCrypto PaymentMethod = "crypto"

	// PaymentMethodEFTBankAccount is the PM for a Canadian EFT bank account
	PaymentMethodEFTBankAccount PaymentMethod = "eft_bank_account"

	PaymentMethodFedwire PaymentMethod = "fedwire"

	// PaymentMethodFIATAccount	is the PM for a fiat nominated Coinbase account
	PaymentMethodFIATAccount PaymentMethod = "fiat_account"

	// PaymentMethodInterac	is the PM for an Interac Online for Canadian bank accounts
	PaymentMethodInterac PaymentMethod = "interac"

	PaymentMethodIntraBankAccount PaymentMethod = "intra_bank_account"

	// PaymentMethodSEPABankAccount is the PM for a European SEPA bank account
	PaymentMethodSEPABankAccount PaymentMethod = "sepa_bank_account"

	// PaymentMethodSecure3D is the PM for a Secure3D verified payment card
	PaymentMethodSecure3D PaymentMethod = "secure3d_card"

	PaymentMethodSWIFTBankAccount PaymentMethod = "swift_bank_account"

	// PaymentMethodiDealBankAccount is the PM for a iDeal bank account (Europe)
	PaymentMethodiDealBankAccount PaymentMethod = "ideal_bank_account"
)

type ReportType

type ReportType string

const (
	ReportTypeFills                   ReportType = "fills"
	ReportTypeAcccount                ReportType = "account"
	ReportTypeOTCFills                ReportType = "otc_fills"
	ReportType1099kTransactionHistory ReportType = "type_1099k_transaction_history"
	ReportTypeTaxInvoice              ReportType = "tax_invoice"
)

func (*ReportType) String

func (reportType *ReportType) String() (str string)

String converts a pointer reference to ReportType to a string

type Status

type Status string

const (
	StatusOnline     Status = "online"
	StatusOffline    Status = "offline"
	StatusInternal   Status = "internal"
	StatusDelisted   Status = "delisted"
	StatusPending    Status = "pending"
	StatusCreating   Status = "creating"
	StatusRead       Status = "ready"
	StatusCreated    Status = "created"
	StatusInProgress Status = "in_progress"
	StatusFailed     Status = "failed"
	STatusComplete   Status = "complete"
)

func (*Status) String

func (status *Status) String() (str string)

String converts a pointer reference to Status to a string

type SystemStatus

type SystemStatus string

const (
	// Kraken is operating normally. All order types may be submitted and trades
	// can occur.
	SystemStatusOnline SystemStatus = "online"

	// The exchange is offline. No new orders or cancellations may be
	// submitted.
	SystemStatusMaintenance SystemStatus = "maintentance"

	// Resting (open) orders can be cancelled but no new orders may be submitted.
	// No trades will occur.
	SystemStatusCancelOnly SystemStatus = "cancel_only"

	// Only post-only limit orders can be submitted. Existing orders may still be
	// cancelled. No trades will occur.
	SystemStatusPostOnly SystemStatus = "post_only"
)

type TimeInForce

type TimeInForce string

OrderTimeInForce (Time in force) policies provide guarantees about the lifetime of an order

const (
	// GTC Good till canceled orders remain open on the book until canceled. This
	// is the default behavior if no policy is specified.
	TimeInForceGTC TimeInForce = "GTC"

	// IOC Immediate or cancel orders instantly cancel the remaining size of the
	// limit order instead of opening it on the book.
	TimeInForceIOC TimeInForce = "IOC"

	// FOK Fill or kill orders are rejected if the entire size cannot be matched.
	TimeInForceFOK TimeInForce = "FOK"

	// GTT Good till time orders remain open on the book until canceled or the
	// allotted cancel_after is depleted on the matching engine. GTT orders are
	// guaranteed to cancel before any other order is processed after the
	// cancel_after timestamp which is returned by the API. A day is considered 24
	// hours.
	TimeInForceGTT TimeInForce = "GTT"
)

func (*TimeInForce) String

func (timeInForce *TimeInForce) String() (str string)

type TransferMethod

type TransferMethod string

const (
	TransferMethodDeposit  TransferMethod = "deposit"
	TransferMethodWithdraw TransferMethod = "withdraw"
)

func (*TransferMethod) String

func (transferMethod *TransferMethod) String() (str string)