better-bitkub-client 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# better-bitkub-client
|
|
2
2
|
|
|
3
|
-
TypeScript
|
|
3
|
+
TypeScript client for working with Bitkub V3 and V4 APIs, based on Bitkub's official API documentation.
|
|
4
4
|
|
|
5
5
|
## What it includes
|
|
6
6
|
|
|
@@ -12,14 +12,13 @@ TypeScript rewrite of the repository's C# `bitkubwrapper` library.
|
|
|
12
12
|
## Install
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
npm install
|
|
16
|
-
npm run build
|
|
15
|
+
npm install better-bitkub-client
|
|
17
16
|
```
|
|
18
17
|
|
|
19
18
|
## Usage
|
|
20
19
|
|
|
21
20
|
```ts
|
|
22
|
-
import { BitkubV3Client, BitkubV4Client } from "
|
|
21
|
+
import { BitkubV3Client, BitkubV4Client } from "better-bitkub-client";
|
|
23
22
|
|
|
24
23
|
const v3 = new BitkubV3Client({
|
|
25
24
|
apiKey: process.env.BITKUB_KEY!,
|
|
@@ -40,3 +39,4 @@ const withdraws = await v4.getCryptoWithdraws({ limit: 50 });
|
|
|
40
39
|
- Requires Node 18+ for the built-in `fetch` API.
|
|
41
40
|
- The default base URL is `https://api.bitkub.com`.
|
|
42
41
|
- DTOs keep Bitkub's field names to make request/response handling predictable.
|
|
42
|
+
- Official API reference: [bitkub/bitkub-official-api-docs](https://github.com/bitkub/bitkub-official-api-docs)
|