!GitHub license
!GitHub stars
!GitHub forks
!Last Commit
#### 完成情况

- [ ] 交易
- [ ] 资金
- [ ] 闪兑
- [ ] 账户
- [ ] 子账户
- [ ] 行情数据
- [x] 公共数据
- [x] 交易大数据
- [x] Status

#### 引入使用

``javascript
const API = require("okx-api-v5")
`

#### 正常使用

`javascript

const api = new API({
api_key: "",
secret_key: "",
pass_phrase: ""
})
`

#### 加入代理

`javascript
const proxy = {
host: '127.0.0.1',
port: 7890
}
const api = new API({
api_key: "",
secret_key: "",
pass_phrase: "",
proxy_setting: proxy
})
`

已添加的API列表

公共数据

$3

#### GET /api/v5/public/instruments

`javascript
console.info(await api.get_api_v5_public_instruments({instType: "", uly: "", instId: ""}));
`

$3

#### GET /api/v5/public/delivery-exercise-history

`javascript
console.info(await api.get_api_v5_public_deliveryExerciseHistory({
instType: "",
uly: "",
after: "",
before: "",
limit: ""
}));
`

$3

#### GET /api/v5/public/open-interest

`javascript
console.info(await api.get_api_v5_public_openInterest({instType: "", uly: "", instId: ""}));
`

$3

#### GET /api/v5/public/funding-rate

`javascript
console.info(await api.get_api_v5_public_fundingRate({instId: ""}));
`

$3

#### GET /api/v5/public/funding-rate-history

`javascript
console.info(await api.get_api_v5_public_fundingRateHistory({instId: "", before: "", after: "", limit: ""}));
`

$3

#### GET /api/v5/public/limit-price

`javascript
console.info(await api.get_api_v5_public_limitPrice({instId: ""}));
`

$3

#### GET /api/v5/public/opt-summary

`javascript
console.info(await api.get_api_v5_public_optSummary({uly: "", expTime: ""}));
`

$3

#### GET /api/v5/public/estimated-price

`javascript
console.info(await api.get_api_v5_public_estimatedPrice({instId: ""}));
`

$3

#### GET /api/v5/public/discount-rate-interest-free-quota

`javascript
console.info(await api.get_api_v5_public_discountRateInterestFreeQuota({discountLv: ""}));
`

$3

#### GET /api/v5/public/time

`javascript
console.info(await api.get_api_v5_public_time({}));
`

$3

#### GET /api/v5/public/liquidation-orders

`javascript
console.info(await api.get_api_v5_public_liquidationOrders({
instType: "",
mgnMode: "",
instId: "",
ccy: "",
uly: "",
alias: "",
state: "",
before: "",
after: "",
limit: ""
}));
`

$3

#### GET /api/v5/public/mark-price

`javascript
console.info(await api.get_api_v5_public_markPrice({instType: "", instId: "", uly: ""}));
`

$3

#### GET /api/v5/public/position-tiers

`javascript
console.info(await api.get_api_v5_public_positionTiers({instType: "", instId: "", uly: ""}));
`

$3

#### GET /api/v5/public/interest-rate-loan-quota

`javascript
console.info(await api.get_api_v5_public_interestRateLoanQuota({
instType: "",
tdMode: "",
instId: "",
uly: "",
tier: ""
}));
`

$3

#### GET /api/v5/public/vip-interest-rate-loan-quota

`javascript
console.info(await api.get_api_v5_public_vipInterestRateLoanQuota({}));
`

$3

#### GET /api/v5/public/underlying

`javascript
console.info(await api.get_api_v5_public_underlying({}));
`

$3

#### GET /api/v5/public/insurance-fund

`javascript
console.info(await api.get_api_v5_public_insuranceFund({instType: ""}));
`

交易大数据

$3

#### GET /api/v5/rubik/stat/trading-data/support-coin

`javascript
console.info(await api.get_api_v5_rubik_stat_tradingData_supportCoin({}));
`

$3

#### GET /api/v5/rubik/stat/taker-volume

`javascript
console.info(await api.get_api_v5_rubik_stat_takerVolume({ccy: "", instType: "", begin: "", end: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/margin/loan-ratio

`javascript
console.info(await api.get_api_v5_rubik_stat_margin_loanRatio({ccy: "", begin: "", end: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/contracts/long-short-account-ratio

`javascript
console.info(await api.get_api_v5_rubik_stat_contracts_longShortAccountRatio({
ccy: "",
begin: "",
end: "",
period: ""
}));
`

$3

#### GET /api/v5/rubik/stat/contracts/open-interest-volume

`javascript
console.info(await api.get_api_v5_rubik_stat_contracts_openInterestVolume({ccy: "", begin: "", end: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/option/open-interest-volume-ratio

`javascript
console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeRate({ccy: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/option/open-interest-volume-expiry

`javascript
console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeExpiry({ccy: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/option/open-interest-volume-strike

`javascript
console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeStrike({ccy: "", expTime: "", period: ""}));
`

$3

#### GET /api/v5/rubik/stat/option/taker-block-volume

`javascript
console.info(await api.get_api_v5_rubik_stat_option_takerBlockVolume({ccy: "", period: ""}));
`

Status

$3

#### GET /api/v5/system/status

`javascript
console.info(await api.get_api_v5_system_status({}));
``