okex-withdrawal-fee/README.md

Get OKEx withdrawal fees of all currencies.

# okex-withdrawal-fee

Get OKEx withdrawal fees of all currencies.

## Quick start

```bash
npx okex-withdrawal-fee USDT ERC20
```

## How to use

```javascript
/* eslint-disable import/no-unresolved,no-console */
const { getWithdrawalFee } = require('okex-withdrawal-fee');

console.info(getWithdrawalFee('BTC'));

console.info(getWithdrawalFee('USDT', 'ERC20'));
```

## API Manual

There is only one API in this library:

```typescript
/**
 * Get withdrawal fee of the symbol.
 *
 * @param symbol The symbol name
 * @param platform The platform, optional
 * @returns WithdrawalFee or undefined
 */
export declare function getWithdrawalFee(
  symbol: string,
  platform?: string,
): WithdrawalFee | undefined;
```

Which returns a `WithdrawalFee`:

```typescript
export interface WithdrawalFee {
  withdrawal_fee: number;
  min_withdraw_amount: number;
  platform?: 'ERC20' | 'TRC20' | 'OMNI';
}
```