{
    "meta": {
        "totalItems": 3
    },
    "market": {
        "id": 2,
        "name": "Transcription Services"
    },
    "data": [
        {
            "domain": "ibm.com",
            "name": "IBM",
            "description": "International Business Machines Corporation (IBM) provides computer solutions. The Company offers application, technology consulting and support, process design and operations, cloud, digital workplace, and network services, as well as business resiliency, strategy, and design solutions. IBM serves clients worldwide.",
            "overallMomentum": 48,
            "contactNumber": "+1 914-499-1900",
            "contactEmail": "ews@us.ibm.com",
            "actualRevenue": 60530000000,
            "naics": [
                {
                    "code": "518210",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "518200",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "518000",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": true
                },
                {
                    "code": "334111",
                    "name": "Electronic Computer Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "334112",
                    "name": "Computer Storage Device Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "335000",
                    "name": "Electrical Equipment, Appliance, and Component Manufacturing",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "334419",
                    "name": "Other Electronic Component Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "330000",
                    "name": "Manufacturing",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "541618",
                    "name": "Other Management Consulting Services",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "541610",
                    "name": "Management Consulting Services",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "334410",
                    "name": "Semiconductor and Other Electronic Component Manufacturing",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "541600",
                    "name": "Management, Scientific, and Technical Consulting Services",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "334400",
                    "name": "Semiconductor and Other Electronic Component Manufacturing",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "541000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "540000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "334110",
                    "name": "Computer and Peripheral Equipment Manufacturing",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "334100",
                    "name": "Computer and Peripheral Equipment Manufacturing",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "334000",
                    "name": "Computer and Electronic Product Manufacturing",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": false
                }
            ],
            "operatesIn": ["us", "ca", "gb", "de", "fr", "in", "jp", "br", "au", "mx", "cn", "it", "es", "nl", "kr", "ch", "se", "sg", "ae", "za"]
        },
        {
            "domain": "pindrop.com",
            "name": "Pindrop",
            "description": "Pindrop Security, Inc. develops and markets security software. The Company offers a caller identification product that helps detect, report, and mitigate phone frauds. Pindrop Security serves the finance and banking industry in the United States.",
            "overallMomentum": 59,
            "contactNumber": "+1 866-245-4045",
            "contactEmail": "info@pindrop.com",
            "actualRevenue": 49000000,
            "naics": [
                {
                    "code": "541511",
                    "name": "Custom Computer Programming Services",
                    "level": 5,
                    "isPrimary": true
                },
                {
                    "code": "541510",
                    "name": "Computer Systems Design and Related Services",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "541500",
                    "name": "Computer Systems Design and Related Services",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "541000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "540000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 1,
                    "isPrimary": true
                },
                {
                    "code": "561612",
                    "name": "Security Guards and Patrol Services",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "561610",
                    "name": "Investigation, Guard, and Armored Car Services",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "561600",
                    "name": "Investigation and Security Services",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "561000",
                    "name": "Administrative and Support Services",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "560000",
                    "name": "Administrative and Support and Waste Management and Remediation Services",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": false
                }
            ],
            "operatesIn": ["gb", "us"]
        },
        {
            "domain": "talkatoo.com",
            "name": "Talkatoo",
            "description": "Talkatoo makes and sells dictation software for professionals.Our customers are busy professionals - doctors, veterinarians, and lawyers - who have high hourly bill rates and hectic schedules; their time is valuable. Driven by liability management and professional regulation, their documentation req... Read more",
            "overallMomentum": 29,
            "contactNumber": null,
            "contactEmail": null,
            "actualRevenue": 7000000,
            "naics": [
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": true
                }
            ],
            "operatesIn": ["ca"]
        }
    ]
}

{
    "title": "A title to display to the user",
    "message": "A block of text to be displayed to the user, explaining the action had been successful.<br/><br/>If the user is to be redirected, explain where they will be redirected to, and instructions to proceed.",
    "redirectUrl": "https://your-internal-system.com/redirect-url"
}
This section is about an client supplied endpoint that Forestreet platform will send a POST request to.The Request section describes the body of the POST request that will be sent to your API, and the Response section describes the expected response from your API.
Forestreet Platform allows users to initiate an API call to export a market to their internal system. This feature is useful for users with real time data integration requirements, without the need for exporting and importing data manually. The workflow is as follows:
1

Register Endpoint

Each team will be able to register a number of endpoints with Forestreet.All endpoints must be POST endpoints, and must be able to accept a JSON body.
Refer to the Register Endpoint section below for the details of the endpoint registration.
2

User create studies

