Search Existing Markets
Search the list of available markets.
Body Request Object Example
Body
The Regular Expression string to search for a phrase or keyword within a Market’s name, description, or subtitle.
With a few notable exceptions below, this value can be treated as a case-insensitive string search for the market title.
Special Characters:
(Foo)
- Due to these being capture groups in Regex, these will need to be escaped as\\(Some Text\\)
if you want to search for literal()
. Actual capture groups are not used by this endpoint, however you can still use them to define group patterns, such as(Stainless )?Steel (Manufacturer|Supplier)
.[Foo]
- Character Class. Square brackets are used to define a character class, which allows you to match any one of the characters inside the brackets. For example,[abc]
matches eithera
,b
, orc
. If you want to search literal[Foo]
, escape the query as\\[Foo\\]
.{Foo}
-Quantifier
. Curly braces are used as quantifiers to specify the number of times an element should be matched. For example,a{2,3}
matches the lettera
if it appears 2 or 3 times. To search for literal{Foo}
, use\\{\\}
.
NOTE It is highly unusual for market names to contain []
or {}
.
The string to search for a phrase or keyword within a Company’s name, domain,
or dunsNumber. If both keyword
and company
are provided, it will
prioritise company
search.
If you would data about a specific market, you can pass the marketId here.
An array of HS Codes to filter the markets by.
The page to return from the paginated results
The number of markets to return per page
The collection to search in.
If not specified, the user’s default collection will be used.
Response
Pagination details and metadata about the search results.
The body of the search response.