okx-api
Version:
Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests
95 lines (94 loc) • 2.44 kB
TypeScript
export interface CollateralAsset {
ccy: string;
amt: string;
notionalUsd: string;
}
export interface CollateralAssetsResponse {
assets: CollateralAsset[];
}
export interface SupplementaryCollateral {
ccy: string;
amt: string;
}
export interface GetFlexibleLoanCollateralAssetsRequest {
ccy?: string;
/** When the account has multiple active flexible-loan positions. */
ordId?: string;
}
export interface MaxLoanRequest {
borrowCcy: string;
supCollateral?: SupplementaryCollateral[];
/** When multiple active loans exist. */
ordId?: string;
}
export interface MaxLoanResponse {
borrowCcy: string;
maxLoan: string;
notionalUsd: string;
remainingQuota: string;
}
export interface AdjustCollateralRequest {
type: 'add' | 'reduce';
collateralCcy: string;
collateralAmt: string;
/** When multiple active loans exist. */
ordId?: string;
}
export interface LoanCurrencyData {
ccy: string;
amt: string;
}
export interface RiskWarningData {
instId: string;
liqPx: string;
}
export interface GetLoanInfoRequest {
/** When the account has multiple active flexible loans . */
ordId?: string;
}
export interface LoanInfo {
/**
* Active loan / position id when the account can hold multiple loan orders.
*/
ordId?: string;
loanNotionalUsd: string;
loanData: LoanCurrencyData[];
/** Adjusted collateral value in USD. */
collateralNotionalUsd: string;
collateralData: LoanCurrencyData[];
riskWarningData: RiskWarningData;
curLTV: string;
marginCallLTV: string;
liqLTV: string;
}
export interface LoanHistoryRequest {
type?: 'borrowed' | 'repaid' | 'collateral_locked' | 'collateral_released' | 'forced_repayment_buy' | 'forced_repayment_sell' | 'forced_liquidation' | 'partial_liquidation';
/** When multiple active loans exist. */
ordId?: string;
after?: string;
before?: string;
limit?: string;
}
export interface LoanHistoryItem {
refId: string;
type: string;
ccy: string;
amt: string;
ts: string;
}
export interface AccruedInterestRequest {
ccy?: string;
/** When multiple active loans exist. */
ordId?: string;
after?: string;
before?: string;
limit?: string;
}
export interface AccruedInterestItem {
refId: string;
ccy: string;
loan: string;
interest: string;
interestRate: string;
ts: string;
}