OpenAgenda API documentation

Getting started

The OpenAgenda API allows you to retrieve event data from the platform as well as publish your own events.

The OpenAgenda event data is available under the ODC-ODbl license.
To use the API, create an account on OpenAgenda, and go to your setting page to get your API key.

Reading data

The OpenAgenda API can be used to retrieve detailed event content available on the OpenAgenda platform in json.

Here is a little walkthrough to get you started:

  • First of all, if you haven't already done so, create an OpenAgenda account.
  • Then you'll need an api key. Go to your account settings page (when you logged on the site with your OpenAgenda account, you can get there by clicking on your profile on the header of the site) and go to the Api tab to generate one.
  • With your api key, you are now ready to fetch content. There are two ways to achieve this:

    • Find an agenda you are interested in on, write down the slug in the url (the bit that derives from the title of your agenda ) and use the api agenda interface to first fetch the agenda uid and then its content.
      agenda slug
    • Find the event you want to retrieve on, write down the slug from the url (same bit as illustrated above, but this time after /event/) and use the api event interface to fetch the event uid and its content.
  • You are done. Check the sidebar links for details.

Publishing Data

The Api can be used to create, edit and delete events, locations and agendas.

An authentication process needs to be followed, which follows the 2-legged form of the OAuth 2.0 standard: Using a secret key (which you never ever share with anyone), you start by getting an access token which you then attach to your requests to authenticate them.

Generating your own secret key from your OpenAgenda account is a feature that is activated by sending a request at the following email:

Once you have a valid access token, you can either handle locations, events or agendas . Keep the following in mind:

  • Before publishing events, you will need to create the locations at which they will take place and use their uids as reference.
  • If you need to test the api, remember not to publish the events you are creating as they will be directly visible to the public on the platform.
  • There is a limitation of 100 event creations per day set mainly for security purposes. Contact us if you think you will need to publish more.
  • If you need to exploit the api a bit heavily (like publishing hundreds of events), we'd appreciate it if you ran your scripts during low traffic periods (night time).

To get you started, we suggest you

  • Start by reading the Authentication section to see how you can get a valid access token
  • Move on to the Locations section to create a bunch of locations which you will then use to create your events (keep track of their uids!)
  • Create your first event following the data structure detailed in the Events section
  • And optionnally, register your newly created event to one of your agendas by following the agendas section