kucoin-universal-sdk
Version:
Official KuCoin Universal SDK.
134 lines (133 loc) • 6.46 kB
TypeScript
import { Transport } from '../../../internal/interfaces/transport';
import { PurchaseReq } from './model_purchase_req';
import { GetPurchaseOrdersReq } from './model_get_purchase_orders_req';
import { PurchaseResp } from './model_purchase_resp';
import { ModifyPurchaseReq } from './model_modify_purchase_req';
import { GetLoanMarketInterestRateReq } from './model_get_loan_market_interest_rate_req';
import { ModifyPurchaseResp } from './model_modify_purchase_resp';
import { GetLoanMarketInterestRateResp } from './model_get_loan_market_interest_rate_resp';
import { GetRedeemOrdersResp } from './model_get_redeem_orders_resp';
import { GetPurchaseOrdersResp } from './model_get_purchase_orders_resp';
import { GetLoanMarketResp } from './model_get_loan_market_resp';
import { RedeemResp } from './model_redeem_resp';
import { GetRedeemOrdersReq } from './model_get_redeem_orders_req';
import { RedeemReq } from './model_redeem_req';
import { GetLoanMarketReq } from './model_get_loan_market_req';
export interface CreditAPI {
/**
* getLoanMarket Get Loan Market
* Description: This API endpoint is used to get the information about the currencies available for lending.
* Documentation: https://www.kucoin.com/docs-new/api-3470212
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | GENERAL |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
getLoanMarket(req: GetLoanMarketReq): Promise<GetLoanMarketResp>;
/**
* getLoanMarketInterestRate Get Loan Market Interest Rate
* Description: This API endpoint is used to get the interest rates of the margin lending market over the past 7 days.
* Documentation: https://www.kucoin.com/docs-new/api-3470215
* +-----------------------+--------+
* | Extra API Info | Value |
* +-----------------------+--------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PUBLIC |
* | API-PERMISSION | NULL |
* | API-RATE-LIMIT-POOL | PUBLIC |
* | API-RATE-LIMIT-WEIGHT | 5 |
* +-----------------------+--------+
*/
getLoanMarketInterestRate(req: GetLoanMarketInterestRateReq): Promise<GetLoanMarketInterestRateResp>;
/**
* purchase Purchase
* Description: Invest credit in the market and earn interest
* Documentation: https://www.kucoin.com/docs-new/api-3470216
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | MARGIN |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 15 |
* +-----------------------+---------+
*/
purchase(req: PurchaseReq): Promise<PurchaseResp>;
/**
* modifyPurchase Modify Purchase
* Description: This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour. Please ensure that the funds are in the main (funding) account.
* Documentation: https://www.kucoin.com/docs-new/api-3470217
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | MARGIN |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
modifyPurchase(req: ModifyPurchaseReq): Promise<ModifyPurchaseResp>;
/**
* getPurchaseOrders Get Purchase Orders
* Description: This API endpoint provides a pagination query for the purchase orders.
* Documentation: https://www.kucoin.com/docs-new/api-3470213
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | GENERAL |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
getPurchaseOrders(req: GetPurchaseOrdersReq): Promise<GetPurchaseOrdersResp>;
/**
* redeem Redeem
* Description: Redeem your loan order.
* Documentation: https://www.kucoin.com/docs-new/api-3470218
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | MARGIN |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 15 |
* +-----------------------+---------+
*/
redeem(req: RedeemReq): Promise<RedeemResp>;
/**
* getRedeemOrders Get Redeem Orders
* Description: This API endpoint provides pagination query for the redeem orders.
* Documentation: https://www.kucoin.com/docs-new/api-3470214
* +-----------------------+---------+
* | Extra API Info | Value |
* +-----------------------+---------+
* | API-DOMAIN | SPOT |
* | API-CHANNEL | PRIVATE |
* | API-PERMISSION | GENERAL |
* | API-RATE-LIMIT-POOL | SPOT |
* | API-RATE-LIMIT-WEIGHT | 10 |
* +-----------------------+---------+
*/
getRedeemOrders(req: GetRedeemOrdersReq): Promise<GetRedeemOrdersResp>;
}
export declare class CreditAPIImpl implements CreditAPI {
private transport;
constructor(transport: Transport);
getLoanMarket(req: GetLoanMarketReq): Promise<GetLoanMarketResp>;
getLoanMarketInterestRate(req: GetLoanMarketInterestRateReq): Promise<GetLoanMarketInterestRateResp>;
purchase(req: PurchaseReq): Promise<PurchaseResp>;
modifyPurchase(req: ModifyPurchaseReq): Promise<ModifyPurchaseResp>;
getPurchaseOrders(req: GetPurchaseOrdersReq): Promise<GetPurchaseOrdersResp>;
redeem(req: RedeemReq): Promise<RedeemResp>;
getRedeemOrders(req: GetRedeemOrdersReq): Promise<GetRedeemOrdersResp>;
}