Users in your Team shall use the Forestreet platform to create markets and publish them as required.Using the Market Collection feature, users can group markets together for different projects or sub-teams etc.
3

Export to API

After publishing a market, users can select the market and choose to export it via the Export to API feature:

This will be visible if API endpoints are registered for the team.

4

Choose the endpoint

All the registered endpoints for the Team will be displayed in a dropdown list, and the user can select the desired endpoint to export the market to.The description will be displayed to the user to help them choose the correct endpoint, and the user can click on the Export button to initiate the API call.
See the Request Body sent to your API section for the expected body of the POST request.
5

Endpoint Response

Depending on the Status Code returned by your API, the user will be shown a success or failure message.

Success

If successful, the user will be shown a title and message that you provide.If a redirect URL is provided, the user will be redirected to that URL after 5 seconds.

Failure

If your API returns a 400-499 status code, the user will be shown a title, message and - optionally - a list of reference URLs that help the user diagnose the issue.

Error

If your API does not respond within 15 seconds, or the connection was closed, or the return status code was 500-599, we will try again for a maximum of 3 times. The user will be shown a generic error message, referring them to contact their IT support.

​
To Register an Endpoint

Endpoints are attached to a Team, and can be registered via the “Manage Teams” feature.
1

Register Endpoint

To register an endpoint, you must be a Team Admin or have the appropriate permissions to manage teams.

Settings Tab

2

Navigate to Manage Teams

Navigate to the Manage Teams section in the Forestreet platform.

API Endpoints Section

3

API Endpoints Section

In the API Endpoints section, you can view existing endpoints and register new ones.
4

Register Endpoint Form

Click on the Register Endpoint button and fill in the required details.

Register Endpoint Form

The name of the endpoint must be unique within the Team, and cannot be changed after it has been registered. If you need to change the name, you must delete the endpoint and register a new one with the desired name.
5

Submit the Form

After filling in the details, click on the Register button to save the endpoint.

​
POST Body to your API

