API Key

The Funding API uses an API key to identify your application. API keys are only available to organisations.

Funding API

Overview

The Funding API lets you get the F6S data about raising startups. The API call returns a JSON based on URL parameters sent through a standard HTTPS request.

Funding API Request Format

A Funding API request takes the following form:

https://api.f6s.com/funding/main?api_key=API-KEY&parameters

where parameters are optional and may be either of the following:

  • page=page-number is the page in pagination [1,2,3,…] where to make the request. Default is 1.
  • count=number_of_startups is the maximum number of Data objects displayed per page. Default is 200.

Response Example

The following example contains the URL of a JSON that contains funding data:

https://api.f6s.com/funding/main?api_key=XXXXXX

When you send through this HTTPS request, the API returns a JSON like the following:

{
 "data":[
    {
       "id":"200165",
       "name":"StartupName",
       "description":"",
       "url":"https:\/\/www.f6s.com\/startupname",
       "funding":{
          "target_valuation":{
             "currency":"EUR",
             "amount":"2000000"
          },
          "amount_raising":{
             "currency":"EUR",
             "amount":"450000"
          },
          "closing_date":"N\/A",
          "security_type":"preferred",
          "stage":"seed"
       }
    },
    {
       "id":"200159",
       "name":"NBT",
       "description":"",
       "url":"https:\/\/www.f6s.com\/nbt",
       "funding":{
          "target_valuation":{
             "currency":"EUR",
             "amount":"500000"
          },
          "amount_raising":{
             "currency":"EUR",
             "amount":"50000"
          },
          "closing_date":"",
          "security_type":"",
          "stage":"seed"
       }
    }
 ],
 "status":200,
 "error":{
    "error_code":0
 }
}

Funding API Results

Defaults:
- The results format is UTF-8 Encoded JSON
- The top object contains three objects: data[] , status[] and error[]
- The response is successful if status is 200, and error_code is 0
- Error[] is always shown
- 100 objects per page by default
- 200 maximum number of startups shown

When the Funding API returns results, it places them within a JSON array.

A typical result is made up of the following fields:

The data[] is an array containing the separate Data components. Each data[] typically contains:

  • id - integer, is the internal id of a team.

  • name - string, is the team name.

  • description - longtext, is the full description of a team.

  • url - string, the full URL of the team profile.

  • city - string, is the name of the team city (shown if exists).

  • country - string, is the name of the team country (shown if exists).

  • funding - array, it's shown if exists and it contains:

    • target_valuation - array, target of valuation:

      • currency - string, 3 symbol code for currency of a progam funding (USD, EUR, GBP, INR, SGD, BRL, EGP).
      • amount - integer, amount of money.
    • amount_raising - array, amount that the startup is raising. It contains:

      • currency - string, 3 symbol code for currency of a progam funding (USD, EUR, GBP, INR, SGD, BRL, EGP).
      • amount - integer, amount of money.
    • closing_date - date, date of the closing date. (Shown if exists).

    • security_type - string, is the current security type. It can be one of the following values:

      • founder
      • common
      • preferred
      • employee_shares
      • options_pool
      • convertible_note
    • stage - string, indicates the current stage. It can be one of the following values:
      • seed
      • angel
      • series-a
      • venture-capital
      • private-equity
      • crowdfunding
      • ipo
  • investments - array, indicates the investments in the current round (only shows if exists).
    • currency - string, 3 symbol code for currency of a progam funding (USD, EUR, GBP, INR, SGD, BRL, EGP).
    • amount - integer, amount of money invested.
    • investor - array, contains information about the investor profile:
      • name - string, is the investor name.
      • actor_id - integer, is the investor internal ID.
      • url - string, is the full URL of the investor.