GET
/
markets
/
{marketId}
/
status
curl --request GET \
  --url https://api.forestreet.com/markets/{marketId}/status \
  --header 'x-api-key: <api-key>'
{
  "discover": {
      "inProgress": false,
      "endTime": "2025-06-02T11:27:29.017Z"
  },
  "companies": {
      "inProgress": false,
      "endTime": "2025-06-02T12:36:56.955Z"
  },
  "news": {
      "inProgress": false,
      "disabled": true
  },
  "esg": {
      "inProgress": false,
      "disabled": true
  },
  "momentum": {
      "inProgress": true
  },
  "topics": {
      "inProgress": true
  },
  "overall": {
      "inProgress": true,
      "status": "inProgress"
  }
}

Path

marketId
string

The ID of the market you would like to get the status of.

Query Parameters

startTime
string

Only include jobs that were started after this time. The time should be UTC, in ISO 8601 format (e.g., 2025-06-02T11:27:29.017Z).

Cannot be in the future; if not provided, all jobs will be included.

This is useful to ensure that any historical anomalies would not be included in the response.

Response

Each of the response fields includes an object with the following properties:

discover
object

The status of initial companies discovery.

companies
object

The status of companies metadata enquiry.

momentum
object

The status of momentum analysis.

topics
object

The status of topics extractions and competitors analysis.

overall
object

The overall status of the discovery.

{
  "discover": {
      "inProgress": false,
      "endTime": "2025-06-02T11:27:29.017Z"
  },
  "companies": {
      "inProgress": false,
      "endTime": "2025-06-02T12:36:56.955Z"
  },
  "news": {
      "inProgress": false,
      "disabled": true
  },
  "esg": {
      "inProgress": false,
      "disabled": true
  },
  "momentum": {
      "inProgress": true
  },
  "topics": {
      "inProgress": true
  },
  "overall": {
      "inProgress": true,
      "status": "inProgress"
  }
}