Events API
We are offering an API to the publicly available events of our database.
This can be useful if you want to (re)use the data on your website, e.g. as
widget for your dance school, city or area regarding specific dances.
Basics
The API offers output as JSON or ICS.
Note that using JSON provides the most complete data set.
ICS Calendar format is mostly useful for direct calendar integration (e.g. using Wordpress plugin).
-
URL:
/api/v1/events.json
or /api/v1/events.ics
-
You will need to contact us for a token to append as query string, as well.
?token=...
Without it you only get 1 record (to test).
- By default, it only returns future events.
-
You can append filtering via query string:
&dance=zouk,bachata&city=berlin
etc as long as the token didn't already limit it.
-
You can also filter by profile or place using the slug, e.g.
&place=my-school&profile=my-teacher
.
- You can limit the results by using
limit=x
(x > 0)
- Further filters:
country=de
(iso2), type=festival
(festival, party, workshop, marathon, course), start=2023-01-02
, end=2023-12-02
Structure
The JSON data structure without extra relations or depth will look like this (mainly in sync with
schema.org):
- events
- id: int
- name: string
- type: string
- startDate: string
- endDate: string
- dateOnly: bool
- eventStatus: string
- statusReason: string
- description: text
- image: string (HTTPS URL)
- url: string
- websiteUrl: string
- organizer: string
- eventAttendanceMode: string
- dances: associative array (key: slug, value: name)
- places: array
- profiles: array
- location
- name: string
- lat: decimal
- lng: decimal
- countryCode: string
- country: string
- city: string
- address: string
See our schema.json for details.
Sending us data
If you want to make an API for us to fetch or for you to push data to us, ideally it would follow a similar structure.
But we can also import from a different schema. Feel free to reach out.