Sharmo API Reference

Introduction

The Sharmo API provides programmatic access to the Sharmo real estate tokenization platform. This reference documents all available endpoints, request parameters, and response formats to help you integrate with our platform.

If you're new to the Sharmo API, we recommend starting with our Getting Started Guide for a step-by-step introduction to the integration process.

Base URL

All API requests should be made to the following base URL:

https://api.sharmo.io/v1

Authentication

All API requests require authentication. Refer to the Authentication Guide for details on how to authenticate with the API.

Authentication

The following endpoints allow you to obtain and manage authentication tokens for accessing the Sharmo API.

Generate an access token using user credentials (OAuth 2.0 password flow).

Request Body

Example Request

fetch('https://api.sharmo.io/v1/auth/token', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    grant_type: 'password',
    username: 'user@example.com',
    password: 'securepassword'
  })
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "def5020061a9ee62553...",
  "token_type": "bearer",
  "expires_in": 3600
}

Properties

Endpoints for accessing and managing tokenized properties on the Sharmo platform.

Returns a list of properties based on the provided filters.

Query Parameters

Example Request

fetch('https://api.sharmo.io/v1/properties?limit=10&status=active', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Returns detailed information about a specific property.

Path Parameters

Tokens

Endpoints for managing property tokens, including retrieving token information and tracking ownership.

Returns token information for a specific property.

Path Parameters

Returns the token balance for the authenticated user.

Transactions

Endpoints for managing and viewing token transactions.

Returns a list of transactions for the authenticated user.

Query Parameters

Creates a new transaction (buy or sell tokens).

Users & KYC

Endpoints for managing user profiles and KYC verification.

Returns the profile information for the authenticated user.

Updates the profile information for the authenticated user.

Initiates KYC verification for the authenticated user.

Analytics

Endpoints for accessing market analytics and performance data.

Returns market-wide analytics and trends.

Returns performance analytics for a specific property.

Path Parameters