Class Client

Parameters

• Optional marketName: string

Returns Promise<boolean>

Example

const result = await nash.cancelAllOrders('neo_gas')
console.log(result)

Parameters

• orderID: string

• marketName: string

Returns Promise<CancelledOrder>

Example

const cancelledOrder = await nash.cancelOrder('11')
console.log(cancelledOrder)

Returns NashSocketEvents

Example

import { Client, EnvironmentConfiguration } from '@neon-exchange/api-client-typescript'

const nash = new Client(EnvironmentConfiguration.sandbox)
await nash.login({ email, password })

const connection = nash.createSocketConnection()

// Getting the orderbook for the neo_eth marked
connection.onUpdatedOrderbook(
 { marketName: 'neo_eth' },
 {
   onResult: ({
     data: {
       updatedOrderBook: { bids, asks }
     }
   }) => {
     console.log(`updated bids ${bids.length}`)
     console.log(`updated asks ${asks.length}`)
   }
 }
)

// Getting the user orderobok for all markets
connection.onUpdatedAccountOrders(
 {},
 {
   onResult: ({
     data: {
       updatedAccountOrders
     }
   }) => {
     console.log(`Updated orders: {updatedAccountOrders.length}`)
   }
 }
)

Parameters

• currency: CryptoCurrency

Returns Promise<AccountBalance>

Example

import { CryptoCurrency } from '@neon-exchange/api-client-typescript'

const accountBalance = await nash.getAcountBalance(CryptoCurrency.ETH)
console.log(accountBalance)

Parameters

• orderID: string

Returns Promise<Order>

Example

const order = await nash.getAccountOrder('999')
console.log(order)

Parameters

• Default value __namedParameters: object = {}

  • fiatSymbol: FiatCurrency

  • period: Period

Returns Promise<AccountPortfolio>

Example

const accountPortfolio = await nash.getAccountPortfolio()
console.log(accountPortfolio)

Parameters

• assetList: string[]

Returns Promise<AssetsNoncesData[]>

Example

const getNoncesData = await nash.getAssetNonces()
console.log(getNoncesData)

Parameters

• currency: CryptoCurrency

Returns Promise<AccountDepositAddress>

Example

import { CryptoCurrency } from '@neon-exchange/api-client-typescript'

const address = await nash.getDepositAddress(CryptoCurrency.NEO)
console.log(address)

Parameters

• marketName: string

Returns Promise<Market>

Example

const market = await nash.getMarket('neo_gas')
console.log(market)

Parameters

• movementID: number

Returns Promise<Movement>

Example

const movement = await nash.getMovement(1)
console.log(movement)

Parameters

• marketName: string

Returns Promise<OrderBook>

Example

const orderBook = await nash.getOrderBook('neo_gas')
console.log(orderBook.bids)

Parameters

• asset: string

Returns Promise<OrdersForMovementData>

Example

const getOrdersForMovementData = await nash.getOrdersForMovement(unit)
console.log(getOrdersForMovementData)

Returns Promise<SyncState[]>

Example

const getSignSyncStates = await nash.getSignAndSyncStates()
console.log(getSignSyncStates)

Parameters

• marketName: string

Returns Promise<Ticker>

Example

const ticker = await nash.getTicker('neo_gas')
console.log(ticker)

Parameters

• ignoreLowBalance: any

Returns Promise<AccountBalance[]>

Example

const accountBalance = await nash.listAccountBalances()
console.log(accountBalance)

Parameters

• Default value __namedParameters: object = {}

  • before: string

  • buyOrSell: OrderBuyOrSell

  • limit: number

  • marketName: string

  • rangeStart: string

  • rangeStop: string

  • shouldIncludeTrades: boolean

  • status: Object

  • type: Object

Returns Promise<AccountOrder>

Example

const accountOrder = await nash.listAccountOrders({
  marketName : 'neo_eth'
})
console.log(accountOrder.orders)

Parameters

• Default value __namedParameters: object = {}

  • before: string

  • limit: number

  • marketName: string

Returns Promise<TradeHistory>

Example

const tradeHistory = await nash.listAccountTrades({
  limit : 10,
  marketName : 'neo_eth'
})
console.log(tradeHistory.trades)

Parameters

• __namedParameters: object

  • cursor: string

  • fiatSymbol: string

  • limit: number

Returns Promise<AccountTransaction>

Example

const accountTransaction = await nash.listAccountTransactions({
  limit : 150,
  ${paramName} : ${paramValue}
})
console.log(accountTransaction.transactions)

Returns Promise<AccountVolume>

Example

const accountVolume = await nash.listAccountVolumes()
console.log(accountVolume.thirtyDayTotalVolumePercent)

Returns Promise<Asset[]>

Example

const assets = await nash.listAssets()
console.log(assets)

Parameters

• __namedParameters: object

  • before: string

  • interval: CandleInterval

  • limit: number

  • marketName: string

Returns Promise<CandleRange>

