bitkub-client
v1.4.3
Published
A client wrapper class for calling the Bitkub APIs
Downloads
17
Maintainers
Readme
A wrapper client class for calling Bitkub APIs.
Installation
By npm
npm install bitkub-client
By yarn
yarn add bitkub-client
How to use
- Create the APK key and secret from the Bitkub exchange
- Create an
BitkubClient
object by putting them to the constructor.
import BitkubClient, {BitkubEnvironment} from "bitkub-client"
const client = new BitkubClient (
"[YOUR_API_KEY]",
"[YOUR_API_SECRET]",
BitkubEnvironment.PRODUCTION
);
Now, you can call the Bitkub API through these functions. Please see more details at bitkub-client document.
If you want to call other POST APIs which is not in the list above, you can use
buildRequestHeaders()
to build your HTTP headers. It includesX-BTK-TIMESTAMP
andX-BTK-SIGN
to the headers. They're required fields for all secured APIs for version 3.
const uri = `/v3/market/cancel-order`
const requestHeaders = client.buildRequestHeaders('POST',uri,payload)
Notes : If you're using client version 1.3 above, it will call Bitkub API version 3. You must generate a new API key on the Bitkub website.
Contributions
Pull Requests
Feel free to send the PR if you're interested. Thanks!
Test Running
We only create the integration tests which we can make sure that the request are proceeded in the Bitkub servers.
You can run them through yarn test
.
To write the test, I suggest to create the mock API by nock
library. This will avoid changing the account data. And we can ensure the client will call the API correctly. You can see the example test in BitkubClient.test.ts