POST
/
markets
/
search
curl --request POST \
  --url https://api.forestreet.com/markets/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "keyword": "<string>",
  "company": "<string>",
  "marketId": 123,
  "hsCode": [
    {}
  ],
  "page": 123,
  "itemsPerPage": 123
}'
{
  "meta": {
      "currentPage": 1,
      "itemsPerPage": 25,
      "totalItems": 5,
      "totalPages": 1
    },
  "data": [
    {
      "_id": "65c22c919f08cad70dae034f",
      "marketId": 4345,
      "name": "Stainless Steel Manufacturers",
      "subtitle": "Created 06/02/2024",
      "description": "Externally created study",
      "headerImageUrl": "https://ailsa-study-thumbnails.s3.eu-west-2.amazonaws.com/default-thumbnail%402x.jpg",
      "companyCount": 10,
      "createdAt": "2024-02-06T12:55:16.000Z",
      "versionDate": "2024-02-06T12:56:49.877Z"
    },
  ]
}

​
Body Request Object Example

{
    "page": 1,
    "itemsPerPage": 5,
    "keyword": ""
}

​
Body

keyword
string
default: ""

The string to search for a phrase or keyword within a Market’s name, description, or subtitle.

company
string
default: ""

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.

marketId
number
default: ""

If you would data about a specific market, you can pass the marketId here.

hsCode
array
default: ""

An array of HS Codes to filter the markets by.

page
number
default: ""

The page to return from the paginated results

itemsPerPage
number
default: ""

The number of markets to return per page

SearchExport CSV