LUSID API requests: character limits and allowed values

LUSID restricts the size of, and characters allowed in, string fields and query parameters submitted in API requests. More on loading data into LUSID.

Kind of field

Example field and value

Max chars in value

Allowed chars in value

Transaction identifier

TransactionRequest.TransactionId

"transactionId": "MyTransactionId-123"

256

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    @ / + - _ * # ; ^ & . ?

  • All currency symbols

  • Note: No spaces allowed

Instrument identifier

InstrumentDefinition.Identifiers

"identifiers": {
  "ClientInternal": {
    "value": "MyInstrumentId-123",
  }
}

256

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    @ / + - _ * # ; ^ & . ?

  • All currency symbols

  • Note: No spaces allowed

Display name

CreateTransactionPortfolioRequest.DisplayName

"displayName": "Portfolio UK"

512

  • All UTF-8 characters

  • Spaces

Description

CreateTransactionPortfolioRequest.Description

"description": "Portfolio for UK market"

512

  • All UTF-8 characters

  • Spaces

Scope
(including the scope of a 3-stage property key)

CreatePropertyDefinitionRequest.Scope

"scope": "MyScopeName"

64

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    - _

  • Note: No spaces allowed

Code
(including the code of a 3-stage property key)

CreatePropertyDefinitionRequest.Code

"code": "MyCodeName"

64

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    - _

  • Note: No spaces allowed

Property value

PropertyValue.LabelValue

"value": {
  "labelValue": "My property value"
}

1024

  • All UTF-8 characters

  • Spaces

Derived property formula

CreateDerivedPropertyDefinitionRequest.DerivationFormula

"derivationFormula": "(Properties[Instrument/default/Price] 
* Properties[Instrument/default/Cost])

8000

  • All UTF-8 characters

  • Spaces

Date (specified as a string) or cut label

TransactionRequest.TransactionDate

"transactionDate": "2018-03-05T00:00:00.0000000+00:00"

256

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    - + : .

  • Spaces

Filter query parameter

ListInstruments.Filter

https://<your-domain>.lusid.com/api/api/instruments?filter=State%20eq%20%27Active%27'

512

  • All UTF-8 characters

  • Spaces (URL encoded)

Sort query parameter

ListInstruments.SortBy

https://<your-domain>.lusid.com/api/api/instruments?sortBy=name

256

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    -

  • Spaces (URL encoded)

Any other input string

TransactionRequest.Source

"source": "My transaction type source"

256

  • Uppercase and lowercase letters

  • Digits 0 - 9

  • Printable characters:
    - _

  • Spaces

Data limits for lists of values

The following size limits are defined for all the data that is accepted as a list of values. These limits are applied for a single API request so if the user wanted to provide an input size more than the limits defined below it may be possible to do that by calling the same API endpoint multiple times with the incremental list of values. For example  if the user wanted to Upsert 1500 transaction IDs this could be done using 2 API calls for the Upsert API endpoint.

Resource Type

Array/List Type

Size

All

Properties

100

Instrument

Instrument identifiers

25

Transaction

Execution indentifiers

1000

Transaction

Transaction identifiers

1000

Transaction

Reconciliation methods

1

Valuation

Holiday calendars

5

Valuation

Date times

2600

Holiday calendars

Date identifiers

25

Recipes

MarketContext.suppliers

25

Recipes

PricingContext.modelChoice

25

Data types

Units

25

Data types

Allowable values

25

Flow convention

Payment calendar

5

Flow convention

Reset calendar

5