Struct kucoin_rs::kucoin::client::Kucoin

pub struct Kucoin {
    pub prefix: String,
    pub client: Client,
    // some fields omitted
}

Fields

prefix: String

client: Client

Implementations

impl Kucoin

pub fn new(
    environment: KucoinEnv,
    credentials: Option<Credentials>
) -> Result<Self, Error>

pub async fn get(
    &self,
    url: String,
    sign: Option<HeaderMap>
) -> Result<Response, APIError>

pub async fn post(
    &self,
    url: String,
    sign: Option<HeaderMap>,
    params: Option<HashMap<String, String>>
) -> Result<Response, APIError>

pub async fn delete(
    &self,
    url: String,
    sign: Option<HeaderMap>
) -> Result<Response, APIError>

pub fn sign_headers(
    &self,
    endpoint: String,
    params: Option<&HashMap<String, String>>,
    query: Option<String>,
    method: Method
) -> Result<HeaderMap, Error>

impl Kucoin

pub async fn get_mark_price(
    &self,
    symbol: &str
) -> Result<APIDatum<MarkPrice>, APIError>

pub async fn get_margin_config_info(
    &self
) -> Result<APIDatum<MarginInfo>, APIError>

pub async fn get_margin_accounts(
    &self
) -> Result<APIDatum<MarginAccounts>, APIError>

pub async fn post_borrow_order(
    &self,
    currency: &str,
    trade_type: &str,
    size: f64,
    max_rate: Option<f64>,
    term: Option<&str>
) -> Result<APIDatum<BorrowOrderId>, APIError>

Term param is comma delimited. Avaialble terms are 7,14,28

pub async fn get_borrow_order(
    &self,
    order_id: &str
) -> Result<APIDatum<BorrowOrder>, APIError>

