curl --request POST \
--url https://rest.forestreet.com/v2/impact/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"searchType": "keywordSearch",
"keyword": "<string>",
"location": "<string>",
"page": 50.5,
"perPage": 55,
"filters": {
"certifications": [
"<string>"
],
"naicsCodes": [
{
"value": "<string>",
"label": "<string>"
}
],
"companyKeyword": "<string>"
},
"sort": {
"field": "name",
"direction": "asc"
}
}
'{
"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
}
}Search for impact data
curl --request POST \
--url https://rest.forestreet.com/v2/impact/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"searchType": "keywordSearch",
"keyword": "<string>",
"location": "<string>",
"page": 50.5,
"perPage": 55,
"filters": {
"certifications": [
"<string>"
],
"naicsCodes": [
{
"value": "<string>",
"label": "<string>"
}
],
"companyKeyword": "<string>"
},
"sort": {
"field": "name",
"direction": "asc"
}
}
'{
"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
}
}Pass a static API key for every request, provided by your customer support.
Type of search to perform: keyword-based or domain-based.
keywordSearch, domainSearch Keyword or domain name to search for.
1Optional location filter to refine search results.
Page number for paginated search results (1–100).
1 <= x <= 100Number of items per page (10–100).
10 <= x <= 100Optional filters applied to the search.
Show child attributes
List of certifications to filter companies by.
Keyword to further filter company names or descriptions.
Search impact data response
List of companies returned by the search.
Show child attributes
Location information for the firm.
Show child attributes
Name of the firm.
Brief description of the firm.
List of keywords associated with the firm.
Verified certifications the firm holds.
Unverified certifications claimed by the firm.
City where the firm is located.
Website domain of the firm.
URL link to the firm’s website.
List of NAICS codes associated with the firm.
Descriptions for the firm's NAICS codes.
Revenue information for the firm.
Show child attributes
Relevance score of the search result.
Change in revenue compared to previous data.
Change in company size compared to previous data.
Pagination metadata for the search results.