/api/events

Returns the list of the upcoming events

Request

Query params Event representation
limit	uint
offset	uint
position	string	Filter events that will happend in a specific position pattern: "^-?\\d{1,3},-?\\d{1,3}$"
positions	array	Filter places in specific positions maxItems: 1000
positions[]	string	pattern: "^-?\\d{1,3},-?\\d{1,3}$"
estate_id	int	Filter events that will happend in a specific estate
creator	address	Filter events created by a user
only_attendee	"1" "true"	Filter events that user will go (requires authentication)
search	string	Filter events that contains a websearch expression, should have at least 3 characters otherwise the resultant list will be empty
schedule	uuid	Filter events by specifyc schedule
list		Filter event using one of the following list default: "active"
	"all"	All events
	"active"	Only current and future events
	"live"	Only current events
	"upcoming"	Only future events
	"highlight"	Only highlighted events
order	"asc" "desc"	List order default: "asc"
world	"1" "true" "0" "false"	True for events in Worlds, false for events not in Worlds, null for all events
world_names	array	Filter events by world names minItems: 1
world_names[]	string	pattern: "^.*\\.dcl\\.eth$"
places_ids	array	Filter events by places ids (UUIDs for land places, world names for worlds) maxItems: 100
places_ids[]	string	minLength: 1
community_id	uuid	Filter events by community ID
from	date-time	Start of date range filter (ISO 8601). Returns events with next_start_at >= from
to	date-time	End of date range filter (ISO 8601). Returns events with next_start_at < to
with_connected_users	"true" "false" "1" "0"	Include the list of connected user wallet addresses for each event location (connected_addresses property). Data is cached for 5 minutes.

Response

Body
ok	boolean	Define where the request was completed
data	array	Event list
data[]	object
data[].id	uudi	event id
data[].name	string	The event name minLength: 0 maxLength: 150
data[].image	uri	Url to the event cover (horizontal format)
data[].image_vertical	uri	Url to the event cover in vertical format (portrait orientation)
data[].description	string	The event description on markdown minLength: 0 maxLength: 5000
data[].start_at	date-time	The initial date of the event
data[].finish_at	date-time	The latest data of the event
data[].coordinates	array	The specific position
data[].coordinates[]	string	pattern: "^-?\\d{1,3}$"
data[].user	string
data[].approved	boolean	True if the event was approved by an admin
data[].created_at	date-time	the time the event was created
data[].updated_at	date-time	The time the event was last updated
data[].total_attendees	number	The number of users who specified that they will attend the event minimum: 0
data[].latest_attendees	array	A list of the latest users who specified that they will attend the event
data[].latest_attendees[]	address
data[].url	uri	The url where the event will take place
data[].scene_name	string	The scene name where the event will take place
data[].user_name	address
data[].rejected	boolean	True if the event was rejected by an admin
data[].trending	boolean	True if the event is tending
data[].server	string	Realm name
data[].estate_id	uudi	state id
data[].estate_name	string	The state name
data[].x	number	minimum: -170 maximum: 170
data[].y	number	minimum: -170 maximum: 170
data[].all_day	boolean	True if the event is all day long
data[].recurrent	boolean	True if the event si recurrent
data[].recurrent_frequency	"YEARLY" "MONTHLY" "WEEKLY" "DAILY" "HOURLY" "MINUTELY" "SECONDLY" null	Rrule FREQ configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data[].recurrent_weekday_mask	number	Rrule WEEKDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data[].recurrent_month_mask	number	Rrule BYMONTH configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data[].recurrent_interval	number	Rrule INTERVAL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data[].recurrent_count	number null	Rrule COUNT configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data[].recurrent_until	date-time null	Rrule UNTIL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data[].duration	number
data[].recurrent_dates	array	The specific position
data[].recurrent_dates[]	date-time
data[].recurrent_setpos	number null	Rrule BYSETPOS configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: -1
data[].recurrent_monthday	number null	Rrule BYMONTHDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data[].highlighted	boolean	True if the event is highlighted
data[].next_start_at	date-time	The next start of the event
data[].next_finish_at	date-time	The next finish of the event
data[].categories	array	List of categories
data[].categories[]	string
data[].schedules	array	List of schedule ids
data[].schedules[]	uudi
data[].approved_by	address
data[].rejected_by	address
data[].attending	boolean	Show if user is attending when searching by user
data[].notify	boolean	Show if user get notify when searching by user
data[].position	array	The specific position
data[].position[]	string	pattern: "^-?\\d{1,3}$"
data[].live	boolean	If event is live
data[].world	boolean	True if the event is in a World
data[].connected_addresses	array	List of wallet addresses currently connected to the event location (only included when with_connected_users=true)
data[].connected_addresses[]	address

