Skip to content

Add Kraken SDK documentation and setup guides - #28

Open
MiniTiago wants to merge 48 commits into
sieblyio:mainfrom
MiniTiago:docs-kraken
Open

MiniTiago wants to merge 48 commits into
sieblyio:mainfrom
MiniTiago:docs-kraken

Conversation

@MiniTiago

@MiniTiago MiniTiago commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add Kraken SDK 1.1.10 to the documentation catalogue and release updates.
  • Add public REST and WebSocket quickstarts, account access, private streams, and a validation-only Spot order walkthrough.
  • Include API reference and eight runtime/framework setup projects, with accurate environment and credential guidance.
  • Preserve original error objects in the shared starter examples.

Validation

  • Full four-SDK build: 3,664 pages and 214,060 links checked; 41 examples typechecked.
  • All nine Kraken examples also typecheck against the published package.
  • Published-package ESM/CommonJS imports, TypeScript consumer, and React/Vite production builds pass.
  • Existing documentation/release checks and all 32 generated starter projects pass.
  • Remote files match the validated local source exactly.

Live public runtime checks

  • Chrome 155: updated Vite and React starters passed live public REST ticker and WebSocket price checks in development and production. Stop closes the connection; React restart opens a fresh subscription.
  • The default SDK headers trigger a failing Kraken CORS preflight. The browser examples now use the supported Axios request transform to omit only UserAgent and locale for public GETs. This is not a claim of general browser REST support. The guides explain the limit and link the server-side Next.js path.
  • Android and iOS Expo Go: the documented Metro/polyfill setup passed SDK import, live public REST and WebSocket ticker checks, and cleanup. Unconfigured Android fails on the Node https import.
  • Regression tests and a published-package TypeScript check cover the browser transform. Independent review found no material issues.

Only public market data was requested. No credentials, private APIs, orders or trades were used. Other browser engines, physical mobile devices, native release builds, private authentication, extended reconnect behavior and background/resume remain unverified.

@MiniTiago
MiniTiago marked this pull request as ready for review November 9, 2026 17:57

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants