Expand description
A rust crate for making requests to the Kraken Rest API and subscribing to Kraken websockets feeds
KrakenRestAPI is the main touchpoint for the rest side of things.
ws::KrakenWsAPI is the main touchpoint for the websockets side of things.
Modules§
- ws
- An interface for getting data from Kraken websockets API, while another thread manages the updates from the websockets connection.
Structs§
- AddOrder
Response - Add order response
- Asset
Info - (Substructure within) Result of kraken public “Assets” API call
- Asset
Pair - (Substructure within) Result of kraken public “Asset Pairs” API call
- Asset
Ticker Info - (Substructure within) Result of kraken public “Ticker” API call
- Cancel
AllOrders After Response - Cancel all orders after response
- Cancel
AllOrders Response - Cancel all orders response
- Cancel
Order Response - Cancel order response
- FeeTier
Info - Substructure of GetTradeVolume response
- GetOpen
Orders Response - Get open orders response
- GetTrade
Volume Response - GetTradeVolume response
- GetWeb
Sockets Token Response - WebSockets authenitcation token response, including token and expiry
- Kraken
Credentials - Credentials needed to use private Kraken APIs.
- Kraken
RestAPI - A connection to the Kraken REST API This only supports blocking http requests for now
- Kraken
Rest Client - A low-level https connection to kraken that can execute public or private methods.
- Kraken
Rest Config - Configuration needed to initialize a Kraken client. The credentials aren’t needed if only public APIs are used
- Kraken
Rest Config Builder - Builder pattern for the KrakenRestConfig object
- Last
AndData - The LastAndData struct is a helper to deal with wierdness in some of the Kraken REST API schemas.
- Limit
Order - A description of a limit order to place
- Market
Order - A description of a market order to place
- Order
Added - Substructure within AddOrderResponse
- Order
Info - Order-info used in OpenOrders and QueryOrders APIs
- System
Status Response - Result of kraken public “SystemStatus” API call
- Time
Response - Result of kraken public “Time” API call
Enums§
- BsType
- Type (buy/sell) These are kebab-case strings in json
- Builder
Error - An error returned by a config builder
- Error
- An error that can be generated from the low-level kraken client
- Order
Flag - Possible order flags in Kraken. These are options in a comma-separated list
- Order
Status - Possible order statuses in Kraken. These are kebab-case strings in json
- Order
Type - Possible order types in Kraken. These are kebab-case strings in json
Type Aliases§
- Asset
Pairs Response - Type alias for response of AssetPairs API call
- Assets
Response - Type alias for response of Assets API call
- Balance
Response - Type alias for response of Balance API call
- GetOHLC
Data Response - Response object of Get OHLC data API call (Note: See issue #3 for discussion of strategy)
- GetRecent
Trades Response - Response object of Get Recent Trades API call (Note: See issue #3 for discussion of strategy)
- Result
- Alias for Result that contains the error type for this crate
- Ticker
Response - Type alias for response of Ticker API call
- TxId
- TxId are represented as String’s in kraken json api
- User
RefId - User-reference id’s are signed 32-bit in kraken json api