Skip to main content

Class: default

Defined in: coinray.ts:67

Constructors​

Constructor​

new default(token, __namedParameters?): Coinray

Defined in: coinray.ts:112

Parameters​

token​

string

__namedParameters?​
apiEndpoint​

string

orderEndpoint​

string

websocketEndpoint​

string

Returns​

Coinray

Properties​

_refreshingToken​

_refreshingToken: Promise<string>

Defined in: coinray.ts:102

_token​

_token: string

Defined in: coinray.ts:75

config​

config: object

Defined in: coinray.ts:70

apiEndpoint​

apiEndpoint: string

orderEndpoint​

orderEndpoint: string

websocketEndpoint​

websocketEndpoint: string

I18n​

static I18n: typeof default

Defined in: coinray.ts:68

Accessors​

clientId​

Get Signature​

get clientId(): string

Defined in: coinray.ts:1112

Returns​

string

Methods​

authenticateDevice()​

authenticateDevice(credential, sessionKey): void

Defined in: coinray.ts:132

Parameters​

credential​

string

sessionKey​

string

Returns​

void

cancelOrder()​

cancelOrder(order): Promise<any>

Defined in: coinray.ts:993

Parameters​

order​

CancelOrderParams

Returns​

Promise<any>

candleCacheKey()​

candleCacheKey(__namedParameters): string

Defined in: coinray.ts:834

Parameters​

__namedParameters​
day?​

any = ""

month?​

any = ""

prefix?​

string = "C"

resolution​

string

symbol​

string

week?​

any = ""

year​

any

Returns​

string

checkToken()​

checkToken(loop?): Promise<boolean>

Defined in: coinray.ts:154

Parameters​

loop?​

boolean = true

Returns​

Promise<boolean>

connect()​

connect(): Promise<void>

Defined in: coinray.ts:250

Returns​

Promise<void>

createCredential()​

createCredential(deviceId, password): Promise<any>

Defined in: coinray.ts:897

Parameters​

deviceId​

string

password​

string

Returns​

Promise<any>

createOrder()​

createOrder(order): Promise<any>

Defined in: coinray.ts:967

Parameters​

order​

CreateOrderParams

Returns​

Promise<any>

createSmartOrderSignature()​

createSmartOrderSignature(smartOrder): Promise<any>

Defined in: coinray.ts:954

Parameters​

smartOrder​

SmartOrderParams

Returns​

Promise<any>

createWebSocketToken()​

createWebSocketToken(__namedParameters): Promise<any>

Defined in: coinray.ts:1010

Parameters​

__namedParameters​
encryptedApiKey​

any

exchangeCode​

any

Returns​

Promise<any>

delete()​

delete(endpoint, attributes): Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

Defined in: coinray.ts:1187

Parameters​

endpoint​

string

attributes​

any

Returns​

Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

destroy()​

destroy(): void

Defined in: coinray.ts:137

Returns​

void

disconnect()​

disconnect(): void

Defined in: coinray.ts:242

Returns​

void

fetchCandles()​

fetchCandles(__namedParameters): Promise<Candle[]>

Defined in: coinray.ts:685

Parameters​

__namedParameters​

CandlesParam

Returns​

Promise<Candle[]>

fetchExchanges()​

fetchExchanges(callback, cachedExchanges): Promise<Exchange[]>

Defined in: coinray.ts:845

Parameters​

callback​

(payload) => Exchange

cachedExchanges​

any

Returns​

Promise<Exchange[]>

fetchFirstCandleTime()​

fetchFirstCandleTime(__namedParameters): Promise<Date>

Defined in: coinray.ts:674

Parameters​

__namedParameters​
coinraySymbol​

any

resolution​

any

Returns​

Promise<Date>

fetchMarkets()​

fetchMarkets(exchange, cachedMarkets): Promise<object[]>

Defined in: coinray.ts:855

Parameters​

exchange​

Exchange

cachedMarkets​

any

Returns​

Promise<object[]>

fetchPositions()​

fetchPositions(__namedParameters): Promise<any>

Defined in: coinray.ts:1023

Parameters​

__namedParameters​
encryptedApiKey​

any

exchangeCode​

any

Returns​

Promise<any>

fetchStaticMarkets()​

fetchStaticMarkets(exchangeCode, etag?): Promise<{ etag?: string; markets: object[]; }>

Defined in: coinray.ts:887

Parameters​

exchangeCode​

string

etag?​

string

Returns​

Promise<{ etag?: string; markets: object[]; }>

fetchTickers()​

fetchTickers(exchangeCodes): Promise<{[exchangeCode: string]: TickerSnapshot[]; }>

Defined in: coinray.ts:869

Parameters​

exchangeCodes​

string[]

Returns​

Promise<{[exchangeCode: string]: TickerSnapshot[]; }>

flushCache()​

flushCache(): void

Defined in: coinray.ts:754

Returns​

void

get()​

get(endpoint, __namedParameters?): Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

Defined in: coinray.ts:1157

Parameters​

endpoint​

string

__namedParameters?​
apiEndpoint?​

any = undefined

headers?​

{ } = {}

params?​

{ } = {}

secret?​

string = ""

version?​

string = "v2"

Returns​

Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

getBalances()​

getBalances(__namedParameters): Promise<{ balances: any; positions: any; }>

Defined in: coinray.ts:1040

Parameters​

__namedParameters​
encryptedApiKey​

any

exchangeCode​

any

Returns​

Promise<{ balances: any; positions: any; }>

getHistoryCandles()​

getHistoryCandles(getParams): Promise<Candle[]>

Defined in: coinray.ts:814

Parameters​

getParams​