pub async fn get_repay_record(
    &self,
    currency: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<RepayRecord>>, APIError>

pub async fn get_repayment_record(
    &self,
    currency: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<RepaymentRecord>>, APIError>

pub async fn one_click_repayment(
    &self,
    currency: &str,
    sequence: &str,
    size: f64
) -> Result<APIDatum<String>, APIError>

pub async fn repay_single_order(
    &self,
    currency: &str,
    trade_id: &str,
    size: f64
) -> Result<APIDatum<String>, APIError>

pub async fn post_lend_order(
    &self,
    currency: &str,
    size: f32,
    daily_int_rate: f32,
    term: i32
) -> Result<APIDatum<MarginOrderId>, APIError>

pub async fn cancel_lend_order(
    &self,
    order_id: &str
) -> Result<APIDatum<String>, APIError>

pub async fn set_auto_lend(
    &self,
    currency: &str,
    is_enable: bool,
    retain_size: Option<f32>,
    daily_int_rate: Option<f32>,
    term: Option<i32>
) -> Result<APIDatum<String>, APIError>

pub async fn get_active_order(
    &self,
    currency: &str,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<MarginOrder>>, APIError>

pub async fn get_lend_history(
    &self,
    currency: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<MarginHistory>>, APIError>

pub async fn get_active_lend(
    &self,
    currency: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<LendOrder>>, APIError>

pub async fn get_settled_lend(
    &self,
    currency: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<LendHistory>>, APIError>

pub async fn get_lend_record(
    &self,
    currency: Option<&str>
) -> Result<APIData<LendRecord>, APIError>

pub async fn get_lend_market_data(
    &self,
    currency: &str,
    term: Option<i32>
) -> Result<APIData<LendMarketData>, APIError>

pub async fn get_margin_trade_data(
    &self,
    currency: &str
) -> Result<APIData<MarginTradeData>, APIError>

impl Kucoin

pub async fn get_symbol_list(
    &self,
    market: Option<&str>
) -> Result<APIData<SymbolList>, APIError>

pub async fn get_ticker(
    &self,
    symbol: &str
) -> Result<APIDatum<Ticker>, APIError>

pub async fn get_all_tickers(&self) -> Result<APIDatum<AllTickers>, APIError>

pub async fn get_daily_stats(
    &self,
    symbol: &str
) -> Result<APIDatum<DailyStats>, APIError>

pub async fn get_market_list(&self) -> Result<APIData<String>, APIError>

pub async fn get_orderbook(
    &self,
    symbol: &str,
    amount: OrderBookType
) -> Result<APIDatum<OrderBook>, APIError>

pub async fn get_atomic_orderbook(
    &self,
    symbol: &str
) -> Result<APIDatum<AtomicOrderBook>, APIError>

pub async fn get_trade_histories(
    &self,
    symbol: &str
) -> Result<APIData<TradeHistories>, APIError>

pub async fn get_klines(
    &self,
    klines: Klines,
    symbol: &str,
    start_at: Option<i64>,
    end_at: Option<i64>
) -> Result<APIData<Vec<String>>, APIError>

pub async fn get_currencies(&self) -> Result<APIData<Currency>, APIError>

pub async fn get_currency(
    &self,
    currency: &str,
    chain: Option<Chain>
) -> Result<APIDatum<Currency>, APIError>

pub async fn get_fiat_prices(
    &self,
    base: Option<&str>,
    currencies: Option<&str>
) -> Result<APIDatum<HashMap<String, String>>, APIError>

pub async fn get_server_time(&self) -> Result<APIDatum<i64>, APIError>

impl Kucoin

pub async fn post_limit_order(
    &self,
    client_oid: &str,
    symbol: &str,
    side: &str,
    price: &str,
    size: &str,
    optionals: Option<OrderOptionals<'_>>
) -> Result<APIDatum<OrderResp>, APIError>

Places a limit order. Takes required inputs directly and a Some type, or None for optional inputs. See OrderOptionals for build pattern usage to simplify generating optional params.

pub async fn post_market_order(
    &self,
    client_oid: &str,
    symbol: &str,
    side: &str,
    size: Option<f32>,
    funds: Option<f32>,
    optionals: Option<OrderOptionals<'_>>
) -> Result<APIDatum<OrderResp>, APIError>

Places a market order. Takes required inputs directly and a Some type, or None for optional inputs. See OrderOptionals for build pattern usage to simplify generating optional params.

Note that size is the amount in the base currency and funds is the amount in quote currency. Users should only use one or the other the order will fail. One of the two is a required parameter.

pub async fn cancel_order(
    &self,
    order_id: &str
) -> Result<APIDatum<CancelResp>, APIError>

Cancels an order based on the provided order id (required).

pub async fn cancel_order_by_client_oid(
    &self,
    client_oid: &str
) -> Result<APIDatum<CancelByClientOidResp>, APIError>

Cancels an order based on the provided order id (required).

pub async fn cancel_all_orders(
    &self,
    symbol: Option<&str>,
    trade_type: Option<&str>
) -> Result<APIDatum<CancelResp>, APIError>

pub async fn get_orders(
    &self,
    optionals: Option<OrderInfoOptionals<'_>>
) -> Result<APIDatum<Pagination<OrderInfo>>, APIError>

pub async fn get_v1_historical_orders(
    &self,
    symbol: Option<&str>,
    start_at: Option<i64>,
    end_at: Option<i64>,
    side: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<HistoricalOrder>>, APIError>

pub async fn get_recent_orders(&self) -> Result<APIData<OrderInfo>, APIError>

pub async fn get_order(
    &self,
    order_id: &str
) -> Result<APIDatum<OrderInfo>, APIError>

pub async fn get_fills(
    &self,
    optionals: Option<FillsOptionals<'_>>
) -> Result<APIDatum<Pagination<FillsInfo>>, APIError>

pub async fn get_recent_fills(&self) -> Result<APIData<FillsInfo>, APIError>

impl Kucoin

pub async fn get_user_subaccount_info(
    &self
) -> Result<APIData<UserInfo>, APIError>

pub async fn create_account(
    &self,
    account_type: AccountType,
    currency: &str
) -> Result<APIDatum<AccountId>, APIError>

pub async fn get_accounts_list(
    &self,
    currency: Option<&str>,
    acct_type: Option<&str>
) -> Result<APIData<Accounts>, APIError>

pub async fn get_account(
    &self,
    account_id: &str
) -> Result<APIDatum<SingleAccount>, APIError>

pub async fn get_account_ledgers(
    &self,
    account_id: &str,
    start_at: Option<i64>,
    end_at: Option<i64>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<AccountInfo>>, APIError>

pub async fn get_hold(
    &self,
    account_id: &str,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<AccountHolds>>, APIError>

pub async fn get_subaccount_balances(
    &self,
    account_id: &str
) -> Result<APIDatum<SubAccountBalances>, APIError>

pub async fn get_all_subaccount_balances(
    &self
) -> Result<APIData<SubAccountBalances>, APIError>

pub async fn get_transferable_balance(
    &self,
    currency: &str,
    account_type: AccountType
) -> Result<APIDatum<TransferableBalance>, APIError>

pub async fn transfer_to_subaccount(
    &self,
    client_oid: &str,
    currency: &str,
    amount: f32,
    direction: &str,
    sub_user_id: &str,
    account_type: Option<&str>,
    sub_account_type: Option<&str>
) -> Result<APIDatum<OrderId>, APIError>

pub async fn inner_transfer(
    &self,
    client_oid: &str,
    currency: &str,
    from: &str,
    to: &str,
    amount: &str
) -> Result<APIDatum<OrderId>, APIError>

pub async fn create_deposit_address(
    &self,
    currency: &str,
    chain: Option<&str>
) -> Result<APIDatum<DepositAddress>, APIError>

pub async fn get_deposit_address(
    &self,
    currency: &str,
    chain: Option<&str>
) -> Result<APIDatum<DepositAddress>, APIError>

pub async fn get_deposit_list(
    &self,
    currency: Option<&str>,
    start_at: Option<i64>,
    end_at: Option<i64>,
    status: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<DepositList>>, APIError>

pub async fn get_v1_deposit_list(
    &self,
    currency: Option<&str>,
    start_at: Option<i64>,
    end_at: Option<i64>,
    status: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<DepositListV1>>, APIError>

pub async fn get_withdrawals_list(
    &self,
    currency: Option<&str>,
    start_at: Option<i64>,
    end_at: Option<i64>,
    status: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<WithdrawalList>>, APIError>

pub async fn get_v1_withdrawals_list(
    &self,
    currency: Option<&str>,
    start_at: Option<i64>,
    end_at: Option<i64>,
    status: Option<&str>,
    current_page: Option<i32>,
    page_size: Option<i32>
) -> Result<APIDatum<Pagination<WithdrawalListV1>>, APIError>

pub async fn get_withdrawals_quotas(
    &self,
    currency: &str,
    chain: Option<&str>
) -> Result<APIDatum<WithdrawalQuotas>, APIError>

pub async fn apply_withdrawal(
    &self,
    currency: &str,
    address: &str,
    amount: i32,
    memo: Option<&str>,
    is_inner: Option<bool>,
    remark: Option<&str>,
    chain: Option<&str>
) -> Result<APIDatum<WithdrawalId>, APIError>

pub async fn cancel_withdrawal(
    &self,
    withdrawal_id: &str
) -> Result<String, APIError>

impl Kucoin

pub fn websocket(&self) -> KucoinWebsocket

pub async fn ws_bullet_private(
    &self
) -> Result<APIDatum<InstanceServers>, APIError>

pub async fn ws_bullet_public(
    &self
) -> Result<APIDatum<InstanceServers>, APIError>

pub async fn get_socket_endpoint(
    &self,
    ws_type: WSType
) -> Result<String, APIError>

Trait Implementations

impl Clone for Kucoin

fn clone(&self) -> Kucoin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Kucoin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.