api.commodity_maps.search

POST /commodity-map/search — ACPortal

Python

api.commodity_maps.search(*, data: CommodityMapSearchRequest | dict) -> list[CommodityMap]

CLI

ab commodity_maps search [--data ...]

POST /commodity-map/search.

Args: data: Search payload with search_text, page, page_size. Accepts a :class:CommodityMapSearchRequest instance or a dict.

Request model: :class:CommodityMapSearchRequest

Request body — CommodityMapSearchRequest

Field	Type	Required	Description
searchText	Optional[str]	no	Free-text search query
page	Optional[int]	no	Page number
pageSize	Optional[int]	no	Results per page

Response

Returns a list of List[CommodityMap].

Field	Type	Required	Description
id	Optional[str]	no	Map ID
customName	Optional[str]	no	Custom commodity name
commodityId	Optional[str]	no	Linked commodity ID

---

← Back to api.commodity_maps