/api/events/search

Returns the list of events filtered by place IDs and/or community ID

Request

Query params Event representation
limit	uint
offset	uint
position	string	Filter events that will happend in a specific position pattern: "^-?\\d{1,3},-?\\d{1,3}$"
positions	array	Filter places in specific positions maxItems: 1000
positions[]	string	pattern: "^-?\\d{1,3},-?\\d{1,3}$"
estate_id	int	Filter events that will happend in a specific estate
creator	address	Filter events created by a user
only_attendee	"1" "true"	Filter events that user will go (requires authentication)
search	string	Filter events that contains a websearch expression, should have at least 3 characters otherwise the resultant list will be empty
schedule	uuid	Filter events by specifyc schedule
list		Filter event using one of the following list default: "active"
	"all"	All events
	"active"	Only current and future events
	"live"	Only current events
	"upcoming"	Only future events
	"highlight"	Only highlighted events
order	"asc" "desc"	List order default: "asc"
world	"1" "true" "0" "false"	True for events in Worlds, false for events not in Worlds, null for all events
world_names	array	Filter events by world names minItems: 1
world_names[]	string	pattern: "^.*\\.dcl\\.eth$"
places_ids	array	Filter events by places ids (UUIDs for land places, world names for worlds) maxItems: 100
places_ids[]	string	minLength: 1
community_id	uuid	Filter events by community ID
from	date-time	Start of date range filter (ISO 8601). Returns events with next_start_at >= from
to	date-time	End of date range filter (ISO 8601). Returns events with next_start_at < to
with_connected_users	"true" "false" "1" "0"	Include the list of connected user wallet addresses for each event location (connected_addresses property). Data is cached for 5 minutes.
Body Request body for filtering events by places and/or community
placeIds	array	Array of place IDs to filter events by (UUIDs for land places, world names for worlds) maxItems: 100
placeIds[]	string	minLength: 1
communityId	uuid	Community ID to filter events by (optional)

Response

Body
ok	boolean	Define where the request was completed
data	object	Event list
data.events	array	Event list
data.events[]	object
data.events[].id	uudi	event id
data.events[].name	string	The event name minLength: 0 maxLength: 150
data.events[].image	uri	Url to the event cover (horizontal format)
data.events[].image_vertical	uri	Url to the event cover in vertical format (portrait orientation)
data.events[].description	string	The event description on markdown minLength: 0 maxLength: 5000
data.events[].start_at	date-time	The initial date of the event
data.events[].finish_at	date-time	The latest data of the event
data.events[].coordinates	array	The specific position
data.events[].coordinates[]	string	pattern: "^-?\\d{1,3}$"
data.events[].user	string
data.events[].approved	boolean	True if the event was approved by an admin
data.events[].created_at	date-time	the time the event was created
data.events[].updated_at	date-time	The time the event was last updated
data.events[].total_attendees	number	The number of users who specified that they will attend the event minimum: 0
data.events[].latest_attendees	array	A list of the latest users who specified that they will attend the event
data.events[].latest_attendees[]	address
data.events[].url	uri	The url where the event will take place
data.events[].scene_name	string	The scene name where the event will take place
data.events[].user_name	address
data.events[].rejected	boolean	True if the event was rejected by an admin
data.events[].trending	boolean	True if the event is tending
data.events[].server	string	Realm name
data.events[].estate_id	uudi	state id
data.events[].estate_name	string	The state name
data.events[].x	number	minimum: -170 maximum: 170
data.events[].y	number	minimum: -170 maximum: 170
data.events[].all_day	boolean	True if the event is all day long
data.events[].recurrent	boolean	True if the event si recurrent
data.events[].recurrent_frequency	"YEARLY" "MONTHLY" "WEEKLY" "DAILY" "HOURLY" "MINUTELY" "SECONDLY" null	Rrule FREQ configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.events[].recurrent_weekday_mask	number	Rrule WEEKDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.events[].recurrent_month_mask	number	Rrule BYMONTH configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.events[].recurrent_interval	number	Rrule INTERVAL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.events[].recurrent_count	number null	Rrule COUNT configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.events[].recurrent_until	date-time null	Rrule UNTIL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.events[].duration	number
data.events[].recurrent_dates	array	The specific position
data.events[].recurrent_dates[]	date-time
data.events[].recurrent_setpos	number null	Rrule BYSETPOS configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: -1
data.events[].recurrent_monthday	number null	Rrule BYMONTHDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.events[].highlighted	boolean	True if the event is highlighted
data.events[].next_start_at	date-time	The next start of the event
data.events[].next_finish_at	date-time	The next finish of the event
data.events[].categories	array	List of categories
data.events[].categories[]	string
data.events[].schedules	array	List of schedule ids
data.events[].schedules[]	uudi
data.events[].approved_by	address
data.events[].rejected_by	address
data.events[].attending	boolean	Show if user is attending when searching by user
data.events[].notify	boolean	Show if user get notify when searching by user
data.events[].position	array	The specific position
data.events[].position[]	string	pattern: "^-?\\d{1,3}$"
data.events[].live	boolean	If event is live
data.events[].world	boolean	True if the event is in a World
data.events[].connected_addresses	array	List of wallet addresses currently connected to the event location (only included when with_connected_users=true)
data.events[].connected_addresses[]	address
data.total	number	Total number of events

