Fediverse Events API (0.0.1)

Download OpenAPI specification:

License: MIT

This API provides metadata information for the events hosted by fediverse.events

Events

Get event related data

Event

id required	string
name required	string
start required	string <date-time>
end	string <date-time>
required	Array of objects (Image) Logos sorted by priority
required	object (EventEndpoints)
required	Array of objects (EventSocial)

{"id": "123CANVAS001",
"name": "Canvas 2024",
"start": "2024-07-12T04:00:00.000Z",
"end": "2024-07-16T04:00:00.000Z",
"logos": [{"type": "image/png",
"url": "https://example.url",
"size": "128x128"
}
],
"endpoints": {"open": "https://canvas.fediverse.events",
"auth_open": "https://canvas.fediverse.events/api/login",
"more_info": "https://fediverse.events/canvas"
},
"social": [{"label": "Community",
"icon": "lemmy",
"url": "https://toast.ooo/c/canvas"
},
{"label": "Announcements",
"icon": "mastodon",
"url": "https://social.fediverse.events/@canvas"
},
{"label": "Matrix Space",
"icon": "matrix",
"url": "https://matrix.to/#/#canvas:aftermath.gg?via=matrix.org"
},
{"label": "Discord",
"icon": "discord",
"url": "https://discord.gg/mEUqXZw8kR"
}
]
}

Get calendar as ICalendar

Responses

Get all events

query Parameters

from	string <date> Default: "today" Only include events whose end date is after this date (ISO-8601)
to	string <date> Default: "today + 1 month" Only include events whose end date is before this date (ISO-8601)

Responses

Response samples

200
400

Content type

application/json

{"events": [{"id": "123CANVAS001",
"name": "Canvas 2024",
"start": "2024-07-12T04:00:00.000Z",
"end": "2024-07-16T04:00:00.000Z",
"logos": [{"type": "image/png",
"url": "https://example.url",
"size": "128x128"
}
],
"endpoints": {"open": "https://canvas.fediverse.events",
"auth_open": "https://canvas.fediverse.events/api/login",
"more_info": "https://fediverse.events/canvas"
},
"social": [{"label": "Community",
"icon": "lemmy",
"url": "https://toast.ooo/c/canvas"
},
{"label": "Announcements",
"icon": "mastodon",
"url": "https://social.fediverse.events/@canvas"
},
{"label": "Matrix Space",
"icon": "matrix",
"url": "https://matrix.to/#/#canvas:aftermath.gg?via=matrix.org"
},
{"label": "Discord",
"icon": "discord",
"url": "https://discord.gg/mEUqXZw8kR"
}
]
}
]
}

Get event by ID

path Parameters

id	string Event ID

Responses

Response samples

200

Content type

application/json

{"id": "123CANVAS001",
"name": "Canvas 2024",
"start": "2024-07-12T04:00:00.000Z",
"end": "2024-07-16T04:00:00.000Z",
"logos": [{"type": "image/png",
"url": "https://example.url",
"size": "128x128"
}
],
"endpoints": {"open": "https://canvas.fediverse.events",
"auth_open": "https://canvas.fediverse.events/api/login",
"more_info": "https://fediverse.events/canvas"
},
"social": [{"label": "Community",
"icon": "lemmy",
"url": "https://toast.ooo/c/canvas"
},
{"label": "Announcements",
"icon": "mastodon",
"url": "https://social.fediverse.events/@canvas"
},
{"label": "Matrix Space",
"icon": "matrix",
"url": "https://matrix.to/#/#canvas:aftermath.gg?via=matrix.org"
},
{"label": "Discord",
"icon": "discord",
"url": "https://discord.gg/mEUqXZw8kR"
}
]
}

Get event as ICalendar

path Parameters

id	string Event ID

Responses

Authentication

Automated authenciation negotiation for clients

Get authentication details

Get the details for automatic authentication on third-party clients

Fetch this endpoint (res)
Send a direct message to res.account containing the content of res.message_template (replacing the placeholder(s))
Wait for a direct message originating from res.account and open the link that gets sent (the message won't contain just the link, the message may contain other text)

Responses

Response samples

200
404

Content type

application/json

{"method": "dm",
"account": "grant@toast.ooo",
"message_template": "I am requesting a login code\nEXAMPLE-CODE\nSent by {software}\n"
}

Administration

Internal event administration