Download OpenAPI specification:Download
Welcome to the RLTY API documentation for partners and developers.
We appreciate your interest in using RLTY no-code platform to create 3D immersive experiences in the metaverse for your customers.
This documentation provides detailed information about how to use our API, including the endpoints and request parameters available to you as a partner, and how to authenticate requests.
Please read this guide carefully before integrating with our platform, and do not hesitate to contact us if you have any questions or feedback.
Our API is designed to allow you to create and manage events for your customers on our platform.
The API allows you to create, update, and read events associated with your account.
You can also retrieve analytics data for each event, such as attendee history, attendees by country, and attendee count, among other related details.
To get started, you need to obtain an API key that will be used to authenticate all requests made to our API.
You can get an API key at any time by contacting us. This key should be kept secret and should only be used in secure environments.
Once you have your API key, you can start making requests to our API using your preferred programming language and HTTP client. All requests must include your API key in the Authorization header. If your request is successful, our API will return a JSON-encoded response with the requested data.
For more information on how to use our API, please refer to the endpoint descriptions and examples provided in this documentation.
We recommend testing your integration in a staging environment before deploying it to production, in order to ensure that your application is working as expected.
Thank you for choosing RLTY platform as a service for creating 3D immersive experiences.
We are excited to work with you and help you create unforgettable virtual events for your customers.
This API endpoint returns a list of buildings with information such as building name, description and features.
[- {
- "Id": "pyramid-rlty",
- "Name": "Giz Pyramid",
- "Description": "You have a big event to promote? The pyramid is the ideal/right place to create a unique experience. On several floors with the possibility to create different universes according to the floors. With a capacity of more than 200 people, you can invite as many guests as possible.",
- "Features": [
- "Building customization (incl. logo, posters, welcome message)",
- "Geospatial voice chat",
- "Typeform integration to gather infos from attendees",
- "Receive donations in crypto",
- "Broadcast up to 2 live video streams",
- "Exhibition area with up to 26 customizable booths (incl. visio)",
- "NFT Gallery with up to 10 NFTs"
],
}
]
This API endpoint is used to create a new event with the specified details. If the building specified in the request does not exist, an error will be thrown. A new user account may be created for the email or wallet address provided. Wallet or Email is required.
Email required | string Email address of the user |
Wallet required | string Wallet address of the user |
Title required | string Title of the event |
Building required | string Building Id |
{- "Email": "john.doe@email.com",
- "Wallet": 2.8408260919584264e+47,
- "Title": "Meta Week Festival",
- "Building": "pyramid-rlty"
}
{- "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
- "Name": "Meta Week Festival",
- "Slug": "meta-week-festival",
- "Building": "pyramid-rlty",
- "Headline": "Meta Week Festival, Party with DJs, Live Conferences and more!",
- "Balance": 42,
- "Live": true,
- "AdminsList": [
- "john.doe@email.com",
- "hannah.smith@email.com"
], - "TestersList": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "IsPrivate": true,
- "WhiteListEmail": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "WhiteListNFT": [
- "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
], - "WhiteListWallet": [
- "0xf7e886215Cd82e9caCf1b1d2cD7CA5cc01D6488e",
- "0xed2ab4948bA6A909a7751DEc4F34f303eB8c7236",
- "0x488dB2810bEbA8DAD806C7d237751075DC48364c",
- "0xa1B0716aa6DBF5D1E477e0E434C40758aD24670b"
], - "WhiteListEmailExtension": [
- "gmail.com",
- "hotmail.com"
], - "HideAnonymous": false,
- "HideEmail": false,
- "HideGoogle": false,
- "HideWallet": false
}
This API endpoint returns a list of events associated with a particular user email/wallet and partner. The returned events contain information such as event name, url and media details.
user required | string Example: user=john.doe@email.com Email or Wallet address of the user. |
[- {
- "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
- "Name": "Meta Week Festival",
- "Slug": "meta-week-festival",
- "Building": "pyramid-rlty",
- "Headline": "Meta Week Festival, Party with DJs, Live Conferences and more!",
- "Balance": 42,
- "Live": true,
- "AdminsList": [
- "john.doe@email.com",
- "hannah.smith@email.com"
], - "TestersList": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "IsPrivate": true,
- "WhiteListEmail": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "WhiteListNFT": [
- "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
], - "WhiteListWallet": [
- "0xf7e886215Cd82e9caCf1b1d2cD7CA5cc01D6488e",
- "0xed2ab4948bA6A909a7751DEc4F34f303eB8c7236",
- "0x488dB2810bEbA8DAD806C7d237751075DC48364c",
- "0xa1B0716aa6DBF5D1E477e0E434C40758aD24670b"
], - "WhiteListEmailExtension": [
- "gmail.com",
- "hotmail.com"
], - "HideAnonymous": false,
- "HideEmail": false,
- "HideGoogle": false,
- "HideWallet": false
}
]
This API endpoint is used to update an existing event specified by its ID, with the provided details. The update request must be made by the partner who created the event.
id required | string |
Name required | string |
Headline | string |
AdminsList | Array of strings |
TestersList | Array of strings |
IsPrivate | boolean |
WhiteListEmail | Array of strings |
WhiteListNFT | Array of strings |
WhiteListWallet | Array of strings |
WhiteListEmailExtension | Array of strings |
HideAnonymous | boolean |
HideEmail | boolean |
HideGoogle | boolean |
HideWallet | boolean |
{- "Name": "Meta Week Festival",
- "Headline": "Meta Week Festival, Party with DJs, Live Conferences and more!",
- "AdminsList": [
- "john.doe@email.com",
- "hannah.smith@email.com"
], - "TestersList": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "IsPrivate": true,
- "WhiteListEmail": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "WhiteListNFT": [
- "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
], - "WhiteListWallet": [
- "0xf7e886215Cd82e9caCf1b1d2cD7CA5cc01D6488e",
- "0xed2ab4948bA6A909a7751DEc4F34f303eB8c7236",
- "0x488dB2810bEbA8DAD806C7d237751075DC48364c",
- "0xa1B0716aa6DBF5D1E477e0E434C40758aD24670b"
], - "WhiteListEmailExtension": [
- "gmail.com",
- "hotmail.com"
], - "HideAnonymous": false,
- "HideEmail": false,
- "HideGoogle": false,
- "HideWallet": false
}
{- "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
- "Name": "Meta Week Festival",
- "Slug": "meta-week-festival",
- "Building": "pyramid-rlty",
- "Headline": "Meta Week Festival, Party with DJs, Live Conferences and more!",
- "Balance": 42,
- "Live": true,
- "AdminsList": [
- "john.doe@email.com",
- "hannah.smith@email.com"
], - "TestersList": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "IsPrivate": true,
- "WhiteListEmail": [
- "alice.boulanger@email.com",
- "test@rlty.live",
- "tom.m123@email.com"
], - "WhiteListNFT": [
- "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb",
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
], - "WhiteListWallet": [
- "0xf7e886215Cd82e9caCf1b1d2cD7CA5cc01D6488e",
- "0xed2ab4948bA6A909a7751DEc4F34f303eB8c7236",
- "0x488dB2810bEbA8DAD806C7d237751075DC48364c",
- "0xa1B0716aa6DBF5D1E477e0E434C40758aD24670b"
], - "WhiteListEmailExtension": [
- "gmail.com",
- "hotmail.com"
], - "HideAnonymous": false,
- "HideEmail": false,
- "HideGoogle": false,
- "HideWallet": false
}
This API endpoint provides analytics data for a particular event specified by its ID. Analytics include information on attendee history, attendees by country, and attendee count, among other related details.
id required | string |
{- "AverageTimeSpent": 102852,
- "TimeSpent": 205703,
- "UniqAttendees": 156,
- "Attendees": [
- {
- "UniqId": "john.doe@rlty.live",
- "TimeSpent": 57475368
}, - {
- "UniqId": "0xc9d945721ed37c6451e457b3c7f1e0cec42417fb",
- "TimeSpent": 1544773458
}, - {
- "UniqId": "guest#d72cfdce-c755-419a-a206-cd99226fc16f",
- "TimeSpent": 2147884144
}, - {
- "UniqId": "guest#ed287cf2-1238-4bbc-b068-53c78eba6c12",
- "TimeSpent": 124552216
}, - {
- "UniqId": "0xdac17f958d2ee523a2206206994597c13d831ec7",
- "TimeSpent": 227802746
}, - {
- "UniqId": "alice.boulanger@email.com",
- "TimeSpent": 1288089995
}
], - "AttendeesHist": {
- "1675900800000": 24,
- "1674691200000": 4,
- "1675814400000": 0,
- "1675036800000": 0,
- "1675641600000": 0,
- "1674777600000": 0,
- "1675728000000": 0,
- "1674864000000": 0,
- "1675209600000": 0,
- "1674086400000": 100,
- "1674172800000": 0,
- "1675555200000": 0,
- "1674950400000": 0,
- "1674604800000": 0,
- "1676073600000": 0,
- "1676246400000": 0,
- "1674518400000": 1,
- "1674345600000": 3,
- "1674432000000": 0,
- "1676332800000": 6,
- "1675123200000": 0,
- "1675382400000": 8,
- "1676160000000": 0,
- "1674259200000": 10,
- "1675296000000": 0,
- "1675987200000": 0,
- "1675468800000": 0
}, - "UniqAttendeesByCountry": {
- "FR": 96,
- "RO": 18,
- "US": 42
}
}
This API endpoint provides information about the current partner profile, such as partner name, email, and default balance.
{- "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
- "Name": "DigitEvent",
- "Email": "hello@digitevent.com",
- "ApiKey": "secretkey",
- "DefaultBalance": 10,
- "DefaultPriceCategory": "free"
}