Skip to content

Commit

Permalink
Merge pull request #17 from tiagosiebler/logodeps
Browse files Browse the repository at this point in the history
v2.1.4: update dependencies, update logo
  • Loading branch information
tiagosiebler authored Sep 10, 2024
2 parents 901e387 + 1139f59 commit 0db0170
Show file tree
Hide file tree
Showing 8 changed files with 689 additions and 20 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Node.js & Typescript BitMart API SDK
# Node.js & JavaScript SDK for BitMart REST API & WebSockets

[![npm version](https://img.shields.io/npm/v/bitmart-api)][1]
[![npm size](https://img.shields.io/bundlephobia/min/bitmart-api/latest)][1]
Expand All @@ -8,7 +8,14 @@
[![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/bitmart-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/bitmart-api)
[![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)

[![connector logo](https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logo1.png?raw=true)][1]
<p align="center">
<a href="https://www.npmjs.com/package/bitmart-api">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
<img alt="SDK Logo" src="https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
</picture>
</a>
</p>

[1]: https://www.npmjs.com/package/bitmart-api

Expand Down
17 changes: 12 additions & 5 deletions docs/endpointFunctionList.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@

# Endpoint maps

[![connector logo](https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logo1.png?raw=true)][1]
<p align="center">
<a href="https://www.npmjs.com/package/bitmart-api">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
<img alt="SDK Logo" src="https://github.com/tiagosiebler/bitmart-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
</picture>
</a>
</p>

Each REST client is a JavaScript class, which provides functions individually mapped to each endpoint available in the exchange's API offering.
Each REST client is a JavaScript class, which provides functions individually mapped to each endpoint available in the exchange's API offering.

The following table shows all methods available in each REST client, whether the method requires authentication (automatically handled if API keys are provided), as well as the exact endpoint each method is connected to.

Expand Down Expand Up @@ -38,7 +45,7 @@ Table consists of 4 parts:

# RestClient.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in [RestClient.ts](/src/RestClient.ts).
This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in [RestClient.ts](/src/RestClient.ts).

| Function | AUTH | HTTP Method | Endpoint |
| -------- | :------: | :------: | -------- |
Expand Down Expand Up @@ -131,7 +138,7 @@ This table includes all endpoints from the official Exchange API docs and corres

# FuturesClientV2.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in [FuturesClientV2.ts](/src/FuturesClientV2.ts).
This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in [FuturesClientV2.ts](/src/FuturesClientV2.ts).

| Function | AUTH | HTTP Method | Endpoint |
| -------- | :------: | :------: | -------- |
Expand Down Expand Up @@ -165,4 +172,4 @@ This table includes all endpoints from the official Exchange API docs and corres
| `getFuturesSubTransfers()` | :closed_lock_with_key: | GET | `account/contract/sub-account/main/v1/transfer-list` |
| `getFuturesSubTransferHistory()` | :closed_lock_with_key: | GET | `account/contract/sub-account/v1/transfer-history` |
| `getFuturesAffiliateRebates()` | :closed_lock_with_key: | GET | `contract/private/affiliate/rebate-list` |
| `getFuturesAffiliateTrades()` | :closed_lock_with_key: | GET | `contract/private/affiliate/trade-list` |
| `getFuturesAffiliateTrades()` | :closed_lock_with_key: | GET | `contract/private/affiliate/trade-list` |
91 changes: 91 additions & 0 deletions docs/images/logoBrightMode1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
195 changes: 195 additions & 0 deletions docs/images/logoBrightMode2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
195 changes: 195 additions & 0 deletions docs/images/logoDarkMode1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
174 changes: 174 additions & 0 deletions docs/images/logoDarkMode2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bitmart-api",
"version": "2.1.3",
"version": "2.1.4",
"description": "Complete & robust Node.js SDK for BitMart's REST APIs and WebSockets, with TypeScript declarations.",
"scripts": {
"clean": "rm -rf dist/*",
Expand All @@ -26,7 +26,7 @@
"Jerko J (https://github.com/JJ-Cro)"
],
"dependencies": {
"axios": "^1.6.6",
"axios": "^1.7.7",
"isomorphic-ws": "^4.0.1",
"ws": "^8.16.0"
},
Expand Down

0 comments on commit 0db0170

Please sign in to comment.