/api/events/{event_id}

Returns information about an event by ID

Request

URL
event_id	uuid	Event ID

Response

Body
ok	boolean	Define where the request was completed
data	object
data.id	uudi	event id
data.name	string	The event name minLength: 0 maxLength: 150
data.image	uri	Url to the event cover (horizontal format)
data.image_vertical	uri	Url to the event cover in vertical format (portrait orientation)
data.description	string	The event description on markdown minLength: 0 maxLength: 5000
data.start_at	date-time	The initial date of the event
data.finish_at	date-time	The latest data of the event
data.coordinates	array	The specific position
data.coordinates[]	string	pattern: "^-?\\d{1,3}$"
data.user	string
data.approved	boolean	True if the event was approved by an admin
data.created_at	date-time	the time the event was created
data.updated_at	date-time	The time the event was last updated
data.total_attendees	number	The number of users who specified that they will attend the event minimum: 0
data.latest_attendees	array	A list of the latest users who specified that they will attend the event
data.latest_attendees[]	address
data.url	uri	The url where the event will take place
data.scene_name	string	The scene name where the event will take place
data.user_name	address
data.rejected	boolean	True if the event was rejected by an admin
data.trending	boolean	True if the event is tending
data.server	string	Realm name
data.estate_id	uudi	state id
data.estate_name	string	The state name
data.x	number	minimum: -170 maximum: 170
data.y	number	minimum: -170 maximum: 170
data.all_day	boolean	True if the event is all day long
data.recurrent	boolean	True if the event si recurrent
data.recurrent_frequency	"YEARLY" "MONTHLY" "WEEKLY" "DAILY" "HOURLY" "MINUTELY" "SECONDLY" null	Rrule FREQ configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.recurrent_weekday_mask	number	Rrule WEEKDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.recurrent_month_mask	number	Rrule BYMONTH configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.recurrent_interval	number	Rrule INTERVAL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: 0
data.recurrent_count	number null	Rrule COUNT configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.recurrent_until	date-time null	Rrule UNTIL configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.duration	number
data.recurrent_dates	array	The specific position
data.recurrent_dates[]	date-time
data.recurrent_setpos	number null	Rrule BYSETPOS configuration, see: https://datatracker.ietf.org/doc/html/rfc5545 minimum: -1
data.recurrent_monthday	number null	Rrule BYMONTHDAY configuration, see: https://datatracker.ietf.org/doc/html/rfc5545
data.highlighted	boolean	True if the event is highlighted
data.next_start_at	date-time	The next start of the event
data.next_finish_at	date-time	The next finish of the event
data.categories	array	List of categories
data.categories[]	string
data.schedules	array	List of schedule ids
data.schedules[]	uudi
data.approved_by	address
data.rejected_by	address
data.attending	boolean	Show if user is attending when searching by user
data.notify	boolean	Show if user get notify when searching by user
data.position	array	The specific position
data.position[]	string	pattern: "^-?\\d{1,3}$"
data.live	boolean	If event is live
data.world	boolean	True if the event is in a World
data.connected_addresses	array	List of wallet addresses currently connected to the event location (only included when with_connected_users=true)
data.connected_addresses[]	address

/api/events/{event_id}/attendees

Returns the list of addresses register for attending an event by ID

Request

URL
event_id	uuid	Event ID

Response

Body
ok	boolean	Define where the request was completed
data	array
data[]	object	User intention to attend an event
data[].event_id	uuid	Event id
data[].user	address	User address
data[].user_name	string null	Name of the user if any
data[].created_at	date-time	The moment the intention to attend was created

/api/events/{event_id}/attendees

Create an intention to attend ot a event

Request

URL
event_id	uuid	Event ID

Response

URL
ok	boolean	Define where the request was completed
data	array
data[]	object	User intention to attend an event
data[].event_id	uuid	Event id
data[].user	address	User address
data[].user_name	string null	Name of the user if any
data[].created_at	date-time	The moment the intention to attend was created

