Token Issuer

Tokenise Real World Assets

Use these APIs to tokenise an asset, and view/ manage tokenised assets.

Steps before tokenising an asset:

How to Connect Your Wallet

import React, { useState } from "react";
import { ethers } from "ethers";

const MetaMaskConnect = () => {
  const [account, setAccount] = useState(null);
  const [balance, setBalance] = useState(null);
  const [error, setError] = useState(null);

  const connectWallet = async () => {
    if (window.ethereum) {
      try {
        const provider = new ethers.BrowserProvider(window.ethereum);
        const accounts = await provider.send("eth_requestAccounts", []);
        setAccount(accounts[0]);

        const signer = await provider.getSigner();
        const balance = await provider.getBalance(signer.address);
        setBalance(ethers.formatEther(balance));
      } catch (err) {
        setError("Failed to connect to MetaMask");
      }
    } else {
      setError("MetaMask is not installed");
    }
  };

  return (
    <div className="p-4 text-center">
      <h1 className="text-2xl font-bold">MetaMask Wallet Connect</h1>
      <button
        onClick={connectWallet}
        className="mt-4 px-4 py-2 bg-blue-500 text-white rounded"
      >
        Connect Wallet
      </button>
      {account && (
        <div className="mt-4">
          <p><strong>Connected Account:</strong> {account}</p>
          <p><strong>Balance:</strong> {balance} ETH</p>
        </div>
      )}
      {error && <p className="text-red-500 mt-4">{error}</p>}
    </div>
  );
};

export default MetaMaskConnect;

Similarly other libraries can be used to achieve this functionality

Publishing Asset

Payment via wallet directly to spydra

Fetch the fee config by calling the api https://api.openrwa.io/api/v/1/config/store/{storeId}/fee
After fetching the data, check the balance and obtain approval for the appropriate listing fee
To check balance, use the following snippet:
1. userAddress is the wallet address of the user making the transaction
2. signer is the JsonRPCSigner object
3. provider is the BrowserProvider object
4. listingFee is the amount for publishing asset from fee config result
5. contractAddress is the currency contract address from fee config result
6. contractDecimal is the currency contract decimal from fee config result

