Skip to main content
POST
/
v2
/
impact
/
search
Search companies
curl --request POST \
  --url https://rest.forestreet.com/v2/impact/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "location": "<string>",
  "page": 50.5,
  "perPage": 55,
  "filters": {
    "certifications": [
      "<string>"
    ],
    "naicsCodes": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "companyKeyword": "<string>"
  },
  "sort": {}
}
'
import requests

url = "https://rest.forestreet.com/v2/impact/search"

payload = {
"keyword": "<string>",
"location": "<string>",
"page": 50.5,
"perPage": 55,
"filters": {
"certifications": ["<string>"],
"naicsCodes": [
{
"value": "<string>",
"label": "<string>"
}
],
"companyKeyword": "<string>"
},
"sort": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keyword: '<string>',
location: '<string>',
page: 50.5,
perPage: 55,
filters: {
certifications: ['<string>'],
naicsCodes: [{value: '<string>', label: '<string>'}],
companyKeyword: '<string>'
},
sort: {}
})
};

fetch('https://rest.forestreet.com/v2/impact/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.forestreet.com/v2/impact/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keyword' => '<string>',
'location' => '<string>',
'page' => 50.5,
'perPage' => 55,
'filters' => [
'certifications' => [
'<string>'
],
'naicsCodes' => [
[
'value' => '<string>',
'label' => '<string>'
]
],
'companyKeyword' => '<string>'
],
'sort' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://rest.forestreet.com/v2/impact/search"

payload := strings.NewReader("{\n \"keyword\": \"<string>\",\n \"location\": \"<string>\",\n \"page\": 50.5,\n \"perPage\": 55,\n \"filters\": {\n \"certifications\": [\n \"<string>\"\n ],\n \"naicsCodes\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"companyKeyword\": \"<string>\"\n },\n \"sort\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://rest.forestreet.com/v2/impact/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"keyword\": \"<string>\",\n \"location\": \"<string>\",\n \"page\": 50.5,\n \"perPage\": 55,\n \"filters\": {\n \"certifications\": [\n \"<string>\"\n ],\n \"naicsCodes\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"companyKeyword\": \"<string>\"\n },\n \"sort\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rest.forestreet.com/v2/impact/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keyword\": \"<string>\",\n \"location\": \"<string>\",\n \"page\": 50.5,\n \"perPage\": 55,\n \"filters\": {\n \"certifications\": [\n \"<string>\"\n ],\n \"naicsCodes\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"companyKeyword\": \"<string>\"\n },\n \"sort\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "location": {
        "state": {
          "type": "<string>",
          "name": "<string>",
          "code": "<string>",
          "country": "<string>"
        },
        "country": {
          "type": "<string>",
          "name": "<string>",
          "code": "<string>"
        }
      },
      "nameOfFirm": "<string>",
      "description": "<string>",
      "keywords": [
        "<string>"
      ],
      "certifications": [
        "<string>"
      ],
      "unverifiedCertifications": [
        "<string>"
      ],
      "city": "<string>",
      "domain": "<string>",
      "url": "<string>",
      "naicsCodes": [
        123
      ],
      "naicsDescriptions": [
        "<string>"
      ],
      "revenue": {
        "actual": {
          "value": 123,
          "currency": "<string>"
        },
        "id": 123,
        "label": "<string>"
      },
      "size": {
        "id": 123,
        "label": "<string>",
        "actual": 123
      },
      "score": 123,
      "revenueDelta": 123,
      "sizeDelta": 123
    }
  ],
  "meta": {
    "totalItems": 123,
    "currentPage": 123,
    "totalPages": 123,
    "itemsPerPage": 123
  }
}
{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request"
}
{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden"
}
{
"success": false,
"errorCode": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json
searchType
enum<string>
required

Type of search to perform: keyword-based or domain-based.

Available options:
keywordSearch,
domainSearch
keyword
string
required

Keyword or domain name to search for.

Minimum string length: 1
location
string

Optional location filter to refine search results.

page
number

Page number for paginated search results (1–100).

Required range: 1 <= x <= 100
perPage
number

Number of items per page (10–100).

Required range: 10 <= x <= 100
filters
object

Optional filters applied to the search.

sort
object

Optional sorting parameters.

Response

Search impact data response

data
object[]
required

List of companies returned by the search.

meta
object
required

Pagination metadata for the search results.