Lemon.markets.js NPM

lemon.markets.js

This is a Javascript/Typescript SDK for the lemon.markets API.

Versions

sdk version	api version
1.x	v1

Node.js Version

lemon.markets.js is build for Node.js v17.x. Older versions may be supported, but not tested and some features may not work. Known issues in older versions:

Dates in Cache are strings, not Date objects.

Getting started

Get API Access

Follow the instructions on lemon.markets.

Install sdk

$ npm i lemon.markets.js

Create new client

import lemon from 'lemon.markets.js'

const client = new lemon.Client({
    mode: 'paper',
    trading_key: 'your-api-key'
})

If you want to use require

const lemon = require('lemon.markets.js').default;

Documentation

Examples

List your positions with latest quote

async function main() {
    const positionsPage = await client.positions.get()
    const positions = positionsPage.values

    positions.forEach(async position => {
        const quote = (await client.quotes.latest({ isin: position.isin })).values[0]
        console.log(`${position.isin_title} @ ${quote.b}/${quote.a}`)
    })
}

main()

Subscribe to realtime data

async function main() {
    const subscription = await client.realtime.subscribe({
        isin: 'US0378331005',
        callback: (data) => {
            console.log((data.a/10000).toFixed(2));
        }
    });
    // close subscription after 10 seconds
    setTimeout(() => {
        subscription.close();
    }, 10000);
}

main()

Numbers

Quantities

If you want to enter a quantity (e.g. when you place an order and want to specify how many stocks you want to buy), you can simply enter the "normal" quantity you want to buy or sell --> "quantity" = 1 will result in you buying 1 stock.

Currencies

If you set "decimals" to be false, then the price must be specified as a hundredth of a cent (e.g. 15000 == 1.50€). By default "decimals" is true and the price is specified as "normal" (e.g. 1.50 == 1.50€).

ResponsePage

If you request too much data, your response will be split into multiple pages.

Name	Type	Description
page	number	Current page number
pages	number	Total number of pages
total	number	Total number of results
previous	() => Promise\<ResponsePage\<T>>	Function to fetch the previous page
next	() => Promise\<ResponsePage\<T>>	Function to fetch the next page
values	T[]	Results

Trading

Account

Name	Type	Description
account_id	string	Unique Identification number for your account
firstname	string	Your first name
lastname	string	Your last name
iban_brokerage	string	IBAN of the brokerage account at the partner bank
iban_origin	string	IBAN of the reference account
balance	number	This is your account balance
cash_to_invest	number	This number shows you how much cash you have left to invest
cash_to_withdraw	number	This number shows you how much cash you have in your account to withdraw to your reference account
amount_bought_intraday	number	This is the intraday buy order amount
amount_sold_intraday	number	This is the intraday sell order amount
amount_open_orders	number	This is the intraday amount of open orders
amount_open_withdrawals	number	This is the intraday amount of withdrawals
amount_estimate_taxes	number	This is the amount of estimated taxes (25%) for your intraday sell orders

const account: Account = await client.account.get()

Cache

const account: Account = client.account.cache()

Withdrawal

Name	Type	Description
id	string	A unique Identification Number of your withdrawal
amount	string	The amount that you specified for your withdrawal.
created_at	Date	Date at which you created the withdrawal
date	Date	Date at which the withdrawal was processed by the partner bank
idempotency?	string	Your own unique idempotency key that you specified in your POST request to prevent duplicate withdrawals.

const response: ResponsePage<Withdrawal> = await client.account.withdrawals.get()
const withdrawals: Withdrawal[] = response.values

Cache

const withdrawals: Withdrawal[] = client.account.withdrawals.cache()

const result: boolean = await client.account.withdrawals.create({ amount: 10, pin: 10 })

BankStatement

Name	Type	Description
id	string	Unique Identification Number of your bank statement
account_id	string	Unique Identification Number of the account the bank statement is related to
type	'pay_in' \| 'pay_out' \| 'order_buy' \| 'order_sell' \| 'eod_balance' \| 'dividend' \| 'tax_refunded'	Type of bank statement
date	Date	The date that the bank statement relates to
amount	number	The amount associated with the bank statement.
isin	string	The International Securities Identification Number (ISIN) related to your bank statement. Only for type order_buy and order_sell, otherwise null
isin_title	string	The title of the International Securities Identification Number (ISIN) related to your bank statement. Only for type order_buy and order_sell, otherwise null
created_at	Date	The Date the bank statement was created internally. This can be different to the date, e.g., when there is a weekend in between.

