Gathering detailed insights and metrics for okx-api-v5
Installations
npm install okx-api-v5Developer Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
14.17.6
NPM Version
6.14.15
Score
72.5
Supply Chain
98.9
Quality
75.4
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
1
Download Statistics
Total Downloads
2,454
Last Day
1
Last Week
12
Last Month
32
Last Year
190
Bundle Size
4.86 kB
Minified
1.54 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.0.7
Package Id
okx-api-v5@1.0.7
Unpacked Size
30.56 kB
Size
7.44 kB
File Count
7
NPM Version
6.14.15
Node Version
14.17.6
Total Downloads
Cumulative downloads
Total Downloads
2,454
Last day
0%
1
Compared to previous day
Last week
33.3%
12
Compared to previous week
Last month
18.5%
32
Compared to previous month
Last year
-43.5%
190
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
Versions
完成情况
- 交易
- 资金
- 闪兑
- 账户
- 子账户
- 行情数据
- 公共数据
- 交易大数据
- Status
引入使用
1const API = require("okx-api-v5")
正常使用
1 2const api = new API({ 3 api_key: "<key>", 4 secret_key: "<secret>", 5 pass_phrase: "<pass>" 6})
加入代理
1const proxy = { 2 host: '127.0.0.1', 3 port: 7890 4} 5const api = new API({ 6 api_key: "<key>", 7 secret_key: "<secret>", 8 pass_phrase: "<pass>", 9 proxy_setting: proxy 10})
已添加的API列表
公共数据
获取交易产品基础信息
GET /api/v5/public/instruments
1console.info(await api.get_api_v5_public_instruments({instType: "", uly: "", instId: ""}));
获取交割和行权记录
GET /api/v5/public/delivery-exercise-history
1console.info(await api.get_api_v5_public_deliveryExerciseHistory({ 2 instType: "", 3 uly: "", 4 after: "", 5 before: "", 6 limit: "" 7}));
获取持仓总量
GET /api/v5/public/open-interest
1console.info(await api.get_api_v5_public_openInterest({instType: "", uly: "", instId: ""}));
获取永续合约当前资金费率
GET /api/v5/public/funding-rate
1console.info(await api.get_api_v5_public_fundingRate({instId: ""}));
获取永续合约历史资金费率
GET /api/v5/public/funding-rate-history
1console.info(await api.get_api_v5_public_fundingRateHistory({instId: "", before: "", after: "", limit: ""}));
获取限价
GET /api/v5/public/limit-price
1console.info(await api.get_api_v5_public_limitPrice({instId: ""}));
获取期权定价
GET /api/v5/public/opt-summary
1console.info(await api.get_api_v5_public_optSummary({uly: "", expTime: ""}));
获取预估交割/行权价格
GET /api/v5/public/estimated-price
1console.info(await api.get_api_v5_public_estimatedPrice({instId: ""}));
获取免息额度和币种折算率等级
GET /api/v5/public/discount-rate-interest-free-quota
1console.info(await api.get_api_v5_public_discountRateInterestFreeQuota({discountLv: ""}));
获取系统时间
GET /api/v5/public/time
1console.info(await api.get_api_v5_public_time({}));
获取平台公共爆仓单信息
GET /api/v5/public/liquidation-orders
1console.info(await api.get_api_v5_public_liquidationOrders({ 2 instType: "", 3 mgnMode: "", 4 instId: "", 5 ccy: "", 6 uly: "", 7 alias: "", 8 state: "", 9 before: "", 10 after: "", 11 limit: "" 12}));
获取标记价格
GET /api/v5/public/mark-price
1console.info(await api.get_api_v5_public_markPrice({instType: "", instId: "", uly: ""}));
获取衍生品仓位档位
GET /api/v5/public/position-tiers
1console.info(await api.get_api_v5_public_positionTiers({instType: "", instId: "", uly: ""}));
获取市场借币杠杆利率和借币限额
GET /api/v5/public/interest-rate-loan-quota
1console.info(await api.get_api_v5_public_interestRateLoanQuota({ 2 instType: "", 3 tdMode: "", 4 instId: "", 5 uly: "", 6 tier: "" 7}));
获取尊享借币杠杆利率和借币限额
GET /api/v5/public/vip-interest-rate-loan-quota
1console.info(await api.get_api_v5_public_vipInterestRateLoanQuota({}));
获取衍生品标的指数
GET /api/v5/public/underlying
1console.info(await api.get_api_v5_public_underlying({}));
获取风险准备金余额
GET /api/v5/public/insurance-fund
1console.info(await api.get_api_v5_public_insuranceFund({instType: ""}));
交易大数据
获取交易大数据支持币种
GET /api/v5/rubik/stat/trading-data/support-coin
1console.info(await api.get_api_v5_rubik_stat_tradingData_supportCoin({}));
获取主动买入/卖出情况
GET /api/v5/rubik/stat/taker-volume
1console.info(await api.get_api_v5_rubik_stat_takerVolume({ccy: "", instType: "", begin: "", end: "", period: ""}));
获取杠杆多空比
GET /api/v5/rubik/stat/margin/loan-ratio
1console.info(await api.get_api_v5_rubik_stat_margin_loanRatio({ccy: "", begin: "", end: "", period: ""}));
获取合约多空持仓人数比
GET /api/v5/rubik/stat/contracts/long-short-account-ratio
1console.info(await api.get_api_v5_rubik_stat_contracts_longShortAccountRatio({ 2 ccy: "", 3 begin: "", 4 end: "", 5 period: "" 6}));
获取合约持仓量及交易量
GET /api/v5/rubik/stat/contracts/open-interest-volume
1console.info(await api.get_api_v5_rubik_stat_contracts_openInterestVolume({ccy: "", begin: "", end: "", period: ""}));
看涨/看跌期权合约 持仓总量比/交易总量比
GET /api/v5/rubik/stat/option/open-interest-volume-ratio
1console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeRate({ccy: "", period: ""}));
看涨看跌持仓总量及交易总量（按到期日分）
GET /api/v5/rubik/stat/option/open-interest-volume-expiry
1console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeExpiry({ccy: "", period: ""}));
看涨看跌持仓总量及交易总量（按执行价格分）
GET /api/v5/rubik/stat/option/open-interest-volume-strike
1console.info(await api.get_api_v5_rubik_stat_option_openInterestVolumeStrike({ccy: "", expTime: "", period: ""}));
看跌/看涨期权合约 主动买入/卖出量
GET /api/v5/rubik/stat/option/taker-block-volume
1console.info(await api.get_api_v5_rubik_stat_option_takerBlockVolume({ccy: "", period: ""}));
Status
Status
GET /api/v5/system/status
1console.info(await api.get_api_v5_system_status({}));
No vulnerabilities found.
No security vulnerabilities found.