any

Returns​

Promise<Candle[]>

getNonce()​

getNonce(): number

Defined in: coinray.ts:204

Returns​

number

getOpenCandles()​

getOpenCandles(useWebSocket, getParams): Promise<Candle[]>

Defined in: coinray.ts:783

Parameters​

useWebSocket​

any

getParams​

any

Returns​

Promise<Candle[]>

getProxyList()​

getProxyList(__namedParameters): Promise<any>

Defined in: coinray.ts:1093

Parameters​

__namedParameters​
credentialVersion?​

string

exchangeCode?​

string

Returns​

Promise<any>

getTime()​

getTime(): number

Defined in: coinray.ts:212

Returns​

number

getToken()​

getToken(): Promise<string>

Defined in: coinray.ts:226

Returns​

Promise<string>

getWebsocketCandles()​

getWebsocketCandles(coinraySymbol, resolution, waitMs?): Promise<Candle[]>

Defined in: coinray.ts:764

Parameters​

coinraySymbol​

any

resolution​

any

waitMs?​

number = 0

Returns​

Promise<Candle[]>

loadTimeOffset()​

loadTimeOffset(): Promise<void>

Defined in: coinray.ts:216

Returns​

Promise<void>

onError()​

onError(callback): void

Defined in: coinray.ts:282

Parameters​

callback​

(event) => void

Returns​

void

onOpen()​

onOpen(callback): void

Defined in: coinray.ts:278

Parameters​

callback​

(event) => void

Returns​

void

onTokenExpired()​

onTokenExpired(callback): void

Defined in: coinray.ts:192

Parameters​

callback​

() => Promise<string>

Returns​

void

patch()​

patch(endpoint, attributes): Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

Defined in: coinray.ts:1181

Parameters​

endpoint​

string

attributes​

any

Returns​

Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

post()​

post(endpoint, attributes): Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

Defined in: coinray.ts:1175

Parameters​

endpoint​

string

attributes​

any

Returns​

Promise<{ _headers: Record<string, string>; _status?: number; result: any; }>

publicKey()​

publicKey(): Promise<any>

Defined in: coinray.ts:1104

Returns​

Promise<any>

reconnect()​

reconnect(): void

Defined in: coinray.ts:235

Returns​

void

refreshToken()​

refreshToken(token): void

Defined in: coinray.ts:200

Parameters​

token​

string

Returns​

void

resubscribe()​

resubscribe(): void

Defined in: coinray.ts:286

Returns​

void

setLeverage()​

setLeverage(__namedParameters): Promise<any>

Defined in: coinray.ts:1057

Parameters​

__namedParameters​
coinraySymbol​

any

encryptedApiKey​

any

leverage​

any

Returns​

Promise<any>

setMarginType()​

setMarginType(__namedParameters): Promise<any>

Defined in: coinray.ts:1075

Parameters​

__namedParameters​
coinraySymbol​

any

encryptedApiKey​

any

marginType​

any

Returns​

Promise<any>

setTransport()​

setTransport(transport): void

Defined in: coinray.ts:188

Parameters​

transport​

any

Returns​

void

startNewCandleTimer()​

startNewCandleTimer(__namedParameters): void

Defined in: coinray.ts:619

Parameters​

__namedParameters​
candleId​

any

coinraySymbol​

any

resolution​

any

Returns​

void

subscribeCandles()​

subscribeCandles(__namedParameters, callback): Promise<(payload) => void>

Defined in: coinray.ts:553

Parameters​

__namedParameters​

CandleParam

callback​

(payload) => void

Returns​

Promise<(payload) => void>

subscribeOrderBook()​

subscribeOrderBook(__namedParameters, callback): Promise<(payload) => void>

Defined in: coinray.ts:477

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<(payload) => void>

subscribeTickers()​

subscribeTickers(coinraySymbols, reset?, callback): Promise<false | ((payload) => void)>

Defined in: coinray.ts:314

Parameters​

coinraySymbols​

string[]

reset?​

Boolean = false

callback​

(payload) => void

Returns​

Promise<false | ((payload) => void)>

subscribeTrades()​

subscribeTrades(__namedParameters, callback): Promise<(payload) => void>

Defined in: coinray.ts:400

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<(payload) => void>

testAccount()​

testAccount(accountTest): Promise<any>

Defined in: coinray.ts:941

Parameters​

accountTest​

AccountTestParams

Returns​

Promise<any>

unsubscribeAllTickers()​

unsubscribeAllTickers(): void

Defined in: coinray.ts:365

Returns​

void

unsubscribeCandles()​

unsubscribeCandles(__namedParameters, callback?): void

Defined in: coinray.ts:654

Parameters​

__namedParameters​

CandleParam

callback?​

(payload) => void

Returns​

void

unsubscribeOrderBook()​

unsubscribeOrderBook(__namedParameters, callback?): void

Defined in: coinray.ts:539

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

void

unsubscribeTickers()​

unsubscribeTickers(coinraySymbols, callback?): void

Defined in: coinray.ts:372

Parameters​

coinraySymbols​

string[]

callback?​

(payload) => void

Returns​

void

unsubscribeTrades()​

unsubscribeTrades(__namedParameters, callback?): void

Defined in: coinray.ts:463

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

void

updateOrder()​

updateOrder(order): Promise<any>

Defined in: coinray.ts:980

Parameters​

order​

UpdateOrderParams

Returns​

Promise<any>

wrapApiKey()​

wrapApiKey(apiKeySettings, preWrapped): Promise<any>

Defined in: coinray.ts:916

Parameters​

apiKeySettings​
preWrapped​

false

Returns​

Promise<any>