API Key

The Programs and Events API uses an API key to identify your application. API keys are only available to organisations.

Programs and Events Search API

Overview

The Programs and Events Search API lets you get the F6S data about Programs and Events. The API call returns a JSON based on URL parameters sent through a standard HTTPS request.

Programs and Events Search API request format

A Programs and Events Search API request takes the following form:

https://api.f6s.com/programs/browse?api_key=API-KEY

Example: requesting information about all the programs on F6S

The following example contains the URL of a JSON that contains every program on F6S:

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

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

{
   "programs":[
      {
         "id":"357835",
         "name":"Startup Program #1",
         "class_name":{
            "id":"166132",
            "name":"Startup Program"
         },
         "signup_link":"https:\/\/www.f6s.com\/startuprogram1#programs\/ajax-application",
         "description":"Startup Program is a startup event that is currently based in Boulder, Colorado. ",
         "brief_description":"Bringing angels and entrepreneurs together, for free.",
         "location":{
            "city":"Boulder",
            "location_region":{
               "region_id":"2",
               "region_name":"North America"
            },
            "country_code":"US",
            "address":"",
            "state_region":"013"
         },
         "application_open":"2014-08-25 12:00:00",
         "application_close":"2014-10-12 05:59:00",
         "date_start":null,
         "date_end":null,
         "thumbnail":{
            "url":"https:\/\/b7e5b4da3d33070b3fe6-481229e12551756844ba828dee5009ec.ssl.cf1.rackcdn.com\/1234\/216249_th3.jpg",
            "image_id":"216249",
            "path":"pictures\/profiles\/22\/1234",
            "type":"jpg",
            "size":"th3",
            "mime_type":"image\/jpeg",
            "width":64,
            "height":64
         },
         "program_type":"accelerator"
      },
    ],
   "status":200,
   "error":{
      "error_code":0
   }
}

Programs and Events Search API results

Defaults:
- The results format is UTF-8 Encoded JSON
- The top object contains three objects: programs[] , 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

When the Programs and Events API returns results, it places them within a JSON array.

A typical result is made up of the following fields:

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

  • id - integer, is the internal id of a program or event.

  • class_name - string, if root profile exists, it returns the root id and name. If the current object is root, it returns the same id and name.

  • name - string, is the name of a program.

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

  • brief_description - string, is the short description of a program.

  • thumbnail contains all the information about the profile picture. It is an array containing the separate thumbnail objects. The array 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. 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.
  • signup_link - string, is the full URL to sign up for programs and book tickets for events.

  • application_open - date, the date/time when the application opens or null.

  • application_close - date, the date/time when the application closes or null.

  • date_start - date, the date/time when the event/program starts or null.

  • date_end - date, the date/time when the event/program ends or null.

  • location[] - array, it contains information about the program or event location. Typically it contains:
    • location_country - iso, 2 symbol country descriptor.
    • city - string, is the full name of the city.
    • address - string, is the complete address.
    • state_region - string, is a code describing state or region ( related to city).
    • region - array, contains values from following table:
region_id region_name
1 Europe
2 North America
3 South America
4 Asia
5 Africa
6 Australia/NZ
7 Middle East
8 Caribbean
9 Eastern Europe
10 Antarctica
  • funding - array, which contains:

    • funding_amount - string, is the amount of funding.
    • funding_unit - string, indicates the type of funding. It can either prize, team or founder.
    • funding_currency - string, code for currency of a program funding (USD, EUR, GBP, INR, SGD, BRL, EGP).
    • equity_taken - array, value of equity taken. It is either integer, a range (integer - integer) or null.
  • event_type - string, indicates the type of the event. It can be one of the following values:

    • accelerator
    • contest
    • hackathon
    • fund
    • conference
    • short_event
  • tags - array, contains Tags Objects.