nestjs-ccxt

:star: Star me on GitHub — it motivates me a lot!

CCXT module for NestJS framework with exchange markets cache for better performance. :rocket::rocket:

Installation

$ npm i --save nestjs-ccxt ccxt

Getting started

Firstly import CcxtModule with CcxtModule.forRoot(...) or CcxtModule.forRootAsync(...). Check out the module configuration options

import { CcxtModule } from 'nestjs-ccxt';

@Module({
  imports: [CcxtModule.forRoot({ ... })],
})
export class AppModule {}

Next, inject CcxtService using normal constructor injection.

@Injectable()
export class ExchangeService {
  constructor(private ccxtService: CcxtService) {}

  async getMarkets() {
    const client = await this.ccxtService.getClient('binance');
    return client.markets;
  }
}

Configuration

nestjs-ccxt can be configured with a variety of options. To configure the underlying Ccxt instance, pass an optional ccxtOptions object to the forRoot() method of CcxtModule when importing it. This options object will be passed directly to the underlying Ccxt constructor.

interface Params {
  /**
   * Optional parameters for the underlying Ccxt instance
   * @see https://docs.ccxt.com/en/latest/manual.html#instantiation
   */
  ccxtOptions?: Partial<ccxt.Exchange>;

  /**
   * Default exchanges to be loaded on start up
   * Default: undefined
   */
  defaultExchanges?: ccxt.ExchangeId | ccxt.ExchangeId[];

  /**
   * If `true`, the markets data of the exchanges setted in the `defaultExchanges`
   * options are loaded on startup
   * Default: true
   */
  loadMarketsOnStartup?: boolean;

  /**
   * Markets data cache expiration. Set this value to 0 (zero)
   * to disable caching markets data
   * Default: 3600000 (1 hour => 60 * 60 * 1000)
   */
  marketsCacheExpireMs?: number;

  /**
   * Enable the Testnet if supported by the underlying exchange
   * Default: false
   */
  sandboxMode?: boolean;

  /**
   * If `true`, ccxt logs every HTTP requests to stdout
   * Default: false
   */
  verbose?: boolean;
}

An optional options object can be passed in the getClient() method of CcxtService. This options object will be passed directly to the underlying Ccxt constructor.

const client = await this.ccxtService.getClient('binance', {
  apiKey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET',
});

Contributing

I would greatly appreciate any contributions to make this project better. Please make sure to follow the below guidelines before getting your hands dirty.

1. Fork the repository
2. Create your branch (git checkout -b my-branch)
3. Commit any changes to your branch
4. Push your changes to your remote branch
5. Open a pull request

Donation

If this project help you reduce time to develop, you can give me a cup of coffee 🍵 :)

ETH: 0xEE45AA08D65352d49344f42d9E0EAf14AA3D812d

License

Copyright Andrea Fassina, Licensed under MIT.