modulepackage
0.0.0-20240622163035-5436aead605d
Repository: https://github.com/donohutcheon/valr-go.git
Documentation: pkg.go.dev
# README
Valr Golang API Client
Go API wrapper for the valr exchange
Based on the luno exchange API wrapper
Installation
go get github.com/donohutcheon/valr-go
Authentication
Public and private API keys can be generated within your account at the exchange
Create a .env file in the root of your project and add the following:
VA_KEY_ID=<api_key_public>
VA_SECRET=<api_key_secret>
Example usage
Refer to the examples directory for examples on how to use the http and websocket client.
License
This is a derived work from github.com/i-norden/valr-go which is licensed under the MIT license.
# Functions
No description provided by the author
MakeURLValues converts a request struct into a url.Values map.
NewClient creates a new Valr API client with the default base URL.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
# Structs
AccountBalance represent the balance info for a specific asset.
AdditionalTransactionInfo holds additional info for a transaction.
BankInfo holds data related to a bank account.
Client is a Valr API client.
CurrencyInfo holds info for a specific asset.
DelOrderByCustomerOrderIDRequest is the request struct for DelOrderByCustomerOrderID.
DelOrderByCustomerOrderIDResponse is the struct that DelOrder responses are unpacked into.
DelOrderRequest is the request struct for DelOrder.
DelOrderResponse is the struct that DelOrder responses are unpacked into.
DepositInfo holds info about a specific deposit.
GetAccountBalancesRequest is the request struct for GetAccountBalances.
GetAllOpenOrdersRequest is the request struct for GetAllOpenOrders.
GetAuthFullOrderBookRequest is the request struct for GetAuthFullOrderBook.
GetAuthOrderBookRequest is the request struct for GetAuthOrderBook.
GetAuthTradeHistoryForPairRequest is the request struct for GetAuthTradeHistoryForPair.
GetBankAccountForAssetRequest is the request struct for GetBankAccountForAsset.
GetCurrenciesRequest is the request struct for GetCurrencies.
GetCurrencyPairsByTypeRequest is the request struct for GetCurrencyPairsByType.
GetCurrencyPairsRequest is the request struct for GetCurrencyPairs.
GetDepositAddressRequest is the request struct for GetDepositAddress.
GetDepositAddressResponse is the struct that GetDepositAddress responses are unpacked into.
GetDepositHistoryForAssetRequest is the request struct for GetDepositHistoryForAsset.
GetMarketSummaryForPairRequest is the request struct for GetMarketSummaryForPair.
GetMarketSummaryRequest is the request struct for GetMarketSummary.
GetOrderBookRequest is the request struct for GetOrderBook.
GetOrderHistoryDetailsByCustomerOrderIDRequest is the request struct for GetOrderHistoryDetailsByCustomerOrderID.
GetOrderHistoryDetailsByOrderIDRequest is the request struct for GetOrderHistoryDetailsByOrderID.
GetOrderHistoryRequest is the request struct for GetOrderHistory.
GetOrderHistorySummaryByCustomerOrderIDRequest is the request struct for GetOrderHistorySummaryByCustomerOrderID.
GetOrderHistorySummaryByCustomerOrderIDResponse is the struct that GetOrderHistorySummaryByCustomerOrderID responses are unpacked into.
GetOrderHistorySummaryByOrderIDRequest is the request struct for GetOrderHistorySummaryByOrderID.
GetOrderHistorySummaryByOrderIDResponse is the struct that GetOrderHistorySummaryByOrderID responses are unpacked into.
GetOrderStatusByCustomerOrderIDRequest is the request struct for GetOrderStatusByCustomerOrderID.
GetOrderStatusByOrderIDRequest is the request struct for GetOrderStatusByOrderID.
GetOrderStatusByOrderIDResponse is the struct that GetOrderStatusByOrderID responses are unpacked into.
GetOrderTypesForPairRequest is the request struct for GetOrderTypesForPair.
GetOrderTypesRequest is the request struct for GetOrderTypes.
GetServerTimeRequest is the request struct for GetServerTime.
GetServerTimeResponse is the struct that GetServerTime responses are unpacked into.
GetSimpleBuyOrSellOrderStatusRequest is the request struct for GetSimpleBuyOrSellOrderStatus.
GetSimpleBuyOrSellOrderStatusResponse is the struct that GetSimpleBuyOrSellOrderStatus responses are unpacked into.
GetTradeHistoryForPairRequest is the request struct for GetTradeHistoryForPair.
GetTransactionHistoryRequest is the request struct for GetTransactionHistory.
GetWithdrawHistoryForAssetRequest is the request struct for GetWithdrawHistoryForAsset.
GetWithdrawInfoRequest is the request struct for GetWithdrawInfo.
GetWithdrawInfoResponse is the struct that GetWithdrawInfo responses are unpacked into.
GetWithdrawStatusRequest is the request struct for GetWithdrawStatus.
MarketSummary holds market summary information.
OpenOrder holds info for an open order on the market.
OrderBook holds OrderBookEntries.
OrderBookEntry is a single entry in an OrderBook.
OrderReceipt collects info for a successful order.
OrderStatus holds info related to the status of a specific order.
OrderTypes associates order types with a specific pair.
PairInfo holds info for a specific pair.
PostLimitOrderRequest is the request struct for PostLimitOrder.
PostLimitOrderResponse is the struct that PostLimitOrder responses are unpacked into.
PostMarketOrderBuyRequest is the request struct for PostMarketOrder.
PostMarketOrderResponse is the struct that PostMarketOrder responses are unpacked into.
PostMarketOrderBuyRequest is the request struct for PostMarketOrder.
PostNewCryptoWithdrawRequest is the request struct for PostNewCryptoWithdraw.
PostNewCryptoWithdrawResponse is the struct that PostNewCryptoWithdraw responses are unpacked into.
PostNewFiatWithdrawRequest is the request struct for PostNewFiatWithdraw.
PostNewFiatWithdrawResponse is the struct that PostNewFiatWithdraw responses are unpacked into.
PostSimpleBuyOrSellOrderRequest is the request struct for PostSimpleBuyOrSellOrder.
PostSimpleBuyOrSellOrderResponse is the struct that PostSimpleBuyOrSellOrder responses are unpacked into.
PostSimpleBuyOrSellQuoteRequest is the request stuct for PostSimpleBuyOrSellQuote.
PostSimpleBuyOrSellQuoteResponse is the struct that PostSimpleBuyOrSellQuote responses are unpacked into.
No description provided by the author
TradeHistoryInfo is the data for a specific trade in trade history.
TradeInfo holds info about a specific trade.
TransactionInfo holds transaction info.
TransactionType associates a transction type with its description.
WithdrawInfo holds info about a specific withdraw.
# Interfaces
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
RequestSide type for explicitly representing the two options.
ResponseSide type for explicitly representing the two options.