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": [
{
"nameOfFirm": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"certifications": [
"<string>"
],
"unverifiedCertifications": [
"<string>"
],
"city": "<string>",
"domain": "<string>",
"url": "<string>",
"naicsCodes": [
123
],
"naicsDescriptions": [
"<string>"
],
"revenue": {
"id": 123,
"label": "<string>",
"actual": {
"value": 123,
"currency": "<string>"
}
},
"size": {
"id": 123,
"label": "<string>",
"actual": 123
},
"score": 123,
"revenueDelta": 123,
"sizeDelta": 123,
"location": {
"state": {
"type": "<string>",
"name": "<string>",
"code": "<string>",
"country": "<string>"
},
"country": {
"type": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}
],
"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": [
{
"nameOfFirm": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"certifications": [
"<string>"
],
"unverifiedCertifications": [
"<string>"
],
"city": "<string>",
"domain": "<string>",
"url": "<string>",
"naicsCodes": [
123
],
"naicsDescriptions": [
"<string>"
],
"revenue": {
"id": 123,
"label": "<string>",
"actual": {
"value": 123,
"currency": "<string>"
}
},
"size": {
"id": 123,
"label": "<string>",
"actual": 123
},
"score": 123,
"revenueDelta": 123,
"sizeDelta": 123,
"location": {
"state": {
"type": "<string>",
"name": "<string>",
"code": "<string>",
"country": "<string>"
},
"country": {
"type": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}
],
"meta": {
"totalItems": 123,
"currentPage": 123,
"totalPages": 123,
"itemsPerPage": 123
}
}
Pass a static API key for every request, provided by your customer support.
Search impact data response
The response is of type object
.