Documentation

Desktop API

The following examples are for desktop only. To get started you will need to download EOS Lynx Desktop
here.
If you need an API key fill out this form and we will reach out to you to get you set up.
Request API key

NOTE: This api is only currently available on the latest EOS Lynx Desktop application.

Getting Started

You must first download and install the EOS Lynx node package module. This package will enable your client/app to directly communicate with EOS Lynx.
Keep in mind that this library is meant for use with client-side code and will utilize deep-linking to open up EOS Lynx desktop.

npm install --save eos-lynx

This package gives you access to three functions. Each of these functions will return a promise.

Get Account Information and Confirm Wallet Owner

Client-side code

Calling this function will open up EOS Lynx and request users to enter their pin.
Once they've successfully unlocked their wallet and verified that they control their wallet, EOS Lynx will send account information back to the dApp.

Sending true will return back the list of token balances of the account.

wantAppVersion

boolean

Sending true will return back the version of the EOS Lynx app the user is using.

session

Optional, string

A string identifier that you can send to us and we will send back to you in the response.

Response Object

This is what the response will be when your user confirms the account with EOS Lynx. Account name will always be
returned, while token, version, and session fields may be empty if these fields are not requested.