Find users, portfolios and instruments.

Params

Param Name Description
q
Required

The search keywords.


Value:

Must be String

mode
Optional

The search mode. Optional. The default is “mixed”.

Acceptable values are:

  • “mixed”: Results are returned mixed regardless of type.
  • “grouped”: Results are returned grouped by type.

Value:

Must be one of: mixed, grouped.

types
Optional

The types of results to return. Optional. The default is [“user”, “portfolio”, “instrument”].


Value:

Must be an array of [user, portfolio, instrument]