-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.
@@ -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 |
| -------- | :------: | :------: | -------- |
@@ -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 |
| -------- | :------: | :------: | -------- |
@@ -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` |
\ No newline at end of file
+| `getFuturesAffiliateTrades()` | :closed_lock_with_key: | GET | `contract/private/affiliate/trade-list` |
diff --git a/docs/images/logoBrightMode1.svg b/docs/images/logoBrightMode1.svg
new file mode 100644
index 0000000..dd1ca6f
--- /dev/null
+++ b/docs/images/logoBrightMode1.svg
@@ -0,0 +1,91 @@
+
diff --git a/docs/images/logoBrightMode2.svg b/docs/images/logoBrightMode2.svg
new file mode 100644
index 0000000..e1d22ac
--- /dev/null
+++ b/docs/images/logoBrightMode2.svg
@@ -0,0 +1,195 @@
+
+
diff --git a/docs/images/logoDarkMode1.svg b/docs/images/logoDarkMode1.svg
new file mode 100644
index 0000000..a64b332
--- /dev/null
+++ b/docs/images/logoDarkMode1.svg
@@ -0,0 +1,195 @@
+
diff --git a/docs/images/logoDarkMode2.svg b/docs/images/logoDarkMode2.svg
new file mode 100644
index 0000000..e368d86
--- /dev/null
+++ b/docs/images/logoDarkMode2.svg
@@ -0,0 +1,174 @@
+
+
diff --git a/package-lock.json b/package-lock.json
index 325b0b5..8c7d2b7 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,15 +1,15 @@
{
"name": "bitmart-api",
- "version": "2.1.3",
+ "version": "2.1.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "bitmart-api",
- "version": "2.1.3",
+ "version": "2.1.4",
"license": "MIT",
"dependencies": {
- "axios": "^1.6.6",
+ "axios": "^1.7.7",
"isomorphic-ws": "^4.0.1",
"ws": "^8.16.0"
},
@@ -1837,11 +1837,11 @@
"integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
},
"node_modules/axios": {
- "version": "1.6.7",
- "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.7.tgz",
- "integrity": "sha512-/hDJGff6/c7u0hDkvkGxR/oy6CbCs8ziCsC7SqmhjfozqiJGc8Z11wrv9z9lYfY4K8l+H9TpjcMDX0xOZmx+RA==",
+ "version": "1.7.7",
+ "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
+ "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
"dependencies": {
- "follow-redirects": "^1.15.4",
+ "follow-redirects": "^1.15.6",
"form-data": "^4.0.0",
"proxy-from-env": "^1.1.0"
}
@@ -4000,12 +4000,12 @@
}
},
"node_modules/micromatch": {
- "version": "4.0.5",
- "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
- "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
"dev": true,
"dependencies": {
- "braces": "^3.0.2",
+ "braces": "^3.0.3",
"picomatch": "^2.3.1"
},
"engines": {
diff --git a/package.json b/package.json
index 50b6d57..a83fae6 100644
--- a/package.json
+++ b/package.json
@@ -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/*",
@@ -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"
},
+