Skip to main content
GET
/
v2
/
markets
/
{marketId}
/
explorer
/
companies
List market explorer companies
curl --request GET \
  --url https://rest.forestreet.com/v2/markets/{marketId}/explorer/companies \
  --header 'x-api-key: <api-key>'
{
  "metadata": {
    "pagination": {
      "totalItems": 123,
      "totalPages": 13,
      "currentPage": 1,
      "pageSize": 10,
      "unfilteredTotalItems": 196,
      "unfilteredTotalPages": 20
    },
    "marketVersion": {
      "currentVersion": "<string>",
      "availableVersions": [
        "<string>"
      ]
    }
  },
  "data": [
    {
      "id": "<string>",
      "domain": "<string>",
      "size": {
        "value": "<string>",
        "sortValue": 123
      },
      "revenue": {
        "value": "<string>",
        "sortValue": 123
      },
      "logoURL": "<string>",
      "name": "<string>",
      "description": "<string>",
      "foundedYear": 123,
      "hqCity": "<string>",
      "hqState": "<string>",
      "hqCountry": "<string>",
      "momentum": {
        "funding": 123,
        "webTraffic": 123,
        "mediaAnalysis": 123,
        "newsSentiment": 123,
        "revenueEstimates": 123
      },
      "overallMomentum": 123,
      "actualRevenue": null,
      "shareholdersList": [
        null
      ],
      "locations": 123,
      "topics": [
        {
          "topicId": "<string>",
          "name": "<string>",
          "score": 123
        }
      ],
      "versionDate": "<string>",
      "userTags": [
        {
          "id": 123,
          "label": "<string>",
          "hexColor": "<string>",
          "companyId": "<string>",
          "parentTagId": 123
        }
      ],
      "isFavourite": true,
      "categories": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "isLocationVerified": true,
      "certifications": [
        "<string>"
      ],
      "contactNumber": "<string>",
      "contactEmail": "<string>",
      "parentCompany": "<string>",
      "subsidiaries": [
        "<string>"
      ],
      "founders": [
        {
          "name": "<string>",
          "type": "<string>",
          "image": "<string>"
        }
      ],
      "ceo": "<string>",
      "ukCompaniesHouseIds": [
        "<string>"
      ],
      "ukPersonsWithSignificantControl": [
        {
          "id": 123,
          "name": "<string>",
          "ownership": [
            "<string>"
          ],
          "type": "<string>",
          "status": true,
          "companyId": "<string>",
          "companiesHouseURL": "<string>"
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

marketId
integer
required

ID of the market whose explorer companies will be retrieved.

Required range: x > 0
teamId
integer

Unique identifier for the team used to access the market, for determining access rights and blacklists. Team ID can be provided either in path or query parameter for backward compatibility; exactly one is required.

Required range: x > 0

Query Parameters

teamId
integer

Unique identifier for the team used to access the market, for determining access rights and blacklists. Team ID can be provided either in path or query parameter for backward compatibility; exactly one is required.

Required range: x > 0

Search term to filter companies by name, or description.

domains
string[]
categories
string[]
userTags
string[]
favourites
boolean | null
topics
string[]
features
string[]

Filter by feature architecture node IDs. Prefix with 'e:' to exclude (e.g., '1, 2, e:3').

size
string[]
revenueRange
string[]
isLocationVerified
boolean | null
hqCountry
string[]
hqState
string[]
hqCity
string[]
phrases
string[]
momentumScoreRange
object
foundedYearRange
object
page
integer
default:1

Page number to retrieve, starting from 1.

Required range: x > 0
pageSize
integer
default:50

Number of companies per page.

Required range: 0 < x <= 500
sort
object
versionDate
string

Filter companies by version date.

Response

Market explorer companies response schema

metadata
object
required
data
object[]
required