const page: ResponsePage<BankStatement> = await client.account.bankstatements.get()
const bankstatements: BankStatement[] = page.values

Cache

const bankstatements: BankStatement[] = client.account.bankstatements.cache()

Document

Name	Type	Description
id	string	The unique Identification Number for the document
name	string	The name of the Document
created_at	Date	Date at which the Document was created internally
category	string	The Document Category
link	string	A Link to download a Document PDF
viewed_first_at	Date	Date at which the Document was first viewed (downloaded)
viewed_last_at	Date	Date at which the Document was last viewed (downloaded)

Get

const page: ResponsePage<Document> = await client.account.documents.get()
const documents: Document[] = page.values

Cache

const documents: Document[] = client.account.documents.cache()

Order

Name	Type	Description
id	string	This is the unique Order Identification Number
isin	string	This is the International Security Identification Number (ISIN) for the instrument bough or sold with this Order
isin_title	string	This is the Title of the instrument bought or sold with this order
expires_at	Date	This is the Date at which the Order expires
created_at	Date	This is the Date at which the Order was created
side	'buy' \| 'sell'	This is the side of an order
quantity	number	This is the number of Instruments specified in the Order
stop_price	number	This is the Stop Price defined for the Order. "null" if Stop Price is not set.
limit_price	number	This is the Limit Price defined for the Order. "null" if Stop Price is not set.
estimated_price	number	This is the Estimated Price the Order will be executed at (only for Market Orders).
estimated_price_total	number	This is the Estimated Price the Order will be executed at (only for Market Orders), multiplied by the Order quantity.
venue	string	This is the Market Identifier Code of the Trading Venue the Order was placed at
status	'inactive' \| 'active' \| 'open' \| 'in_progress' \| 'canceling' \| 'executed' \| 'canceled' \| 'expired'	This is the Order Status
activate?	(options: { pin: number }) => Promise\<boolean>	Activate your Order if it is inactive. See here for more informations

Create Params

const page: ResponsePage<Order> = await client.orders.get()
const orders: Order[] = page.values

const order: Order = await client.orders.getOne('order-id')

const canceled: boolean = await client.orders.cancel('order-id')

Create Params | Name | Type | Description | | - | - | - | | isin | string | This is the International Security Identification Number that uniquely identifies the instrument you wish to buy or sell | | quantity | number | Use this attribute to define the number of shares you want to buy. This is limited to 25,000€ estimated order price per request | | side | 'buy' | 'sell' | Use this attribute to define whether you want to buy ('buy') or sell ('sell') a specific instrument | | venue | string | Use this attribute to specify the Market Identifier Code (MIC) of the stock exchange you want to place the order at. Use "allday" for 24/7 order exeution (only in the Paper Money environment). The order is then executed at the last saved quote. | | expires_at? | 'day' | Date | Use this attribute to specify when you want your order to expire. The Maximum expiration date is 30 days in the future. When limit_price and/or stop_price are set, the expires_at parameter is required. For a market order, the expires_at parameter is optional. In the case of a market order, the default value is the end of the same day. Default is day | | decimals? | boolean | Specify the numbers format you want to get your response in. Default is true |

const confirmation: OrderConfirmation = await client.orders.create({
    isin: 'US0378331005',
    side: 'buy',
    quantity: 10,
    venue: 'allday'
})

OrderConfirmation

