https://github.com/vdegenne/kraken-api-browser

kraken-api port for modern browsers
https://github.com/vdegenne/kraken-api-browser

Last synced: 2 months ago
JSON representation

kraken-api port for modern browsers

• Host: GitHub
• URL: https://github.com/vdegenne/kraken-api-browser
• Owner: vdegenne
• Created: 2019-10-26T12:29:26.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T23:35:55.000Z (about 2 years ago)
• Last Synced: 2024-11-11T10:53:05.028Z (2 months ago)
• Language: TypeScript
• Size: 129 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kraken-api-browser

`kraken-api-browser` is a browser port of the server-side kraken API [`kraken-api`](https://github.com/nothingisdead/npm-kraken-api).

Use `npm i kraken-api-browser` to install it.

It's a es6 module file, which means you can directly import it into your web page

```html

```

*(see Browser Usage for more details)*  

You can also import it in a es6 module project, and in a TypeScript project (typings included)

```typescript

import { KrakenClient } from 'kraken-api-browser';

```

## Usage

```javascript

const kraken = new KrakenClient();

async function main () {

  const { result } = await kraken.api('Ticker', { pair: 'XBTEUR' });

  console.log(result);

}

main()

```

### Browser Usage

```html

  const kraken = new KrakenClient();

  ...

```

or

```html

  import { KrakenClient } from '/node_modules/kraken-api-browser/build.js';

  const kraken = new KrakenClient();

  ...

```

*(note: if you are using a server that resolves es module paths on requests you know what's up)*

### TypeScript Usage

If you are using TypeScript you can easily see the methods available with auto-suggestion feature in your IDE.



## Availabe public methods

```

'Time' | 'Assets' | 'AssetPairs' | 'Ticker' | 'Depth' | 'Trades' | 'Spread' | 'OHLC'

```

*(note: You can also use the `publicMethod` function to narrow down the list of available public methods because right now the private methods won't work, read the disclaimer below)*

# Disclaimer

I contacted the Kraken support to ask them to allow cors requests when using private methods such as `Balance` but they couldn't help me... When requesting a private method Kraken API requires a bunch of security codes such as the API keys and other things to be sent in the header of that https request. On a server side it works just fine but browsers such as Google Chrome send a pre-flight `OPTIONS` request before the `POST` one (https://stackoverflow.com/a/29954326/773595) when modifying the header of sensitive requests.  

**For this reason the private methods in this framework are for the time being not working**  

One way for Kraken to fix this issue would be to accept `OPTIONS` requests from trusted origins (if not all origins) but they didn't.

## Support

[Buy Me a Coffee](https://www.buymeacoffee.com/vdegenne)  

bitcoin address: 3KfrLBhWgKxnNH9hoC8ipSPYi3LW3Qrj8i