RLTY Partners API (0.0.1)

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.

Buildings

All available buildings.

This API endpoint returns a list of buildings with information such as building name, description and features.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[]

Events

Create a new event.

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.

Authorizations:
ApiKey
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "Email": "john.doe@email.com",
  • "Wallet": 2.8408260919584264e+47,
  • "Title": "Meta Week Festival",
  • "Building": "pyramid-rlty"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "TestersList": [
    ],
  • "IsPrivate": true,
  • "WhiteListEmail": [
    ],
  • "WhiteListNFT": [
    ],
  • "WhiteListWallet": [
    ],
  • "WhiteListEmailExtension": [
    ],
  • "HideAnonymous": false,
  • "HideEmail": false,
  • "HideGoogle": false,
  • "HideWallet": false
}

Get user's events.

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.

Authorizations:
ApiKey
query Parameters
user
required
string
Example: user=john.doe@email.com

Email or Wallet address of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an user event.

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.

Authorizations:
ApiKey
path Parameters
id
required
string
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "Name": "Meta Week Festival",
  • "Headline": "Meta Week Festival, Party with DJs, Live Conferences and more!",
  • "AdminsList": [
    ],
  • "TestersList": [
    ],
  • "IsPrivate": true,
  • "WhiteListEmail": [
    ],
  • "WhiteListNFT": [
    ],
  • "WhiteListWallet": [
    ],
  • "WhiteListEmailExtension": [
    ],
  • "HideAnonymous": false,
  • "HideEmail": false,
  • "HideGoogle": false,
  • "HideWallet": false
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "TestersList": [
    ],
  • "IsPrivate": true,
  • "WhiteListEmail": [
    ],
  • "WhiteListNFT": [
    ],
  • "WhiteListWallet": [
    ],
  • "WhiteListEmailExtension": [
    ],
  • "HideAnonymous": false,
  • "HideEmail": false,
  • "HideGoogle": false,
  • "HideWallet": false
}

Get event's analytics.

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.

Authorizations:
ApiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "AverageTimeSpent": 102852,
  • "TimeSpent": 205703,
  • "UniqAttendees": 156,
  • "Attendees": [
    ],
  • "AttendeesHist": {
    },
  • "UniqAttendeesByCountry": {
    }
}

Partner

Your partner profile.

This API endpoint provides information about the current partner profile, such as partner name, email, and default balance.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
  • "Name": "DigitEvent",
  • "Email": "hello@digitevent.com",
  • "ApiKey": "secretkey",
  • "DefaultBalance": 10,
  • "DefaultPriceCategory": "free"
}

Partner statistics.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "EventsCount": 42,
  • "CreatorsCount": 18
}

Renew API Key.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "Id": "7217560c-6d35-4e08-9e34-08eb9dc475f1",
  • "Name": "DigitEvent",
  • "Email": "hello@digitevent.com",
  • "ApiKey": "secretkey",
  • "DefaultBalance": 10,
  • "DefaultPriceCategory": "free"
}