⚙️API Endpoints

Here are Sakai Vault API endpoints.

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

Health Check

• Check the health status of the server.

Health check

Use this endpoint to check if the server is online

GEThttps://api.sakaivault.io/api/healthcheck

Response

200500

Server is online

Body

application/json

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/healthcheck', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "status": "text"
}

Wallet Information

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

Retrieve wallet details

GEThttps://api.sakaivault.io/api/wallet/{wallet}

Path parameters

wallet*string

Wallet identifier

Response

200404500

Wallet details successfully retrieved

Body

application/json

walletstring

depositAmountnumber

availableClaimnumber

referralClaimnumber

totalGroupSalenumber

totalReferralCountinteger

levelinteger

isSpecialboolean

startDepositstring (date-time)

endPeriodstring (date-time)

rewardAllocatednumber

rewardLimitnumber

refCodestring

directReferralAmountnumber

sponsorLevelAmountnumber

dailyInterestAmountnumber

rankingRewardAmountnumber

sameLevelAmountnumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/wallet/{wallet}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404500

{
  "wallet": "text",
  "depositAmount": 0,
  "availableClaim": 0,
  "referralClaim": 0,
  "totalGroupSale": 0,
  "isSpecial": false,
  "startDeposit": "2024-09-12T01:53:16.470Z",
  "endPeriod": "2024-09-12T01:53:16.470Z",
  "rewardAllocated": 0,
  "rewardLimit": 0,
  "refCode": "text",
  "directReferralAmount": 0,
  "sponsorLevelAmount": 0,
  "dailyInterestAmount": 0,
  "rankingRewardAmount": 0,
  "sameLevelAmount": 0
}

Wallet Log

• Retrieve the log history for a specific wallet address.

Retrieve wallet log

GEThttps://api.sakaivault.io/api/logwallet/{wallet}

Path parameters

wallet*string

Wallet identifier

Response

200500

Wallet log successfully retrieved

Body

application/json

walletstring

kindstring

txhashstring

datestring (date-time)

fromstring

tostring

valuestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/logwallet/{wallet}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "wallet": "text",
    "kind": "text",
    "txhash": "text",
    "date": "2024-09-12T01:53:16.470Z",
    "from": "text",
    "to": "text",
    "value": "text"
  }
]

Log Total

• Retrieve the last 100 logs for transactions.

Retrieve the last 100 logs for transactions

GEThttps://api.sakaivault.io/api/logtotal

Response

200500

Transaction logs successfully retrieved

Body

application/json

_idstring

walletstring

kindstring

txhashstring

datestring (date-time)

fromstring

tostring

valuestring

__vinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/logtotal', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "_id": "text",
    "wallet": "text",
    "kind": "text",
    "txhash": "text",
    "date": "2024-09-12T01:53:16.470Z",
    "from": "text",
    "to": "text",
    "value": "text"
  }
]

Ranking by Deposit

• Retrieve the deposit ranking within a specified time range.

Retrieve deposit ranking by time range

GEThttps://api.sakaivault.io/api/rankdeposit/{timerange}

Path parameters

timerange*string

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

Response

200500

Deposit ranking successfully retrieved

Body

application/json

walletstring

commissionstring

profitstring

depositstring

directReferralCountinteger

totalReferralCountinteger

totalGroupSalestring

levelinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/rankdeposit/{timerange}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "totalGroupSale": "text"
  }
]

Ranking by Profit

• Retrieve the profit ranking within a specified time range.

Retrieve top 100 profit rankings by time range

GEThttps://api.sakaivault.io/api/rankprofit/{timerange}

Path parameters

timerange*string

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

Response

200500

Profit ranking successfully retrieved

Body

application/json

walletstring

commissionstring

profitstring

depositstring

directReferralCountinteger

totalReferralCountinteger

totalGroupSalestring

levelinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/rankprofit/{timerange}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "totalGroupSale": "text"
  }
]

Ranking by Commission

• Retrieve the commission ranking within a specified time range.

Retrieve top 100 commission rankings by time range

GEThttps://api.sakaivault.io/api/rankcommission/{timerange}

Path parameters

timerange*string

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

Response

200500

Commission ranking successfully retrieved

Body

application/json

walletstring

commissionstring

profitstring

depositstring

directReferralCountinteger

totalReferralCountinteger

totalGroupSalestring

levelinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/rankcommission/{timerange}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "wallet": "text",
    "commission": "text",
    "profit": "text",
    "deposit": "text",
    "totalGroupSale": "text"
  }
]

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.

Update the user's balance (ref is optional)

POSThttps://api.sakaivault.io/api/updatebalance

Body

application/json

walletstring

refstring

txhashstring

Response

200400500

Balance updated successfully

Body

application/json

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/updatebalance', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

{
  "status": "text"
}

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.

Claim user's accumulated rewards

POSThttps://api.sakaivault.io/api/claimreward

Body

application/json

txhashstring

Response

200400500

Rewards claimed successfully

Body

application/json

statusstring

txhashstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.sakaivault.io/api/claimreward', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

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