Skip to main content
GET
/
v2
/
markets
/
{marketId}
/
explorer
/
companies
/
filters
Get market explorer filters
curl --request GET \
  --url https://rest.forestreet.com/v2/markets/{marketId}/explorer/companies/filters \
  --header 'x-api-key: <api-key>'
{
  "yearFounded": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "yearFoundedMin": {
    "filtered": {
      "label": "<string>",
      "count": 123
    },
    "unfiltered": {
      "label": "<string>",
      "count": 123
    }
  },
  "yearFoundedMax": {
    "filtered": {
      "label": "<string>",
      "count": 123
    },
    "unfiltered": {
      "label": "<string>",
      "count": 123
    }
  },
  "companySize": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "companyRevenue": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "hqCountry": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "hqState": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "hqCity": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "categories": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "userTags": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "momentumScore": {
    "filtered": [
      {
        "label": "<string>",
        "count": 123
      }
    ],
    "unfiltered": [
      {
        "label": "<string>",
        "count": 123
      }
    ]
  },
  "momentumScoreMin": {
    "filtered": {
      "label": "<string>",
      "count": 123
    },
    "unfiltered": {
      "label": "<string>",
      "count": 123
    }
  },
  "momentumScoreMax": {
    "filtered": {
      "label": "<string>",
      "count": 123
    },
    "unfiltered": {
      "label": "<string>",
      "count": 123
    }
  },
  "isLocationVerified": {
    "filtered": {
      "label": "<string>",
      "count": 123
    },
    "unfiltered": {
      "label": "<string>",
      "count": 123
    }
  }
}

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
versionDate
string

Filter companies by version date.

Response

Market explorer filters response schema

yearFounded
object
required
yearFoundedMin
object
required
yearFoundedMax
object
required
companySize
object
required
companyRevenue
object
required
hqCountry
object
required
hqState
object
required
hqCity
object
required
categories
object
required
userTags
object
required
momentumScore
object
required
momentumScoreMin
object
required
momentumScoreMax
object
required
isLocationVerified
object
required