Categorygithub.com/wthorp/kraken-go-api-client
modulepackage
0.0.0-20210130131916-e06ae779b880
Repository: https://github.com/wthorp/kraken-go-api-client.git
Documentation: pkg.go.dev

# README

Kraken GO API Client

A simple API Client for the Kraken Trading platform.

This is a fork of kraken-go-api-client which uses strings instead of typed symbol constants.

Example usage:

package main

import (
	"fmt"
	"log"

	"github.com/wthorp/kraken-go-api-client"
)

func main() {
	api := krakenapi.New("KEY", "SECRET")

	ticker, err := api.Ticker("STORJUSD")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Bid price: %s\n", (*ticker)["STORJUSD"].Bid[0])
}

# Packages

No description provided by the author

# Functions

New creates a new Kraken API client.
NewOHLC constructor for OHLC.
NewWithClient creates a new Kraken API client with custom http client.

# Constants

APIURL is the official Kraken API Endpoint.
APIUserAgent identifies this library with the Kraken API.
APIVersion is the official Kraken API Version Number.
actions constants.
actions constants.
actions constants.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
These represent the minimum order sizes for the respective coins Should be monitored through here: https://support.kraken.com/hc/en-us/articles/205893708-What-is-the-minimum-order-size-.
(price = limit price).
OrderTypes for AddOrder.
OrderTypes for AddOrder.
(price = stop loss price).
(price = stop loss price, price2 = limit price).
(price = stop loss trigger price, price2 = triggered limit price).
(price = stop loss price, price2 = take profit price).
(price = stop loss price, price2 = take profit price).
(price = take profit price).
(price = take profit trigger price, price2 = triggered limit price).
(price = trailing stop offset).
(price = trailing stop offset, price2 = triggered limit offset).
actions constants.

# Structs

AddOrderResponse response when adding an order.
AssetInfo represents an asset information.
AssetPairInfo represents asset pair information.
CancelOrderResponse response when cancelling and order.
ClosedOrdersResponse represents a list of closed orders, indexed by id.
FeeInfo represents a fee information.
KrakenAPI represents a Kraken API Client connection.
KrakenResponse wraps the Kraken API JSON response.
LedgerInfo Represents the ledger informations.
LedgersResponse represents an associative array of ledgers infos.
OHLC represents the "Open-high-low-close chart".
OHLCResponse represents the OHLC's response.
OpenOrdersResponse response when opening an order.
Order represents a single order.
OrderBook contains top asks and bids.
OrderBookItem is a piece of information about an order.
OrderDescription represents an orders description.
PairTickerInfo represents ticker information for a pair.
TimeResponse represents the server's time.
TradeBalanceResponse struct used as the response for the TradeBalance method.
TradeHistoryInfo represents a transaction.
TradeInfo represents a trades information.
TradesHistoryResponse represents a list of executed trade.
TradesResponse represents a list of the last trades.
TradeVolumeResponse represents the response for trade volume.
WithdrawInfoResponse is the response type showing withdrawal information for a selected withdrawal method.
WithdrawResponse is the response type of a Withdraw query to the Kraken API.

# Type aliases

AssetPairsResponse includes asset pair informations.
AssetsResponse includes asset informations.
BalanceResponse represents the account's balances (list of currencies).
DepositAddressesResponse is the response type of a DepositAddresses query to the Kraken API.
DepthResponse is a response from kraken to Depth request.
Fees includes fees information for different currencies.
KrakenApi represents a Kraken API Client connection.
QueryOrdersResponse response when checking all orders.
TickerResponse includes the requested ticker pairs.