Module: Kucoin::Api

Defined in:

lib/kucoin/api.rb,
lib/kucoin/api/rest.rb,
lib/kucoin/api/error.rb,
lib/kucoin/api/version.rb,
lib/kucoin/api/endpoints.rb,
lib/kucoin/api/websocket.rb,
lib/kucoin/api/endpoints/base.rb,
lib/kucoin/api/endpoints/user.rb,
lib/kucoin/api/endpoints/other.rb,
lib/kucoin/api/endpoints/trade.rb,
lib/kucoin/api/rest/connection.rb,
lib/kucoin/api/endpoints/markets.rb,
lib/kucoin/api/endpoints/websocket.rb,
lib/kucoin/api/endpoints/trade/fills.rb,
lib/kucoin/api/endpoints/trade/orders.rb,
lib/kucoin/api/endpoints/user/accounts.rb,
lib/kucoin/api/endpoints/user/deposits.rb,
lib/kucoin/api/middleware/auth_request.rb,
lib/kucoin/api/middleware/nonce_request.rb,
lib/kucoin/api/endpoints/markets/symbols.rb,
lib/kucoin/api/endpoints/markets/tickers.rb,
lib/kucoin/api/endpoints/user/withdrawals.rb,
lib/kucoin/api/endpoints/markets/histories.rb,
lib/kucoin/api/endpoints/markets/currencies.rb,
lib/kucoin/api/endpoints/markets/order_book.rb

Defined Under Namespace

Modules: Endpoints, Middleware Classes: ClientError, Error, InvalidParamError, MissingApiKeyError, MissingApiPassphraseError, MissingApiSecretError, MissingParamError, REST, Websocket

Constant Summary

VERSION =

"0.2.1"

ENDPOINTS =

{
  user:  {
    accounts: {
      index:            '/api/v1/accounts',
      inner_transfer:   '/api/v1/accounts/inner-transfer',
      # member
      show:             '/api/v1/accounts/:account_id',
      ledgers:          '/api/v1/accounts/:account_id/ledgers',
      holds:            '/api/v1/accounts/:account_id/holds',
    },
    deposits: {
      create:           '/api/v1/deposit-addresses',
      index:            '/api/v1/deposits',
      # member
      show:             '/api/v1/deposit-addresses?currency=:currency',
    },
    withdrawals: {
      index:            '/api/v1/withdrawals',
      quotas:           '/api/v1/withdrawals/quotas',
      # member
      delete:           '/api/v1/withdrawals/:withdrawal_id',
    }
  },
  trade:  {
    orders: {
      index:              '/api/v1/orders',
      recent:             '/api/v1/limit/orders',
      # member
      show:               '/api/v1/orders/:order_id',
    },
    fills: {
      index:              '/api/v1/fills',
      recent:             '/api/v1/limit/fills',
    }
  },
  markets: {
    index:                '/api/v1/markets',
    # member
    stats:                '/api/v1/market/stats?symbol=:symbol',
    symbols: {
      index:              '/api/v1/symbols',
    },
    tickers: {
      # member
      index:              '/api/v1/market/allTickers',
      inside:             '/api/v1/market/orderbook/level1?symbol=:symbol',
    },
    order_book: {
      part_aggregated:    '/api/v1/market/orderbook/level2_:depth?symbol=:symbol',
      full_aggregated:    '/api/v2/market/orderbook/level2?symbol=:symbol',
      full_atomic:        '/api/v1/market/orderbook/level3?symbol=:symbol',
    },
    histories: {
      trade:              '/api/v1/market/histories?symbol=:symbol',
      klines:             '/api/v1/market/candles?symbol=:symbol'
    },
    currencies: {
      index:              '/api/v1/currencies',
      fiat:               '/api/v1/prices',
      # member
      show:               '/api/v1/currencies/:currency',
    }
  },
  other: {
    timestamp:            '/api/v1/timestamp'
  },

  websocket: {
    public:                '/api/v1/bullet-public',
    private:               '/api/v1/bullet-private'
  }
}

Class Method Summary

• .default_key ⇒ Object
• .default_passphrase ⇒ Object
• .default_secret ⇒ Object

Class Method Details

.default_key ⇒ Object

# File 'lib/kucoin/api.rb', line 22

def self.default_key
  ENV['KUCOIN_API_KEY'].to_s
end

.default_passphrase ⇒ Object

# File 'lib/kucoin/api.rb', line 30

def self.default_passphrase
  ENV['KUCOIN_API_PASSPHRASE'].to_s
end

.default_secret ⇒ Object

# File 'lib/kucoin/api.rb', line 26

def self.default_secret
  ENV['KUCOIN_API_SECRET'].to_s
end