const genericErc20Abi = [
  'function balanceOf(address account) public view returns (uint256)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

const nativeTokenBalance = await provider.getBalance(userAddress as string);
const formattedBalanceNative = Number(formatEther(nativeTokenBalance));

if (
  Number.isNaN(formattedBalanceNative)
  || formattedBalanceNative <= 0
) {
  throw new Error('Not enough native tokens to pay the gas fee.')
}

const balance = await contract.balanceOf(userAddress);
const formattedBalance = Number(formatUnits(balance, contractDecimal));

if (
  formattedBalance < listingFee
) {
  throw new Error('Not enough tokens for listing fee.')
}

To approve, use the following snippet:
1. signer is the JsonRPCSigner object
2. listingFee is the amount for publishing asset from fee config result
3. contractAddress is the currency contract address from fee config result
4. contractDecimal is the currency contract decimal from fee config result
5. tRexContractAddress is the RWA contract address from fee config result

const approvalAmount = parseUnits(listingFee.toString(), contractDecimal);

const genericErc20Abi = [
  'function approve(address spender, uint256 amount) public returns (bool)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

await contract.approve(tRexContractAddress, approvalAmount).then(async (tx: any) => tx.wait());

After successful approval, send these additional parameters to the publish API

listingFeePaymentMode: 'wallet' // this value will always be wallet
listingFeePaymentChainId: number // chain id passed to fee config api
listingFeeContractAddress: string // selected currency contract address

Node Modules Required

ethers.js
Any preferred libaray to connect wallet for getting the BrowserProvider and Signer objects

Token & Token Sale

Issuer API's to create/update a token, and token sale. API's to view and manage token price.

Creating a Debt Token

Debt Tokens require the debt object while creating the token which are

interestPayoutFrequency
- 1 - Monthly Payouts
- 2 - Quaterly Payouts
- 3 - Annual Payouts
- 5 - Semi-Annual Payouts
date
- Required in case of monthly, quaterly, annual and semi-annual payouts
- Accepted Range: 1-28
month
- Required in case of annual payouts
- Accepted Range: 1-12
  - 1 : Jan
  - 2 : Feb
  - 3 : Mar
  - 4 : Apr
  - 5 : May
  - 6 : June
  - 7 : July
  - 8 : Aug
  - 9 : Sept
  - 10 : Oct
  - 11 : Nov
  - 12 : Dec
quarter
- Required in case of quartely payouts
- Accepted Range: 1-3
  - 1 : Jan-Apr-Jul-Oct
  - 2 : Feb-May-Aug-Nov
  - 3 : Mar-Jun-Sep-Dec
halfYear
- Required in case of semi-annauly payouts
- Accepted Range: 1-6
  - 1 : Jan-Jul
  - 2 : Feb-Aug
  - 3 : Mar-Sept
  - 4 : Apr-Oct
  - 5 : May-Nov
  - 6 : Jun-Dec
schedules
- array of schedule objects
  - name
  - principal
    Principal amount for particular schedule
numberOfPayouts
interestRate

Token Sales can be Running or have End Date

Creating an Equity Token

Equity Tokens require the equity object while creating the token which are

payoutFrequency
- 1 - Monthly Payouts
- 2 - Quaterly Payouts
- 3 - Annual Payouts
expectedReturns

Token Payout

Token Lifecycle APIs: Initiating/ Managing Payout for Debt and Equity Tokens.

How to Set Up an Equity Payout

Fetch the payout metadata by calling the API https://api.openrwa.io/api/v/1/payouts/{storeId}/token/{tokenId}/metadata
After fetching the data, check the balance and obtain approval fora. totalAmount = amountPerToken × totalTokens
To check the balance, use the following snippet:
1. userAddress is the wallet address of the user making the transaction
2. signer is the JsonRPCSigner object
3. provider is the BrowserProvider object
4. contractAddress is the currency contract address from metadata result
5. contractDecimal is the currency contract decimal from metadata result

const genericErc20Abi = [
  'function balanceOf(address account) public view returns (uint256)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

const nativeTokenBalance = await provider.getBalance(userAddress as string);
const formattedBalanceNative = Number(formatEther(nativeTokenBalance));

if (
  Number.isNaN(formattedBalanceNative)
  || formattedBalanceNative <= 0
) {
  throw new Error('Not enough native tokens to pay the gas fee.')
}

const balance = await contract.balanceOf(userAddress);
const formattedBalance = Number(formatUnits(balance, contractDecimal));

if (
  formattedBalance < totalAmount
) {
  throw new Error('Not enough tokens for payout.')
}

To approve, use the following snippet:
1. signer is the JsonRPCSigner object
2. contractAddress is the currency contract address from metadata result
3. contractDecimal is the currency contract decimal from metadata result
4. tokenContractAddress is the Token Contract Address from metadata result

const approvalAmount = parseUnits(totalAmount.toString(), contractDecimal);

const genericErc20Abi = [
  'function approve(address spender, uint256 amount) public returns (bool)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

await contract.approve(tokenContractAddress, approvalAmount).then(async (tx: any) => tx.wait());

How to Set Up an Debt Payout

Fetch the payout metadata by calling the API https://api.openrwa.io/api/v/1/payouts/{storeId}/token/{tokenId}/metadata?payoutId={payoutId}
After fetching the data, check the balance and obtain approval for totalAmount
To check balance, use the following snippet:
1. userAddress is the wallet address of the user making the transaction
2. signer is the JsonRPCSigner object
3. provider is the BrowserProvider object
4. contractAddress is the currency contract address from metadata result
5. contractDecimal is the currency contract decimal from metadata result

const genericErc20Abi = [
  'function balanceOf(address account) public view returns (uint256)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

const nativeTokenBalance = await provider.getBalance(userAddress as string);
const formattedBalanceNative = Number(formatEther(nativeTokenBalance));

if (
  Number.isNaN(formattedBalanceNative)
  || formattedBalanceNative <= 0
) {
  throw new Error('Not enough native tokens to pay the gas fee.')
}

const balance = await contract.balanceOf(userAddress);
const formattedBalance = Number(formatUnits(balance, contractDecimal));

if (
  formattedBalance < totalAmount
) {
  throw new Error('Not enough tokens for payout.')
}

To approve, use the following snippet:
1. signer is the JsonRPCSigner object
2. contractAddress is the currency contract address from metadata result
3. contractDecimal is the currency contract decimal from metadata result
4. tokenContractAddress is the Token Contract Address from metadata result

const approvalAmount = parseUnits(totalAmount.toString(), contractDecimal);

const genericErc20Abi = [
  'function approve(address spender, uint256 amount) public returns (bool)',
];

const contract = new Contract(
  contractAddress,
  genericErc20Abi,
  signer,
);

await contract.approve(tokenContractAddress, approvalAmount).then(async (tx: any) => tx.wait());

Store User Authentication

Investor Mangement

IPFS

When is this required?

While Updating the Asset when Asset is live
While Updating the Token when Asset/Token is live
While Creatingthe TokenSale when Token is live

Uploading Asset Metadata to IPFS

const tokenAbi = [
  'function setTokenURI(string _uri)',
];

const contract = new Contract(
  tokenAddress,
  tokenAbi,
  signer,
);

await contract.setTokenURI(cid).then(async (tx: any) => tx.wait());

After Updating the TokenURL, the respective save API's should be called.

eg. After Calling the Upload to IPFS API with new Token Sales Data and updating the Token URI, we need to call the Put TokenSales API to reflect the new token sales.

Configs

PreviousToken Store (Public Chain)NextInvestor

Last updated 1 month ago

Was this helpful?

{ "status": 0, "response": { "assets": [ { "id": "text", "assetCategory": 1, "assetCategoryText": "text", "chain": "text", "chainIcon": "text", "chainType": "text", "investmentType": 1, "investmentTypeText": "text", "title": "text", "description": "text", "coverImage": "text", "constructionYear": 1, "numberOfBedrooms": 1, "propertyType": 1, "propertyTypeText": "text", "shortDescription": "text", "assetType": "text", "status": 1, "statusText": "text", "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "valuation": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "address": { "address_1": "text", "address_2": "text", "google_place": "text", "city": "text", "zip_code": "text", "country": "text", "coords": { "lat": 1, "lng": 1 } }, "aboutTheIssuer": "text", "moreInfo": [ { "title": "text", "description": "text" } ], "termsAndConditions": "text", "faqs": [ { "question": "text", "answer": "text" } ], "storeId": "text", "timezone": "text", "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z", "publishedOn": "2025-05-25T01:04:05.268Z", "tokens": [ { "id": "text", "assetId": "text", "storeId": "text", "availableTokens": 1, "soldTokens": 1, "chainId": "text", "icon": "text", "name": "text", "symbol": "text", "debt": { "date": 1, "month": 1, "quarter": 1, "halfYear": 1, "schedules": [ { "id": "text", "principal": 1 } ], "numberOfPayouts": 1, "interestRate": 1, "interestPayoutFrequency": 1 }, "equity": { "expectedReturns": 1, "payoutFrequency": 1 }, "includedJurisdictions": [ "text" ], "excludedJurisdictions": [ "text" ], "maxSupply": 1, "maxPerUser": 1, "minHoldInPeriod": 1, "percentageAvailableTokens": 1, "percentageSoldTokens": 1, "price": 1, "requiresKyc": true, "secondaryMarketplace": true, "timezone": "text", "tokenAddress": "text", "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z", "tokenSales": [ { "id": "text", "tokenId": "text", "tokenName": "text", "tokenSymbol": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text", "expectedReturns": 1, "totalSoldTokens": 1, "percentageTokenSold": 1, "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z" } ] } ] } ] }, "pagination": { "page": 1, "limit": 1, "totalPages": 1, "totalItems": 1 } }

{ "status": 0, "response": { "asset": { "id": "text", "assetCategory": 1, "assetCategoryText": "text", "chain": "text", "chainIcon": "text", "chainType": "text", "investmentType": 1, "investmentTypeText": "text", "title": "text", "description": "text", "coverImage": "text", "constructionYear": 1, "numberOfBedrooms": 1, "propertyType": 1, "propertyTypeText": "text", "shortDescription": "text", "assetType": "text", "status": 1, "statusText": "text", "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "valuation": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "address": { "address_1": "text", "address_2": "text", "google_place": "text", "city": "text", "zip_code": "text", "country": "text", "coords": { "lat": 1, "lng": 1 } }, "aboutTheIssuer": "text", "moreInfo": [ { "title": "text", "description": "text" } ], "termsAndConditions": "text", "faqs": [ { "question": "text", "answer": "text" } ], "storeId": "text", "timezone": "text", "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z", "publishedOn": "2025-05-25T01:04:05.268Z", "tokens": [ { "id": "text", "assetId": "text", "storeId": "text", "availableTokens": 1, "soldTokens": 1, "chainId": "text", "icon": "text", "name": "text", "symbol": "text", "debt": { "date": 1, "month": 1, "quarter": 1, "halfYear": 1, "schedules": [ { "id": "text", "principal": 1 } ], "numberOfPayouts": 1, "interestRate": 1, "interestPayoutFrequency": 1 }, "equity": { "expectedReturns": 1, "payoutFrequency": 1 }, "includedJurisdictions": [ "text" ], "excludedJurisdictions": [ "text" ], "maxSupply": 1, "maxPerUser": 1, "minHoldInPeriod": 1, "percentageAvailableTokens": 1, "percentageSoldTokens": 1, "price": 1, "requiresKyc": true, "secondaryMarketplace": true, "timezone": "text", "tokenAddress": "text", "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z", "tokenSales": [ { "id": "text", "tokenId": "text", "tokenName": "text", "tokenSymbol": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text", "expectedReturns": 1, "totalSoldTokens": 1, "percentageTokenSold": 1, "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z" } ] } ] } } }

