Message: ProductSearchRequest

File: WebAPI/symbol_browsing_2.proto

Description

Request for a list of product symbols matching a search criteria (see Symbol.product_metadata).

Limits:

1.  The request rate is 30 per 60 seconds by default.

2.  The number of simultaneous requests in processing is 5 by default.

Response: ProductSearchReport.

Used in

InformationRequest

Fields

search_term

Type: string

Description: Term to search matched product symbols on. Search term needs to be filled and its length must be greater than 3 (by default) if category_id filter is empty. Searching is done on the text associated to the being searched product symbols. Matching is supported only by “starts with” pattern. Multi-word input (whitespace delimited) is applied by “or”. I.e. it matches a symbol if any word from the search term matches.

category_ids

Type: string

Description: Optional category filter controlling how multiple symbol categories are applied in the filter. Categories within the same tree (having the same root) are applied by “OR” in the category filter (e.g., two exchanges, either matches). Otherwise, categories are applied by “AND” (e.g., exchange and asset).

See: SymbolCategory, SymbolCategoryListRequest.

Source: SymbolCategory.id