There are multiple tools and interfaces you can use to write a Luminesce query and analyse the results, to suit different environments and use cases.
To use any tool, you must have a Luminesce licence. Contact Technical Support for a trial license.
You must additionally:
- Authenticate, which means you must have a LUSID account username and password and be able to verify your identity using an OAuth 2.0 flow (the precise nature of which depends upon the tool).
- Have sufficient access control permissions. For evaluation purposes, it’s sufficient to assign your LUSID user the built-in lusid-administrator role, which is automatically the case if you are the domain owner. Find out more about access control.
For a general guide to the Luminesce platform architecture, see this article.
| Tool/interface | Notes | Authentication | Protocol (port) |
| LUSID web app | Simple GUI interface built in to the LUSID web app itself; recommended for beginners. Returns results as exportable tables, provides a simple charting facility, and enables you to schedule queries to run at particular or regular times. | OAuth 2.0 | HTTPS (443) |
| Luminesce CLI | .NET Core 3.1 app that runs queries either at the command line or from files (in which case results are returned in either CSV, Excel or SQLite format), or using an interactive mode (in which case results can be printed). | OAuth 2.0 (+ PKI certificate in some scenarios) | HTTPS (443) (+ AMQPS (5671) in some scenarios) |
| Luminesce REST API | You can write a custom app or script to call the REST API and return results in either Excel, CSV, SQlite, JSON or pipe-delimited format. | OAuth 2.0 | HTTPS (443) |
| Python SDK and C# SDK | You can write a custom app or script to call an SDK, which provides convenient access to the REST API in relevant environments. | OAuth 2.0 | HTTPS (443) |
| Lumipy | Python SDK but not a wrapper around the REST API. Particular focus on data science. | OAuth 2.0 | HTTPS (443) |
| .NET API | You can write a custom app or script to call the .NET API, which might be the most performant option. Contact Technical Support for delivery options. | OAuth 2.0 + PKI certificate | HTTPS (443) and AMQPS (5671) |
| 3rd party BI app | ODBC/JDBC drivers are available to support native integration with apps such as Excel, Tableau, DBeaver and Power BI. | OAuth 2.0 (+ PKI certificate in some scenarios) | HTTPS (443) (+ AMQPS (5671) in some scenarios) |