Market Data / Instruments & Trading Venues

Instruments & Trading Venues

This page gives you a detailed description of all endpoints related to Instruments and Trading Venues. These endpoints are part of the Market Data API, therefore use the following base URL for your request:


https://data.lemon.markets/v1/

Finding an Instrument

The instrument endpoint allows to search through all offered instruments. Instruments are equities that are tradable on lemon.markets. The instruments endpoint lets you identify relevant instruments that you can then integrate into your brokerage product.

GET /instruments/

This endpoint returns a list of instruments, based on the search criteria or filter you provided in your query parameters. To use the endpoint, use the following request URL:

https://data.lemon.markets/v1/instruments/

Request

To retrieve a list of instruments, specify your request as follows:

Header Parameters

Authorization
string
required

Set your Authorization header in the format "Authorization: Bearer YOUR-API-KEY"
(see the example in the code snippet on the right)


Specifying multiple ISINs, MICs and Types in one request

Using the isin, mic and type query parameter, you have the option to request multiple instruments, trading venues and/or types. Depending on the client you are using, you could do so by definining multiple ISINs/MICs/Types in the Query Parameters, like ?isin=US88160R1014&isin=US19260Q1076 or by simply using commas, like isin=US88160R1014,US19260Q1076.

Query Parameters

isin
string
optional

Use this query parameter to specify the Instrument you are interested in through its International Securities Identification Number. You can also specify multiple ISINs.

To specify multiple ISINs, either define multiple Query Parameters like ?isin=US88160R1014&isin=US19260Q1076 or simply use commas, like isin=US88160R1014,US19260Q1076.

Read more ↘
Maximum 10 ISINs per Request
search
string
optional

Use this query parameter to search for Name/Title, ISIN, WKN or symbol. You can also perform a partial search by only specifiying the first 4 symbols.

type
string
optional

Use this query parameter to specify the type of instrument you want to filter for, e.g. "stock" or "etf"

Other Query Parameters

mic
string
optional

Enter a Market Identifier Code (MIC) in there. We currently offer data from the Munich Stock Exchange (XMUN).

currency
string
optional

Define a three letter ISO currency code to see instruments traded in a specific currency, like "EUR" or "USD"

tradable
boolean
optional

Filter for tradable or non-tradable Instruments with true or false

limit
int
optional

This parameter is required to influence the Pagination. Use it to define the limit of displayed results on one page.
The default value is 100, the maximum number is 250.

page
int
optional

This parameter is required to influence the Pagination. Use it to define the specific results page you wish to display.


How do we determine whether an Instrument is tradable?

Twice a day, we check with Gettex whether an Instrument is tradable - once right before the exchange opens and around 3:35pm when NASDAQ opens. Based on that check, we update our Instruments list.

Response

Response Parameters

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
string

This tells you about the type of instrument, e.g. "stock" or "etf"

Other Attributes

time
string

Timestamp of your API request

Venues

name
string

This is the name of the trading venue

title
string

This is the title of the trading venue

mic
string

This is the Market Identifier Code of the trading venue

is_open
boolean

This indicates if the trading venue is currently open

tradable
boolean

This indicates if the instrument is tradable at the trading venue

currency
string

This indicates in which currency the instrument is traded

Pagination

previous
string

Pagination attribute: this is a URL of the previous page

next
string

Pagination attribute: this is a URL of the next page

total
int

Pagination attribute: this is the total number of results

page
int

Pagination attribute: this is the current page number

pages
int

Pagination attribute: this is the total number of pages

Check our Error Handling Page for specific information on error types.

GET/instruments/
1import requests
2import json
3
4request = requests.get("https://data.lemon.markets/v1/instruments/",
5          headers={"Authorization": "Bearer YOUR-API-KEY"})
6print(request.json())
Response
1{
2  "time": "2022-02-14T20:44:03.759+00:00",
3  "results":
4  [
5    {
6      "isin": "US19260Q1076",
7      "wkn": "A2QP7J",
8      "name": "COINBASE GLB.CL.A -,00001",
9      "title": "COINBASE GLOBAL INC",
10      "symbol": "1QZ",
11      "type": "stock",
12      "venues":
13      [
14        {
15          "name": "Börse München - Gettex",
16          "title": "Gettex",
17          "mic": "XMUN",
18          "is_open": true,
19          "tradable": true,
20          "currency": "EUR"
21        }
22      ]
23    }
24  ],
25  "previous": "https://data.lemon.markets/v1/instruments/?limit=100&page=1",
26  "next": "https://data.lemon.markets/v1/instruments/?limit=100&page=3",
27  "total": 26283,
28  "page": 2,
29  "pages": 263
30}
31

Trading Venues

The Market Data API structure allows to specify from which Trading Venue you want to receive your data. We currently support the connection to the Munich Stock Exchange ("XMUN").

GET /venues/

You can access everything related to Trading Venues by using the following request URL:

https://data.lemon.markets/v1/venues/

Request

Specify your request as follows:

Header Parameters

Authorization
string
required

Set your Authorization header in the format "Authorization: Bearer YOUR-API-KEY"
(see the example in the code snippet on the right)

Query Parameters

mic
string
optional

Enter a Market Identifier Code (MIC) in there. We currently offer data from the Munich Stock Exchange (XMUN).

limit
int
optional

This parameter is required to influence the Pagination. Use it to define the limit of displayed results on one page.
The default value is 100, the maximum number is 250.

page
int
optional

This parameter is required to influence the Pagination. Use it to define the specific results page you wish to display.

Response

Response Parameters

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

Other Attributes

time
string

Timestamp of your API request

opening_days
array

This is a list of days when Trading Venue is open

Opening Hours

start
string

This is the time the Trading Venue opens

end
string

This is the time the Trading Venue closes

timezone
string

This is the timezone the Opening Hours are returned in

Pagination

previous
string

Pagination attribute: this is a URL of the previous page

next
string

Pagination attribute: this is a URL of the next page

total
int

Pagination attribute: this is the total number of results

page
int

Pagination attribute: this is the current page number

pages
int

Pagination attribute: this is the total number of pages

Check our Error Handling Page for specific information on error types.

GET/venues/
1import requests
2import json
3
4request = requests.get("https://data.lemon.markets/v1/venues/",
5          headers={"Authorization": "Bearer YOUR-API-KEY"})
6print(request.json())
Response
1{
2  "time": "2022-02-14T20:44:03.759+00:00",
3  "results":
4  [
5    {
6      "name": "Börse München - Gettex",
7      "title": "Gettex",
8      "mic": "XMUN",
9      "is_open": true,
10      "opening_hours": {
11        "start": "08:00",
12        "end": "22:00",
13        "timezone": "Europe/Berlin"
14      },
15      "opening_days": [
16        "2021-12-06",
17        "2021-12-07",
18        "2021-12-08",
19        ...
20      ]
21    }
22  ],
23  "previous": "https://data.lemon.markets/v1/venues/?limit=1&&page=1",
24  "next": "https://data.lemon.markets/v1/venues/?limit=1&&page=3",
25  "total": 3,
26  "page": 2,
27  "pages": 3,
28}
29