Find Co-Founders & Employees Connect with {{ promotions.totalJobCandidates }} talented F6Sers

API Key

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

Deal Feed API

Overview

The Deal Feed API lets you get the F6S Deals Feed data. The API call returns a JSON based on URL parameters sent through a standard HTTPS request.

Deal Feed API Request Format

A Deal Feed API request takes the following form:

https://api.f6s.com/deals/browse?api_key=API-KEY&parameters

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

  • program=profile_id : returns deals for a specific profile. The profile id can be found adding /main/actor-id in the url of the profile wanted.

Example: To get the profile_id of the profile BestProgramEver, which has the url https://www.f6s.com/bestprogramever, the user should type https://www.f6s.com/bestprogramever/main/actor-id in the address bar.

  • area=name : where area is the alias of category. This parameter returns deals from a specific category. The possible values of areas can be found by accessing https://www.f6s.com/deals and clicking on the categories listed on the left hand side of the page. The last segment of the page URL is the area alias.

Example By clicking on the Computer Hardware category on the left side of the page https://www.f6s.com/deals, the url becomes https://www.f6s.com/deals/computer-hardware. Then, computer-hardware is the name for the Computer Hardware category.

  • 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 20.

Requesting All Deals

The following example contains the URL of a JSON that contains every deal on the F6S platform, which is displayed below:

https://api.f6s.com/deals/browse?api_key=XXXXXX

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

  {
     "deals":[
        {
           "id":"242",
           "name":"Program for Startups",
           "description":"Program for Startups is a global program that helps software startups succeed by giving them access to software, support and visibility.",
           "thumbnail":{
              "url":"https:\/\/www.f6s.com\/pictures\/profiles\/1\/74\/1234_th3.jpg",
              "image_id":"1234",
              "path":"pictures\/profiles\/1\/74",
              "type":"jpg",
              "size":"th3",
              "mime_type":"image\/jpeg",
              "width":64,
              "height":64
           },
           "value":"15000.00",
           "currency":"USD",
           "beta":false,
           "distribution_type":"everyone",
           "category":{
              "id":"28",
              "name":"Cloud Services"
           },
           "company":{
              "id":"6122",
              "name":"Program for Startups",
              "url":"https:\/\/www.f6s.com\/programforstartups"
           },
           "url":"https:\/\/www.f6s.com\/programforstartups",
           "get_deal_url":"https:\/\/www.f6s.com\/programforstartups?get_deal=242",
           "date_created":"2012-10-11 18:47:39",
           "date_modified":"2012-10-11 18:47:39",
           "date_expires":"2112-10-11 18:47:39"
        },
     ],
     "status":200,
     "error":{
        "error_code":0
     }
  }

Requesting Deals for a Specific Profile

The following example contains the URL of a JSON that contains only the deals on the F6S platform that are available for a specific profile:

https://api.f6s.com/deals/browse?api_key=XXXXXX&program=12345

Where 32485 is the profile_id of GreatProgram Fall 2012. The profile_id can be found adding /main/actor-id in the url of the profile wanted. In this case it would be https://www.f6s.com/greatprogramfall2012/main/actor-id

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

  {
 "deals":[
    {
       "id":"458",
       "name":"$2000 Credit for 12 Months ",
       "description":"DealOne is the worlds leader in open cloud technology. Now you can take advantage of DealOneCloud.  You will receive $2,000 in monthly credits for 12 months.  ",
       "thumbnail":{
          "url":"https:\/\/ac2c51ee7d4a55a0590b-e4e7fcbee39bd69844070032b8458ad7.ssl.cf1.rackcdn.com\/1234\/1234_th3.jpg",
          "image_id":"148994",
          "path":"pictures\/profiles\/15\/1234",
          "type":"jpg",
          "size":"th3",
          "mime_type":"image\/jpeg",
          "width":64,
          "height":64
       },
       "value":"24000.00",
       "currency":"USD",
       "beta":false,
       "distribution_type":"specific",
       "distributions":[
          {
             "profile_id":"32485",
             "profile_name":"GreatProgram - Fall 2012",
             "profile_url":"https:\/\/www.f6s.com\/greatprogramfall2012",
             "type":"accepted"
          }
       ],
       "category":{
          "id":"28",
          "name":"Cloud Services"
       },
       "company":{
          "id":"2179",
          "name":"DealOne",
          "url":"https:\/\/www.f6s.com\/dealone"
       },
       "url":"https:\/\/www.f6s.com\/dealone",
       "get_deal_url":"https:\/\/www.f6s.com\/dealone?get_deal=458",
       "date_created":"2012-10-11 18:47:39",
       "date_modified":"2014-09-25 16:03:53",
       "date_expires":"2114-10-11 18:47:39"
    }
 ],
 "status":200,
 "error":{
    "error_code":0
 }

}

Requesting Deals from a Specific Area

The following example contains the URL of a JSON that contains only the deals on the F6S platform that belongs to a specific category (area is the alias of category):

https://api.f6s.com/deals/browse?api_key=XXXXXX&area=databas

