Investor
Token Sales
This endpoint provides a paginated list of token sales available on the platform. Users can filter sales by investment type, status, and sort order. This is essential for investors looking to explore and participate in ongoing or upcoming token sales.
Page number for pagination
Number of items per page
Search term for asset title or description
Investment type 0 - All // Default, can be omitted 1 - Equity 2 - Debt
Status of the token sale 0 - All // Default, can be omitted 1 - Active 2 - Upcoming 3 - Ended
Sort order none - Default, can be omitted price|l-h - Sort by price low to high price|h-l - Sort by price high to low return|h-l - Sort by expected returns high to low
GET /api/v/1/token-sales HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
Token sales retrieved successfully
{
"status": "SUCCESS",
"response": {
"sales": [
{
"id": "text",
"tokenId": "text",
"tokenName": "text",
"tokenSymbol": "text",
"name": "text",
"description": "text",
"startDate": "2025-07-09T23:57:57.545Z",
"endDate": "2025-07-09T23:57:57.545Z",
"payoutStartDate": "2025-07-09T23:57:57.545Z",
"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-07-09T23:57:57.545Z",
"updatedAt": "2025-07-09T23:57:57.545Z"
}
],
"pagination": {
"page": 1,
"limit": 1,
"totalPages": 1,
"totalItems": 1
}
}
}This endpoint facilitates the purchase of tokens from a specific token sale. It requires details such as the token sale ID, user wallet address, and purchase amount. Upon successful processing, the tokens are allocated to the user's account. This is essential for investors looking to acquire tokens from active sales.
Identifier of the token sale
Wallet address of the user
Amount of tokens to purchase
Currency contract address
Timezone of the user
POST /api/v/1/token-sales/buy HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"tokenSaleId": "text",
"userAddress": "text",
"amount": 1,
"currencyContract": "text",
"timezone": "text"
}Tokens purchased successfully
{
"status": "SUCCESS",
"response": {
"result": {
"transactionId": "text",
"tokenSaleId": "text",
"amount": 1,
"userAddress": "text",
"status": "text"
}
}
}This endpoint fetches detailed information about a specific token sale identified by its ID. It includes comprehensive details such as the sale's name, description, token count, and associated documents. This is crucial for investors and administrators who need in-depth information about a particular token sale.
Token sale ID
GET /api/v/1/token-sales/{tokenSaleId} HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
Token sale retrieved successfully
{
"status": 0,
"response": {
"sale": {
"id": "text",
"tokenId": "text",
"tokenName": "text",
"tokenSymbol": "text",
"name": "text",
"description": "text",
"startDate": "2025-07-09T23:57:57.545Z",
"endDate": "2025-07-09T23:57:57.545Z",
"payoutStartDate": "2025-07-09T23:57:57.545Z",
"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-07-09T23:57:57.545Z",
"updatedAt": "2025-07-09T23:57:57.545Z"
}
}
}Investment Portfolio
This endpoint fetches a list of investments made by a specific user. It includes details about the tokens held, transaction history, and pagination options. This is crucial for users to track their investment portfolio and performance.
Page number for pagination
Number of items per page
GET /api/v/1/investments/user/tokens HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
{
"status": 0,
"response": {
"tokens": [
{
"id": "text",
"tokenId": "text",
"assetId": "text",
"icon": "text",
"name": "text",
"symbol": "text",
"assetName": "text",
"assetCategoryText": "text",
"investmentTypeText": "text",
"propertyTypeText": "text",
"title": "text",
"currency": "text",
"requiresTokenBuyBack": 1,
"tokenPrice": 1,
"totalInvestment": 1,
"totalInvestmentWithCurrency": "text",
"tokenCount": 1,
"totalTokenCount": 1,
"pendingTokenCount": 1,
"burnTokenCount": 1,
"tokenPercentage": 1,
"badges": [
{
"title": "text",
"value": "text"
}
],
"softCaps": [
{
"amountToBeInvested": 1,
"cap": 1,
"saleEndDate": "text",
"saleId": "text",
"status": 1,
"saleName": "text",
"subscriptionCount": 1,
"subscriptionPercentage": 1,
"supply": 1
}
]
}
],
"metaData": {
"totalInvestment": "text",
"tokenHoldings": 1,
"currency": "text"
}
},
"pagination": {
"page": 1,
"limit": 1,
"totalPages": 1,
"totalItems": 1
}
}This endpoint provides a list of transactions for a specific user and token. It includes transaction types, status, and pagination options. This is useful for users to monitor their transaction history and investment activities.
Page number for pagination
Number of items per page
GET /api/v/1/investments/user/tokens/{tokenId}/transactions HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
{
"status": 0,
"response": {
"transactions": [
{
"id": "text",
"explorerUrl": "text",
"type": "text",
"principalExplorerUrl": "text",
"txnDate": "text",
"amount": 1,
"principalAmount": 1,
"burnAmount": 1,
"interestAmount": 1,
"delayedInterestAmount": 1,
"pricePerToken": 1,
"total": 1,
"fromWallet": "text",
"toWallet": "text",
"fromWalletAddress": "text",
"toWalletAddress": "text",
"tokenSaleName": "text",
"tokenSaleId": "text",
"payoutId": "text",
"payoutName": "text",
"status": 1,
"tokenId": "text",
"tokenName": "text",
"tokenSymbol": "text",
"tokenIcon": "text",
"assetId": "text",
"assetName": "text",
"payoutDocuments": [],
"usdTotalValue": "text",
"totalValue": "text",
"tokenCount": 1,
"soldTokens": 1,
"usdTokenValue": 1,
"tokenValue": 1,
"currency": "text",
"tokenAddress": "text",
"tokenAddressUrl": "text"
}
]
},
"pagination": {
"page": 1,
"limit": 1,
"totalPages": 1,
"totalItems": 1
}
}This endpoint returns a comprehensive list of all transactions made by a user. It includes transaction details such as types, status, and pagination options. This is essential for users to have a complete view of their financial activities on the platform.
Page number for pagination
Number of items per page
GET /api/v/1/investments/user/transactions HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
{
"status": 0,
"response": {
"transactions": [
{
"id": "text",
"explorerUrl": "text",
"type": "text",
"principalExplorerUrl": "text",
"txnDate": "text",
"amount": 1,
"principalAmount": 1,
"burnAmount": 1,
"interestAmount": 1,
"delayedInterestAmount": 1,
"pricePerToken": 1,
"total": 1,
"fromWallet": "text",
"toWallet": "text",
"fromWalletAddress": "text",
"toWalletAddress": "text",
"tokenSaleName": "text",
"tokenSaleId": "text",
"payoutId": "text",
"payoutName": "text",
"status": 1,
"tokenId": "text",
"tokenName": "text",
"tokenSymbol": "text",
"tokenIcon": "text",
"assetId": "text",
"assetName": "text",
"payoutDocuments": [],
"usdTotalValue": "text",
"totalValue": "text",
"tokenCount": 1,
"soldTokens": 1,
"usdTokenValue": 1,
"tokenValue": 1,
"currency": "text",
"tokenAddress": "text",
"tokenAddressUrl": "text"
}
]
},
"pagination": {
"page": 1,
"limit": 1,
"totalPages": 1,
"totalItems": 1
}
}Payouts
This endpoint returns the payout schedule for a specific debt token sale. It includes details such as principal, interest, and total amounts. This is essential for investors to plan and anticipate payout activities related to a token sale.
Identifier of the store
Identifier of the token
Identifier of the token sale
Quantity of the token sale
Date of purchase
Timezone of the user
GET /api/v/1/payouts/{storeId}/token/{tokenId}/sale/{tokenSaleId}/schedule HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
{
"status": 0,
"response": {
"schedules": [
{
"totalAmount": 1,
"principal": 1,
"interestAmount": 1,
"principalPercentage": 1,
"interestPercentage": 1,
"pointsDifference": 1,
"interestIncurred": 1,
"burnAmount": 1,
"payoutName": "text",
"payoutDate": "text",
"frequencyType": "text",
"index": 1
}
],
"totalPrincipal": 1,
"totalInterest": 1,
"totalAmount": 1
}
}This endpoint provides the payout schedule for a specific token, including principal and interest amounts. It is useful for investors to understand the timing and amounts of future payouts.
Identifier of the store
Identifier of the token
Quantity of the token
Date of purchase
Timezone of the user
GET /api/v/1/payouts/{storeId}/token/{tokenId}/schedule HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
{
"status": 0,
"response": {
"schedules": [
{
"totalAmount": 1,
"principal": 1,
"interestAmount": 1,
"principalPercentage": 1,
"interestPercentage": 1,
"pointsDifference": 1,
"interestIncurred": 1,
"burnAmount": 1,
"payoutName": "text",
"payoutDate": "text",
"frequencyType": "text",
"index": 1
}
],
"totalPrincipal": 1,
"totalInterest": 1,
"totalAmount": 1
}
}KYC
This endpoint updates the KYC (Know Your Customer) information for a user in the token store. It requires details such as country code and other identity attributes. This is crucial for ensuring compliance with regulatory requirements and verifying user identities.
ISO 3166-1 numeric code
POST /api/v/1/identity/kyc HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"countryCode": 1
}Token identity updated successfully
{
"status": 0,
"response": {
"kycStatus": "text",
"kycDetails": {},
"orgId": "text",
"updatedAt": "text",
"createdAt": "text",
"id": "text",
"countryId": "text",
"countryName": "text",
"userId": "text",
"accredit": {}
}
}This endpoint provides the necessary contract addresses required for minting a specific token. It includes addresses for token and sale contracts, which are crucial for the tokenization process. This information is vital for developers and administrators managing token minting operations.
Token identifier
GET /api/v/1/config/contract-addresses/{tokenId} HTTP/1.1
Host: localhost:5004
x-api-key: YOUR_API_KEY
Accept: */*
Contract addresses retrieved successfully
{
"status": "SUCCESS",
"response": {
"config": {
"tokenContract": "text",
"saleContract": "text"
}
}
}Last updated
Was this helpful?