{ "status": 0, "response": { "tokens": [ { "id": "text", "assetId": "text", "storeId": "text", "availableTokens": 1, "soldTokens": 1, "chainId": "text", "icon": "text", "name": "text", "symbol": "text", "debt": { "date": 1, "month": 1, "quarter": 1, "halfYear": 1, "schedules": [ { "id": "text", "principal": 1 } ], "numberOfPayouts": 1, "interestRate": 1, "interestPayoutFrequency": 1 }, "equity": { "expectedReturns": 1, "payoutFrequency": 1 }, "includedJurisdictions": [ "text" ], "excludedJurisdictions": [ "text" ], "maxSupply": 1, "maxPerUser": 1, "minHoldInPeriod": 1, "percentageAvailableTokens": 1, "percentageSoldTokens": 1, "price": 1, "requiresKyc": true, "secondaryMarketplace": true, "timezone": "text", "tokenAddress": "text", "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z", "tokenSales": [ { "id": "text", "tokenId": "text", "tokenName": "text", "tokenSymbol": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text", "expectedReturns": 1, "totalSoldTokens": 1, "percentageTokenSold": 1, "createdAt": "2025-05-25T01:04:05.268Z", "updatedAt": "2025-05-25T01:04:05.268Z" } ] } ] } }

{ "status": 0, "token": { "id": "text", "assetId": "text", "icon": "text", "name": "text", "symbol": "text", "debt": { "interestPayoutFrequency": "text", "interestRate": 1, "numberOfPayouts": 1, "payoutMethod": "text", "principalPayoutFrequency": "text", "schedules": [ { "id": "text", "name": "text", "principal": 1 } ], "date": "2025-05-25", "month": "text", "quarter": "text", "halfYear": "text" }, "equity": { "expectedReturns": 1, "payoutFrequency": "text", "payoutType": "text" }, "includedJurisdictions": [ "text" ], "excludedJurisdictions": [ "text" ], "maxSupply": 1, "maxPerUser": 1, "minHoldInPeriod": 1, "price": 1, "requiresKyc": true, "secondaryMarketplace": true, "timezone": "text", "tokenSales": [ { "id": "text", "tokenId": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text" } ] }, "chartData": { "points": [ { "date": "text", "price": 1 } ], "metadata": {}, "updateIntervals": [ { "date": "text", "price": 1, "updatedBy": "text" } ] } }

PUT /api/v/1/assets HTTP/1.1 Host: api.openrwa.io x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 1896 { "assetCategory": 1, "investmentType": 2, "coverImage": "https://devrwaassets.blob.core.windows.net/rwaassetsdocuments/6728d2c9fbe7a9ccf6f2db8d/07cdf99f-5ad9-4734-900a-3fafc1da8e9a_fumfudppcfedox0yim9m.png", "title": "Luxury Beachfront Villa", "description": "<p>Beautiful 4-bedroom villa with direct beach access</p>", "shortDescription": "", "propertyType": 1, "constructionYear": 2010, "numberOfBedrooms": 3, "images": [ { "name": "qqwgbirwqbaxjzfxah5t.png", "size": 1312647, "type": "image/png", "url": "https://devrwaassets.blob.core.windows.net/rwaassetsdocuments/6728d2c9fbe7a9ccf6f2db8d/ab0972bb-998c-410c-a70e-95e3921f03a9_qqwgbirwqbaxjzfxah5t.png" }, { "name": "nsmjdavtyphppvg7wki1.png", "size": 784638, "type": "image/png", "url": "https://devrwaassets.blob.core.windows.net/rwaassetsdocuments/6728d2c9fbe7a9ccf6f2db8d/07f7c9da-3160-4c84-9c29-0079cdf4c39e_nsmjdavtyphppvg7wki1.png" } ], "documents": [], "valuations": [], "address": { "google_place": "Miami Beach, FL, USA", "coords": { "lat": 25.790654, "lng": -80.1300455 }, "address_1": "123, Beach Road", "address_2": "Unit A", "zip_code": 33139, "city": "Miami", "country": "630364b1739406442c73e3fb" }, "aboutTheIssuer": "<p>Beach Villas Ltd. is a visionary entrepreneur dedicated to creating luxury beachfront villas that blend modern design with natural beauty. With a passion for sustainable architecture, they focus on building exclusive, eco-friendly homes that offer unparalleled comfort and breathtaking ocean views. Their commitment to quality craftsmanship and attention to detail ensures each villa is a tranquil retreat, offering an ideal blend of elegance and coastal living.</p>", "moreInfo": [ { "id": "339", "label": "Distance to shore", "description": "250 yards" } ], "faqs": [ { "id": "339", "question": "What are the amenities?", "answer": "The villas come with a private beach access, a swimming pool, a gym, and a spa." }, { "id": "340", "question": "What is the construction year?", "answer": "2010" } ] }

POST /api/v/1/assets/publish HTTP/1.1 Host: api.openrwa.io x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 216 { "assetId": "6788d2a296f0630b8b1318e0", "tokenWalletAddress": "0x649458E05F928Fa77Ec2cd5e2f1889C891c20015", "tokenChainId": 80002, "paymentWalletAddress": "0x649458E05F928Fa77Ec2cd5e2f1889C891c20015", "paymentChainId": 80002 }

PUT /api/v/1/tokens HTTP/1.1 Host: api.openrwa.io x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 1108 { "tokens": [ { "assetId": "6788d2a296f0630b8b1318e0", "icon": "", "name": "Beach Villa Token", "symbol": "BVTD", "maxSupply": 10000000, "price": 1, "maxPerUser": 10000, "requiresKyc": false, "secondaryMarketplace": false, "minHoldInPeriod": 30, "includedJurisdictions": [ "-1" ], "excludedJurisdictions": [], "tokenSales": [ { "name": "Villa 104 - Initial Offering", "description": "", "tokenCountOnSale": 100000, "startDate": "2025-01-17T00:00:01+05:30", "endDate": "2025-01-30T23:59:59+05:30", "payoutStartDate": "2030-05-10T00:00:01+05:30", "images": [], "documents": [] } ], "debt": { "interestRate": 12, "interestPayoutFrequency": 3, "numberOfPayouts": 5, "month": 5, "date": 10, "schedules": [ { "id": "6788d40233ea3664e4ea11de", "name": "Annual Payment 1 (Interest only)", "principal": 0 }, { "id": "6788d40233ea3664e4ea11df", "name": "Annual Payment 2 (Interest only)", "principal": 0 }, { "id": "6788d40233ea3664e4ea11e0", "name": "Annual Payment 3 (Interest only)", "principal": 0 }, { "id": "6788d40233ea3664e4ea11e1", "name": "Annual Payment 4 (Principal + Interest)", "principal": 0.5 }, { "id": "6788d40233ea3664e4ea11e2", "name": "Annual Payment 5 (Principal + Interest)", "principal": 0.5 } ] } } ] }

{ "status": "SUCCESS", "response": { "tokens": [ { "id": "text", "assetId": "text", "icon": "text", "name": "text", "symbol": "text", "debt": { "interestPayoutFrequency": "text", "interestRate": 1, "numberOfPayouts": 1, "payoutMethod": "text", "principalPayoutFrequency": "text", "schedules": [ { "id": "text", "name": "text", "principal": 1 } ], "date": "2025-05-25", "month": "text", "quarter": "text", "halfYear": "text" }, "equity": { "expectedReturns": 1, "payoutFrequency": "text", "payoutType": "text" }, "includedJurisdictions": [ "text" ], "excludedJurisdictions": [ "text" ], "maxSupply": 1, "maxPerUser": 1, "minHoldInPeriod": 1, "price": 1, "requiresKyc": true, "secondaryMarketplace": true, "timezone": "text", "tokenSales": [ { "id": "text", "tokenId": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text" } ] } ] } }

POST /api/v/1/assets/upload-to-ipfs/{assetId} HTTP/1.1 Host: localhost:5004 x-api-key: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 1327 { "assetData": { "id": "text", "assetCategory": 1, "investmentType": 1, "title": "text", "description": "text", "shortDescription": "text", "coverImage": "text", "constructionYear": 1, "numberOfBedrooms": 1, "propertyType": 1, "assetType": "text", "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "valuation": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "address": { "address_1": "text", "address_2": "text", "google_place": "text", "city": "text", "zip_code": "text", "country": "text", "coords": { "lat": 1, "lng": 1 } }, "aboutTheIssuer": "text", "moreInfo": [ { "title": "text", "description": "text" } ], "termsAndConditions": "text", "faqs": [ { "question": "text", "answer": "text" } ], "timezone": "text" }, "tokenData": { "id": "text", "price": 1 }, "tokenSalesData": { "id": "text", "tokenId": "text", "name": "text", "description": "text", "startDate": "2025-05-25T01:04:05.268Z", "endDate": "2025-05-25T01:04:05.268Z", "payoutStartDate": "2025-05-25T01:04:05.268Z", "tokenCountOnSale": 1, "images": [ { "name": "text", "size": 1, "type": "text", "url": "text" } ], "documents": [ { "id": "text", "name": "text", "size": 1, "type": "text", "url": "text", "title": "text", "description": "text", "order": 1 } ], "softCap": 1, "timezone": "text" } }

{ "status": 0, "response": { "assetId": "text", "tokens": [ { "name": "text", "id": "text", "cid": "text", "tokenAddress": "text", "issuerAddress": "text", "chainId": 1, "network": { "id": "text", "name": "text", "chainId": "text", "rpcUrl": "https://example.com", "explorerUrl": "https://example.com", "currency": "text", "store_id": "text", "created_by": "text", "updated_by": "text" } } ] } }

Tokenise Real World Assets

Token & Token Sale

Token Payout

Store User Authentication

Investor Mangement

IPFS

Configs

Tokenise Real World Assets

Token & Token Sale

Token Payout

Store User Authentication

Investor Mangement

IPFS

Configs

Retrieve a paginated list of assets

Retrieve detailed information about a specific asset

Retrieve tokens associated with a specific asset

Retrieve token sales associated with a specific asset

Retrieve the current price of a token

Create or update an asset

Publish an asset to make it available for tokenization

Create or update multiple tokens

Update the price of a token

Retrieve token sales by token ID

Retrieve a list of token sales

Retrieve details of a specific token sale

Retrieve past debt payouts for a token

Retrieve metadata for a token

Retrieve equity payouts for a token

Retrieve all investors

Retrieve investors for a specific token

Retrieve listing fee configuration for a token store

Retrieve contract addresses for token minting

Retrieve a list of supported countries

Retrieve all supported blockchain networks

Purchase tokens from a token sale

Initiate a payout for an equity token

Initiate a payout for a debt token

Register a new user

Update user information

Upload an asset to IPFS

Update token with IPFS data