eventer web API (1.0)

Download OpenAPI specification:Download

License: MIT

This is the official documentation of the (public) eventer web API, with which you can search and receive information about events in Germany.

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

Making a request

All URLs starts 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: https://api.eventer.app/v1/events?search=Party

Date formats

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 and Limits

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, no authentication needed.

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 feel free to contact us or contribute directly to our git repository.

events

Retrieve events from all known and trusted sources of the eventer platform.

/events

Use this endpoint to search for events over all known and trusted sources.

query Parameters
search
string <string>
Example: search=Party

Searches events by a free text search.

starts_at_min
string <date-time>

The minimum starts-at timestamp for events. If not given the default value will be now.

starts_at_max
string <date-time>

The maximum starts-at timestamp for events.

categories
string
Example: categories=meetup,movie

A comma-separated list of event categories to search for (not all events are categorized yet). If not specified all events of all categories (or no category) will be returned.

Currently the following categories are supported:
exhibition, meetup, movie'

google_place_ids
string
Example: google_place_ids=ChIJYzs3_URGp0cRspbeorh84LM,ChIJQXmv10JGp0cROM6S5hB1AG8

A comma-separated list of ids of google places to restrict search to events from these places only.
You can use the google maps api to search for google place ids: google place id finder.

geo_area
string
Example: geo_area=50.838948,12.912577,50.827132,12.933774

Restricts the event search to a geo area bounding box specified by 4 comma separated coordinates: top (latitude), left (longitude), bottom (latitude) and right (longitude), in this order.

geo_raster_points
string
Example: geo_raster_points=50.8;12.9,50.9;12.9

Restricts the event search to a geo areas specified by "raster points". A raster point is a latitude/longitude combination of double values rounded off to 1 decimal point (separated by a semicolon). For example the "raster point" 50.8;12.9 restricts events to locations within a latitude starting with 50.8 and longitude starting with 12.9.

contexts
string
Example: contexts=meetup/groups/29602718

Events may assigned to different contexts to determine where they come from. For example a meetup event has the following contexts: meetup, meetup/groups/:groupId and meetup/events/:eventId.

So you can search for all events related to a context (e.g. all events of a meetup group).

updated_since
string <date-time>

If set, only events will be returned which has been added or modified since the given timestamp. Can be used for synchronization or fetch scenarios.

include_deleted
boolean

If set to true the response will also include events which have been deleted (since the last update timestamp). This option can be used for synchronization to get information about deleted events.

include_places
boolean

If set to true the response will also include the field places which holds all places of the fetched events by their id. So you can use one request to fetch events with the places where they take part.

limit
integer <int32> [ 1 .. 100 ]
Default: 10
Example: limit=10

Sets the limit of entries returned by the response.

cursor
string

Continues a result list from an offset specified by this cursor. To go to the next page, call the endpoint again, with exactly the same parameters, but with the specified cursor value.

Responses

/events/{id}

Retrieve an event by id.

path Parameters
id
required
string

The id of the event to get.

Responses

Response samples

Content type
application/json
{}

places

Get details about the venues where the events take place.

/places

Use this endpoint to search for places.

query Parameters
google_place_ids
string
Example: google_place_ids=ChIJYzs3_URGp0cRspbeorh84LM,ChIJQXmv10JGp0cROM6S5hB1AG8

A comma-separated list of ids of google places.
You can use the google maps api to search for google place ids: google place id finder.

Responses

Response samples

Content type
application/json
{}

/places/{id}

Retrieve a place by its google place id.

path Parameters
id
required
string

The google place id of the place to get.

Responses

Response samples

Content type
application/json
{}

pods

Retrieve semantic data (JSON-LD) from specific sources (semantic pods).

/pods/{pod}/events

Retrieve semantic events from a specific account (pod).

path Parameters
pod
required
string

The name of the account (pod) to get events from.

query Parameters
startDateMin
string <date-time>

The minimum starts-at timestamp for events. Corresponds to https://schema.org/startDate.

startDateMax
string <date-time>

The maximum starts-at timestamp for events. Corresponds to https://schema.org/startDate.

dateModifiedMin
string <date-time>

The minimum timestamp when the event was last modified. Corresponds to https://schema.org/dateModified.

dateModifiedMax
string <date-time>

The maximum timestamp when the event was last modified. Corresponds to https://schema.org/dateModified.

sort
string
Default: "startDate_asc"
Enum: "startDate_asc" "startDate_desc" "dateModified_asc" "dateModified_desc"

Specify the sort order of the events to be returned.

expand
string
Example: expand=image,offers

A list of fields to be included in the response. The names of the fields are separated by commas. Every https://schema.org/Event field can be expanded, the default vocab is https://schema.org. All expanded fields will be added into "@graph" entries by it URI (if the property exists).

limit
integer <int32> [ 1 .. 100 ]
Default: 10
Example: limit=10

Sets the limit of entries returned by the response.

cursor
string

Continues a result list from an offset specified by this cursor. To go to the next page, call the endpoint again, with exactly the same parameters, but with the specified cursor value.

Responses

Response samples

Content type
{}