The official documentation of the Eventer web api
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
endpoints
README.md

README.md

The Eventer API

This is the official documentation of the public Eventer REST-API, with which you can search and receive informations about events in Germany.

Note: Because this project is in beta stage the offered events are restricted to the Chemnitz area in Saxony / Germany.

This API is used by eventer.app, a mobile app to find local events.

Making a request

All URLs start with https://api.eventer.app/v1/. The path is prefixed with the API version. If we change the API in backward-incompatible ways, we'll bump the version marker and maintain stable support for the old URLs.

Here's a simple example to search for upcoming "Party"-events:

GET https://api.eventer.app/v1/events?search=Party

GET/POST methods

All endpoints will be available for POST requests with a body including the parameters in json (Content-Type: application/json; charset=utf-8). Additionally some endpoints support GET methods for easier usage. Parameters for GET requests must be application/x-www-form-urlencoded. Parameter names will use the snake_case format.

Date format

All timestamps (for requests and responses) are encoded in ISO 8601 with the following format: YYYY-MM-DD'T'HH:mm'Z'. The timezone used in responses is UTC.

Pagination & Limit

Most collection APIs paginate their results. Normally you can specify a limit with the parameter limit which must be greater than 0 and lower than 101 (default: 10). If there are more results to paginate for, you will get a cursor in the response which can be used as parameter for the next request (e.g. &cursor=foo), and so on until you get a response without cursor.

Authentication

This is an open API without authentication.

API ready for use

API libraries

Coming soon..

Help us make it better

Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please use GitHub issues. Fork these docs and send a pull request with improvements.

To talk with us and other developers about the API, post a question on StackOverflow tagged with eventer.