Name	Type	Description
created_at	Date	Date for when the order was created
id	string	This is the unique Order Identification Number.
status	'inactive' \| 'active' \| 'open' \| 'in_progress' \| 'canceling' \| 'executed' \| 'canceled' \| 'expired'	This is the status the Order is currently in
isin	string	This is the International Securities Identification Number of the instrument specified in that order
expires_at	Date	Date until when the order is valid
side	'buy' \| 'sell'	This is the side of an order
quantity	number	This is the amount of instruments specified in the order
stop_price	number	This is the Stop price for the order. "null" if not specified.
limit_price	number	This is the Limit price for the order. "null" if not specified.
venue	string	This is the Market Identifier Code of the trading venue the order was placed at (default is XMUN)
estimated_price	number	This is an estimation from the lemon.markets end for what price the order will be executed.
charge	number	This is the charge for the placed order.
activate	(options: { pin: number }) => Promise\<boolean>	If you want to activate a paper money order or are interested in building your own 2FA experience you can use this function

let confirmation: OrderConfirmation;
// create order ...
const activated: boolean = confirmation.activate({ pin: 1234 })

Position

Name	Type	Description
isin	string	This is the International Securities Identification Number (ISIN) of the position
isin_title	string	This is the Title of the instrument
quantity	number	This is the number of positions you currently hold for the respective Instrument
buy_price_avg	number	This is the average buy-in price of the respective position. If you buy one share for 100€ and a second one for 110€, the average buy-in price would be 105€
estimated_price_total	number	This is the current position valuation to the market trading price. So, if you own 3 shares of stock XYZ, and the current market trading price for XYZ is 100€, this attribute would return 300€
estimated_price	number	This is the current market trading price for the respective position

const page: ResponsePage<Position> = await client.positions.get()
const positions: Position[] = page.values

Cache

const positions: Position[] = client.positions.cache()

Statement

Name	Type	Description
id	string	This is the unique Identification Number for the statement
order_id	string	This is the unique Identification Number for the related order (if type = order_buy or order_sell, otherwise null)
external_id	string	If you imported a position from an external source, lemon.markets provides the external identification number here
type	'order_buy' \| 'order_sell' \| 'split' \| 'import' \| 'snx'	This is the type of statement that tells you about the type of change that happened to your position
quantity	number	This is the quantity related to the position statement
isin	string	This is the ISIN of the Instrument that is affected in the statement
isin_title	string	This is the Title of the Instrument that is affected in the statement
date	Date	This is the Date the statement occurs at
created_at	Date	Date for when the statement is processed by us internally. It can be the case that lemon.markets receives data 1-3 days later. So, for example when a position change occurs on a Friday afternoon, lemon.markets only receives the data on Monday morning. Therefore, date would then be date of the Friday, while created_at is a date from Monday morning.

const page: ResponsePage<Statement> = await client.positions.statements.get()
const statements: Statement[] = page.values

Cache

const statements: Statement[] = client.positions.statements.cache()

Performance

Name	Type	Description
isin	string	This is the ISIN of the respective position
isin_title	string	This is the Title of the respective position
profit	number	This shows a profit when all or parts of the respective position were sold for more than they were bought for. Otherwise 0
loss	number	This shows a loss when all or parts of the respective position were sold for less than they were bought for. Otherwise 0
quantity_bought	number	This shows how many position shares were bought over specific time period
quantity_sold	number	This shows how many position shares were sold over specific time period
quantity_open	number	This shows the number of open position shares
opened_at	Date	This show the specific date for when the position was opened (first share(s) were bought)
closed_at	Date	This show the specific date for when the position was closed (last share(s) were sold)
fees	number	This shows the amount of fees for orders related to the respective position

const page: ResponsePage<Performance> = await client.positions.performances.get()
const performances: Performance[] = page.values

Cache

const performances: Performance[] = client.positions.performances.cache()

MarketData

Instrument

Name	Type	Description
isin	string	This is the International Securities Identification Number (ISIN) of the instrument
wkn	string	This is the German Securities Identification Number of instrument
name	string	This is the Instrument name
title	string	This is the Instrument Title
symbol	string	This is the Symbol of the instrument at the trading venue
type	'stock' \| 'etf'	This tells you about the type of instrument. Not all types are mentioned in the lemon.markets docs

const page: ResponsePage<Instrument> = await client.instruments.get()
const instruments: Instrument[] = page.values

Cache

const instruments: Instrument[] = client.instruments.cache()

Venue

Name	Type	Description
name	string	This is the Full Name of the Trading Venue
title	string	This is the Short Title of the Trading Venue
mic	string	This is the Market Identifier Code (MIC) of the Trading Venue
is_open	boolean	This indicates if the Trading Venue is currently open