After the user had chosen the endpoint and clicked on the Export button, Forestreet will send a POST request to the URL provided in the endpoint registration. An example body of the POST request is shown on the right, to illustrate the structure of the data that will be sent to your API.
Unfortunately we cannot provide any IP ranges for whitelisting, as our servers could be run globally from all AWS regions.
This is equivalent to the Response from the Companies endpoint, with the following fields selected:
Equivalent Companies Request
{
    "page": 1,
    "itemsPerPage": 500,
    "sorts": {
        "score": "desc"
    },
    "fields": [
        "domain",
        "score",
        "name",
        "description",
        "overallMomentum",
        "contactNumber",
        "contactEmail",
        "actualRevenue",
        "naics",
        "operatesIn"
    ]
}
The maximum number of companies that will be sent is 500. If more companies are required, use the market.id to query the Market/Companies endpoint for paginated results.
{
    "meta": {
        "totalItems": 3
    },
    "market": {
        "id": 2,
        "name": "Transcription Services"
    },
    "data": [
        {
            "domain": "ibm.com",
            "name": "IBM",
            "description": "International Business Machines Corporation (IBM) provides computer solutions. The Company offers application, technology consulting and support, process design and operations, cloud, digital workplace, and network services, as well as business resiliency, strategy, and design solutions. IBM serves clients worldwide.",
            "overallMomentum": 48,
            "contactNumber": "+1 914-499-1900",
            "contactEmail": "ews@us.ibm.com",
            "actualRevenue": 60530000000,
            "naics": [
                {
                    "code": "518210",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "518200",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "518000",
                    "name": "Computing Infrastructure Providers, Data Processing, Web Hosting, and Related Services",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": true
                },
                {
                    "code": "334111",
                    "name": "Electronic Computer Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "334112",
                    "name": "Computer Storage Device Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "335000",
                    "name": "Electrical Equipment, Appliance, and Component Manufacturing",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "334419",
                    "name": "Other Electronic Component Manufacturing",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "330000",
                    "name": "Manufacturing",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "541618",
                    "name": "Other Management Consulting Services",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "541610",
                    "name": "Management Consulting Services",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "334410",
                    "name": "Semiconductor and Other Electronic Component Manufacturing",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "541600",
                    "name": "Management, Scientific, and Technical Consulting Services",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "334400",
                    "name": "Semiconductor and Other Electronic Component Manufacturing",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "541000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "540000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "334110",
                    "name": "Computer and Peripheral Equipment Manufacturing",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "334100",
                    "name": "Computer and Peripheral Equipment Manufacturing",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "334000",
                    "name": "Computer and Electronic Product Manufacturing",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": false
                }
            ],
            "operatesIn": ["us", "ca", "gb", "de", "fr", "in", "jp", "br", "au", "mx", "cn", "it", "es", "nl", "kr", "ch", "se", "sg", "ae", "za"]
        },
        {
            "domain": "pindrop.com",
            "name": "Pindrop",
            "description": "Pindrop Security, Inc. develops and markets security software. The Company offers a caller identification product that helps detect, report, and mitigate phone frauds. Pindrop Security serves the finance and banking industry in the United States.",
            "overallMomentum": 59,
            "contactNumber": "+1 866-245-4045",
            "contactEmail": "info@pindrop.com",
            "actualRevenue": 49000000,
            "naics": [
                {
                    "code": "541511",
                    "name": "Custom Computer Programming Services",
                    "level": 5,
                    "isPrimary": true
                },
                {
                    "code": "541510",
                    "name": "Computer Systems Design and Related Services",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "541500",
                    "name": "Computer Systems Design and Related Services",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "541000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "540000",
                    "name": "Professional, Scientific, and Technical Services",
                    "level": 1,
                    "isPrimary": true
                },
                {
                    "code": "561612",
                    "name": "Security Guards and Patrol Services",
                    "level": 5,
                    "isPrimary": false
                },
                {
                    "code": "561610",
                    "name": "Investigation, Guard, and Armored Car Services",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "561600",
                    "name": "Investigation and Security Services",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "561000",
                    "name": "Administrative and Support Services",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "560000",
                    "name": "Administrative and Support and Waste Management and Remediation Services",
                    "level": 1,
                    "isPrimary": false
                },
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": false
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": false
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": false
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": false
                }
            ],
            "operatesIn": ["gb", "us"]
        },
        {
            "domain": "talkatoo.com",
            "name": "Talkatoo",
            "description": "Talkatoo makes and sells dictation software for professionals.Our customers are busy professionals - doctors, veterinarians, and lawyers - who have high hourly bill rates and hectic schedules; their time is valuable. Driven by liability management and professional regulation, their documentation req... Read more",
            "overallMomentum": 29,
            "contactNumber": null,
            "contactEmail": null,
            "actualRevenue": 7000000,
            "naics": [
                {
                    "code": "513210",
                    "name": "Software Publishers",
                    "level": 4,
                    "isPrimary": true
                },
                {
                    "code": "513200",
                    "name": "Software Publishers",
                    "level": 3,
                    "isPrimary": true
                },
                {
                    "code": "513000",
                    "name": "Publishing Industries",
                    "level": 2,
                    "isPrimary": true
                },
                {
                    "code": "510000",
                    "name": "Information",
                    "level": 1,
                    "isPrimary": true
                }
            ],
            "operatesIn": ["ca"]
        }
    ]
}

​
Expected Response from your API

Your API should be constructed to return a JSON object with the following structure: 
{
    "title": "A title to display to the user",
    "message": "A block of text to be displayed to the user, explaining the action had been successful.<br/><br/>If the user is to be redirected, explain where they will be redirected to, and instructions to proceed.",
    "redirectUrl": "https://your-internal-system.com/redirect-url"
}

​
On Success

Response status must be 200, with Content-Type: application/json in the header, and a JSON body with the following schema:
On Success
{
    "title": "A title to display to the user",
    "message": "A block of text to be displayed to the user, explaining the action had been successful.<br/><br/>If the user is to be redirected, explain where they will be redirected to, and instructions to proceed.",
    "redirectUrl": "https://your-internal-system.com/redirect-url"
}
The above response will be rendered in a modal dialog to the user as:
If the redirectUrl is provided and is not null, the user will be redirected to that URL in a new window after 5 seconds.

​
On Failure

Response status code 400-499 will be considered a failure. Where possible, the response body should contain a JSON object with the following schema:
On Failure
{
    "title": "A title to display to the user",
    "message": "A block of text to be displayed to the user, informing them all the issues that occurred during the export, and links to documentations that help resolve them.",
    "references": [
        {
            "url": "https://your-internal-system.com/docs/error-codes/123",
            "title": "Error Code 123"
        },
        {
            "url": "https://your-internal-system.com/it/contact",
            "title": "Contact IT Support"
        }
    ]
}
The above response will be rendered in a modal dialog to the user as:

​
On Exception/Timeout

Response status code 500-599 will be considered an server side exception. The API will try again immediately upto 3 times using the same Idempotency-Key. If that fails, the user will be shown a generic error message, referring them to contact their IT support.
The response contents from your API will not be parsed regardless of Content-Type if the status code is an Exception.
An error message that describes the issue will be shown to the user in a human language.