Skip to content

Commit 3538e17

Browse files
JJ-CroJJ-Cro
committed
feat(v3.1.5): enhance API documentation and examples
- Updated `llms.txt` to reflect changes in directory structure and added new request/response types for affiliate and stable rewards. - Removed deprecated dual investment request types from `src/types/rest/request/dual-investment.ts`. - Added new request and response types for recurring buy functionality in `src/types/rest/response/private-recurring-buy.ts`. - Updated multiple example scripts to use ES6 import syntax for the RestClient. - Enhanced the API documentation in `docs/endpointFunctionList.md` to include new endpoints and examples.
1 parent 4cb7db2 commit 3538e17

385 files changed

Lines changed: 11551 additions & 10089 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/endpointFunctionList.md‎

Lines changed: 374 additions & 363 deletions
Large diffs are not rendered by default.

‎examples/apidoc/RestClient/activateOption.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/account/activate-option
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/account/activate-option
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/adjustCollateral.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/finance/flexible-loan/adjust-collateral
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/finance/flexible-loan/adjust-collateral
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/adjustGridInvestment.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/tradingBot/grid/adjust-investment
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/tradingBot/grid/adjust-investment
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/adjustGridMarginBalance.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/tradingBot/grid/margin-balance
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/tradingBot/grid/margin-balance
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/amendAlgoOrder.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/trade/amend-algos
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/trade/amend-algos
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/amendGridAlgoOrder.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/tradingBot/grid/amend-order-algo
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/tradingBot/grid/amend-order-algo
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/amendLendingOrder.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/finance/fixed-loan/amend-lending-order
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/finance/fixed-loan/amend-lending-order
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/amendMultipleOrders.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/trade/amend-batch-orders
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/trade/amend-batch-orders
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

‎examples/apidoc/RestClient/amendOrder.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
const { RestClient } = require('okx-api');
1+
import { RestClient } from 'okx-api';
2+
// or, if require is preferred:
3+
// const { RestClient } = require('okx-api');
24

3-
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
4-
// This OKX API SDK is available on npm via "npm install okx-api"
5-
// ENDPOINT: /api/v5/trade/amend-order
6-
// METHOD: POST
7-
// PUBLIC: NO
5+
// This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
6+
// This OKX API SDK is available on npm via "npm install okx-api"
7+
// ENDPOINT: /api/v5/trade/amend-order
8+
// METHOD: POST
9+
// PUBLIC: NO
810

911
const client = new RestClient({
1012
apiKey: 'apiKeyHere',

0 commit comments

Comments
 (0)