Example ` const candleRange = await nash.listCandles({ marketName : 'neo_gas' }) console.log(candleRange)

Returns Promise<Market[]>

Example

const markets = await nash.listMarkets()
console.log(markets)

Parameters

• __namedParameters: object

  • currency: CryptoCurrency

  • status: MovementStatus

  • type: MovementType

Returns Promise<Movement[]>

Example

const movements = await nash.listMovements({
  currency : 'eth'
})
console.log(movements)

Returns Promise<Ticker[]>

Example

const tickers = await nash.listTickers()
console.log(tickers)

Parameters

• __namedParameters: object

  • before: string

  • limit: number

  • marketName: string

Returns Promise<TradeHistory>

Example

const tradeHistory = await nash.listTrades({
  marketname : 'neo_gas'
})
console.log(tradeHistory.trades)

Parameters

• __namedParameters: object

  • email: string

  • password: string

  • presetWallets: object

  • twoFaCode: string

  • walletIndices: object

    • btc: number

    • eth: number

    • neo: number

Returns Promise<void>

Parameters

• allowTaker: boolean

• amount: CurrencyAmount

• buyOrSell: OrderBuyOrSell

• cancellationPolicy: OrderCancellationPolicy

• limitPrice: CurrencyPrice

• marketName: string

• Optional cancelAt: DateTime

Returns Promise<OrderPlaced>

Example

import {
  createCurrencyAmount,
  createCurrencyPrice,
  OrderBuyOrSell,
  OrderCancellationPolicy
} from '@neon-exchange/api-client-typescript'

const order = await nash.placeLimitOrder(
  false,
  createCurrencyAmount('1', CryptoCurrency.NEO),
  OrderBuyOrSell.BUY,
  OrdeCancellationPolicy.GOOD_TILL_CANCELLED,
  createCurrencyPrice('0.01', CryptoCurrency.GAS, CryptoCurrency.NEO),
  'neo_gas'
)
console.log(order.status)

Parameters

• amount: CurrencyAmount

• buyOrSell: OrderBuyOrSell

• marketName: string

Returns Promise<OrderPlaced>

Example

import {
  createCurrencyAmount,
  OrderBuyOrSell,
} from '@neon-exchange/api-client-typescript'

const order = await nash.placeMarketOrder(
  createCurrencyAmount('1.00', CryptoCurrency.NEO),
  OrderBuyOrSell.SELL,
  'neo_gas'
)
console.log(order.status)

Parameters

• allowTaker: boolean

• amount: CurrencyAmount

• buyOrSell: OrderBuyOrSell

• cancellationPolicy: OrderCancellationPolicy

• limitPrice: CurrencyPrice

• marketName: string

• stopPrice: CurrencyPrice

• Optional cancelAt: DateTime

Returns Promise<OrderPlaced>

Example

import {
  createCurrencyAmount,
  createCurrencyPrice,
  OrderBuyOrSell,
  OrderCancellationPolicy
} from '@neon-exchange/api-client-typescript'

const order = await nash.placeStopLimitOrder(
  false,
  createCurrencyAmount('1', CryptoCurrency.NEO),
  OrderBuyOrSell.BUY,
  OrdeCancellationPolicy.GOOD_TILL_CANCELLED,
  createCurrencyPrice('0.01', CryptoCurrency.GAS, CryptoCurrency.NEO),
  'neo_gas'
  createCurrencyPrice('0.02', CryptoCurrency.GAS, CryptoCurrency.NEO)
)
console.log(order.status)

Parameters

• amount: CurrencyAmount

• buyOrSell: OrderBuyOrSell

• marketName: string

• stopPrice: CurrencyPrice

Returns Promise<OrderPlaced>

Example

import {
  createCurrencyAmount,
  createCurrencyPrice,
  OrderBuyOrSell,
} from '@neon-exchange/api-client-typescript'

const order = await nash.placeStopLimitOrder(
  createCurrencyAmount('1', CryptoCurrency.NEO),
  OrderBuyOrSell.BUY,
  'neo_gas'
  createCurrencyPrice('0.02', CryptoCurrency.GAS, CryptoCurrency.NEO)
)
console.log(order.status)

Parameters

• address: string

• quantity: CurrencyAmount

• Optional nonce: number

Returns Promise<SignMovementResult>

Parameters

• getStatesData: GetStatesData

• Default value depth: number = 0

Returns Promise<SignStatesData>

Example

const signStatesResult = await nash.signStates(getStatesResult)
console.log(signStatesResult)

Parameters

• address: string

• quantity: CurrencyAmount

• Optional nonce: number

Returns Promise<SignMovementResult>

Example

import { createCurrencyAmount } from '@neon-exchange/api-client-ts'

const address = 'd5480a0b20e2d056720709a9538b17119fbe9fd6';
const amount = createCurrencyAmount('1.5', CryptoCurrency.ETH);
const signedMovement = await nash.signWithdrawRequest(address, amount);
console.log(signedMovement)

Parameters

• signStatesData: SignStatesData

Returns Promise<SyncState[]>

Example

const getStatesData = await nash.getStates()
console.log(getStatesData)