Views:

You can communicate with LUSID via a RESTful API.

In addition to interacting with the API directly, there is also a suite of SDKs which are open-source and available to assist in using the LUSID platform.

Authorising calls to the LUSID API

Every call to the API must be authorised by an API access token.

Once authenticated, the permissions granted to the calling user to access data and perform operations within LUSID depend entirely upon the roles and polices assigned to that user.

For much more on identity management and access control (IAM) for LUSID, start with this table of contents. There's a step-by-step tutorial for authorising API calls too.

Installing an appropriate SDK

The SDKs are currently available in the following languages. For each language you will find a set of tutorials/tests that you can run to give you an idea of how to call LUSID using the SDK.

Python

To install via the Python package manager pip:

$ pip install lusid-sdk

For further details on the Python SDK please refer to the GitHub repository:
https://github.com/finbourne/lusid-sdk-python

Java

Maven artifacts can be downloaded from the Open Source Software Repository Hosting (OSSRH) by adding the following to your pom.xml:

<project>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>com.finbourne</groupId>
      <artifactId>lusid-sdk</artifactId>
      <version>{SDK Version}</version>
    </dependency>
    ...
  </dependencies>
  ...
</project>

For further details on the Java SDK please refer to the GitHub repository:
https://github.com/finbourne/lusid-sdk-java

C#

To install via the C# package manager NuGet:

$ dotnet add package Lusid.Sdk

For further details on the C# SDK please refer to the GitHub repository:
https://github.com/finbourne/lusid-sdk-csharp

Typescript/Javascript

To install via the Node package manager npm:

$ npm install @finbourne/lusid

For further details on the Typescript/Javascript SDK please refer to the GitHub repository:
https://github.com/finbourne/lusid-sdk-js