const page: ResponsePage<Venue> = await client.venues.get()
const venues: Venue[] = page.values

Cache

const venues: Venue[] = client.venues.cache()

Quote

Name	Type	Description
isin	string	This is the International Securities Identification Number of the instrument you requested the quotes for
b_v	number	This is the Bid Volume for the Quote
a_v	number	This is the Ask Volume for the Quote
b	number	This is the Bid price for the Quote
a	number	This is the Ask price for the Quote
t	Date	This is the date the Quote occured at
mic	string	This is the Market Identifier Code of the Trading Venue the Quote occured at

const page: ResponsePage<Quote> = await client.quotes.latest({
    isin: 'US0378331005'
})
const quotes: Quote[] = page.values

OHLC

Name	Type	Description
isin	string	This is the International Securities Identification Number of the instrument you requested the OHLC data for
o	number	This is the Open Price in the specific time period
h	number	This is the Highest Price in the specific time period
l	number	This is the Lowest Price in the specific time period
c	number	This is the Close Price in the specific time period
v	number	This is the aggegrated volume (Number of trades) of the instrument in the specific time period
pbv	number	This is the Price by Volume (Sum of (quantity * last price)) of the instrument in the specific time period
t	Date	The date of the beginning of the represented time interval
mic	string	This is the Market Identifier Code of the Trading Venue the OHLC data occured at

Get Params | Name | Type | Description | | - | - | - | | x1 | 'm1' | 'h1' | 'd1' | Specify the type of data you wish to retrieve: m1 (per minute), h1 (per hour), or d1 (per day) | | isin | string | string[] | Use the International Securities Identification Number (ISIN) to filter for the instrument you want to get the OHLC data for | | mic? | string | Use the Market Identifier Code to filter for a specific Trading Venue | | from? | string | Start of time range you want to get OHLC data for. For D1 data, you can request 60 days of data with one request, therefore the time range between from and to cannot be longer than 60 days. If to is not defined, the API automatically returns data until the current day or up to 60 days, based on the from date. For H1 and M1 data, you can request historical data for one day, therefore the time range between from and to cannot be longer than 1 day | | to? | string | End of time range you want to get OHLC data for. For D1 data, you can request 60 days of data with one request, therefore the time range between from and to cannot be longer than 60 days. If to is not defined, the API automatically returns data until the current day or up to 60 days, based on the from date. For H1 and M1 data, you can request historical data for one day, therefore the time range between from and to cannot be longer than 1 day. | | decimals? | boolean | Specify the numbers format you want to get your response in. Default is true |

const page: ResponsePage<OHLC> = await client.ohlc.get({
    x1: 'm1',
    isin: 'US0378331005'
})
const ohlc: OHLC[] = page.values

Cache

const ohlc: OHLC[] = client.ohlc.cache()

Trade

Name	Type	Description
isin	string	This is the International Securities Identification Number of the instrument you requested the trades for
p	number	This is the Price the trade happened at
v	number	This is the Volume for the trade (quantity)
t	Date	This is the Timestamp the trade occured at
mic	string	This is the Market Identifier Code of the Trading Venue the trade occured at

const page: ResponsePage<Trade> = await client.trades.latest({
    isin: 'US0378331005',
})
const trades: Trade[] = page.values

Realtime

Info: If no data is sent, the exchange may be closed.

RealtimeSubscription

Name	Type	Description
close	() => void	A function to close the subscription

const subscription: RealtimeSubscription = await client.realtime.subscribe({
    isin: 'US0378331005',
    callback: (data: Quote) => {
        console.log(data)
    }
})

Or to receive realtime data without exposing your API key.

// backend (API key is required)
const auth - await client.realtime.auth()
// frontend (API key is not required)
const realtime = new lemon.Realtime(auth)
const subscription = realtime.subscribe({
    isin: 'US0378331005',
    callback: (data: Quote) => {
        console.log(data)
    }
})

lemon.markets trading

ably node-fetch

@everything-registry/sub-chunk-2057 @zalastax/nolb-lem @infinitebrahmanuniverse/nolb-lem

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago