Developers

Unfinished content. The Lexicon Local API is under development.

Lexicon has an API that other applications can use to get data out of Lexicon. You can get almost anything out of Lexicon, like your tracks, playlists, cues, beatgrids, tags, etc.

You can also directly query the Lexicon SQLite database, but it is not recommended to do so. You may run into locking issues while Lexicon is running, and you will have to join your own data. Unless you have a very specific use-case, you should always use the API first.

Enabling the API

The Lexicon Local API is a REST API that you can send requests to as long as Lexicon is running.

The API is disabled by default. You can enable the API in the Lexicon settings under Integrations.

Authentication

There is currently no authentication for the API, but this will change in the future.

Parameters

All query parameters can also be sent as a JSON body, even for GET requests.

Query string parameter arrays and objects are in the following form:

Array: /tracks?fields=title&fields=artist

Object: /search/tracks?filter[artist]=Daft%20Punk&filter[title]=Touch

Getting help

You can get help or share your project with other Lexicon users on the forum or on Discord.