node-lykke-api (master) - Lykke API Node Wrapper

# API_BASE_PATH()

API path

Returns

String

Returns '/api/' path

# HOME_BASE_PATH()

Home path

Returns

String

Returns '/home/' path

# LykkePublicAPI()

Lykke Public API Client

Returns

Function

Returns an empty function

# LykkePublicAPI._get(url, params)

GET method for Lykke Public API

Parameters

Name	Types	Description
url	`String`	GET request url
params	`Object`	GET request params

Returns

Promise

Returns a promise

# LykkePublicAPI._post(url, params)

POST method for Lykke Public API

Parameters

Name	Types	Description
url	`String`	POST request url
params	`Object`	POST request params

Returns

Promise

Returns a promise

# LykkePublicAPI.assetPairsDictionary()

Method to get asset pairs dictionary

Returns

Promise

Returns a promise

# LykkePublicAPI.assetPairsRates(assetPairId)

Method to get all asset pairs rates or rates for an asset pair

Parameters

Name	Types	Description
assetPairId	`String`	Asset Pair Id

Returns

Promise

Returns a promise

# LykkePublicAPI.assetPairsRatesHistory(assetPairIds, period, dateTime)

Method to get rates fol several or one asset pair for a specified period

Parameters

Name	Types	Description
assetPairIds	`String`	Array
period	`String`	Period in 'Sec', 'Minute', 'Hour', 'Day', 'Month'
dateTime	`String`	Date time in the following format 2017-11-11T13:43:35.723Z

Returns

Promise

Returns a promise

# LykkePublicAPI.assetsDictionary()

Method to get assets dictionary

Returns

Promise

Returns a promise

# LykkePublicAPI.companyOwnershipStructure()

Method to get Company Ownership Structure

Returns

Promise

Returns a promise

# LykkePublicAPI.isAlive()

Method to check if Lykke Public API is alive

Returns

Promise

Returns a promise

# LykkePublicAPI.market(assetPairId)

Method to get trade volumes for all available asset pairs or for an asset

Parameters

Name	Types	Description
assetPairId	`String`	Asset Pair Id

Returns

Promise

Returns a promise

# LykkePublicAPI.marketCapitalization(assetPairId)

Method to get market capitalization for asset

Parameters

Name	Types	Description
assetPairId	`String`	Asset Pair Id

Returns

Promise

Returns a promise

# LykkePublicAPI.orderBook(assetPairId)

Method to get all orderbooks or orderbook for specified asset pair

Parameters

Name	Types	Description
assetPairId	`String`	Asset Pair Id

Returns

Promise

Returns a promise

# LykkePublicAPI.trades(n)

Method to get last trades

Parameters

Name	Types	Description
n	`Integer`	Number of trades superior to zero

Returns

Promise

Returns a promise

# LykkePublicAPI.version()

Method to get Lykke Public API version

Returns

Promise

Returns a promise

# LykkeWalletAPI()

Lykke Wallet API Client

Returns

Function

Returns an empty function

# LykkeWalletAPI._get(url, params)

GET method for Lykke Wallet API

Parameters

Name	Types	Description
url	`String`	GET request url
params	`Object`	GET request params

Returns

Promise

Returns a promise

# LykkeWalletAPI._post(url, params)

POST method for Lykke Wallet API

Parameters

Name	Types	Description
url	`String`	POST request url
params	`Object`	POST request params

Returns

Promise

Returns a promise

# LykkeWalletAPI.accountExist(email, partnerId)

Method to get if an account exist

Parameters

Name	Types	Description
email	`String`	Account email
partnerId	`String`	Account partnerId

Returns

Promise

Returns a promise

# LykkeWalletAPI.auth(email, password, clientInfo, partnerId)

Method to authenticate

Parameters

Name	Types	Description
email	`String`	Account email
password	`String`	Account password
clientInfo	`String`	Account clientInfo
partnerId	`String`	Account partnerId

Returns

Promise

Returns a promise

# LykkeWalletAPI.isAlive()

Method to check if Lykke Wallet API is alive

Returns

Promise

Returns a promise

# LykkeWalletAPI.version()

Method to get Lykke Wallet API version

Returns

Promise

Returns a promise

# PUBLIC_API_URL()

Public API url

Returns

String

Returns Public API url https://lykke-public-api.azurewebsites.net

# WALLET_API_URL()

Wallet API url

Returns

String

Returns Wallet API url https://api.lykkex.com