Sakai Vault
  • 🔎Overview
  • ⏩Roadmap
  • 📔Contracts Addresses
  • 📱Scan to Download App IOS & Android
  • 🤵‍♂️FAQs
  • FEATURES
    • 🔁STAKING
    • 🔥Liquidity Farming Protocol
      • 💎Farming Pair: SAKAI/PAXE
      • 🌟Farming Pair: sUSD/PAXE
      • 🌱How to Farm
      • 💰Referrals program
      • ❓FAQ
    • ⚖️SakaiDAO
      • User Guides
      • Participating in SakaiDAO
      • Contracts
      • FAQ
      • Governance
      • SakaiDAO Operator MultiSig
    • ⚒️Rewards
    • 📊Trading
    • 🛡️API
      • ⚙️API Endpoints
    • 💬DeFi Talks
      • ↔️Sakai Swap
    • 🤖Artificial Inteligent
    • 🔢Lottery
    • 🚀Sakai LaunchPad
    • 📱Sakai Wallet
  • TOKENOMICS
    • 🔄Tokenomics
  • SECURITY
    • 🛡️Security & Audit Reports
    • 🐞Bug Bounty Program
      • 💱STAKING TESTNET
      • 🌾LIQUIDITY FARMING TESTNET
    • 💟Media Kit
  • SAKAI VAULT +
    • 🖥️App Links
    • 🌐Our Links & Socials
    • 📋Privacy Policy
    • 📋Terms of Service
    • 📒Disclaimer
Powered by GitBook
On this page
  1. FEATURES
  2. API

API Endpoints

Here are Sakai Vault API endpoints.

PreviousAPINextDeFi Talks

Last updated 1 year ago

API URL: https://api.sakaivault.io/api

Health Check

  • Check the health status of the server.

Wallet Information

  • Retrieve wallet data for a specific user based on their wallet address.

Wallet Log

  • Retrieve the log history for a specific wallet address.

Log Total

  • Retrieve the last 100 logs for transactions.

Ranking by Deposit

  • Retrieve the deposit ranking within a specified time range.

Ranking by Profit

  • Retrieve the profit ranking within a specified time range.

Ranking by Commission

  • Retrieve the commission ranking within a specified time range.

Check if user exists and update user's deposit amount.

  • Update user's staking balance Description: This API endpoint updates the user's staking balance based on the provided wallet and transaction hash (txhash). It checks for user existence, creates a new user if necessary, and updates the parent's rewards and referral details. If successful, the endpoint returns a JSON response with a status indicating success.

Claim Rewards

  • Update user's staking balance Description: This API endpoint updates the user's staking balance based on the provided wallet and transaction hash (txhash). It checks for user existence, creates a new user if necessary, and updates the parent's rewards and referral details. If successful, the endpoint returns a JSON response with a status indicating success.

🛡️
⚙️

Health check

get

Use this endpoint to check if the server is online

Responses
200
Server is online
application/json
500
Internal Server Error
application/json
get
GET /api/healthcheck HTTP/1.1
Host: api.sakaivault.io
Accept: */*
{
  "status": "text"
}

Retrieve wallet details

get
Path parameters
walletstringRequired

Wallet identifier

Responses
200
Wallet details successfully retrieved
application/json
404
User not found
application/json
500
Internal Server Error
application/json
get
GET /api/wallet/{wallet} HTTP/1.1
Host: api.sakaivault.io
Accept: */*
{
  "wallet": "text",
  "depositAmount": 1,
  "availableClaim": 1,
  "referralClaim": 1,
  "totalGroupSale": 1,
  "totalReferralCount": 1,
  "level": 1,
  "isSpecial": true,
  "startDeposit": "2025-05-23T07:17:10.885Z",
  "endPeriod": "2025-05-23T07:17:10.885Z",
  "rewardAllocated": 1,
  "rewardLimit": 1,
  "refCode": "text",
  "directReferralAmount": 1,
  "sponsorLevelAmount": 1,
  "dailyInterestAmount": 1,
  "rankingRewardAmount": 1,
  "sameLevelAmount": 1
}

