x-api-key

Forestreet Documentation

Welcome to the home of the Forestreet API documentation.

Introduction

Authentication

An assortment of ready-to-use UI components designed to enrich data visualisation and market analysis capabilities.

Pre-built UI Components

How to handle standard errors from our API

Errors

An innovative data visualisation tool designed to provide a comprehensive overview of the features and services offered by companies within a market.

Feature Map

Transform complex market data into clear, interactive visual insights for rapid understanding and informed decision-making

Topic Mosaic

The Momentum Score widget is a holistic measure of a company's market performance, encapsulating key growth indicators in a single, intuitive visualisation.

Momentum Score

Connect a market to your internal system using an API hook.

Export via API

This endpoint starts an on-demand discovery to find companies for a market.

Start Discovery

This endpoint gets the status of a market.

Status

This endpoint suggests keywords for a given market name

Suggests Keywords

Get all the collections that the current user is allowed to access.

Market Collections

Search Existing Markets

Suggest a market name based on the user-entered keyword.

Suggest Market Name

This endpoint search the companies for a given keyword.

Search

Create Project

A group of endpoints for management and of other users

Management Accounts

List all the users managed by the authenticated user

List all Managed Users

Get the activities of a user during a specific time period, up to 180 days.

User Activities

Forestreet Platform

Forestreet.com

Platform

Contact Us

This endpoint starts a quicker, lighter search than the full discovery endpoint.

Quick Search

This endpoint returns the status and results of a search

Quick Search Status

This endpoint retrieves ESG data for a given market.

Get a download link for CSV file of a market.

Export CSV

Retrieve a list of news articles and events specifically tailored for a given market, providing up-to-date insights and happenings related to that market.

News

This endpoint gets a hierarchy of topics talked about in a given market.

Topics

This endpoint gets a hierarchy of features and services provided by companies in a given market.

Quick Start

UI Components

Discover

Markets

Companies

Projects

Users

Market radar