Repository navigation
feat(v1.1.8): document Futures edit size semantics, add raw ws README section - #63
Merged
Merged
Conversation
…ge name Changelog: - Document Futures editOrder and batch edit size. Default qtyMode RELATIVE sets the open (remaining) size, not the total quantity. ABSOLUTE sets the total including past fills. - README: Why not raw ws? Covers reconnect, heartbeats, resubscribe, and auth token handling. Book checksum is not validated by the SDK. - README install: @siebly/kraken-api is this package. Unscoped kraken-api on npm is a different package. Co-authored-by: Jerko J <JJ-Cro@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document what
sizemeans when editing a Kraken Futures order, add a "Why not raw ws?" README section, and make the README install step clearly point to the scoped@siebly/kraken-apipackage.Changelog
editOrderand batch edit (batchOrderManagement): JSDoc onsizeandqtyMode. Kraken's defaultqtyModeisRELATIVE, which sets the open (remaining) size, not the total quantity including fills.qtyMode: 'ABSOLUTE'sets the total size including past fills. Source: https://docs.kraken.com/api-reference/order-management/edit-order@siebly/kraken-apiis this SDK; the unscopedkraken-apion npm is a different package.docs/endpointFunctionList.mdandllms.txt.Checks