Retrieve wallet log

get
Path parameters
walletstringRequired

Wallet identifier

Responses
200
Wallet log successfully retrieved
application/json
500
Internal Server Error
application/json
get
GET /api/logwallet/{wallet} HTTP/1.1
Host: api.sakaivault.io
Accept: */*
[
  {
    "wallet": "text",
    "kind": "text",
    "txhash": "text",
    "date": "2025-05-23T07:17:10.885Z",
    "from": "text",
    "to": "text",
    "value": "text"
  }
]

Retrieve the last 100 logs for transactions

get
Responses
200
Transaction logs successfully retrieved
application/json
500
Internal Server Error
application/json
get
GET /api/logtotal HTTP/1.1
Host: api.sakaivault.io
Accept: */*
[
  {
    "_id": "text",
    "wallet": "text",
    "kind": "text",
    "txhash": "text",
    "date": "2025-05-23T07:17:10.885Z",
    "from": "text",
    "to": "text",
    "value": "text",
    "__v": 1
  }
]

Retrieve deposit ranking by time range

get
Path parameters
timerangestringRequired

Time range identifier (e.g., "7d", "24h", or "cumulative")

Responses
200
Deposit ranking successfully retrieved
application/json
500
Internal Server Error
application/json
get
GET /api/rankdeposit/{timerange} HTTP/1.1
Host: api.sakaivault.io
Accept: */*
[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "directReferralCount": 1,
    "totalReferralCount": 1,
    "totalGroupSale": "text",
    "level": 1
  }
]

Retrieve top 100 profit rankings by time range

get
Path parameters
timerangestringRequired

Time range identifier (e.g., "7d", "24h", or "cumulative")

Responses
200
Profit ranking successfully retrieved
application/json
500
Internal Server Error
application/json
get
GET /api/rankprofit/{timerange} HTTP/1.1
Host: api.sakaivault.io
Accept: */*
[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "directReferralCount": 1,
    "totalReferralCount": 1,
    "totalGroupSale": "text",
    "level": 1
  }
]

Retrieve top 100 commission rankings by time range

get
Path parameters
timerangestringRequired

Time range identifier (e.g., "7d", "24h", or "cumulative")

Responses
200
Commission ranking successfully retrieved
application/json
500
Internal Server Error
application/json
get
GET /api/rankcommission/{timerange} HTTP/1.1
Host: api.sakaivault.io
Accept: */*
[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "directReferralCount": 1,
    "totalReferralCount": 1,
    "totalGroupSale": "text",
    "level": 1
  }
]
  • Health Check
  • GETHealth check
  • Wallet Information
  • GETRetrieve wallet details
  • Wallet Log
  • GETRetrieve wallet log
  • Log Total
  • GETRetrieve the last 100 logs for transactions
  • Ranking by Deposit
  • GETRetrieve deposit ranking by time range
  • Ranking by Profit
  • GETRetrieve top 100 profit rankings by time range
  • Ranking by Commission
  • GETRetrieve top 100 commission rankings by time range
  • Check if user exists and update user's deposit amount.
  • POSTUpdate the user's balance (ref is optional)
  • Claim Rewards
  • POSTClaim user's accumulated rewards

Update the user's balance (ref is optional)

post
Body
walletstringOptional
refstringOptional
txhashstringOptional
Responses
200
Balance updated successfully
application/json
400
User not staked yet or balance not increased since last checked
application/json
500
Internal Server Error
application/json
post
POST /api/updatebalance HTTP/1.1
Host: api.sakaivault.io
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "wallet": "text",
  "ref": "text",
  "txhash": "text"
}
{
  "status": "text"
}

Claim user's accumulated rewards

post
Body
txhashstringOptional
Responses
200
Rewards claimed successfully
application/json
400
Various error cases, e.g., TxHash BNB already used, user not found, etc.
application/json
500
Internal Server Error
application/json
post
POST /api/claimreward HTTP/1.1
Host: api.sakaivault.io
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "txhash": "text"
}
{
  "status": "text",
  "txhash": "text"
}