/api/events/{event_id}/attendees

Remove your intention to attend ot a event

Request

URL
event_id	uuid	Event ID

Response

Body
ok	boolean	Define where the request was completed
data	array
data[]	object	User intention to attend an event
data[].event_id	uuid	Event id
data[].user	address	User address
data[].user_name	string null	Name of the user if any
data[].created_at	date-time	The moment the intention to attend was created

/api/events/categories

Return all the categories of events

Request

Response

Body
ok	boolean	Define where the request was completed
data	array
data[]	object	Tags for events
data[].name	string	The category tag label minLength: 0 maxLength: 50
data[].active	boolean	Whether the tag can be displayed in the listing or not
data[].created_at	date-time	the time the tag was created
data[].updated_at	date-time	The time the tag was last updated

/api/schedules

Return all the schedules

Request

Response

Body
ok	boolean	Define where the request was completed
data	array
data[]	object	Schedules for events
data[].id	uudi	schedule id
data[].name	string	The name of the schedule minLength: 0 maxLength: 50
data[].description	string	The description of the schedule minLength: 0 maxLength: 255
data[].image	string	The url of an image for this schedule minLength: 0 maxLength: 255
data[].theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
data[].background	array	List of color used as backgorund
data[].background[]	string	minLength: 0 maxLength: 255
data[].active_since	date-time	the time the schedule is going to start
data[].active_until	date-time	The time the schedule is going to end
data[].active	boolean	Whether the schedule can be displayed in the listing or not
data[].created_at	date-time	the time the schedule was created
data[].updated_at	date-time	The time the schedule was last updated

/api/schedules/{schedule_id}

Return information of a schedule by ID

Request

Response

Body Schedules for events
id	uudi	schedule id
name	string	The name of the schedule minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	string	The url of an image for this schedule minLength: 0 maxLength: 255
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active_since	date-time	the time the schedule is going to start
active_until	date-time	The time the schedule is going to end
active	boolean	Whether the schedule can be displayed in the listing or not
created_at	date-time	the time the schedule was created
updated_at	date-time	The time the schedule was last updated

/api/schedules

Create a schedule

Request

URL Schedules for events
name	string	The name of the schedule required minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	uri null	The url of an image for this schedule
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active	boolean	Whether the schedule can be displayed in the listing or not
active_since	date-time	the time the schedule is going to start required
active_until	date-time	The time the schedule is going to end required

Response

URL Schedules for events
id	uudi	schedule id
name	string	The name of the schedule minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	string	The url of an image for this schedule minLength: 0 maxLength: 255
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active_since	date-time	the time the schedule is going to start
active_until	date-time	The time the schedule is going to end
active	boolean	Whether the schedule can be displayed in the listing or not
created_at	date-time	the time the schedule was created
updated_at	date-time	The time the schedule was last updated

/api/schedules

Edit a schedule

Request

URL Schedules for events
name	string	The name of the schedule required minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	uri null	The url of an image for this schedule
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active	boolean	Whether the schedule can be displayed in the listing or not
active_since	date-time	the time the schedule is going to start required
active_until	date-time	The time the schedule is going to end required

Response

URL Schedules for events
id	uudi	schedule id
name	string	The name of the schedule minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	string	The url of an image for this schedule minLength: 0 maxLength: 255
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active_since	date-time	the time the schedule is going to start
active_until	date-time	The time the schedule is going to end
active	boolean	Whether the schedule can be displayed in the listing or not
created_at	date-time	the time the schedule was created
updated_at	date-time	The time the schedule was last updated

/api/schedules/{schedule_id}

Delete a schedule

Request

URL Schedules for events
name	string	The name of the schedule required minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	uri null	The url of an image for this schedule
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active	boolean	Whether the schedule can be displayed in the listing or not
active_since	date-time	the time the schedule is going to start required
active_until	date-time	The time the schedule is going to end required

Response

URL Schedules for events
id	uudi	schedule id
name	string	The name of the schedule minLength: 0 maxLength: 50
description	string	The description of the schedule minLength: 0 maxLength: 255
image	string	The url of an image for this schedule minLength: 0 maxLength: 255
theme	null "mvmf_2022" "mvfw_2023" "pride_2023"	Pre-build theme for the schedule
background	array	List of color used as backgorund
background[]	string	minLength: 0 maxLength: 255
active_since	date-time	the time the schedule is going to start
active_until	date-time	The time the schedule is going to end
active	boolean	Whether the schedule can be displayed in the listing or not
created_at	date-time	the time the schedule was created
updated_at	date-time	The time the schedule was last updated

shop

create

learn

vote

events

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response