@mxlabs/okxnotify
Version:
OKX notification package with Feishu, Cloudflare Workers, and Gemini AI agent integration - Complete bundle
107 lines (106 loc) • 3.52 kB
TypeScript
/**
* 资金费率响应数据接口
*/
export interface FundingRateData {
/** 产品类型 SWAP：永续合约 */
instType: string;
/** 产品ID，如 BTC-USD-SWAP 或 ANY */
instId: string;
/**
* 资金费收取逻辑
* current_period：当期收
* next_period：跨期收（不再支持跨期收合约）
*/
method: string;
/**
* 公式类型
* noRate：旧资金费率计算公式
* withRate：新资金费率计算公式
*/
formulaType: string;
/** 资金费率 */
fundingRate: string;
/**
* 下一期预测资金费率
* 当收取逻辑为 current_period 时，nextFundingRate字段将返回""（不再支持跨期收合约）
*/
nextFundingRate: string;
/** 资金费时间，Unix时间戳的毫秒数格式，如 1597026383085 */
fundingTime: string;
/** 下一期资金费时间，Unix时间戳的毫秒数格式，如 1622851200000 */
nextFundingTime: string;
/** 下一期的预测资金费率下限 */
minFundingRate: string;
/** 下一期的预测资金费率上限 */
maxFundingRate: string;
/** 利率 */
interestRate: string;
/** 深度加权金额（计价币数量） */
impactValue: string;
/**
* 资金费率结算状态
* processing：结算中
* settled：已结算
*/
settState: string;
/**
* 若 settState = processing，该字段代表用于本轮结算的资金费率；
* 若 settState = settled，该字段代表用于上轮结算的资金费率
*/
settFundingRate: string;
/** 溢价，为合约的中间价和指数价格的差异 */
premium: string;
/** 数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085 */
ts: string;
}
/**
* 资金费率请求参数接口
*/
export interface FundingRateParams {
/** 产品ID，如 BTC-USD-SWAP，或 ANY 以返回所有永续合约的资金费率信息 */
instId: string;
}
/**
* 获取指定产品的资金费率
* @param instId 产品ID，如 BTC-USD-SWAP
* @returns Promise<FundingRateData[]>
*/
export declare function getFundingRateByInstId(params: FundingRateParams): Promise<FundingRateData[]>;
/**
* 历史资金费率请求参数接口
*/
export interface FundingRateHistoryParams {
/** 产品ID，如 BTC-USD-SWAP */
instId: string;
/** 开始时间，Unix时间戳的毫秒数，最近三个月 */
begin?: string;
/** 结束时间，Unix时间戳的毫秒数，最近三个月 */
end?: string;
/** 返回结果的数量，最大100，默认100 */
limit?: string;
}
/**
* 历史资金费率返回数据接口
*/
export interface FundingRateHistoryData {
/** 产品类型，如 SWAP */
instType: string;
/** 产品ID，如 BTC-USD-SWAP */
instId: string;
/** 公式类型，noRate: 旧资金费率计算公式，withRate: 新资金费率计算公式 */
formulaType: string;
/** 资金费率 */
fundingRate: string;
/** 实际资金费率 */
realizedRate: string;
/** 资金费率结算时间，Unix时间戳的毫秒数 */
fundingTime: string;
/** 资金费率收取类型，current_period: 当前收，next_period: 跨期收 */
method: string;
}
/**
* 获取历史资金费率（最近三个月）
* @param params 请求参数
* @returns Promise<FundingRateHistoryData[]>
*/
export declare function getFundingRateHistory(params: FundingRateHistoryParams): Promise<FundingRateHistoryData[]>;