The possible values of areas can be found by accessing https://www.f6s.com/deals and clicking on the categories listed on the left hand side of the page. The last segment of the page URL is the area alias.

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

  {
 "deals":[
    {
       "id":"562",
       "name":"Free 3 month GreatDeal",
       "description":"Get 6 months of free GreatDeal (excl. EC2 cost). Deploy, backup, moniter and scale GreatDeal servers in the safety of your own account.\n\nEmail support@greatdeal.com to notify us that you would like to take the F6s deal!",
       "thumbnail":{
          "url":"https:\/\/6bbcabc1bccfd1d2d6ae-f8a2e00146e625dfe09528f7945304ec.ssl.cf1.rackcdn.com\/1246\/1234_th3.jpg",
          "image_id":"12345",
          "path":"pictures\/profiles\/13\/1234",
          "type":"jpg",
          "size":"th3",
          "mime_type":"image\/jpeg",
          "width":64,
          "height":64
       },
       "value":"4080.00",
       "currency":"USD",
       "beta":false,
       "distribution_type":"everyone",
       "category":{
          "id":"17",
          "name":"Database"
       },
       "company":{
          "id":"36974",
          "name":"GreatDeal",
          "url":"https:\/\/www.f6s.com\/gretdeal"
       },
       "url":"https:\/\/www.f6s.com\/greatdeal",
       "get_deal_url":"https:\/\/www.f6s.com\/greatdeal?get_deal=562",
       "date_created":"2012-10-24 18:20:36",
       "date_modified":"2014-06-04 23:23:30",
       "date_expires":"2114-10-24 18:20:36"
    }
 ],
 "status":200,
 "error":{
    "error_code":0
 }

}

Deal Feed API Results

Defaults:
- `distribution_type` is everyone, unless specific F6S `actor_ID` specified
- The results format is UTF-8 Encoded JSON
- The top object contains three objects: deals[], *status* and error[]
- The response is successful if status is 200, and *error_code* is *0*
- Error[] is always shown

When the Deal Feed API returns results, it places them within a JSON deals[] array.

A typical result is made up of the following fields:

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

  • deal_id is an integer representing the internal id of a deal.
  • name is a string that displays the name of a deal - it's limited to 255 characters.
  • description is a string representing the description of a deal - limited to 600 characters.
  • thumbnail[] contains all the information about the image of a deal. It is an array containing the separate thumbnail objects. Each object typically contains:
    • url is a string that displays the full URL of deal thumbnail with the selected size.
    • image_id - string, is the id of an image.
    • path - string, is the path part of URL to image folder.
    • type - string, is the file extension of an image (jpg,png,gif)
    • size - string, is the name of the re-sized image thumbnail (string, by default: "th3" - 64x64). To see all the available sizes, check the thumbnail sizes section below.
    • mime_type is the mime type of the file.
    • width - integer, is the width in pixels of current re-sized copy of original image.
    • height - integer, is the height in pixels of current re-sized copy of original image.
  • value - string, is the monetary value of a deal (decimal containing dot).
  • currency - string, is the currency of a deal (USD, EUR, GBP, INR, SGD, BRL, EGP).
  • beta is a boolean explaining whether this deal is a beta or not.
  • distribution_type - string, shows how this deal is distributed. Now only everyone available.
  • category[] contains the information about the internal category of a deal. It is an array containing the separate category[] components. Each component typically contains:
    • id - integer, is the internal id of the category.
    • name - string, is the name of the category.
  • company[] contains the information about the deal publisher company. It is an array containing the separate company[] components. Each component typically contains:
    • id - integer, is the id of the company profile.
    • name - string, is the name of the company as shown in the company’s page URL.
    • url - string, is the full URL of the company profile.
  • url - string, is the full URL where to access more information about this deal.
  • get_deal_url - string, is the full URL with get deal flow action attached. It may require login in some cases. You will review the deal before getting it.
  • date_created - date, is the date when the deal was created (gmt).
  • date_modified - date, is the date when the deal last modified time (gmt).
  • date_expires - date, is the date when the deal expires (+100 years from date_created by default)≥

The status[] is an integer. It displays conventional HTTP response codes to indicate success or failure of an API request.

200 OK - Everything worked as expected.
400 Bad Request - Often missing a required parameter.
401 Unauthorized - No valid API key provided.
402 Request Failed - Parameters were valid but request failed.
404 Not Found - The requested item doesn't exist.
500, 502, 503, 504 Server errors - something went wrong on F6S’ end.

Thumbnail sizes:

  • (empty string) - uploaded copy of image - size is limited to 5000x5000 px
  • original - image that fits in 700x700 px square (could be smaller if image is smaller) - with original w/h proportion
  • half - image that fits in 350x350 px square (could be smaller if image is smaller) - with original w/h proportion
  • quad - image that fits in 170x170 px square (could be smaller if image is smaller) - with original w/h proportion
  • small - image that fits in 50x50 px square - with original w/h proportion
  • th1 - 140x140 px square
  • th2 - 112x112 px square
  • th3 - 64x64 px square
  • th4 - 30x30 px square

You can request any size by adding ?thumbnail_size=[size name] to request url https://api.f6s.com/deals/browse?thumbnail_size=th4